Add initial qualcomm support.
[official-gcc.git] / gcc / doc / invoke.texi
blobc18df986f057801816757777324d10386f683080
1 @c Copyright (C) 1988-2015 Free Software Foundation, Inc.
2 @c This is part of the GCC manual.
3 @c For copying conditions, see the file gcc.texi.
5 @ignore
6 @c man begin INCLUDE
7 @include gcc-vers.texi
8 @c man end
10 @c man begin COPYRIGHT
11 Copyright @copyright{} 1988-2015 Free Software Foundation, Inc.
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.
21 (a) The FSF's Front-Cover Text is:
23      A GNU Manual
25 (b) The FSF's Back-Cover Text is:
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{}
43 Only the most useful options are listed here; see below for the
44 remainder.  @command{g++} accepts mostly the same options as @command{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
63 @node Invoking GCC
64 @chapter GCC Command Options
65 @cindex GCC command options
66 @cindex command options
67 @cindex options, GCC command
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.
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.
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.
88 @cindex C++ compilation options
89 @xref{Invoking G++,,Compiling C++ Programs}, for a summary of special
90 options for compiling C++ programs.
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}}.
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.
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.
114 @c man end
116 @xref{Option Index}, for an index to GCC's options.
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 * Diagnostic Message Formatting Options:: Controlling how diagnostics should
129                         be 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
149 @c man begin OPTIONS
151 @node Option Summary
152 @section Option Summary
154 Here is a summary of all the options, grouped by type.  Explanations are
155 in the following sections.
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{unit} -fdump-go-spec=@var{file}}
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 -fopenacc -fopenmp -fopenmp-simd @gol
172 -fms-extensions -fplan9-extensions -fsso-struct=@var{endianness}
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char @gol
176 -trigraphs -traditional -traditional-cpp}
178 @item C++ Language Options
179 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
180 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
181 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
182 -fno-elide-constructors @gol
183 -fno-enforce-eh-specs @gol
184 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
185 -fno-implicit-templates @gol
186 -fno-implicit-inline-templates @gol
187 -fno-implement-inlines  -fms-extensions @gol
188 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
189 -fno-optional-diags  -fpermissive @gol
190 -fno-pretty-templates @gol
191 -frepo  -fno-rtti -fsized-deallocation @gol
192 -fstats  -ftemplate-backtrace-limit=@var{n} @gol
193 -ftemplate-depth=@var{n} @gol
194 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
195 -fno-weak  -nostdinc++ @gol
196 -fvisibility-inlines-hidden @gol
197 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
198 -fvtv-counts -fvtv-debug @gol
199 -fvisibility-ms-compat @gol
200 -fext-numeric-literals @gol
201 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
202 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wmultiple-inheritance @gol
203 -Wnamespaces -Wnarrowing @gol
204 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
205 -Weffc++  -Wstrict-null-sentinel -Wtemplates @gol
206 -Wno-non-template-friend  -Wold-style-cast @gol
207 -Woverloaded-virtual  -Wno-pmf-conversions @gol
208 -Wsign-promo -Wvirtual-inheritance}
210 @item Objective-C and Objective-C++ Language Options
211 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
212 Objective-C and Objective-C++ Dialects}.
213 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
214 -fgnu-runtime  -fnext-runtime @gol
215 -fno-nil-receivers @gol
216 -fobjc-abi-version=@var{n} @gol
217 -fobjc-call-cxx-cdtors @gol
218 -fobjc-direct-dispatch @gol
219 -fobjc-exceptions @gol
220 -fobjc-gc @gol
221 -fobjc-nilcheck @gol
222 -fobjc-std=objc1 @gol
223 -fno-local-ivars @gol
224 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
225 -freplace-objc-classes @gol
226 -fzero-link @gol
227 -gen-decls @gol
228 -Wassign-intercept @gol
229 -Wno-protocol  -Wselector @gol
230 -Wstrict-selector-match @gol
231 -Wundeclared-selector}
233 @item Diagnostic Message Formatting Options
234 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
235 @gccoptlist{-fmessage-length=@var{n}  @gol
236 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
237 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
238 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
240 @item Warning Options
241 @xref{Warning Options,,Options to Request or Suppress Warnings}.
242 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
243 -pedantic-errors @gol
244 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
245 -Waggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
246 -Wbool-compare -Wduplicated-cond -Wframe-address @gol
247 -Wno-attributes -Wno-builtin-macro-redefined @gol
248 -Wc90-c99-compat -Wc99-c11-compat @gol
249 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
250 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
251 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
252 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
253 -Wdisabled-optimization @gol
254 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
255 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
256 -Wno-endif-labels -Werror  -Werror=* @gol
257 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
258 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
259 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
260 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
261 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
262 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
263 -Winit-self  -Winline  -Wno-int-conversion @gol
264 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
265 -Wnull-dereference @gol
266 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
267 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
268 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args @gol
269 -Wmisleading-indentation -Wmissing-braces @gol
270 -Wmissing-field-initializers -Wmissing-include-dirs @gol
271 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
272 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
273 -Woverride-init-side-effects @gol
274 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
275 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
276 -Wplacement-new -Wpointer-arith  -Wno-pointer-to-int-cast @gol
277 -Wredundant-decls  -Wno-return-local-addr @gol
278 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
279 -Wshift-overflow -Wshift-overflow=@var{n} @gol
280 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
281 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
282 -Wno-scalar-storage-order @gol
283 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
284 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
285 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
286 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
287 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
288 -Wmissing-format-attribute -Wsubobject-linkage @gol
289 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
290 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
291 -Wtype-limits  -Wundef @gol
292 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
293 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
294 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
295 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
296 -Wunused-const-variable @gol
297 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
298 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
299 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
300 -Wzero-as-null-pointer-constant}
302 @item C and Objective-C-only Warning Options
303 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
304 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
305 -Wold-style-declaration  -Wold-style-definition @gol
306 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
307 -Wdeclaration-after-statement -Wpointer-sign}
309 @item Debugging Options
310 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
311 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
312 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
313 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
314 -fsanitize-undefined-trap-on-error @gol
315 -fcheck-pointer-bounds -fchecking -fchkp-check-incomplete-type @gol
316 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
317 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
318 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
319 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
320 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
321 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
322 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
323 -fchkp-use-wrappers @gol
324 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
325 -fdisable-ipa-@var{pass_name} @gol
326 -fdisable-rtl-@var{pass_name} @gol
327 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
328 -fdisable-tree-@var{pass_name} @gol
329 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
330 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
331 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
332 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
333 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
334 -fdump-passes @gol
335 -fdump-statistics @gol
336 -fdump-tree-all @gol
337 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
338 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
339 -fdump-tree-cfg -fdump-tree-alias @gol
340 -fdump-tree-ch @gol
341 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
342 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
343 -fdump-tree-gimple@r{[}-raw@r{]} @gol
344 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
345 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
346 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
347 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
348 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
349 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
350 -fdump-tree-nrv -fdump-tree-vect @gol
351 -fdump-tree-sink @gol
352 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
353 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
354 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
355 -fdump-tree-vtable-verify @gol
356 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
357 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
358 -fdump-final-insns=@var{file} @gol
359 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
360 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
361 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
362 -fenable-@var{kind}-@var{pass} @gol
363 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
364 -fdebug-types-section -fmem-report-wpa @gol
365 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
366 -fopt-info @gol
367 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
368 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
369 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
370 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
371 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
372 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
373 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
374 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
375 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
376 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
377 -fdebug-prefix-map=@var{old}=@var{new} @gol
378 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
379 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
380 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
381 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
382 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
383 -print-sysroot -print-sysroot-headers-suffix @gol
384 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
386 @item Optimization Options
387 @xref{Optimize Options,,Options that Control Optimization}.
388 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
389 -falign-jumps[=@var{n}] @gol
390 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
391 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
392 -fauto-inc-dec -fbranch-probabilities @gol
393 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
394 -fbtr-bb-exclusive -fcaller-saves @gol
395 -fcombine-stack-adjustments -fconserve-stack @gol
396 -fcompare-elim -fcprop-registers -fcrossjumping @gol
397 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
398 -fcx-limited-range @gol
399 -fdata-sections -fdce -fdelayed-branch @gol
400 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
401 -fdevirtualize-at-ltrans -fdse @gol
402 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
403 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
404 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
405 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
406 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
407 -fif-conversion2 -findirect-inlining @gol
408 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
409 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
410 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
411 -fira-algorithm=@var{algorithm} @gol
412 -fira-region=@var{region} -fira-hoist-pressure @gol
413 -fira-loop-pressure -fno-ira-share-save-slots @gol
414 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
415 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
416 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
417 -fkeep-static-consts -flive-range-shrinkage @gol
418 -floop-block -floop-interchange -floop-strip-mine @gol
419 -floop-unroll-and-jam -floop-nest-optimize @gol
420 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
421 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
422 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
423 -fmove-loop-invariants -fno-branch-count-reg @gol
424 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
425 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
426 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
427 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
428 -fomit-frame-pointer -foptimize-sibling-calls @gol
429 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
430 -fprefetch-loop-arrays -fprofile-report @gol
431 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
432 -fprofile-generate=@var{path} @gol
433 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
434 -fprofile-reorder-functions @gol
435 -freciprocal-math -free -frename-registers -freorder-blocks @gol
436 -freorder-blocks-algorithm=@var{algorithm} @gol
437 -freorder-blocks-and-partition -freorder-functions @gol
438 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
439 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
440 -fsched-spec-load -fsched-spec-load-dangerous @gol
441 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
442 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
443 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
444 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
445 -fschedule-fusion @gol
446 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
447 -fselective-scheduling -fselective-scheduling2 @gol
448 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
449 -fsemantic-interposition -fshrink-wrap -fsignaling-nans @gol
450 -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
451 -fsplit-wide-types -fssa-backprop -fssa-phiopt @gol
452 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
453 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
454 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
455 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
456 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
457 -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
458 -ftree-loop-if-convert-stores -ftree-loop-im @gol
459 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
460 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
461 -ftree-loop-vectorize @gol
462 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
463 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
464 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
465 -ftree-vectorize -ftree-vrp @gol
466 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
467 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
468 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
469 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
470 --param @var{name}=@var{value}
471 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
473 @item Preprocessor Options
474 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
475 @gccoptlist{-A@var{question}=@var{answer} @gol
476 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
477 -C  -dD  -dI  -dM  -dN @gol
478 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
479 -idirafter @var{dir} @gol
480 -include @var{file}  -imacros @var{file} @gol
481 -iprefix @var{file}  -iwithprefix @var{dir} @gol
482 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
483 -imultilib @var{dir} -isysroot @var{dir} @gol
484 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
485 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
486 -remap -trigraphs  -undef  -U@var{macro}  @gol
487 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
489 @item Assembler Option
490 @xref{Assembler Options,,Passing Options to the Assembler}.
491 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
493 @item Linker Options
494 @xref{Link Options,,Options for Linking}.
495 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
496 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
497 -s  -static -static-libgcc -static-libstdc++ @gol
498 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
499 -static-libmpx -static-libmpxwrappers @gol
500 -shared -shared-libgcc  -symbolic @gol
501 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
502 -u @var{symbol} -z @var{keyword}}
504 @item Directory Options
505 @xref{Directory Options,,Options for Directory Search}.
506 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
507 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
508 --sysroot=@var{dir} --no-sysroot-suffix}
510 @item Machine Dependent Options
511 @xref{Submodel Options,,Hardware Models and Configurations}.
512 @c This list is ordered alphanumerically by subsection name.
513 @c Try and put the significant identifier (CPU or system) first,
514 @c so users have a clue at guessing where the ones they want will be.
516 @emph{AArch64 Options}
517 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
518 -mgeneral-regs-only @gol
519 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
520 -mstrict-align @gol
521 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
522 -mtls-dialect=desc  -mtls-dialect=traditional @gol
523 -mtls-size=@var{size} @gol
524 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
525 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
526 -mlow-precision-recip-sqrt -mno-low-precision-recip-sqrt@gol
527 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
529 @emph{Adapteva Epiphany Options}
530 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
531 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
532 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
533 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
534 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
535 -msplit-vecmove-early -m1reg-@var{reg}}
537 @emph{ARC Options}
538 @gccoptlist{-mbarrel-shifter @gol
539 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
540 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
541 -mea -mno-mpy -mmul32x16 -mmul64 @gol
542 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
543 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
544 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
545 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
546 -mucb-mcount -mvolatile-cache @gol
547 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
548 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
549 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
550 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
551 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
552 -mtune=@var{cpu} -mmultcost=@var{num} @gol
553 -munalign-prob-threshold=@var{probability} -mmpy-option=@var{multo} @gol
554 -mdiv-rem -mcode-density}
556 @emph{ARM Options}
557 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
558 -mabi=@var{name} @gol
559 -mapcs-stack-check  -mno-apcs-stack-check @gol
560 -mapcs-float  -mno-apcs-float @gol
561 -mapcs-reentrant  -mno-apcs-reentrant @gol
562 -msched-prolog  -mno-sched-prolog @gol
563 -mlittle-endian  -mbig-endian @gol
564 -mfloat-abi=@var{name} @gol
565 -mfp16-format=@var{name}
566 -mthumb-interwork  -mno-thumb-interwork @gol
567 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
568 -mtune=@var{name} -mprint-tune-info @gol
569 -mstructure-size-boundary=@var{n} @gol
570 -mabort-on-noreturn @gol
571 -mlong-calls  -mno-long-calls @gol
572 -msingle-pic-base  -mno-single-pic-base @gol
573 -mpic-register=@var{reg} @gol
574 -mnop-fun-dllimport @gol
575 -mpoke-function-name @gol
576 -mthumb  -marm @gol
577 -mtpcs-frame  -mtpcs-leaf-frame @gol
578 -mcaller-super-interworking  -mcallee-super-interworking @gol
579 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
580 -mword-relocations @gol
581 -mfix-cortex-m3-ldrd @gol
582 -munaligned-access @gol
583 -mneon-for-64bits @gol
584 -mslow-flash-data @gol
585 -masm-syntax-unified @gol
586 -mrestrict-it}
588 @emph{AVR Options}
589 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
590 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
591 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
593 @emph{Blackfin Options}
594 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
595 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
596 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
597 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
598 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
599 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
600 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
601 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
602 -micplb}
604 @emph{C6X Options}
605 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
606 -msim -msdata=@var{sdata-type}}
608 @emph{CRIS Options}
609 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
610 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
611 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
612 -mstack-align  -mdata-align  -mconst-align @gol
613 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
614 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
615 -mmul-bug-workaround  -mno-mul-bug-workaround}
617 @emph{CR16 Options}
618 @gccoptlist{-mmac @gol
619 -mcr16cplus -mcr16c @gol
620 -msim -mint32 -mbit-ops
621 -mdata-model=@var{model}}
623 @emph{Darwin Options}
624 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
625 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
626 -client_name  -compatibility_version  -current_version @gol
627 -dead_strip @gol
628 -dependency-file  -dylib_file  -dylinker_install_name @gol
629 -dynamic  -dynamiclib  -exported_symbols_list @gol
630 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
631 -force_flat_namespace  -headerpad_max_install_names @gol
632 -iframework @gol
633 -image_base  -init  -install_name  -keep_private_externs @gol
634 -multi_module  -multiply_defined  -multiply_defined_unused @gol
635 -noall_load   -no_dead_strip_inits_and_terms @gol
636 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
637 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
638 -private_bundle  -read_only_relocs  -sectalign @gol
639 -sectobjectsymbols  -whyload  -seg1addr @gol
640 -sectcreate  -sectobjectsymbols  -sectorder @gol
641 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
642 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
643 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
644 -single_module  -static  -sub_library  -sub_umbrella @gol
645 -twolevel_namespace  -umbrella  -undefined @gol
646 -unexported_symbols_list  -weak_reference_mismatches @gol
647 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
648 -mkernel -mone-byte-bool}
650 @emph{DEC Alpha Options}
651 @gccoptlist{-mno-fp-regs  -msoft-float @gol
652 -mieee  -mieee-with-inexact  -mieee-conformant @gol
653 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
654 -mtrap-precision=@var{mode}  -mbuild-constants @gol
655 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
656 -mbwx  -mmax  -mfix  -mcix @gol
657 -mfloat-vax  -mfloat-ieee @gol
658 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
659 -msmall-text  -mlarge-text @gol
660 -mmemory-latency=@var{time}}
662 @emph{FR30 Options}
663 @gccoptlist{-msmall-model -mno-lsim}
665 @emph{FT32 Options}
666 @gccoptlist{-msim -mlra}
668 @emph{FRV Options}
669 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
670 -mhard-float  -msoft-float @gol
671 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
672 -mdouble  -mno-double @gol
673 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
674 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
675 -mlinked-fp  -mlong-calls  -malign-labels @gol
676 -mlibrary-pic  -macc-4  -macc-8 @gol
677 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
678 -moptimize-membar -mno-optimize-membar @gol
679 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
680 -mvliw-branch  -mno-vliw-branch @gol
681 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
682 -mno-nested-cond-exec  -mtomcat-stats @gol
683 -mTLS -mtls @gol
684 -mcpu=@var{cpu}}
686 @emph{GNU/Linux Options}
687 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
688 -tno-android-cc -tno-android-ld}
690 @emph{H8/300 Options}
691 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
693 @emph{HPPA Options}
694 @gccoptlist{-march=@var{architecture-type} @gol
695 -mdisable-fpregs  -mdisable-indexing @gol
696 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
697 -mfixed-range=@var{register-range} @gol
698 -mjump-in-delay -mlinker-opt -mlong-calls @gol
699 -mlong-load-store  -mno-disable-fpregs @gol
700 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
701 -mno-jump-in-delay  -mno-long-load-store @gol
702 -mno-portable-runtime  -mno-soft-float @gol
703 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
704 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
705 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
706 -munix=@var{unix-std}  -nolibdld  -static  -threads}
708 @emph{IA-64 Options}
709 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
710 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
711 -mconstant-gp  -mauto-pic  -mfused-madd @gol
712 -minline-float-divide-min-latency @gol
713 -minline-float-divide-max-throughput @gol
714 -mno-inline-float-divide @gol
715 -minline-int-divide-min-latency @gol
716 -minline-int-divide-max-throughput  @gol
717 -mno-inline-int-divide @gol
718 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
719 -mno-inline-sqrt @gol
720 -mdwarf2-asm -mearly-stop-bits @gol
721 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
722 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
723 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
724 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
725 -msched-spec-ldc -msched-spec-control-ldc @gol
726 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
727 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
728 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
729 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
731 @emph{LM32 Options}
732 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
733 -msign-extend-enabled -muser-enabled}
735 @emph{M32R/D Options}
736 @gccoptlist{-m32r2 -m32rx -m32r @gol
737 -mdebug @gol
738 -malign-loops -mno-align-loops @gol
739 -missue-rate=@var{number} @gol
740 -mbranch-cost=@var{number} @gol
741 -mmodel=@var{code-size-model-type} @gol
742 -msdata=@var{sdata-type} @gol
743 -mno-flush-func -mflush-func=@var{name} @gol
744 -mno-flush-trap -mflush-trap=@var{number} @gol
745 -G @var{num}}
747 @emph{M32C Options}
748 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
750 @emph{M680x0 Options}
751 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
752 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
753 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
754 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
755 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
756 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
757 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
758 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
759 -mxgot -mno-xgot}
761 @emph{MCore Options}
762 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
763 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
764 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
765 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
766 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
768 @emph{MeP Options}
769 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
770 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
771 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
772 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
773 -mtiny=@var{n}}
775 @emph{MicroBlaze Options}
776 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
777 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
778 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
779 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
780 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
782 @emph{MIPS Options}
783 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
784 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
785 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
786 -mips16  -mno-mips16  -mflip-mips16 @gol
787 -minterlink-compressed -mno-interlink-compressed @gol
788 -minterlink-mips16  -mno-interlink-mips16 @gol
789 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
790 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
791 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
792 -mno-float  -msingle-float  -mdouble-float @gol
793 -modd-spreg -mno-odd-spreg @gol
794 -mcompact-branches=@var{policy} @gol
795 -mabs=@var{mode}  -mnan=@var{encoding} @gol
796 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
797 -mmcu -mmno-mcu @gol
798 -meva -mno-eva @gol
799 -mvirt -mno-virt @gol
800 -mxpa -mno-xpa @gol
801 -mmicromips -mno-micromips @gol
802 -mfpu=@var{fpu-type} @gol
803 -msmartmips  -mno-smartmips @gol
804 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
805 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
806 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
807 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
808 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
809 -membedded-data  -mno-embedded-data @gol
810 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
811 -mcode-readable=@var{setting} @gol
812 -msplit-addresses  -mno-split-addresses @gol
813 -mexplicit-relocs  -mno-explicit-relocs @gol
814 -mcheck-zero-division  -mno-check-zero-division @gol
815 -mdivide-traps  -mdivide-breaks @gol
816 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
817 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
818 -mfix-24k -mno-fix-24k @gol
819 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
820 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
821 -mfix-vr4120  -mno-fix-vr4120 @gol
822 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
823 -mflush-func=@var{func}  -mno-flush-func @gol
824 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
825 -mfp-exceptions -mno-fp-exceptions @gol
826 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
827 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
828 -mframe-header-opt -mno-frame-header-opt}
830 @emph{MMIX Options}
831 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
832 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
833 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
834 -mno-base-addresses  -msingle-exit  -mno-single-exit}
836 @emph{MN10300 Options}
837 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
838 -mno-am33 -mam33 -mam33-2 -mam34 @gol
839 -mtune=@var{cpu-type} @gol
840 -mreturn-pointer-on-d0 @gol
841 -mno-crt0  -mrelax -mliw -msetlb}
843 @emph{Moxie Options}
844 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
846 @emph{MSP430 Options}
847 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
848 -mcode-region= -mdata-region= @gol
849 -msilicon-errata= -msilicon-errata-warn= @gol
850 -mhwmult= -minrt}
852 @emph{NDS32 Options}
853 @gccoptlist{-mbig-endian -mlittle-endian @gol
854 -mreduced-regs -mfull-regs @gol
855 -mcmov -mno-cmov @gol
856 -mperf-ext -mno-perf-ext @gol
857 -mv3push -mno-v3push @gol
858 -m16bit -mno-16bit @gol
859 -misr-vector-size=@var{num} @gol
860 -mcache-block-size=@var{num} @gol
861 -march=@var{arch} @gol
862 -mcmodel=@var{code-model} @gol
863 -mctor-dtor -mrelax}
865 @emph{Nios II Options}
866 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
867 -mel -meb @gol
868 -mno-bypass-cache -mbypass-cache @gol
869 -mno-cache-volatile -mcache-volatile @gol
870 -mno-fast-sw-div -mfast-sw-div @gol
871 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
872 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
873 -mcustom-fpu-cfg=@var{name} @gol
874 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
875 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
877 @emph{Nvidia PTX Options}
878 @gccoptlist{-m32 -m64 -mmainkernel -moptimize}
880 @emph{PDP-11 Options}
881 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
882 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
883 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
884 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
885 -mbranch-expensive  -mbranch-cheap @gol
886 -munix-asm  -mdec-asm}
888 @emph{picoChip Options}
889 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
890 -msymbol-as-address -mno-inefficient-warnings}
892 @emph{PowerPC Options}
893 See RS/6000 and PowerPC Options.
895 @emph{RL78 Options}
896 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
897 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
898 -m64bit-doubles -m32bit-doubles}
900 @emph{RS/6000 and PowerPC Options}
901 @gccoptlist{-mcpu=@var{cpu-type} @gol
902 -mtune=@var{cpu-type} @gol
903 -mcmodel=@var{code-model} @gol
904 -mpowerpc64 @gol
905 -maltivec  -mno-altivec @gol
906 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
907 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
908 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
909 -mfprnd  -mno-fprnd @gol
910 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
911 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
912 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
913 -malign-power  -malign-natural @gol
914 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
915 -msingle-float -mdouble-float -msimple-fpu @gol
916 -mstring  -mno-string  -mupdate  -mno-update @gol
917 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
918 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
919 -mstrict-align  -mno-strict-align  -mrelocatable @gol
920 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
921 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
922 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
923 -mprioritize-restricted-insns=@var{priority} @gol
924 -msched-costly-dep=@var{dependence_type} @gol
925 -minsert-sched-nops=@var{scheme} @gol
926 -mcall-sysv  -mcall-netbsd @gol
927 -maix-struct-return  -msvr4-struct-return @gol
928 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
929 -mblock-move-inline-limit=@var{num} @gol
930 -misel -mno-isel @gol
931 -misel=yes  -misel=no @gol
932 -mspe -mno-spe @gol
933 -mspe=yes  -mspe=no @gol
934 -mpaired @gol
935 -mgen-cell-microcode -mwarn-cell-microcode @gol
936 -mvrsave -mno-vrsave @gol
937 -mmulhw -mno-mulhw @gol
938 -mdlmzb -mno-dlmzb @gol
939 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
940 -mprototype  -mno-prototype @gol
941 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
942 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
943 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
944 -mno-recip-precision @gol
945 -mveclibabi=@var{type} -mfriz -mno-friz @gol
946 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
947 -msave-toc-indirect -mno-save-toc-indirect @gol
948 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
949 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
950 -mquad-memory -mno-quad-memory @gol
951 -mquad-memory-atomic -mno-quad-memory-atomic @gol
952 -mcompat-align-parm -mno-compat-align-parm @gol
953 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
954 -mupper-regs -mno-upper-regs -mmodulo -mno-modulo @gol
955 -mfloat128 -mno-float128 -mfloat128-hardware -mno-float128-hardware @gol
956 -mpower9-fusion -mno-mpower9-fusion -mpower9-vector -mno-power9-vector}
958 @emph{RX Options}
959 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
960 -mcpu=@gol
961 -mbig-endian-data -mlittle-endian-data @gol
962 -msmall-data @gol
963 -msim  -mno-sim@gol
964 -mas100-syntax -mno-as100-syntax@gol
965 -mrelax@gol
966 -mmax-constant-size=@gol
967 -mint-register=@gol
968 -mpid@gol
969 -mallow-string-insns -mno-allow-string-insns@gol
970 -mno-warn-multiple-fast-interrupts@gol
971 -msave-acc-in-interrupts}
973 @emph{S/390 and zSeries Options}
974 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
975 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
976 -mlong-double-64 -mlong-double-128 @gol
977 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
978 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
979 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
980 -mhtm -mvx -mzvector @gol
981 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
982 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
983 -mhotpatch=@var{halfwords},@var{halfwords}}
985 @emph{Score Options}
986 @gccoptlist{-meb -mel @gol
987 -mnhwloop @gol
988 -muls @gol
989 -mmac @gol
990 -mscore5 -mscore5u -mscore7 -mscore7d}
992 @emph{SH Options}
993 @gccoptlist{-m1  -m2  -m2e @gol
994 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
995 -m3  -m3e @gol
996 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
997 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
998 -mb  -ml  -mdalign  -mrelax @gol
999 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
1000 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
1001 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
1002 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
1003 -maccumulate-outgoing-args @gol
1004 -matomic-model=@var{atomic-model} @gol
1005 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1006 -mcbranch-force-delay-slot @gol
1007 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1008 -mpretend-cmove -mtas}
1010 @emph{Solaris 2 Options}
1011 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1012 -pthreads -pthread}
1014 @emph{SPARC Options}
1015 @gccoptlist{-mcpu=@var{cpu-type} @gol
1016 -mtune=@var{cpu-type} @gol
1017 -mcmodel=@var{code-model} @gol
1018 -mmemory-model=@var{mem-model} @gol
1019 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1020 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1021 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1022 -mhard-quad-float  -msoft-quad-float @gol
1023 -mstack-bias  -mno-stack-bias @gol
1024 -munaligned-doubles  -mno-unaligned-doubles @gol
1025 -muser-mode  -mno-user-mode @gol
1026 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1027 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1028 -mcbcond -mno-cbcond @gol
1029 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1030 -mfix-at697f -mfix-ut699}
1032 @emph{SPU Options}
1033 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1034 -msafe-dma -munsafe-dma @gol
1035 -mbranch-hints @gol
1036 -msmall-mem -mlarge-mem -mstdmain @gol
1037 -mfixed-range=@var{register-range} @gol
1038 -mea32 -mea64 @gol
1039 -maddress-space-conversion -mno-address-space-conversion @gol
1040 -mcache-size=@var{cache-size} @gol
1041 -matomic-updates -mno-atomic-updates}
1043 @emph{System V Options}
1044 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1046 @emph{TILE-Gx Options}
1047 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1048 -mcmodel=@var{code-model}}
1050 @emph{TILEPro Options}
1051 @gccoptlist{-mcpu=@var{cpu} -m32}
1053 @emph{V850 Options}
1054 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1055 -mprolog-function  -mno-prolog-function  -mspace @gol
1056 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1057 -mapp-regs  -mno-app-regs @gol
1058 -mdisable-callt  -mno-disable-callt @gol
1059 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1060 -mv850e -mv850 -mv850e3v5 @gol
1061 -mloop @gol
1062 -mrelax @gol
1063 -mlong-jumps @gol
1064 -msoft-float @gol
1065 -mhard-float @gol
1066 -mgcc-abi @gol
1067 -mrh850-abi @gol
1068 -mbig-switch}
1070 @emph{VAX Options}
1071 @gccoptlist{-mg  -mgnu  -munix}
1073 @emph{Visium Options}
1074 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1075 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1077 @emph{VMS Options}
1078 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1079 -mpointer-size=@var{size}}
1081 @emph{VxWorks Options}
1082 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1083 -Xbind-lazy  -Xbind-now}
1085 @emph{x86 Options}
1086 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1087 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1088 -mfpmath=@var{unit} @gol
1089 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1090 -mno-fp-ret-in-387  -msoft-float @gol
1091 -mno-wide-multiply  -mrtd  -malign-double @gol
1092 -mpreferred-stack-boundary=@var{num} @gol
1093 -mincoming-stack-boundary=@var{num} @gol
1094 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1095 -mrecip -mrecip=@var{opt} @gol
1096 -mvzeroupper -mprefer-avx128 @gol
1097 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1098 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1099 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1100 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
1101 -mprefetchwt1 -mclflushopt -mxsavec -mxsaves @gol
1102 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1103 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mthreads @gol
1104 -mno-align-stringops  -minline-all-stringops @gol
1105 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1106 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1107 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1108 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1109 -mregparm=@var{num}  -msseregparm @gol
1110 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1111 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1112 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1113 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1114 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1115 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1116 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1117 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1119 @emph{x86 Windows Options}
1120 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1121 -mnop-fun-dllimport -mthread @gol
1122 -municode -mwin32 -mwindows -fno-set-stack-executable}
1124 @emph{Xstormy16 Options}
1125 @gccoptlist{-msim}
1127 @emph{Xtensa Options}
1128 @gccoptlist{-mconst16 -mno-const16 @gol
1129 -mfused-madd  -mno-fused-madd @gol
1130 -mforce-no-pic @gol
1131 -mserialize-volatile  -mno-serialize-volatile @gol
1132 -mtext-section-literals  -mno-text-section-literals @gol
1133 -mauto-litpools  -mno-auto-litpools @gol
1134 -mtarget-align  -mno-target-align @gol
1135 -mlongcalls  -mno-longcalls}
1137 @emph{zSeries Options}
1138 See S/390 and zSeries Options.
1140 @item Code Generation Options
1141 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1142 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1143 -ffixed-@var{reg}  -fexceptions @gol
1144 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1145 -fasynchronous-unwind-tables @gol
1146 -fno-gnu-unique @gol
1147 -finhibit-size-directive  -finstrument-functions @gol
1148 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1149 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1150 -fno-common  -fno-ident @gol
1151 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1152 -fno-jump-tables @gol
1153 -frecord-gcc-switches @gol
1154 -freg-struct-return  -fshort-enums @gol
1155 -fshort-double  -fshort-wchar @gol
1156 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1157 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1158 -fno-stack-limit -fsplit-stack @gol
1159 -fleading-underscore  -ftls-model=@var{model} @gol
1160 -fstack-reuse=@var{reuse_level} @gol
1161 -ftrapv  -fwrapv  -fbounds-check @gol
1162 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1163 -fstrict-volatile-bitfields -fsync-libcalls}
1164 @end table
1167 @node Overall Options
1168 @section Options Controlling the Kind of Output
1170 Compilation can involve up to four stages: preprocessing, compilation
1171 proper, assembly and linking, always in that order.  GCC is capable of
1172 preprocessing and compiling several files either into several
1173 assembler input files, or into one assembler input file; then each
1174 assembler input file produces an object file, and linking combines all
1175 the object files (those newly compiled, and those specified as input)
1176 into an executable file.
1178 @cindex file name suffix
1179 For any given input file, the file name suffix determines what kind of
1180 compilation is done:
1182 @table @gcctabopt
1183 @item @var{file}.c
1184 C source code that must be preprocessed.
1186 @item @var{file}.i
1187 C source code that should not be preprocessed.
1189 @item @var{file}.ii
1190 C++ source code that should not be preprocessed.
1192 @item @var{file}.m
1193 Objective-C source code.  Note that you must link with the @file{libobjc}
1194 library to make an Objective-C program work.
1196 @item @var{file}.mi
1197 Objective-C source code that should not be preprocessed.
1199 @item @var{file}.mm
1200 @itemx @var{file}.M
1201 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1202 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1203 to a literal capital M@.
1205 @item @var{file}.mii
1206 Objective-C++ source code that should not be preprocessed.
1208 @item @var{file}.h
1209 C, C++, Objective-C or Objective-C++ header file to be turned into a
1210 precompiled header (default), or C, C++ header file to be turned into an
1211 Ada spec (via the @option{-fdump-ada-spec} switch).
1213 @item @var{file}.cc
1214 @itemx @var{file}.cp
1215 @itemx @var{file}.cxx
1216 @itemx @var{file}.cpp
1217 @itemx @var{file}.CPP
1218 @itemx @var{file}.c++
1219 @itemx @var{file}.C
1220 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1221 the last two letters must both be literally @samp{x}.  Likewise,
1222 @samp{.C} refers to a literal capital C@.
1224 @item @var{file}.mm
1225 @itemx @var{file}.M
1226 Objective-C++ source code that must be preprocessed.
1228 @item @var{file}.mii
1229 Objective-C++ source code that should not be preprocessed.
1231 @item @var{file}.hh
1232 @itemx @var{file}.H
1233 @itemx @var{file}.hp
1234 @itemx @var{file}.hxx
1235 @itemx @var{file}.hpp
1236 @itemx @var{file}.HPP
1237 @itemx @var{file}.h++
1238 @itemx @var{file}.tcc
1239 C++ header file to be turned into a precompiled header or Ada spec.
1241 @item @var{file}.f
1242 @itemx @var{file}.for
1243 @itemx @var{file}.ftn
1244 Fixed form Fortran source code that should not be preprocessed.
1246 @item @var{file}.F
1247 @itemx @var{file}.FOR
1248 @itemx @var{file}.fpp
1249 @itemx @var{file}.FPP
1250 @itemx @var{file}.FTN
1251 Fixed form Fortran source code that must be preprocessed (with the traditional
1252 preprocessor).
1254 @item @var{file}.f90
1255 @itemx @var{file}.f95
1256 @itemx @var{file}.f03
1257 @itemx @var{file}.f08
1258 Free form Fortran source code that should not be preprocessed.
1260 @item @var{file}.F90
1261 @itemx @var{file}.F95
1262 @itemx @var{file}.F03
1263 @itemx @var{file}.F08
1264 Free form Fortran source code that must be preprocessed (with the
1265 traditional preprocessor).
1267 @item @var{file}.go
1268 Go source code.
1270 @c FIXME: Descriptions of Java file types.
1271 @c @var{file}.java
1272 @c @var{file}.class
1273 @c @var{file}.zip
1274 @c @var{file}.jar
1276 @item @var{file}.ads
1277 Ada source code file that contains a library unit declaration (a
1278 declaration of a package, subprogram, or generic, or a generic
1279 instantiation), or a library unit renaming declaration (a package,
1280 generic, or subprogram renaming declaration).  Such files are also
1281 called @dfn{specs}.
1283 @item @var{file}.adb
1284 Ada source code file containing a library unit body (a subprogram or
1285 package body).  Such files are also called @dfn{bodies}.
1287 @c GCC also knows about some suffixes for languages not yet included:
1288 @c Pascal:
1289 @c @var{file}.p
1290 @c @var{file}.pas
1291 @c Ratfor:
1292 @c @var{file}.r
1294 @item @var{file}.s
1295 Assembler code.
1297 @item @var{file}.S
1298 @itemx @var{file}.sx
1299 Assembler code that must be preprocessed.
1301 @item @var{other}
1302 An object file to be fed straight into linking.
1303 Any file name with no recognized suffix is treated this way.
1304 @end table
1306 @opindex x
1307 You can specify the input language explicitly with the @option{-x} option:
1309 @table @gcctabopt
1310 @item -x @var{language}
1311 Specify explicitly the @var{language} for the following input files
1312 (rather than letting the compiler choose a default based on the file
1313 name suffix).  This option applies to all following input files until
1314 the next @option{-x} option.  Possible values for @var{language} are:
1315 @smallexample
1316 c  c-header  cpp-output
1317 c++  c++-header  c++-cpp-output
1318 objective-c  objective-c-header  objective-c-cpp-output
1319 objective-c++ objective-c++-header objective-c++-cpp-output
1320 assembler  assembler-with-cpp
1322 f77  f77-cpp-input f95  f95-cpp-input
1324 java
1325 @end smallexample
1327 @item -x none
1328 Turn off any specification of a language, so that subsequent files are
1329 handled according to their file name suffixes (as they are if @option{-x}
1330 has not been used at all).
1332 @item -pass-exit-codes
1333 @opindex pass-exit-codes
1334 Normally the @command{gcc} program exits with the code of 1 if any
1335 phase of the compiler returns a non-success return code.  If you specify
1336 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1337 the numerically highest error produced by any phase returning an error
1338 indication.  The C, C++, and Fortran front ends return 4 if an internal
1339 compiler error is encountered.
1340 @end table
1342 If you only want some of the stages of compilation, you can use
1343 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1344 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1345 @command{gcc} is to stop.  Note that some combinations (for example,
1346 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1348 @table @gcctabopt
1349 @item -c
1350 @opindex c
1351 Compile or assemble the source files, but do not link.  The linking
1352 stage simply is not done.  The ultimate output is in the form of an
1353 object file for each source file.
1355 By default, the object file name for a source file is made by replacing
1356 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1358 Unrecognized input files, not requiring compilation or assembly, are
1359 ignored.
1361 @item -S
1362 @opindex S
1363 Stop after the stage of compilation proper; do not assemble.  The output
1364 is in the form of an assembler code file for each non-assembler input
1365 file specified.
1367 By default, the assembler file name for a source file is made by
1368 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1370 Input files that don't require compilation are ignored.
1372 @item -E
1373 @opindex E
1374 Stop after the preprocessing stage; do not run the compiler proper.  The
1375 output is in the form of preprocessed source code, which is sent to the
1376 standard output.
1378 Input files that don't require preprocessing are ignored.
1380 @cindex output file option
1381 @item -o @var{file}
1382 @opindex o
1383 Place output in file @var{file}.  This applies to whatever
1384 sort of output is being produced, whether it be an executable file,
1385 an object file, an assembler file or preprocessed C code.
1387 If @option{-o} is not specified, the default is to put an executable
1388 file in @file{a.out}, the object file for
1389 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1390 assembler file in @file{@var{source}.s}, a precompiled header file in
1391 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1392 standard output.
1394 @item -v
1395 @opindex v
1396 Print (on standard error output) the commands executed to run the stages
1397 of compilation.  Also print the version number of the compiler driver
1398 program and of the preprocessor and the compiler proper.
1400 @item -###
1401 @opindex ###
1402 Like @option{-v} except the commands are not executed and arguments
1403 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1404 This is useful for shell scripts to capture the driver-generated command lines.
1406 @item -pipe
1407 @opindex pipe
1408 Use pipes rather than temporary files for communication between the
1409 various stages of compilation.  This fails to work on some systems where
1410 the assembler is unable to read from a pipe; but the GNU assembler has
1411 no trouble.
1413 @item --help
1414 @opindex help
1415 Print (on the standard output) a description of the command-line options
1416 understood by @command{gcc}.  If the @option{-v} option is also specified
1417 then @option{--help} is also passed on to the various processes
1418 invoked by @command{gcc}, so that they can display the command-line options
1419 they accept.  If the @option{-Wextra} option has also been specified
1420 (prior to the @option{--help} option), then command-line options that
1421 have no documentation associated with them are also displayed.
1423 @item --target-help
1424 @opindex target-help
1425 Print (on the standard output) a description of target-specific command-line
1426 options for each tool.  For some targets extra target-specific
1427 information may also be printed.
1429 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1430 Print (on the standard output) a description of the command-line
1431 options understood by the compiler that fit into all specified classes
1432 and qualifiers.  These are the supported classes:
1434 @table @asis
1435 @item @samp{optimizers}
1436 Display all of the optimization options supported by the
1437 compiler.
1439 @item @samp{warnings}
1440 Display all of the options controlling warning messages
1441 produced by the compiler.
1443 @item @samp{target}
1444 Display target-specific options.  Unlike the
1445 @option{--target-help} option however, target-specific options of the
1446 linker and assembler are not displayed.  This is because those
1447 tools do not currently support the extended @option{--help=} syntax.
1449 @item @samp{params}
1450 Display the values recognized by the @option{--param}
1451 option.
1453 @item @var{language}
1454 Display the options supported for @var{language}, where
1455 @var{language} is the name of one of the languages supported in this
1456 version of GCC@.
1458 @item @samp{common}
1459 Display the options that are common to all languages.
1460 @end table
1462 These are the supported qualifiers:
1464 @table @asis
1465 @item @samp{undocumented}
1466 Display only those options that are undocumented.
1468 @item @samp{joined}
1469 Display options taking an argument that appears after an equal
1470 sign in the same continuous piece of text, such as:
1471 @samp{--help=target}.
1473 @item @samp{separate}
1474 Display options taking an argument that appears as a separate word
1475 following the original option, such as: @samp{-o output-file}.
1476 @end table
1478 Thus for example to display all the undocumented target-specific
1479 switches supported by the compiler, use:
1481 @smallexample
1482 --help=target,undocumented
1483 @end smallexample
1485 The sense of a qualifier can be inverted by prefixing it with the
1486 @samp{^} character, so for example to display all binary warning
1487 options (i.e., ones that are either on or off and that do not take an
1488 argument) that have a description, use:
1490 @smallexample
1491 --help=warnings,^joined,^undocumented
1492 @end smallexample
1494 The argument to @option{--help=} should not consist solely of inverted
1495 qualifiers.
1497 Combining several classes is possible, although this usually
1498 restricts the output so much that there is nothing to display.  One
1499 case where it does work, however, is when one of the classes is
1500 @var{target}.  For example, to display all the target-specific
1501 optimization options, use:
1503 @smallexample
1504 --help=target,optimizers
1505 @end smallexample
1507 The @option{--help=} option can be repeated on the command line.  Each
1508 successive use displays its requested class of options, skipping
1509 those that have already been displayed.
1511 If the @option{-Q} option appears on the command line before the
1512 @option{--help=} option, then the descriptive text displayed by
1513 @option{--help=} is changed.  Instead of describing the displayed
1514 options, an indication is given as to whether the option is enabled,
1515 disabled or set to a specific value (assuming that the compiler
1516 knows this at the point where the @option{--help=} option is used).
1518 Here is a truncated example from the ARM port of @command{gcc}:
1520 @smallexample
1521   % gcc -Q -mabi=2 --help=target -c
1522   The following options are target specific:
1523   -mabi=                                2
1524   -mabort-on-noreturn                   [disabled]
1525   -mapcs                                [disabled]
1526 @end smallexample
1528 The output is sensitive to the effects of previous command-line
1529 options, so for example it is possible to find out which optimizations
1530 are enabled at @option{-O2} by using:
1532 @smallexample
1533 -Q -O2 --help=optimizers
1534 @end smallexample
1536 Alternatively you can discover which binary optimizations are enabled
1537 by @option{-O3} by using:
1539 @smallexample
1540 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1541 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1542 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1543 @end smallexample
1545 @item -no-canonical-prefixes
1546 @opindex no-canonical-prefixes
1547 Do not expand any symbolic links, resolve references to @samp{/../}
1548 or @samp{/./}, or make the path absolute when generating a relative
1549 prefix.
1551 @item --version
1552 @opindex version
1553 Display the version number and copyrights of the invoked GCC@.
1555 @item -wrapper
1556 @opindex wrapper
1557 Invoke all subcommands under a wrapper program.  The name of the
1558 wrapper program and its parameters are passed as a comma separated
1559 list.
1561 @smallexample
1562 gcc -c t.c -wrapper gdb,--args
1563 @end smallexample
1565 @noindent
1566 This invokes all subprograms of @command{gcc} under
1567 @samp{gdb --args}, thus the invocation of @command{cc1} is
1568 @samp{gdb --args cc1 @dots{}}.
1570 @item -fplugin=@var{name}.so
1571 @opindex fplugin
1572 Load the plugin code in file @var{name}.so, assumed to be a
1573 shared object to be dlopen'd by the compiler.  The base name of
1574 the shared object file is used to identify the plugin for the
1575 purposes of argument parsing (See
1576 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1577 Each plugin should define the callback functions specified in the
1578 Plugins API.
1580 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1581 @opindex fplugin-arg
1582 Define an argument called @var{key} with a value of @var{value}
1583 for the plugin called @var{name}.
1585 @item -fdump-ada-spec@r{[}-slim@r{]}
1586 @opindex fdump-ada-spec
1587 For C and C++ source and include files, generate corresponding Ada specs.
1588 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1589 GNAT User's Guide}, which provides detailed documentation on this feature.
1591 @item -fada-spec-parent=@var{unit}
1592 @opindex fada-spec-parent
1593 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1594 Ada specs as child units of parent @var{unit}.
1596 @item -fdump-go-spec=@var{file}
1597 @opindex fdump-go-spec
1598 For input files in any language, generate corresponding Go
1599 declarations in @var{file}.  This generates Go @code{const},
1600 @code{type}, @code{var}, and @code{func} declarations which may be a
1601 useful way to start writing a Go interface to code written in some
1602 other language.
1604 @include @value{srcdir}/../libiberty/at-file.texi
1605 @end table
1607 @node Invoking G++
1608 @section Compiling C++ Programs
1610 @cindex suffixes for C++ source
1611 @cindex C++ source file suffixes
1612 C++ source files conventionally use one of the suffixes @samp{.C},
1613 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1614 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1615 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1616 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1617 files with these names and compiles them as C++ programs even if you
1618 call the compiler the same way as for compiling C programs (usually
1619 with the name @command{gcc}).
1621 @findex g++
1622 @findex c++
1623 However, the use of @command{gcc} does not add the C++ library.
1624 @command{g++} is a program that calls GCC and automatically specifies linking
1625 against the C++ library.  It treats @samp{.c},
1626 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1627 files unless @option{-x} is used.  This program is also useful when
1628 precompiling a C header file with a @samp{.h} extension for use in C++
1629 compilations.  On many systems, @command{g++} is also installed with
1630 the name @command{c++}.
1632 @cindex invoking @command{g++}
1633 When you compile C++ programs, you may specify many of the same
1634 command-line options that you use for compiling programs in any
1635 language; or command-line options meaningful for C and related
1636 languages; or options that are meaningful only for C++ programs.
1637 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1638 explanations of options for languages related to C@.
1639 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1640 explanations of options that are meaningful only for C++ programs.
1642 @node C Dialect Options
1643 @section Options Controlling C Dialect
1644 @cindex dialect options
1645 @cindex language dialect options
1646 @cindex options, dialect
1648 The following options control the dialect of C (or languages derived
1649 from C, such as C++, Objective-C and Objective-C++) that the compiler
1650 accepts:
1652 @table @gcctabopt
1653 @cindex ANSI support
1654 @cindex ISO support
1655 @item -ansi
1656 @opindex ansi
1657 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1658 equivalent to @option{-std=c++98}.
1660 This turns off certain features of GCC that are incompatible with ISO
1661 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1662 such as the @code{asm} and @code{typeof} keywords, and
1663 predefined macros such as @code{unix} and @code{vax} that identify the
1664 type of system you are using.  It also enables the undesirable and
1665 rarely used ISO trigraph feature.  For the C compiler,
1666 it disables recognition of C++ style @samp{//} comments as well as
1667 the @code{inline} keyword.
1669 The alternate keywords @code{__asm__}, @code{__extension__},
1670 @code{__inline__} and @code{__typeof__} continue to work despite
1671 @option{-ansi}.  You would not want to use them in an ISO C program, of
1672 course, but it is useful to put them in header files that might be included
1673 in compilations done with @option{-ansi}.  Alternate predefined macros
1674 such as @code{__unix__} and @code{__vax__} are also available, with or
1675 without @option{-ansi}.
1677 The @option{-ansi} option does not cause non-ISO programs to be
1678 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1679 addition to @option{-ansi}.  @xref{Warning Options}.
1681 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1682 option is used.  Some header files may notice this macro and refrain
1683 from declaring certain functions or defining certain macros that the
1684 ISO standard doesn't call for; this is to avoid interfering with any
1685 programs that might use these names for other things.
1687 Functions that are normally built in but do not have semantics
1688 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1689 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1690 built-in functions provided by GCC}, for details of the functions
1691 affected.
1693 @item -std=
1694 @opindex std
1695 Determine the language standard. @xref{Standards,,Language Standards
1696 Supported by GCC}, for details of these standard versions.  This option
1697 is currently only supported when compiling C or C++.
1699 The compiler can accept several base standards, such as @samp{c90} or
1700 @samp{c++98}, and GNU dialects of those standards, such as
1701 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1702 compiler accepts all programs following that standard plus those
1703 using GNU extensions that do not contradict it.  For example,
1704 @option{-std=c90} turns off certain features of GCC that are
1705 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1706 keywords, but not other GNU extensions that do not have a meaning in
1707 ISO C90, such as omitting the middle term of a @code{?:}
1708 expression. On the other hand, when a GNU dialect of a standard is
1709 specified, all features supported by the compiler are enabled, even when
1710 those features change the meaning of the base standard.  As a result, some
1711 strict-conforming programs may be rejected.  The particular standard
1712 is used by @option{-Wpedantic} to identify which features are GNU
1713 extensions given that version of the standard. For example
1714 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1715 comments, while @option{-std=gnu99 -Wpedantic} does not.
1717 A value for this option must be provided; possible values are
1719 @table @samp
1720 @item c90
1721 @itemx c89
1722 @itemx iso9899:1990
1723 Support all ISO C90 programs (certain GNU extensions that conflict
1724 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1726 @item iso9899:199409
1727 ISO C90 as modified in amendment 1.
1729 @item c99
1730 @itemx c9x
1731 @itemx iso9899:1999
1732 @itemx iso9899:199x
1733 ISO C99.  This standard is substantially completely supported, modulo
1734 bugs and floating-point issues
1735 (mainly but not entirely relating to optional C99 features from
1736 Annexes F and G).  See
1737 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1738 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1740 @item c11
1741 @itemx c1x
1742 @itemx iso9899:2011
1743 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1744 substantially completely supported, modulo bugs, floating-point issues
1745 (mainly but not entirely relating to optional C11 features from
1746 Annexes F and G) and the optional Annexes K (Bounds-checking
1747 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1749 @item gnu90
1750 @itemx gnu89
1751 GNU dialect of ISO C90 (including some C99 features).
1753 @item gnu99
1754 @itemx gnu9x
1755 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1757 @item gnu11
1758 @itemx gnu1x
1759 GNU dialect of ISO C11.  This is the default for C code.
1760 The name @samp{gnu1x} is deprecated.
1762 @item c++98
1763 @itemx c++03
1764 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1765 additional defect reports. Same as @option{-ansi} for C++ code.
1767 @item gnu++98
1768 @itemx gnu++03
1769 GNU dialect of @option{-std=c++98}.  This is the default for
1770 C++ code.
1772 @item c++11
1773 @itemx c++0x
1774 The 2011 ISO C++ standard plus amendments.
1775 The name @samp{c++0x} is deprecated.
1777 @item gnu++11
1778 @itemx gnu++0x
1779 GNU dialect of @option{-std=c++11}.
1780 The name @samp{gnu++0x} is deprecated.
1782 @item c++14
1783 @itemx c++1y
1784 The 2014 ISO C++ standard plus amendments.
1785 The name @samp{c++1y} is deprecated.
1787 @item gnu++14
1788 @itemx gnu++1y
1789 GNU dialect of @option{-std=c++14}.
1790 The name @samp{gnu++1y} is deprecated.
1792 @item c++1z
1793 The next revision of the ISO C++ standard, tentatively planned for
1794 2017.  Support is highly experimental, and will almost certainly
1795 change in incompatible ways in future releases.
1797 @item gnu++1z
1798 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1799 and will almost certainly change in incompatible ways in future
1800 releases.
1801 @end table
1803 @item -fgnu89-inline
1804 @opindex fgnu89-inline
1805 The option @option{-fgnu89-inline} tells GCC to use the traditional
1806 GNU semantics for @code{inline} functions when in C99 mode.
1807 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1808 Using this option is roughly equivalent to adding the
1809 @code{gnu_inline} function attribute to all inline functions
1810 (@pxref{Function Attributes}).
1812 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1813 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1814 specifies the default behavior).
1815 This option is not supported in @option{-std=c90} or
1816 @option{-std=gnu90} mode.
1818 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1819 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1820 in effect for @code{inline} functions.  @xref{Common Predefined
1821 Macros,,,cpp,The C Preprocessor}.
1823 @item -aux-info @var{filename}
1824 @opindex aux-info
1825 Output to the given filename prototyped declarations for all functions
1826 declared and/or defined in a translation unit, including those in header
1827 files.  This option is silently ignored in any language other than C@.
1829 Besides declarations, the file indicates, in comments, the origin of
1830 each declaration (source file and line), whether the declaration was
1831 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1832 @samp{O} for old, respectively, in the first character after the line
1833 number and the colon), and whether it came from a declaration or a
1834 definition (@samp{C} or @samp{F}, respectively, in the following
1835 character).  In the case of function definitions, a K&R-style list of
1836 arguments followed by their declarations is also provided, inside
1837 comments, after the declaration.
1839 @item -fallow-parameterless-variadic-functions
1840 @opindex fallow-parameterless-variadic-functions
1841 Accept variadic functions without named parameters.
1843 Although it is possible to define such a function, this is not very
1844 useful as it is not possible to read the arguments.  This is only
1845 supported for C as this construct is allowed by C++.
1847 @item -fno-asm
1848 @opindex fno-asm
1849 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1850 keyword, so that code can use these words as identifiers.  You can use
1851 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1852 instead.  @option{-ansi} implies @option{-fno-asm}.
1854 In C++, this switch only affects the @code{typeof} keyword, since
1855 @code{asm} and @code{inline} are standard keywords.  You may want to
1856 use the @option{-fno-gnu-keywords} flag instead, which has the same
1857 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1858 switch only affects the @code{asm} and @code{typeof} keywords, since
1859 @code{inline} is a standard keyword in ISO C99.
1861 @item -fno-builtin
1862 @itemx -fno-builtin-@var{function}
1863 @opindex fno-builtin
1864 @cindex built-in functions
1865 Don't recognize built-in functions that do not begin with
1866 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1867 functions provided by GCC}, for details of the functions affected,
1868 including those which are not built-in functions when @option{-ansi} or
1869 @option{-std} options for strict ISO C conformance are used because they
1870 do not have an ISO standard meaning.
1872 GCC normally generates special code to handle certain built-in functions
1873 more efficiently; for instance, calls to @code{alloca} may become single
1874 instructions which adjust the stack directly, and calls to @code{memcpy}
1875 may become inline copy loops.  The resulting code is often both smaller
1876 and faster, but since the function calls no longer appear as such, you
1877 cannot set a breakpoint on those calls, nor can you change the behavior
1878 of the functions by linking with a different library.  In addition,
1879 when a function is recognized as a built-in function, GCC may use
1880 information about that function to warn about problems with calls to
1881 that function, or to generate more efficient code, even if the
1882 resulting code still contains calls to that function.  For example,
1883 warnings are given with @option{-Wformat} for bad calls to
1884 @code{printf} when @code{printf} is built in and @code{strlen} is
1885 known not to modify global memory.
1887 With the @option{-fno-builtin-@var{function}} option
1888 only the built-in function @var{function} is
1889 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1890 function is named that is not built-in in this version of GCC, this
1891 option is ignored.  There is no corresponding
1892 @option{-fbuiltin-@var{function}} option; if you wish to enable
1893 built-in functions selectively when using @option{-fno-builtin} or
1894 @option{-ffreestanding}, you may define macros such as:
1896 @smallexample
1897 #define abs(n)          __builtin_abs ((n))
1898 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1899 @end smallexample
1901 @item -fhosted
1902 @opindex fhosted
1903 @cindex hosted environment
1905 Assert that compilation targets a hosted environment.  This implies
1906 @option{-fbuiltin}.  A hosted environment is one in which the
1907 entire standard library is available, and in which @code{main} has a return
1908 type of @code{int}.  Examples are nearly everything except a kernel.
1909 This is equivalent to @option{-fno-freestanding}.
1911 @item -ffreestanding
1912 @opindex ffreestanding
1913 @cindex hosted environment
1915 Assert that compilation targets a freestanding environment.  This
1916 implies @option{-fno-builtin}.  A freestanding environment
1917 is one in which the standard library may not exist, and program startup may
1918 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1919 This is equivalent to @option{-fno-hosted}.
1921 @xref{Standards,,Language Standards Supported by GCC}, for details of
1922 freestanding and hosted environments.
1924 @item -fopenacc
1925 @opindex fopenacc
1926 @cindex OpenACC accelerator programming
1927 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1928 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1929 compiler generates accelerated code according to the OpenACC Application
1930 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1931 implies @option{-pthread}, and thus is only supported on targets that
1932 have support for @option{-pthread}.
1934 Note that this is an experimental feature, incomplete, and subject to
1935 change in future versions of GCC.  See
1936 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1938 @item -fopenmp
1939 @opindex fopenmp
1940 @cindex OpenMP parallel
1941 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1942 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1943 compiler generates parallel code according to the OpenMP Application
1944 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1945 implies @option{-pthread}, and thus is only supported on targets that
1946 have support for @option{-pthread}. @option{-fopenmp} implies
1947 @option{-fopenmp-simd}.
1949 @item -fopenmp-simd
1950 @opindex fopenmp-simd
1951 @cindex OpenMP SIMD
1952 @cindex SIMD
1953 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1954 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1955 are ignored.
1957 @item -fcilkplus
1958 @opindex fcilkplus
1959 @cindex Enable Cilk Plus
1960 Enable the usage of Cilk Plus language extension features for C/C++.
1961 When the option @option{-fcilkplus} is specified, enable the usage of
1962 the Cilk Plus Language extension features for C/C++.  The present
1963 implementation follows ABI version 1.2.  This is an experimental
1964 feature that is only partially complete, and whose interface may
1965 change in future versions of GCC as the official specification
1966 changes.  Currently, all features but @code{_Cilk_for} have been
1967 implemented.
1969 @item -fgnu-tm
1970 @opindex fgnu-tm
1971 When the option @option{-fgnu-tm} is specified, the compiler
1972 generates code for the Linux variant of Intel's current Transactional
1973 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1974 an experimental feature whose interface may change in future versions
1975 of GCC, as the official specification changes.  Please note that not
1976 all architectures are supported for this feature.
1978 For more information on GCC's support for transactional memory,
1979 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1980 Transactional Memory Library}.
1982 Note that the transactional memory feature is not supported with
1983 non-call exceptions (@option{-fnon-call-exceptions}).
1985 @item -fms-extensions
1986 @opindex fms-extensions
1987 Accept some non-standard constructs used in Microsoft header files.
1989 In C++ code, this allows member names in structures to be similar
1990 to previous types declarations.
1992 @smallexample
1993 typedef int UOW;
1994 struct ABC @{
1995   UOW UOW;
1997 @end smallexample
1999 Some cases of unnamed fields in structures and unions are only
2000 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
2001 fields within structs/unions}, for details.
2003 Note that this option is off for all targets but x86 
2004 targets using ms-abi.
2006 @item -fplan9-extensions
2007 @opindex fplan9-extensions
2008 Accept some non-standard constructs used in Plan 9 code.
2010 This enables @option{-fms-extensions}, permits passing pointers to
2011 structures with anonymous fields to functions that expect pointers to
2012 elements of the type of the field, and permits referring to anonymous
2013 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2014 struct/union fields within structs/unions}, for details.  This is only
2015 supported for C, not C++.
2017 @item -trigraphs
2018 @opindex trigraphs
2019 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2020 options for strict ISO C conformance) implies @option{-trigraphs}.
2022 @cindex traditional C language
2023 @cindex C language, traditional
2024 @item -traditional
2025 @itemx -traditional-cpp
2026 @opindex traditional-cpp
2027 @opindex traditional
2028 Formerly, these options caused GCC to attempt to emulate a pre-standard
2029 C compiler.  They are now only supported with the @option{-E} switch.
2030 The preprocessor continues to support a pre-standard mode.  See the GNU
2031 CPP manual for details.
2033 @item -fcond-mismatch
2034 @opindex fcond-mismatch
2035 Allow conditional expressions with mismatched types in the second and
2036 third arguments.  The value of such an expression is void.  This option
2037 is not supported for C++.
2039 @item -flax-vector-conversions
2040 @opindex flax-vector-conversions
2041 Allow implicit conversions between vectors with differing numbers of
2042 elements and/or incompatible element types.  This option should not be
2043 used for new code.
2045 @item -funsigned-char
2046 @opindex funsigned-char
2047 Let the type @code{char} be unsigned, like @code{unsigned char}.
2049 Each kind of machine has a default for what @code{char} should
2050 be.  It is either like @code{unsigned char} by default or like
2051 @code{signed char} by default.
2053 Ideally, a portable program should always use @code{signed char} or
2054 @code{unsigned char} when it depends on the signedness of an object.
2055 But many programs have been written to use plain @code{char} and
2056 expect it to be signed, or expect it to be unsigned, depending on the
2057 machines they were written for.  This option, and its inverse, let you
2058 make such a program work with the opposite default.
2060 The type @code{char} is always a distinct type from each of
2061 @code{signed char} or @code{unsigned char}, even though its behavior
2062 is always just like one of those two.
2064 @item -fsigned-char
2065 @opindex fsigned-char
2066 Let the type @code{char} be signed, like @code{signed char}.
2068 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2069 the negative form of @option{-funsigned-char}.  Likewise, the option
2070 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2072 @item -fsigned-bitfields
2073 @itemx -funsigned-bitfields
2074 @itemx -fno-signed-bitfields
2075 @itemx -fno-unsigned-bitfields
2076 @opindex fsigned-bitfields
2077 @opindex funsigned-bitfields
2078 @opindex fno-signed-bitfields
2079 @opindex fno-unsigned-bitfields
2080 These options control whether a bit-field is signed or unsigned, when the
2081 declaration does not use either @code{signed} or @code{unsigned}.  By
2082 default, such a bit-field is signed, because this is consistent: the
2083 basic integer types such as @code{int} are signed types.
2085 @item -fsso-struct=@var{endianness}
2086 @opindex fsso-struct
2087 Set the default scalar storage order of structures and unions to the
2088 specified endianness.  The accepted values are @samp{big-endian} and
2089 @samp{little-endian}.  If the option is not passed, the compiler uses
2090 the native endianness of the target.  This option is not supported for C++.
2092 @strong{Warning:} the @option{-fsso-struct} switch causes GCC to generate
2093 code that is not binary compatible with code generated without it if the
2094 specified endianness is not the native endianness of the target.
2095 @end table
2097 @node C++ Dialect Options
2098 @section Options Controlling C++ Dialect
2100 @cindex compiler options, C++
2101 @cindex C++ options, command-line
2102 @cindex options, C++
2103 This section describes the command-line options that are only meaningful
2104 for C++ programs.  You can also use most of the GNU compiler options
2105 regardless of what language your program is in.  For example, you
2106 might compile a file @file{firstClass.C} like this:
2108 @smallexample
2109 g++ -g -fstrict-enums -O -c firstClass.C
2110 @end smallexample
2112 @noindent
2113 In this example, only @option{-fstrict-enums} is an option meant
2114 only for C++ programs; you can use the other options with any
2115 language supported by GCC@.
2117 Here is a list of options that are @emph{only} for compiling C++ programs:
2119 @table @gcctabopt
2121 @item -fabi-version=@var{n}
2122 @opindex fabi-version
2123 Use version @var{n} of the C++ ABI@.  The default is version 0.
2125 Version 0 refers to the version conforming most closely to
2126 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2127 will change in different versions of G++ as ABI bugs are fixed.
2129 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2131 Version 2 is the version of the C++ ABI that first appeared in G++
2132 3.4, and was the default through G++ 4.9.
2134 Version 3 corrects an error in mangling a constant address as a
2135 template argument.
2137 Version 4, which first appeared in G++ 4.5, implements a standard
2138 mangling for vector types.
2140 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2141 attribute const/volatile on function pointer types, decltype of a
2142 plain decl, and use of a function parameter in the declaration of
2143 another parameter.
2145 Version 6, which first appeared in G++ 4.7, corrects the promotion
2146 behavior of C++11 scoped enums and the mangling of template argument
2147 packs, const/static_cast, prefix ++ and --, and a class scope function
2148 used as a template argument.
2150 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2151 builtin type and corrects the mangling of lambdas in default argument
2152 scope.
2154 Version 8, which first appeared in G++ 4.9, corrects the substitution
2155 behavior of function types with function-cv-qualifiers.
2157 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2158 @code{nullptr_t}.
2160 Version 10, which first appeared in G++ 6.1, adds mangling of
2161 attributes that affect type identity, such as ia32 calling convention
2162 attributes (e.g. @samp{stdcall}).
2164 See also @option{-Wabi}.
2166 @item -fabi-compat-version=@var{n}
2167 @opindex fabi-compat-version
2168 On targets that support strong aliases, G++
2169 works around mangling changes by creating an alias with the correct
2170 mangled name when defining a symbol with an incorrect mangled name.
2171 This switch specifies which ABI version to use for the alias.
2173 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2174 compatibility).  If another ABI version is explicitly selected, this
2175 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2176 use @option{-fabi-compat-version=2}.
2178 If this option is not provided but @option{-Wabi=@var{n}} is, that
2179 version is used for compatibility aliases.  If this option is provided
2180 along with @option{-Wabi} (without the version), the version from this
2181 option is used for the warning.
2183 @item -fno-access-control
2184 @opindex fno-access-control
2185 Turn off all access checking.  This switch is mainly useful for working
2186 around bugs in the access control code.
2188 @item -fcheck-new
2189 @opindex fcheck-new
2190 Check that the pointer returned by @code{operator new} is non-null
2191 before attempting to modify the storage allocated.  This check is
2192 normally unnecessary because the C++ standard specifies that
2193 @code{operator new} only returns @code{0} if it is declared
2194 @code{throw()}, in which case the compiler always checks the
2195 return value even without this option.  In all other cases, when
2196 @code{operator new} has a non-empty exception specification, memory
2197 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2198 @samp{new (nothrow)}.
2200 @item -fconstexpr-depth=@var{n}
2201 @opindex fconstexpr-depth
2202 Set the maximum nested evaluation depth for C++11 constexpr functions
2203 to @var{n}.  A limit is needed to detect endless recursion during
2204 constant expression evaluation.  The minimum specified by the standard
2205 is 512.
2207 @item -fdeduce-init-list
2208 @opindex fdeduce-init-list
2209 Enable deduction of a template type parameter as
2210 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2212 @smallexample
2213 template <class T> auto forward(T t) -> decltype (realfn (t))
2215   return realfn (t);
2218 void f()
2220   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2222 @end smallexample
2224 This deduction was implemented as a possible extension to the
2225 originally proposed semantics for the C++11 standard, but was not part
2226 of the final standard, so it is disabled by default.  This option is
2227 deprecated, and may be removed in a future version of G++.
2229 @item -ffriend-injection
2230 @opindex ffriend-injection
2231 Inject friend functions into the enclosing namespace, so that they are
2232 visible outside the scope of the class in which they are declared.
2233 Friend functions were documented to work this way in the old Annotated
2234 C++ Reference Manual.  
2235 However, in ISO C++ a friend function that is not declared
2236 in an enclosing scope can only be found using argument dependent
2237 lookup.  GCC defaults to the standard behavior.
2239 This option is for compatibility, and may be removed in a future
2240 release of G++.
2242 @item -fno-elide-constructors
2243 @opindex fno-elide-constructors
2244 The C++ standard allows an implementation to omit creating a temporary
2245 that is only used to initialize another object of the same type.
2246 Specifying this option disables that optimization, and forces G++ to
2247 call the copy constructor in all cases.
2249 @item -fno-enforce-eh-specs
2250 @opindex fno-enforce-eh-specs
2251 Don't generate code to check for violation of exception specifications
2252 at run time.  This option violates the C++ standard, but may be useful
2253 for reducing code size in production builds, much like defining
2254 @code{NDEBUG}.  This does not give user code permission to throw
2255 exceptions in violation of the exception specifications; the compiler
2256 still optimizes based on the specifications, so throwing an
2257 unexpected exception results in undefined behavior at run time.
2259 @item -fextern-tls-init
2260 @itemx -fno-extern-tls-init
2261 @opindex fextern-tls-init
2262 @opindex fno-extern-tls-init
2263 The C++11 and OpenMP standards allow @code{thread_local} and
2264 @code{threadprivate} variables to have dynamic (runtime)
2265 initialization.  To support this, any use of such a variable goes
2266 through a wrapper function that performs any necessary initialization.
2267 When the use and definition of the variable are in the same
2268 translation unit, this overhead can be optimized away, but when the
2269 use is in a different translation unit there is significant overhead
2270 even if the variable doesn't actually need dynamic initialization.  If
2271 the programmer can be sure that no use of the variable in a
2272 non-defining TU needs to trigger dynamic initialization (either
2273 because the variable is statically initialized, or a use of the
2274 variable in the defining TU will be executed before any uses in
2275 another TU), they can avoid this overhead with the
2276 @option{-fno-extern-tls-init} option.
2278 On targets that support symbol aliases, the default is
2279 @option{-fextern-tls-init}.  On targets that do not support symbol
2280 aliases, the default is @option{-fno-extern-tls-init}.
2282 @item -ffor-scope
2283 @itemx -fno-for-scope
2284 @opindex ffor-scope
2285 @opindex fno-for-scope
2286 If @option{-ffor-scope} is specified, the scope of variables declared in
2287 a @i{for-init-statement} is limited to the @code{for} loop itself,
2288 as specified by the C++ standard.
2289 If @option{-fno-for-scope} is specified, the scope of variables declared in
2290 a @i{for-init-statement} extends to the end of the enclosing scope,
2291 as was the case in old versions of G++, and other (traditional)
2292 implementations of C++.
2294 If neither flag is given, the default is to follow the standard,
2295 but to allow and give a warning for old-style code that would
2296 otherwise be invalid, or have different behavior.
2298 @item -fno-gnu-keywords
2299 @opindex fno-gnu-keywords
2300 Do not recognize @code{typeof} as a keyword, so that code can use this
2301 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2302 @option{-ansi} implies @option{-fno-gnu-keywords}.
2304 @item -fno-implicit-templates
2305 @opindex fno-implicit-templates
2306 Never emit code for non-inline templates that are instantiated
2307 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2308 @xref{Template Instantiation}, for more information.
2310 @item -fno-implicit-inline-templates
2311 @opindex fno-implicit-inline-templates
2312 Don't emit code for implicit instantiations of inline templates, either.
2313 The default is to handle inlines differently so that compiles with and
2314 without optimization need the same set of explicit instantiations.
2316 @item -fno-implement-inlines
2317 @opindex fno-implement-inlines
2318 To save space, do not emit out-of-line copies of inline functions
2319 controlled by @code{#pragma implementation}.  This causes linker
2320 errors if these functions are not inlined everywhere they are called.
2322 @item -fms-extensions
2323 @opindex fms-extensions
2324 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2325 int and getting a pointer to member function via non-standard syntax.
2327 @item -fno-nonansi-builtins
2328 @opindex fno-nonansi-builtins
2329 Disable built-in declarations of functions that are not mandated by
2330 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2331 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2333 @item -fnothrow-opt
2334 @opindex fnothrow-opt
2335 Treat a @code{throw()} exception specification as if it were a
2336 @code{noexcept} specification to reduce or eliminate the text size
2337 overhead relative to a function with no exception specification.  If
2338 the function has local variables of types with non-trivial
2339 destructors, the exception specification actually makes the
2340 function smaller because the EH cleanups for those variables can be
2341 optimized away.  The semantic effect is that an exception thrown out of
2342 a function with such an exception specification results in a call
2343 to @code{terminate} rather than @code{unexpected}.
2345 @item -fno-operator-names
2346 @opindex fno-operator-names
2347 Do not treat the operator name keywords @code{and}, @code{bitand},
2348 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2349 synonyms as keywords.
2351 @item -fno-optional-diags
2352 @opindex fno-optional-diags
2353 Disable diagnostics that the standard says a compiler does not need to
2354 issue.  Currently, the only such diagnostic issued by G++ is the one for
2355 a name having multiple meanings within a class.
2357 @item -fpermissive
2358 @opindex fpermissive
2359 Downgrade some diagnostics about nonconformant code from errors to
2360 warnings.  Thus, using @option{-fpermissive} allows some
2361 nonconforming code to compile.
2363 @item -fno-pretty-templates
2364 @opindex fno-pretty-templates
2365 When an error message refers to a specialization of a function
2366 template, the compiler normally prints the signature of the
2367 template followed by the template arguments and any typedefs or
2368 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2369 rather than @code{void f(int)}) so that it's clear which template is
2370 involved.  When an error message refers to a specialization of a class
2371 template, the compiler omits any template arguments that match
2372 the default template arguments for that template.  If either of these
2373 behaviors make it harder to understand the error message rather than
2374 easier, you can use @option{-fno-pretty-templates} to disable them.
2376 @item -frepo
2377 @opindex frepo
2378 Enable automatic template instantiation at link time.  This option also
2379 implies @option{-fno-implicit-templates}.  @xref{Template
2380 Instantiation}, for more information.
2382 @item -fno-rtti
2383 @opindex fno-rtti
2384 Disable generation of information about every class with virtual
2385 functions for use by the C++ run-time type identification features
2386 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2387 of the language, you can save some space by using this flag.  Note that
2388 exception handling uses the same information, but G++ generates it as
2389 needed. The @code{dynamic_cast} operator can still be used for casts that
2390 do not require run-time type information, i.e.@: casts to @code{void *} or to
2391 unambiguous base classes.
2393 @item -fsized-deallocation
2394 @opindex fsized-deallocation
2395 Enable the built-in global declarations
2396 @smallexample
2397 void operator delete (void *, std::size_t) noexcept;
2398 void operator delete[] (void *, std::size_t) noexcept;
2399 @end smallexample
2400 as introduced in C++14.  This is useful for user-defined replacement
2401 deallocation functions that, for example, use the size of the object
2402 to make deallocation faster.  Enabled by default under
2403 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2404 warns about places that might want to add a definition.
2406 @item -fstats
2407 @opindex fstats
2408 Emit statistics about front-end processing at the end of the compilation.
2409 This information is generally only useful to the G++ development team.
2411 @item -fstrict-enums
2412 @opindex fstrict-enums
2413 Allow the compiler to optimize using the assumption that a value of
2414 enumerated type can only be one of the values of the enumeration (as
2415 defined in the C++ standard; basically, a value that can be
2416 represented in the minimum number of bits needed to represent all the
2417 enumerators).  This assumption may not be valid if the program uses a
2418 cast to convert an arbitrary integer value to the enumerated type.
2420 @item -ftemplate-backtrace-limit=@var{n}
2421 @opindex ftemplate-backtrace-limit
2422 Set the maximum number of template instantiation notes for a single
2423 warning or error to @var{n}.  The default value is 10.
2425 @item -ftemplate-depth=@var{n}
2426 @opindex ftemplate-depth
2427 Set the maximum instantiation depth for template classes to @var{n}.
2428 A limit on the template instantiation depth is needed to detect
2429 endless recursions during template class instantiation.  ANSI/ISO C++
2430 conforming programs must not rely on a maximum depth greater than 17
2431 (changed to 1024 in C++11).  The default value is 900, as the compiler
2432 can run out of stack space before hitting 1024 in some situations.
2434 @item -fno-threadsafe-statics
2435 @opindex fno-threadsafe-statics
2436 Do not emit the extra code to use the routines specified in the C++
2437 ABI for thread-safe initialization of local statics.  You can use this
2438 option to reduce code size slightly in code that doesn't need to be
2439 thread-safe.
2441 @item -fuse-cxa-atexit
2442 @opindex fuse-cxa-atexit
2443 Register destructors for objects with static storage duration with the
2444 @code{__cxa_atexit} function rather than the @code{atexit} function.
2445 This option is required for fully standards-compliant handling of static
2446 destructors, but only works if your C library supports
2447 @code{__cxa_atexit}.
2449 @item -fno-use-cxa-get-exception-ptr
2450 @opindex fno-use-cxa-get-exception-ptr
2451 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2452 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2453 if the runtime routine is not available.
2455 @item -fvisibility-inlines-hidden
2456 @opindex fvisibility-inlines-hidden
2457 This switch declares that the user does not attempt to compare
2458 pointers to inline functions or methods where the addresses of the two functions
2459 are taken in different shared objects.
2461 The effect of this is that GCC may, effectively, mark inline methods with
2462 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2463 appear in the export table of a DSO and do not require a PLT indirection
2464 when used within the DSO@.  Enabling this option can have a dramatic effect
2465 on load and link times of a DSO as it massively reduces the size of the
2466 dynamic export table when the library makes heavy use of templates.
2468 The behavior of this switch is not quite the same as marking the
2469 methods as hidden directly, because it does not affect static variables
2470 local to the function or cause the compiler to deduce that
2471 the function is defined in only one shared object.
2473 You may mark a method as having a visibility explicitly to negate the
2474 effect of the switch for that method.  For example, if you do want to
2475 compare pointers to a particular inline method, you might mark it as
2476 having default visibility.  Marking the enclosing class with explicit
2477 visibility has no effect.
2479 Explicitly instantiated inline methods are unaffected by this option
2480 as their linkage might otherwise cross a shared library boundary.
2481 @xref{Template Instantiation}.
2483 @item -fvisibility-ms-compat
2484 @opindex fvisibility-ms-compat
2485 This flag attempts to use visibility settings to make GCC's C++
2486 linkage model compatible with that of Microsoft Visual Studio.
2488 The flag makes these changes to GCC's linkage model:
2490 @enumerate
2491 @item
2492 It sets the default visibility to @code{hidden}, like
2493 @option{-fvisibility=hidden}.
2495 @item
2496 Types, but not their members, are not hidden by default.
2498 @item
2499 The One Definition Rule is relaxed for types without explicit
2500 visibility specifications that are defined in more than one
2501 shared object: those declarations are permitted if they are
2502 permitted when this option is not used.
2503 @end enumerate
2505 In new code it is better to use @option{-fvisibility=hidden} and
2506 export those classes that are intended to be externally visible.
2507 Unfortunately it is possible for code to rely, perhaps accidentally,
2508 on the Visual Studio behavior.
2510 Among the consequences of these changes are that static data members
2511 of the same type with the same name but defined in different shared
2512 objects are different, so changing one does not change the other;
2513 and that pointers to function members defined in different shared
2514 objects may not compare equal.  When this flag is given, it is a
2515 violation of the ODR to define types with the same name differently.
2517 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2518 @opindex fvtable-verify
2519 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2520 feature that verifies at run time, for every virtual call, that
2521 the vtable pointer through which the call is made is valid for the type of
2522 the object, and has not been corrupted or overwritten.  If an invalid vtable
2523 pointer is detected at run time, an error is reported and execution of the
2524 program is immediately halted.
2526 This option causes run-time data structures to be built at program startup,
2527 which are used for verifying the vtable pointers.  
2528 The options @samp{std} and @samp{preinit}
2529 control the timing of when these data structures are built.  In both cases the
2530 data structures are built before execution reaches @code{main}.  Using
2531 @option{-fvtable-verify=std} causes the data structures to be built after
2532 shared libraries have been loaded and initialized.
2533 @option{-fvtable-verify=preinit} causes them to be built before shared
2534 libraries have been loaded and initialized.
2536 If this option appears multiple times in the command line with different
2537 values specified, @samp{none} takes highest priority over both @samp{std} and
2538 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2540 @item -fvtv-debug
2541 @opindex fvtv-debug
2542 When used in conjunction with @option{-fvtable-verify=std} or 
2543 @option{-fvtable-verify=preinit}, causes debug versions of the 
2544 runtime functions for the vtable verification feature to be called.  
2545 This flag also causes the compiler to log information about which 
2546 vtable pointers it finds for each class.
2547 This information is written to a file named @file{vtv_set_ptr_data.log} 
2548 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2549 if that is defined or the current working directory otherwise.
2551 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2552 file, be sure to delete any existing one.
2554 @item -fvtv-counts
2555 @opindex fvtv-counts
2556 This is a debugging flag.  When used in conjunction with
2557 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2558 causes the compiler to keep track of the total number of virtual calls
2559 it encounters and the number of verifications it inserts.  It also
2560 counts the number of calls to certain run-time library functions
2561 that it inserts and logs this information for each compilation unit.
2562 The compiler writes this information to a file named
2563 @file{vtv_count_data.log} in the directory named by the environment
2564 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2565 directory otherwise.  It also counts the size of the vtable pointer sets
2566 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2567 in the same directory.
2569 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2570 files, be sure to delete any existing ones.
2572 @item -fno-weak
2573 @opindex fno-weak
2574 Do not use weak symbol support, even if it is provided by the linker.
2575 By default, G++ uses weak symbols if they are available.  This
2576 option exists only for testing, and should not be used by end-users;
2577 it results in inferior code and has no benefits.  This option may
2578 be removed in a future release of G++.
2580 @item -nostdinc++
2581 @opindex nostdinc++
2582 Do not search for header files in the standard directories specific to
2583 C++, but do still search the other standard directories.  (This option
2584 is used when building the C++ library.)
2585 @end table
2587 In addition, these optimization, warning, and code generation options
2588 have meanings only for C++ programs:
2590 @table @gcctabopt
2591 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2592 @opindex Wabi
2593 @opindex Wno-abi
2594 Warn when G++ it generates code that is probably not compatible with
2595 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2596 ABI with each major release, normally @option{-Wabi} will warn only if
2597 there is a check added later in a release series for an ABI issue
2598 discovered since the initial release.  @option{-Wabi} will warn about
2599 more things if an older ABI version is selected (with
2600 @option{-fabi-version=@var{n}}).
2602 @option{-Wabi} can also be used with an explicit version number to
2603 warn about compatibility with a particular @option{-fabi-version}
2604 level, e.g. @option{-Wabi=2} to warn about changes relative to
2605 @option{-fabi-version=2}.
2607 If an explicit version number is provided and
2608 @option{-fabi-compat-version} is not specified, the version number
2609 from this option is used for compatibility aliases.  If no explicit
2610 version number is provided with this option, but
2611 @option{-fabi-compat-version} is specified, that version number is
2612 used for ABI warnings.
2614 Although an effort has been made to warn about
2615 all such cases, there are probably some cases that are not warned about,
2616 even though G++ is generating incompatible code.  There may also be
2617 cases where warnings are emitted even though the code that is generated
2618 is compatible.
2620 You should rewrite your code to avoid these warnings if you are
2621 concerned about the fact that code generated by G++ may not be binary
2622 compatible with code generated by other compilers.
2624 Known incompatibilities in @option{-fabi-version=2} (which was the
2625 default from GCC 3.4 to 4.9) include:
2627 @itemize @bullet
2629 @item
2630 A template with a non-type template parameter of reference type was
2631 mangled incorrectly:
2632 @smallexample
2633 extern int N;
2634 template <int &> struct S @{@};
2635 void n (S<N>) @{2@}
2636 @end smallexample
2638 This was fixed in @option{-fabi-version=3}.
2640 @item
2641 SIMD vector types declared using @code{__attribute ((vector_size))} were
2642 mangled in a non-standard way that does not allow for overloading of
2643 functions taking vectors of different sizes.
2645 The mangling was changed in @option{-fabi-version=4}.
2647 @item
2648 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2649 qualifiers, and @code{decltype} of a plain declaration was folded away.
2651 These mangling issues were fixed in @option{-fabi-version=5}.
2653 @item
2654 Scoped enumerators passed as arguments to a variadic function are
2655 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2656 On most targets this does not actually affect the parameter passing
2657 ABI, as there is no way to pass an argument smaller than @code{int}.
2659 Also, the ABI changed the mangling of template argument packs,
2660 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2661 a class scope function used as a template argument.
2663 These issues were corrected in @option{-fabi-version=6}.
2665 @item
2666 Lambdas in default argument scope were mangled incorrectly, and the
2667 ABI changed the mangling of @code{nullptr_t}.
2669 These issues were corrected in @option{-fabi-version=7}.
2671 @item
2672 When mangling a function type with function-cv-qualifiers, the
2673 un-qualified function type was incorrectly treated as a substitution
2674 candidate.
2676 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2678 @item
2679 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2680 unaligned accesses.  Note that this did not affect the ABI of a
2681 function with a @code{nullptr_t} parameter, as parameters have a
2682 minimum alignment.
2684 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2686 @item
2687 Target-specific attributes that affect the identity of a type, such as
2688 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2689 did not affect the mangled name, leading to name collisions when
2690 function pointers were used as template arguments.
2692 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2694 @end itemize
2696 It also warns about psABI-related changes.  The known psABI changes at this
2697 point include:
2699 @itemize @bullet
2701 @item
2702 For SysV/x86-64, unions with @code{long double} members are 
2703 passed in memory as specified in psABI.  For example:
2705 @smallexample
2706 union U @{
2707   long double ld;
2708   int i;
2710 @end smallexample
2712 @noindent
2713 @code{union U} is always passed in memory.
2715 @end itemize
2717 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2718 @opindex Wabi-tag
2719 @opindex -Wabi-tag
2720 Warn when a type with an ABI tag is used in a context that does not
2721 have that ABI tag.  See @ref{C++ Attributes} for more information
2722 about ABI tags.
2724 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2725 @opindex Wctor-dtor-privacy
2726 @opindex Wno-ctor-dtor-privacy
2727 Warn when a class seems unusable because all the constructors or
2728 destructors in that class are private, and it has neither friends nor
2729 public static member functions.  Also warn if there are no non-private
2730 methods, and there's at least one private member function that isn't
2731 a constructor or destructor.
2733 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2734 @opindex Wdelete-non-virtual-dtor
2735 @opindex Wno-delete-non-virtual-dtor
2736 Warn when @code{delete} is used to destroy an instance of a class that
2737 has virtual functions and non-virtual destructor. It is unsafe to delete
2738 an instance of a derived class through a pointer to a base class if the
2739 base class does not have a virtual destructor.  This warning is enabled
2740 by @option{-Wall}.
2742 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2743 @opindex Wliteral-suffix
2744 @opindex Wno-literal-suffix
2745 Warn when a string or character literal is followed by a ud-suffix which does
2746 not begin with an underscore.  As a conforming extension, GCC treats such
2747 suffixes as separate preprocessing tokens in order to maintain backwards
2748 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2749 For example:
2751 @smallexample
2752 #define __STDC_FORMAT_MACROS
2753 #include <inttypes.h>
2754 #include <stdio.h>
2756 int main() @{
2757   int64_t i64 = 123;
2758   printf("My int64: %" PRId64"\n", i64);
2760 @end smallexample
2762 In this case, @code{PRId64} is treated as a separate preprocessing token.
2764 This warning is enabled by default.
2766 @item -Wlto-type-mismatch
2767 @opindex Wlto-type-mismatch
2768 @opindex Wno-lto-type-mistmach
2770 During the link-time optimization warn about type mismatches in between
2771 global declarations from different compilation units.
2772 Requires @option{-flto} to be enabled.  Enabled by default.
2774 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2775 @opindex Wnarrowing
2776 @opindex Wno-narrowing
2777 Warn when a narrowing conversion prohibited by C++11 occurs within
2778 @samp{@{ @}}, e.g.
2780 @smallexample
2781 int i = @{ 2.2 @}; // error: narrowing from double to int
2782 @end smallexample
2784 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2786 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2787 required by the standard.  Note that this does not affect the meaning
2788 of well-formed code; narrowing conversions are still considered
2789 ill-formed in SFINAE context.
2791 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2792 @opindex Wnoexcept
2793 @opindex Wno-noexcept
2794 Warn when a noexcept-expression evaluates to false because of a call
2795 to a function that does not have a non-throwing exception
2796 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2797 the compiler to never throw an exception.
2799 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2800 @opindex Wnon-virtual-dtor
2801 @opindex Wno-non-virtual-dtor
2802 Warn when a class has virtual functions and an accessible non-virtual
2803 destructor itself or in an accessible polymorphic base class, in which
2804 case it is possible but unsafe to delete an instance of a derived
2805 class through a pointer to the class itself or base class.  This
2806 warning is automatically enabled if @option{-Weffc++} is specified.
2808 @item -Wreorder @r{(C++ and Objective-C++ only)}
2809 @opindex Wreorder
2810 @opindex Wno-reorder
2811 @cindex reordering, warning
2812 @cindex warning for reordering of member initializers
2813 Warn when the order of member initializers given in the code does not
2814 match the order in which they must be executed.  For instance:
2816 @smallexample
2817 struct A @{
2818   int i;
2819   int j;
2820   A(): j (0), i (1) @{ @}
2822 @end smallexample
2824 @noindent
2825 The compiler rearranges the member initializers for @code{i}
2826 and @code{j} to match the declaration order of the members, emitting
2827 a warning to that effect.  This warning is enabled by @option{-Wall}.
2829 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2830 @opindex fext-numeric-literals
2831 @opindex fno-ext-numeric-literals
2832 Accept imaginary, fixed-point, or machine-defined
2833 literal number suffixes as GNU extensions.
2834 When this option is turned off these suffixes are treated
2835 as C++11 user-defined literal numeric suffixes.
2836 This is on by default for all pre-C++11 dialects and all GNU dialects:
2837 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2838 @option{-std=gnu++14}.
2839 This option is off by default
2840 for ISO C++11 onwards (@option{-std=c++11}, ...).
2841 @end table
2843 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2845 @table @gcctabopt
2846 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2847 @opindex Weffc++
2848 @opindex Wno-effc++
2849 Warn about violations of the following style guidelines from Scott Meyers'
2850 @cite{Effective C++} series of books:
2852 @itemize @bullet
2853 @item
2854 Define a copy constructor and an assignment operator for classes
2855 with dynamically-allocated memory.
2857 @item
2858 Prefer initialization to assignment in constructors.
2860 @item
2861 Have @code{operator=} return a reference to @code{*this}.
2863 @item
2864 Don't try to return a reference when you must return an object.
2866 @item
2867 Distinguish between prefix and postfix forms of increment and
2868 decrement operators.
2870 @item
2871 Never overload @code{&&}, @code{||}, or @code{,}.
2873 @end itemize
2875 This option also enables @option{-Wnon-virtual-dtor}, which is also
2876 one of the effective C++ recommendations.  However, the check is
2877 extended to warn about the lack of virtual destructor in accessible
2878 non-polymorphic bases classes too.
2880 When selecting this option, be aware that the standard library
2881 headers do not obey all of these guidelines; use @samp{grep -v}
2882 to filter out those warnings.
2884 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2885 @opindex Wstrict-null-sentinel
2886 @opindex Wno-strict-null-sentinel
2887 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2888 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2889 to @code{__null}.  Although it is a null pointer constant rather than a
2890 null pointer, it is guaranteed to be of the same size as a pointer.
2891 But this use is not portable across different compilers.
2893 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2894 @opindex Wno-non-template-friend
2895 @opindex Wnon-template-friend
2896 Disable warnings when non-templatized friend functions are declared
2897 within a template.  Since the advent of explicit template specification
2898 support in G++, if the name of the friend is an unqualified-id (i.e.,
2899 @samp{friend foo(int)}), the C++ language specification demands that the
2900 friend declare or define an ordinary, nontemplate function.  (Section
2901 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2902 could be interpreted as a particular specialization of a templatized
2903 function.  Because this non-conforming behavior is no longer the default
2904 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2905 check existing code for potential trouble spots and is on by default.
2906 This new compiler behavior can be turned off with
2907 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2908 but disables the helpful warning.
2910 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2911 @opindex Wold-style-cast
2912 @opindex Wno-old-style-cast
2913 Warn if an old-style (C-style) cast to a non-void type is used within
2914 a C++ program.  The new-style casts (@code{dynamic_cast},
2915 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2916 less vulnerable to unintended effects and much easier to search for.
2918 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2919 @opindex Woverloaded-virtual
2920 @opindex Wno-overloaded-virtual
2921 @cindex overloaded virtual function, warning
2922 @cindex warning for overloaded virtual function
2923 Warn when a function declaration hides virtual functions from a
2924 base class.  For example, in:
2926 @smallexample
2927 struct A @{
2928   virtual void f();
2931 struct B: public A @{
2932   void f(int);
2934 @end smallexample
2936 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2937 like:
2939 @smallexample
2940 B* b;
2941 b->f();
2942 @end smallexample
2944 @noindent
2945 fails to compile.
2947 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2948 @opindex Wno-pmf-conversions
2949 @opindex Wpmf-conversions
2950 Disable the diagnostic for converting a bound pointer to member function
2951 to a plain pointer.
2953 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2954 @opindex Wsign-promo
2955 @opindex Wno-sign-promo
2956 Warn when overload resolution chooses a promotion from unsigned or
2957 enumerated type to a signed type, over a conversion to an unsigned type of
2958 the same size.  Previous versions of G++ tried to preserve
2959 unsignedness, but the standard mandates the current behavior.
2961 @item -Wtemplates @r{(C++ and Objective-C++ only)}
2962 @opindex Wtemplates
2963 Warn when a primary template declaration is encountered.  Some coding
2964 rules disallow templates, and this may be used to enforce that rule.
2965 The warning is inactive inside a system header file, such as the STL, so
2966 one can still use the STL.  One may also instantiate or specialize
2967 templates.
2969 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
2970 @opindex Wmultiple-inheritance
2971 Warn when a class is defined with multiple direct base classes.  Some
2972 coding rules disallow multiple inheritance, and this may be used to
2973 enforce that rule.  The warning is inactive inside a system header file,
2974 such as the STL, so one can still use the STL.  One may also define
2975 classes that indirectly use multiple inheritance.
2977 @item -Wvirtual-inheritance
2978 @opindex Wvirtual-inheritance
2979 Warn when a class is defined with a virtual direct base classe.  Some
2980 coding rules disallow multiple inheritance, and this may be used to
2981 enforce that rule.  The warning is inactive inside a system header file,
2982 such as the STL, so one can still use the STL.  One may also define
2983 classes that indirectly use virtual inheritance.
2985 @item -Wnamespaces
2986 @opindex Wnamespaces
2987 Warn when a namespace definition is opened.  Some coding rules disallow
2988 namespaces, and this may be used to enforce that rule.  The warning is
2989 inactive inside a system header file, such as the STL, so one can still
2990 use the STL.  One may also use using directives and qualified names.
2992 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2993 @opindex Wterminate
2994 @opindex Wno-terminate
2995 Disable the warning about a throw-expression that will immediately
2996 result in a call to @code{terminate}.
2997 @end table
2999 @node Objective-C and Objective-C++ Dialect Options
3000 @section Options Controlling Objective-C and Objective-C++ Dialects
3002 @cindex compiler options, Objective-C and Objective-C++
3003 @cindex Objective-C and Objective-C++ options, command-line
3004 @cindex options, Objective-C and Objective-C++
3005 (NOTE: This manual does not describe the Objective-C and Objective-C++
3006 languages themselves.  @xref{Standards,,Language Standards
3007 Supported by GCC}, for references.)
3009 This section describes the command-line options that are only meaningful
3010 for Objective-C and Objective-C++ programs.  You can also use most of
3011 the language-independent GNU compiler options.
3012 For example, you might compile a file @file{some_class.m} like this:
3014 @smallexample
3015 gcc -g -fgnu-runtime -O -c some_class.m
3016 @end smallexample
3018 @noindent
3019 In this example, @option{-fgnu-runtime} is an option meant only for
3020 Objective-C and Objective-C++ programs; you can use the other options with
3021 any language supported by GCC@.
3023 Note that since Objective-C is an extension of the C language, Objective-C
3024 compilations may also use options specific to the C front-end (e.g.,
3025 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3026 C++-specific options (e.g., @option{-Wabi}).
3028 Here is a list of options that are @emph{only} for compiling Objective-C
3029 and Objective-C++ programs:
3031 @table @gcctabopt
3032 @item -fconstant-string-class=@var{class-name}
3033 @opindex fconstant-string-class
3034 Use @var{class-name} as the name of the class to instantiate for each
3035 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3036 class name is @code{NXConstantString} if the GNU runtime is being used, and
3037 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3038 @option{-fconstant-cfstrings} option, if also present, overrides the
3039 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3040 to be laid out as constant CoreFoundation strings.
3042 @item -fgnu-runtime
3043 @opindex fgnu-runtime
3044 Generate object code compatible with the standard GNU Objective-C
3045 runtime.  This is the default for most types of systems.
3047 @item -fnext-runtime
3048 @opindex fnext-runtime
3049 Generate output compatible with the NeXT runtime.  This is the default
3050 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3051 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3052 used.
3054 @item -fno-nil-receivers
3055 @opindex fno-nil-receivers
3056 Assume that all Objective-C message dispatches (@code{[receiver
3057 message:arg]}) in this translation unit ensure that the receiver is
3058 not @code{nil}.  This allows for more efficient entry points in the
3059 runtime to be used.  This option is only available in conjunction with
3060 the NeXT runtime and ABI version 0 or 1.
3062 @item -fobjc-abi-version=@var{n}
3063 @opindex fobjc-abi-version
3064 Use version @var{n} of the Objective-C ABI for the selected runtime.
3065 This option is currently supported only for the NeXT runtime.  In that
3066 case, Version 0 is the traditional (32-bit) ABI without support for
3067 properties and other Objective-C 2.0 additions.  Version 1 is the
3068 traditional (32-bit) ABI with support for properties and other
3069 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3070 nothing is specified, the default is Version 0 on 32-bit target
3071 machines, and Version 2 on 64-bit target machines.
3073 @item -fobjc-call-cxx-cdtors
3074 @opindex fobjc-call-cxx-cdtors
3075 For each Objective-C class, check if any of its instance variables is a
3076 C++ object with a non-trivial default constructor.  If so, synthesize a
3077 special @code{- (id) .cxx_construct} instance method which runs
3078 non-trivial default constructors on any such instance variables, in order,
3079 and then return @code{self}.  Similarly, check if any instance variable
3080 is a C++ object with a non-trivial destructor, and if so, synthesize a
3081 special @code{- (void) .cxx_destruct} method which runs
3082 all such default destructors, in reverse order.
3084 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3085 methods thusly generated only operate on instance variables
3086 declared in the current Objective-C class, and not those inherited
3087 from superclasses.  It is the responsibility of the Objective-C
3088 runtime to invoke all such methods in an object's inheritance
3089 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3090 by the runtime immediately after a new object instance is allocated;
3091 the @code{- (void) .cxx_destruct} methods are invoked immediately
3092 before the runtime deallocates an object instance.
3094 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3095 support for invoking the @code{- (id) .cxx_construct} and
3096 @code{- (void) .cxx_destruct} methods.
3098 @item -fobjc-direct-dispatch
3099 @opindex fobjc-direct-dispatch
3100 Allow fast jumps to the message dispatcher.  On Darwin this is
3101 accomplished via the comm page.
3103 @item -fobjc-exceptions
3104 @opindex fobjc-exceptions
3105 Enable syntactic support for structured exception handling in
3106 Objective-C, similar to what is offered by C++ and Java.  This option
3107 is required to use the Objective-C keywords @code{@@try},
3108 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3109 @code{@@synchronized}.  This option is available with both the GNU
3110 runtime and the NeXT runtime (but not available in conjunction with
3111 the NeXT runtime on Mac OS X 10.2 and earlier).
3113 @item -fobjc-gc
3114 @opindex fobjc-gc
3115 Enable garbage collection (GC) in Objective-C and Objective-C++
3116 programs.  This option is only available with the NeXT runtime; the
3117 GNU runtime has a different garbage collection implementation that
3118 does not require special compiler flags.
3120 @item -fobjc-nilcheck
3121 @opindex fobjc-nilcheck
3122 For the NeXT runtime with version 2 of the ABI, check for a nil
3123 receiver in method invocations before doing the actual method call.
3124 This is the default and can be disabled using
3125 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3126 checked for nil in this way no matter what this flag is set to.
3127 Currently this flag does nothing when the GNU runtime, or an older
3128 version of the NeXT runtime ABI, is used.
3130 @item -fobjc-std=objc1
3131 @opindex fobjc-std
3132 Conform to the language syntax of Objective-C 1.0, the language
3133 recognized by GCC 4.0.  This only affects the Objective-C additions to
3134 the C/C++ language; it does not affect conformance to C/C++ standards,
3135 which is controlled by the separate C/C++ dialect option flags.  When
3136 this option is used with the Objective-C or Objective-C++ compiler,
3137 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3138 This is useful if you need to make sure that your Objective-C code can
3139 be compiled with older versions of GCC@.
3141 @item -freplace-objc-classes
3142 @opindex freplace-objc-classes
3143 Emit a special marker instructing @command{ld(1)} not to statically link in
3144 the resulting object file, and allow @command{dyld(1)} to load it in at
3145 run time instead.  This is used in conjunction with the Fix-and-Continue
3146 debugging mode, where the object file in question may be recompiled and
3147 dynamically reloaded in the course of program execution, without the need
3148 to restart the program itself.  Currently, Fix-and-Continue functionality
3149 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3150 and later.
3152 @item -fzero-link
3153 @opindex fzero-link
3154 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3155 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3156 compile time) with static class references that get initialized at load time,
3157 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3158 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3159 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3160 for individual class implementations to be modified during program execution.
3161 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3162 regardless of command-line options.
3164 @item -fno-local-ivars
3165 @opindex fno-local-ivars
3166 @opindex flocal-ivars
3167 By default instance variables in Objective-C can be accessed as if
3168 they were local variables from within the methods of the class they're
3169 declared in.  This can lead to shadowing between instance variables
3170 and other variables declared either locally inside a class method or
3171 globally with the same name.  Specifying the @option{-fno-local-ivars}
3172 flag disables this behavior thus avoiding variable shadowing issues.
3174 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3175 @opindex fivar-visibility
3176 Set the default instance variable visibility to the specified option
3177 so that instance variables declared outside the scope of any access
3178 modifier directives default to the specified visibility.
3180 @item -gen-decls
3181 @opindex gen-decls
3182 Dump interface declarations for all classes seen in the source file to a
3183 file named @file{@var{sourcename}.decl}.
3185 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3186 @opindex Wassign-intercept
3187 @opindex Wno-assign-intercept
3188 Warn whenever an Objective-C assignment is being intercepted by the
3189 garbage collector.
3191 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3192 @opindex Wno-protocol
3193 @opindex Wprotocol
3194 If a class is declared to implement a protocol, a warning is issued for
3195 every method in the protocol that is not implemented by the class.  The
3196 default behavior is to issue a warning for every method not explicitly
3197 implemented in the class, even if a method implementation is inherited
3198 from the superclass.  If you use the @option{-Wno-protocol} option, then
3199 methods inherited from the superclass are considered to be implemented,
3200 and no warning is issued for them.
3202 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3203 @opindex Wselector
3204 @opindex Wno-selector
3205 Warn if multiple methods of different types for the same selector are
3206 found during compilation.  The check is performed on the list of methods
3207 in the final stage of compilation.  Additionally, a check is performed
3208 for each selector appearing in a @code{@@selector(@dots{})}
3209 expression, and a corresponding method for that selector has been found
3210 during compilation.  Because these checks scan the method table only at
3211 the end of compilation, these warnings are not produced if the final
3212 stage of compilation is not reached, for example because an error is
3213 found during compilation, or because the @option{-fsyntax-only} option is
3214 being used.
3216 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3217 @opindex Wstrict-selector-match
3218 @opindex Wno-strict-selector-match
3219 Warn if multiple methods with differing argument and/or return types are
3220 found for a given selector when attempting to send a message using this
3221 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3222 is off (which is the default behavior), the compiler omits such warnings
3223 if any differences found are confined to types that share the same size
3224 and alignment.
3226 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3227 @opindex Wundeclared-selector
3228 @opindex Wno-undeclared-selector
3229 Warn if a @code{@@selector(@dots{})} expression referring to an
3230 undeclared selector is found.  A selector is considered undeclared if no
3231 method with that name has been declared before the
3232 @code{@@selector(@dots{})} expression, either explicitly in an
3233 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3234 an @code{@@implementation} section.  This option always performs its
3235 checks as soon as a @code{@@selector(@dots{})} expression is found,
3236 while @option{-Wselector} only performs its checks in the final stage of
3237 compilation.  This also enforces the coding style convention
3238 that methods and selectors must be declared before being used.
3240 @item -print-objc-runtime-info
3241 @opindex print-objc-runtime-info
3242 Generate C header describing the largest structure that is passed by
3243 value, if any.
3245 @end table
3247 @node Diagnostic Message Formatting Options
3248 @section Options to Control Diagnostic Messages Formatting
3249 @cindex options to control diagnostics formatting
3250 @cindex diagnostic messages
3251 @cindex message formatting
3253 Traditionally, diagnostic messages have been formatted irrespective of
3254 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3255 options described below
3256 to control the formatting algorithm for diagnostic messages, 
3257 e.g.@: how many characters per line, how often source location
3258 information should be reported.  Note that some language front ends may not
3259 honor these options.
3261 @table @gcctabopt
3262 @item -fmessage-length=@var{n}
3263 @opindex fmessage-length
3264 Try to format error messages so that they fit on lines of about
3265 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3266 done; each error message appears on a single line.  This is the
3267 default for all front ends.
3269 @item -fdiagnostics-show-location=once
3270 @opindex fdiagnostics-show-location
3271 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3272 reporter to emit source location information @emph{once}; that is, in
3273 case the message is too long to fit on a single physical line and has to
3274 be wrapped, the source location won't be emitted (as prefix) again,
3275 over and over, in subsequent continuation lines.  This is the default
3276 behavior.
3278 @item -fdiagnostics-show-location=every-line
3279 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3280 messages reporter to emit the same source location information (as
3281 prefix) for physical lines that result from the process of breaking
3282 a message which is too long to fit on a single line.
3284 @item -fdiagnostics-color[=@var{WHEN}]
3285 @itemx -fno-diagnostics-color
3286 @opindex fdiagnostics-color
3287 @cindex highlight, color, colour
3288 @vindex GCC_COLORS @r{environment variable}
3289 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3290 or @samp{auto}.  The default depends on how the compiler has been configured,
3291 it can be any of the above @var{WHEN} options or also @samp{never}
3292 if @env{GCC_COLORS} environment variable isn't present in the environment,
3293 and @samp{auto} otherwise.
3294 @samp{auto} means to use color only when the standard error is a terminal.
3295 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3296 aliases for @option{-fdiagnostics-color=always} and
3297 @option{-fdiagnostics-color=never}, respectively.
3299 The colors are defined by the environment variable @env{GCC_COLORS}.
3300 Its value is a colon-separated list of capabilities and Select Graphic
3301 Rendition (SGR) substrings. SGR commands are interpreted by the
3302 terminal or terminal emulator.  (See the section in the documentation
3303 of your text terminal for permitted values and their meanings as
3304 character attributes.)  These substring values are integers in decimal
3305 representation and can be concatenated with semicolons.
3306 Common values to concatenate include
3307 @samp{1} for bold,
3308 @samp{4} for underline,
3309 @samp{5} for blink,
3310 @samp{7} for inverse,
3311 @samp{39} for default foreground color,
3312 @samp{30} to @samp{37} for foreground colors,
3313 @samp{90} to @samp{97} for 16-color mode foreground colors,
3314 @samp{38;5;0} to @samp{38;5;255}
3315 for 88-color and 256-color modes foreground colors,
3316 @samp{49} for default background color,
3317 @samp{40} to @samp{47} for background colors,
3318 @samp{100} to @samp{107} for 16-color mode background colors,
3319 and @samp{48;5;0} to @samp{48;5;255}
3320 for 88-color and 256-color modes background colors.
3322 The default @env{GCC_COLORS} is
3323 @smallexample
3324 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3325 @end smallexample
3326 @noindent
3327 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3328 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3329 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3330 string disables colors.
3331 Supported capabilities are as follows.
3333 @table @code
3334 @item error=
3335 @vindex error GCC_COLORS @r{capability}
3336 SGR substring for error: markers.
3338 @item warning=
3339 @vindex warning GCC_COLORS @r{capability}
3340 SGR substring for warning: markers.
3342 @item note=
3343 @vindex note GCC_COLORS @r{capability}
3344 SGR substring for note: markers.
3346 @item caret=
3347 @vindex caret GCC_COLORS @r{capability}
3348 SGR substring for caret line.
3350 @item locus=
3351 @vindex locus GCC_COLORS @r{capability}
3352 SGR substring for location information, @samp{file:line} or
3353 @samp{file:line:column} etc.
3355 @item quote=
3356 @vindex quote GCC_COLORS @r{capability}
3357 SGR substring for information printed within quotes.
3358 @end table
3360 @item -fno-diagnostics-show-option
3361 @opindex fno-diagnostics-show-option
3362 @opindex fdiagnostics-show-option
3363 By default, each diagnostic emitted includes text indicating the
3364 command-line option that directly controls the diagnostic (if such an
3365 option is known to the diagnostic machinery).  Specifying the
3366 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3368 @item -fno-diagnostics-show-caret
3369 @opindex fno-diagnostics-show-caret
3370 @opindex fdiagnostics-show-caret
3371 By default, each diagnostic emitted includes the original source line
3372 and a caret '^' indicating the column.  This option suppresses this
3373 information.  The source line is truncated to @var{n} characters, if
3374 the @option{-fmessage-length=n} option is given.  When the output is done
3375 to the terminal, the width is limited to the width given by the
3376 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3378 @end table
3380 @node Warning Options
3381 @section Options to Request or Suppress Warnings
3382 @cindex options to control warnings
3383 @cindex warning messages
3384 @cindex messages, warning
3385 @cindex suppressing warnings
3387 Warnings are diagnostic messages that report constructions that
3388 are not inherently erroneous but that are risky or suggest there
3389 may have been an error.
3391 The following language-independent options do not enable specific
3392 warnings but control the kinds of diagnostics produced by GCC@.
3394 @table @gcctabopt
3395 @cindex syntax checking
3396 @item -fsyntax-only
3397 @opindex fsyntax-only
3398 Check the code for syntax errors, but don't do anything beyond that.
3400 @item -fmax-errors=@var{n}
3401 @opindex fmax-errors
3402 Limits the maximum number of error messages to @var{n}, at which point
3403 GCC bails out rather than attempting to continue processing the source
3404 code.  If @var{n} is 0 (the default), there is no limit on the number
3405 of error messages produced.  If @option{-Wfatal-errors} is also
3406 specified, then @option{-Wfatal-errors} takes precedence over this
3407 option.
3409 @item -w
3410 @opindex w
3411 Inhibit all warning messages.
3413 @item -Werror
3414 @opindex Werror
3415 @opindex Wno-error
3416 Make all warnings into errors.
3418 @item -Werror=
3419 @opindex Werror=
3420 @opindex Wno-error=
3421 Make the specified warning into an error.  The specifier for a warning
3422 is appended; for example @option{-Werror=switch} turns the warnings
3423 controlled by @option{-Wswitch} into errors.  This switch takes a
3424 negative form, to be used to negate @option{-Werror} for specific
3425 warnings; for example @option{-Wno-error=switch} makes
3426 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3427 is in effect.
3429 The warning message for each controllable warning includes the
3430 option that controls the warning.  That option can then be used with
3431 @option{-Werror=} and @option{-Wno-error=} as described above.
3432 (Printing of the option in the warning message can be disabled using the
3433 @option{-fno-diagnostics-show-option} flag.)
3435 Note that specifying @option{-Werror=}@var{foo} automatically implies
3436 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3437 imply anything.
3439 @item -Wfatal-errors
3440 @opindex Wfatal-errors
3441 @opindex Wno-fatal-errors
3442 This option causes the compiler to abort compilation on the first error
3443 occurred rather than trying to keep going and printing further error
3444 messages.
3446 @end table
3448 You can request many specific warnings with options beginning with
3449 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3450 implicit declarations.  Each of these specific warning options also
3451 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3452 example, @option{-Wno-implicit}.  This manual lists only one of the
3453 two forms, whichever is not the default.  For further
3454 language-specific options also refer to @ref{C++ Dialect Options} and
3455 @ref{Objective-C and Objective-C++ Dialect Options}.
3457 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3458 options, such as @option{-Wunused}, which may turn on further options,
3459 such as @option{-Wunused-value}. The combined effect of positive and
3460 negative forms is that more specific options have priority over less
3461 specific ones, independently of their position in the command-line. For
3462 options of the same specificity, the last one takes effect. Options
3463 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3464 as if they appeared at the end of the command-line.
3466 When an unrecognized warning option is requested (e.g.,
3467 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3468 that the option is not recognized.  However, if the @option{-Wno-} form
3469 is used, the behavior is slightly different: no diagnostic is
3470 produced for @option{-Wno-unknown-warning} unless other diagnostics
3471 are being produced.  This allows the use of new @option{-Wno-} options
3472 with old compilers, but if something goes wrong, the compiler
3473 warns that an unrecognized option is present.
3475 @table @gcctabopt
3476 @item -Wpedantic
3477 @itemx -pedantic
3478 @opindex pedantic
3479 @opindex Wpedantic
3480 Issue all the warnings demanded by strict ISO C and ISO C++;
3481 reject all programs that use forbidden extensions, and some other
3482 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3483 version of the ISO C standard specified by any @option{-std} option used.
3485 Valid ISO C and ISO C++ programs should compile properly with or without
3486 this option (though a rare few require @option{-ansi} or a
3487 @option{-std} option specifying the required version of ISO C)@.  However,
3488 without this option, certain GNU extensions and traditional C and C++
3489 features are supported as well.  With this option, they are rejected.
3491 @option{-Wpedantic} does not cause warning messages for use of the
3492 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3493 warnings are also disabled in the expression that follows
3494 @code{__extension__}.  However, only system header files should use
3495 these escape routes; application programs should avoid them.
3496 @xref{Alternate Keywords}.
3498 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3499 C conformance.  They soon find that it does not do quite what they want:
3500 it finds some non-ISO practices, but not all---only those for which
3501 ISO C @emph{requires} a diagnostic, and some others for which
3502 diagnostics have been added.
3504 A feature to report any failure to conform to ISO C might be useful in
3505 some instances, but would require considerable additional work and would
3506 be quite different from @option{-Wpedantic}.  We don't have plans to
3507 support such a feature in the near future.
3509 Where the standard specified with @option{-std} represents a GNU
3510 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3511 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3512 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3513 where they are required by the base standard.  (It does not make sense
3514 for such warnings to be given only for features not in the specified GNU
3515 C dialect, since by definition the GNU dialects of C include all
3516 features the compiler supports with the given option, and there would be
3517 nothing to warn about.)
3519 @item -pedantic-errors
3520 @opindex pedantic-errors
3521 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3522 requires a diagnostic, in some cases where there is undefined behavior
3523 at compile-time and in some other cases that do not prevent compilation
3524 of programs that are valid according to the standard. This is not
3525 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3526 by this option and not enabled by the latter and vice versa.
3528 @item -Wall
3529 @opindex Wall
3530 @opindex Wno-all
3531 This enables all the warnings about constructions that some users
3532 consider questionable, and that are easy to avoid (or modify to
3533 prevent the warning), even in conjunction with macros.  This also
3534 enables some language-specific warnings described in @ref{C++ Dialect
3535 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3537 @option{-Wall} turns on the following warning flags:
3539 @gccoptlist{-Waddress   @gol
3540 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3541 -Wc++11-compat  -Wc++14-compat@gol
3542 -Wchar-subscripts  @gol
3543 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3544 -Wimplicit-int @r{(C and Objective-C only)} @gol
3545 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3546 -Wbool-compare  @gol
3547 -Wduplicated-cond  @gol
3548 -Wcomment  @gol
3549 -Wformat   @gol
3550 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3551 -Wmaybe-uninitialized @gol
3552 -Wmissing-braces @r{(only for C/ObjC)} @gol
3553 -Wnonnull  @gol
3554 -Wopenmp-simd @gol
3555 -Wparentheses  @gol
3556 -Wpointer-sign  @gol
3557 -Wreorder   @gol
3558 -Wreturn-type  @gol
3559 -Wsequence-point  @gol
3560 -Wsign-compare @r{(only in C++)}  @gol
3561 -Wstrict-aliasing  @gol
3562 -Wstrict-overflow=1  @gol
3563 -Wswitch  @gol
3564 -Wtautological-compare  @gol
3565 -Wtrigraphs  @gol
3566 -Wuninitialized  @gol
3567 -Wunknown-pragmas  @gol
3568 -Wunused-function  @gol
3569 -Wunused-label     @gol
3570 -Wunused-value     @gol
3571 -Wunused-variable  @gol
3572 -Wvolatile-register-var @gol
3575 Note that some warning flags are not implied by @option{-Wall}.  Some of
3576 them warn about constructions that users generally do not consider
3577 questionable, but which occasionally you might wish to check for;
3578 others warn about constructions that are necessary or hard to avoid in
3579 some cases, and there is no simple way to modify the code to suppress
3580 the warning. Some of them are enabled by @option{-Wextra} but many of
3581 them must be enabled individually.
3583 @item -Wextra
3584 @opindex W
3585 @opindex Wextra
3586 @opindex Wno-extra
3587 This enables some extra warning flags that are not enabled by
3588 @option{-Wall}. (This option used to be called @option{-W}.  The older
3589 name is still supported, but the newer name is more descriptive.)
3591 @gccoptlist{-Wclobbered  @gol
3592 -Wempty-body  @gol
3593 -Wignored-qualifiers @gol
3594 -Wmissing-field-initializers  @gol
3595 -Wmissing-parameter-type @r{(C only)}  @gol
3596 -Wold-style-declaration @r{(C only)}  @gol
3597 -Woverride-init  @gol
3598 -Wsign-compare  @gol
3599 -Wtype-limits  @gol
3600 -Wuninitialized  @gol
3601 -Wshift-negative-value  @gol
3602 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3603 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3606 The option @option{-Wextra} also prints warning messages for the
3607 following cases:
3609 @itemize @bullet
3611 @item
3612 A pointer is compared against integer zero with @code{<}, @code{<=},
3613 @code{>}, or @code{>=}.
3615 @item
3616 (C++ only) An enumerator and a non-enumerator both appear in a
3617 conditional expression.
3619 @item
3620 (C++ only) Ambiguous virtual bases.
3622 @item
3623 (C++ only) Subscripting an array that has been declared @code{register}.
3625 @item
3626 (C++ only) Taking the address of a variable that has been declared
3627 @code{register}.
3629 @item
3630 (C++ only) A base class is not initialized in a derived class's copy
3631 constructor.
3633 @end itemize
3635 @item -Wchar-subscripts
3636 @opindex Wchar-subscripts
3637 @opindex Wno-char-subscripts
3638 Warn if an array subscript has type @code{char}.  This is a common cause
3639 of error, as programmers often forget that this type is signed on some
3640 machines.
3641 This warning is enabled by @option{-Wall}.
3643 @item -Wcomment
3644 @opindex Wcomment
3645 @opindex Wno-comment
3646 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3647 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3648 This warning is enabled by @option{-Wall}.
3650 @item -Wno-coverage-mismatch
3651 @opindex Wno-coverage-mismatch
3652 Warn if feedback profiles do not match when using the
3653 @option{-fprofile-use} option.
3654 If a source file is changed between compiling with @option{-fprofile-gen} and
3655 with @option{-fprofile-use}, the files with the profile feedback can fail
3656 to match the source file and GCC cannot use the profile feedback
3657 information.  By default, this warning is enabled and is treated as an
3658 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3659 warning or @option{-Wno-error=coverage-mismatch} can be used to
3660 disable the error.  Disabling the error for this warning can result in
3661 poorly optimized code and is useful only in the
3662 case of very minor changes such as bug fixes to an existing code-base.
3663 Completely disabling the warning is not recommended.
3665 @item -Wno-cpp
3666 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3668 Suppress warning messages emitted by @code{#warning} directives.
3670 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3671 @opindex Wdouble-promotion
3672 @opindex Wno-double-promotion
3673 Give a warning when a value of type @code{float} is implicitly
3674 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3675 floating-point unit implement @code{float} in hardware, but emulate
3676 @code{double} in software.  On such a machine, doing computations
3677 using @code{double} values is much more expensive because of the
3678 overhead required for software emulation.
3680 It is easy to accidentally do computations with @code{double} because
3681 floating-point literals are implicitly of type @code{double}.  For
3682 example, in:
3683 @smallexample
3684 @group
3685 float area(float radius)
3687    return 3.14159 * radius * radius;
3689 @end group
3690 @end smallexample
3691 the compiler performs the entire computation with @code{double}
3692 because the floating-point literal is a @code{double}.
3694 @item -Wformat
3695 @itemx -Wformat=@var{n}
3696 @opindex Wformat
3697 @opindex Wno-format
3698 @opindex ffreestanding
3699 @opindex fno-builtin
3700 @opindex Wformat=
3701 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3702 the arguments supplied have types appropriate to the format string
3703 specified, and that the conversions specified in the format string make
3704 sense.  This includes standard functions, and others specified by format
3705 attributes (@pxref{Function Attributes}), in the @code{printf},
3706 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3707 not in the C standard) families (or other target-specific families).
3708 Which functions are checked without format attributes having been
3709 specified depends on the standard version selected, and such checks of
3710 functions without the attribute specified are disabled by
3711 @option{-ffreestanding} or @option{-fno-builtin}.
3713 The formats are checked against the format features supported by GNU
3714 libc version 2.2.  These include all ISO C90 and C99 features, as well
3715 as features from the Single Unix Specification and some BSD and GNU
3716 extensions.  Other library implementations may not support all these
3717 features; GCC does not support warning about features that go beyond a
3718 particular library's limitations.  However, if @option{-Wpedantic} is used
3719 with @option{-Wformat}, warnings are given about format features not
3720 in the selected standard version (but not for @code{strfmon} formats,
3721 since those are not in any version of the C standard).  @xref{C Dialect
3722 Options,,Options Controlling C Dialect}.
3724 @table @gcctabopt
3725 @item -Wformat=1
3726 @itemx -Wformat
3727 @opindex Wformat
3728 @opindex Wformat=1
3729 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3730 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3731 @option{-Wformat} also checks for null format arguments for several
3732 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3733 aspects of this level of format checking can be disabled by the
3734 options: @option{-Wno-format-contains-nul},
3735 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3736 @option{-Wformat} is enabled by @option{-Wall}.
3738 @item -Wno-format-contains-nul
3739 @opindex Wno-format-contains-nul
3740 @opindex Wformat-contains-nul
3741 If @option{-Wformat} is specified, do not warn about format strings that
3742 contain NUL bytes.
3744 @item -Wno-format-extra-args
3745 @opindex Wno-format-extra-args
3746 @opindex Wformat-extra-args
3747 If @option{-Wformat} is specified, do not warn about excess arguments to a
3748 @code{printf} or @code{scanf} format function.  The C standard specifies
3749 that such arguments are ignored.
3751 Where the unused arguments lie between used arguments that are
3752 specified with @samp{$} operand number specifications, normally
3753 warnings are still given, since the implementation could not know what
3754 type to pass to @code{va_arg} to skip the unused arguments.  However,
3755 in the case of @code{scanf} formats, this option suppresses the
3756 warning if the unused arguments are all pointers, since the Single
3757 Unix Specification says that such unused arguments are allowed.
3759 @item -Wno-format-zero-length
3760 @opindex Wno-format-zero-length
3761 @opindex Wformat-zero-length
3762 If @option{-Wformat} is specified, do not warn about zero-length formats.
3763 The C standard specifies that zero-length formats are allowed.
3766 @item -Wformat=2
3767 @opindex Wformat=2
3768 Enable @option{-Wformat} plus additional format checks.  Currently
3769 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3770 -Wformat-y2k}.
3772 @item -Wformat-nonliteral
3773 @opindex Wformat-nonliteral
3774 @opindex Wno-format-nonliteral
3775 If @option{-Wformat} is specified, also warn if the format string is not a
3776 string literal and so cannot be checked, unless the format function
3777 takes its format arguments as a @code{va_list}.
3779 @item -Wformat-security
3780 @opindex Wformat-security
3781 @opindex Wno-format-security
3782 If @option{-Wformat} is specified, also warn about uses of format
3783 functions that represent possible security problems.  At present, this
3784 warns about calls to @code{printf} and @code{scanf} functions where the
3785 format string is not a string literal and there are no format arguments,
3786 as in @code{printf (foo);}.  This may be a security hole if the format
3787 string came from untrusted input and contains @samp{%n}.  (This is
3788 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3789 in future warnings may be added to @option{-Wformat-security} that are not
3790 included in @option{-Wformat-nonliteral}.)
3792 @item -Wformat-signedness
3793 @opindex Wformat-signedness
3794 @opindex Wno-format-signedness
3795 If @option{-Wformat} is specified, also warn if the format string
3796 requires an unsigned argument and the argument is signed and vice versa.
3798 @item -Wformat-y2k
3799 @opindex Wformat-y2k
3800 @opindex Wno-format-y2k
3801 If @option{-Wformat} is specified, also warn about @code{strftime}
3802 formats that may yield only a two-digit year.
3803 @end table
3805 @item -Wnonnull
3806 @opindex Wnonnull
3807 @opindex Wno-nonnull
3808 Warn about passing a null pointer for arguments marked as
3809 requiring a non-null value by the @code{nonnull} function attribute.
3811 Also warns when comparing an argument marked with the @code{nonnull}
3812 function attribute against null inside the function.
3814 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3815 can be disabled with the @option{-Wno-nonnull} option.
3817 @item -Wnull-dereference
3818 @opindex Wnull-dereference
3819 @opindex Wno-null-dereference
3820 Warn if the compiler detects paths that trigger erroneous or
3821 undefined behavior due to dereferencing a null pointer.  This option
3822 is only active when @option{-fdelete-null-pointer-checks} is active,
3823 which is enabled by optimizations in most targets.  The precision of
3824 the warnings depends on the optimization options used.
3826 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3827 @opindex Winit-self
3828 @opindex Wno-init-self
3829 Warn about uninitialized variables that are initialized with themselves.
3830 Note this option can only be used with the @option{-Wuninitialized} option.
3832 For example, GCC warns about @code{i} being uninitialized in the
3833 following snippet only when @option{-Winit-self} has been specified:
3834 @smallexample
3835 @group
3836 int f()
3838   int i = i;
3839   return i;
3841 @end group
3842 @end smallexample
3844 This warning is enabled by @option{-Wall} in C++.
3846 @item -Wimplicit-int @r{(C and Objective-C only)}
3847 @opindex Wimplicit-int
3848 @opindex Wno-implicit-int
3849 Warn when a declaration does not specify a type.
3850 This warning is enabled by @option{-Wall}.
3852 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3853 @opindex Wimplicit-function-declaration
3854 @opindex Wno-implicit-function-declaration
3855 Give a warning whenever a function is used before being declared. In
3856 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3857 enabled by default and it is made into an error by
3858 @option{-pedantic-errors}. This warning is also enabled by
3859 @option{-Wall}.
3861 @item -Wimplicit @r{(C and Objective-C only)}
3862 @opindex Wimplicit
3863 @opindex Wno-implicit
3864 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3865 This warning is enabled by @option{-Wall}.
3867 @item -Wignored-qualifiers @r{(C and C++ only)}
3868 @opindex Wignored-qualifiers
3869 @opindex Wno-ignored-qualifiers
3870 Warn if the return type of a function has a type qualifier
3871 such as @code{const}.  For ISO C such a type qualifier has no effect,
3872 since the value returned by a function is not an lvalue.
3873 For C++, the warning is only emitted for scalar types or @code{void}.
3874 ISO C prohibits qualified @code{void} return types on function
3875 definitions, so such return types always receive a warning
3876 even without this option.
3878 This warning is also enabled by @option{-Wextra}.
3880 @item -Wmain
3881 @opindex Wmain
3882 @opindex Wno-main
3883 Warn if the type of @code{main} is suspicious.  @code{main} should be
3884 a function with external linkage, returning int, taking either zero
3885 arguments, two, or three arguments of appropriate types.  This warning
3886 is enabled by default in C++ and is enabled by either @option{-Wall}
3887 or @option{-Wpedantic}.
3889 @item -Wmisleading-indentation @r{(C and C++ only)}
3890 @opindex Wmisleading-indentation
3891 @opindex Wno-misleading-indentation
3892 Warn when the indentation of the code does not reflect the block structure.
3893 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3894 @code{for} clauses with a guarded statement that does not use braces,
3895 followed by an unguarded statement with the same indentation.
3897 This warning is disabled by default.
3899 In the following example, the call to ``bar'' is misleadingly indented as
3900 if it were guarded by the ``if'' conditional.
3902 @smallexample
3903   if (some_condition ())
3904     foo ();
3905     bar ();  /* Gotcha: this is not guarded by the "if".  */
3906 @end smallexample
3908 In the case of mixed tabs and spaces, the warning uses the
3909 @option{-ftabstop=} option to determine if the statements line up
3910 (defaulting to 8).
3912 The warning is not issued for code involving multiline preprocessor logic
3913 such as the following example.
3915 @smallexample
3916   if (flagA)
3917     foo (0);
3918 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3919   if (flagB)
3920 #endif
3921     foo (1);
3922 @end smallexample
3924 The warning is not issued after a @code{#line} directive, since this
3925 typically indicates autogenerated code, and no assumptions can be made
3926 about the layout of the file that the directive references.
3928 @item -Wmissing-braces
3929 @opindex Wmissing-braces
3930 @opindex Wno-missing-braces
3931 Warn if an aggregate or union initializer is not fully bracketed.  In
3932 the following example, the initializer for @code{a} is not fully
3933 bracketed, but that for @code{b} is fully bracketed.  This warning is
3934 enabled by @option{-Wall} in C.
3936 @smallexample
3937 int a[2][2] = @{ 0, 1, 2, 3 @};
3938 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3939 @end smallexample
3941 This warning is enabled by @option{-Wall}.
3943 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3944 @opindex Wmissing-include-dirs
3945 @opindex Wno-missing-include-dirs
3946 Warn if a user-supplied include directory does not exist.
3948 @item -Wparentheses
3949 @opindex Wparentheses
3950 @opindex Wno-parentheses
3951 Warn if parentheses are omitted in certain contexts, such
3952 as when there is an assignment in a context where a truth value
3953 is expected, or when operators are nested whose precedence people
3954 often get confused about.
3956 Also warn if a comparison like @code{x<=y<=z} appears; this is
3957 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3958 interpretation from that of ordinary mathematical notation.
3960 Also warn about constructions where there may be confusion to which
3961 @code{if} statement an @code{else} branch belongs.  Here is an example of
3962 such a case:
3964 @smallexample
3965 @group
3967   if (a)
3968     if (b)
3969       foo ();
3970   else
3971     bar ();
3973 @end group
3974 @end smallexample
3976 In C/C++, every @code{else} branch belongs to the innermost possible
3977 @code{if} statement, which in this example is @code{if (b)}.  This is
3978 often not what the programmer expected, as illustrated in the above
3979 example by indentation the programmer chose.  When there is the
3980 potential for this confusion, GCC issues a warning when this flag
3981 is specified.  To eliminate the warning, add explicit braces around
3982 the innermost @code{if} statement so there is no way the @code{else}
3983 can belong to the enclosing @code{if}.  The resulting code
3984 looks like this:
3986 @smallexample
3987 @group
3989   if (a)
3990     @{
3991       if (b)
3992         foo ();
3993       else
3994         bar ();
3995     @}
3997 @end group
3998 @end smallexample
4000 Also warn for dangerous uses of the GNU extension to
4001 @code{?:} with omitted middle operand. When the condition
4002 in the @code{?}: operator is a boolean expression, the omitted value is
4003 always 1.  Often programmers expect it to be a value computed
4004 inside the conditional expression instead.
4006 This warning is enabled by @option{-Wall}.
4008 @item -Wsequence-point
4009 @opindex Wsequence-point
4010 @opindex Wno-sequence-point
4011 Warn about code that may have undefined semantics because of violations
4012 of sequence point rules in the C and C++ standards.
4014 The C and C++ standards define the order in which expressions in a C/C++
4015 program are evaluated in terms of @dfn{sequence points}, which represent
4016 a partial ordering between the execution of parts of the program: those
4017 executed before the sequence point, and those executed after it.  These
4018 occur after the evaluation of a full expression (one which is not part
4019 of a larger expression), after the evaluation of the first operand of a
4020 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4021 function is called (but after the evaluation of its arguments and the
4022 expression denoting the called function), and in certain other places.
4023 Other than as expressed by the sequence point rules, the order of
4024 evaluation of subexpressions of an expression is not specified.  All
4025 these rules describe only a partial order rather than a total order,
4026 since, for example, if two functions are called within one expression
4027 with no sequence point between them, the order in which the functions
4028 are called is not specified.  However, the standards committee have
4029 ruled that function calls do not overlap.
4031 It is not specified when between sequence points modifications to the
4032 values of objects take effect.  Programs whose behavior depends on this
4033 have undefined behavior; the C and C++ standards specify that ``Between
4034 the previous and next sequence point an object shall have its stored
4035 value modified at most once by the evaluation of an expression.
4036 Furthermore, the prior value shall be read only to determine the value
4037 to be stored.''.  If a program breaks these rules, the results on any
4038 particular implementation are entirely unpredictable.
4040 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4041 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4042 diagnosed by this option, and it may give an occasional false positive
4043 result, but in general it has been found fairly effective at detecting
4044 this sort of problem in programs.
4046 The standard is worded confusingly, therefore there is some debate
4047 over the precise meaning of the sequence point rules in subtle cases.
4048 Links to discussions of the problem, including proposed formal
4049 definitions, may be found on the GCC readings page, at
4050 @uref{http://gcc.gnu.org/@/readings.html}.
4052 This warning is enabled by @option{-Wall} for C and C++.
4054 @item -Wno-return-local-addr
4055 @opindex Wno-return-local-addr
4056 @opindex Wreturn-local-addr
4057 Do not warn about returning a pointer (or in C++, a reference) to a
4058 variable that goes out of scope after the function returns.
4060 @item -Wreturn-type
4061 @opindex Wreturn-type
4062 @opindex Wno-return-type
4063 Warn whenever a function is defined with a return type that defaults
4064 to @code{int}.  Also warn about any @code{return} statement with no
4065 return value in a function whose return type is not @code{void}
4066 (falling off the end of the function body is considered returning
4067 without a value), and about a @code{return} statement with an
4068 expression in a function whose return type is @code{void}.
4070 For C++, a function without return type always produces a diagnostic
4071 message, even when @option{-Wno-return-type} is specified.  The only
4072 exceptions are @code{main} and functions defined in system headers.
4074 This warning is enabled by @option{-Wall}.
4076 @item -Wshift-count-negative
4077 @opindex Wshift-count-negative
4078 @opindex Wno-shift-count-negative
4079 Warn if shift count is negative. This warning is enabled by default.
4081 @item -Wshift-count-overflow
4082 @opindex Wshift-count-overflow
4083 @opindex Wno-shift-count-overflow
4084 Warn if shift count >= width of type. This warning is enabled by default.
4086 @item -Wshift-negative-value
4087 @opindex Wshift-negative-value
4088 @opindex Wno-shift-negative-value
4089 Warn if left shifting a negative value.  This warning is enabled by
4090 @option{-Wextra} in C99 and C++11 modes (and newer).
4092 @item -Wshift-overflow
4093 @itemx -Wshift-overflow=@var{n}
4094 @opindex Wshift-overflow
4095 @opindex Wno-shift-overflow
4096 Warn about left shift overflows.  This warning is enabled by
4097 default in C99 and C++11 modes (and newer).
4099 @table @gcctabopt
4100 @item -Wshift-overflow=1
4101 This is the warning level of @option{-Wshift-overflow} and is enabled
4102 by default in C99 and C++11 modes (and newer).  This warning level does
4103 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4104 an overflow is still rejected in contexts where an integer constant expression
4105 is required.)
4107 @item -Wshift-overflow=2
4108 This warning level also warns about left-shifting 1 into the sign bit,
4109 unless C++14 mode is active.
4110 @end table
4112 @item -Wswitch
4113 @opindex Wswitch
4114 @opindex Wno-switch
4115 Warn whenever a @code{switch} statement has an index of enumerated type
4116 and lacks a @code{case} for one or more of the named codes of that
4117 enumeration.  (The presence of a @code{default} label prevents this
4118 warning.)  @code{case} labels outside the enumeration range also
4119 provoke warnings when this option is used (even if there is a
4120 @code{default} label).
4121 This warning is enabled by @option{-Wall}.
4123 @item -Wswitch-default
4124 @opindex Wswitch-default
4125 @opindex Wno-switch-default
4126 Warn whenever a @code{switch} statement does not have a @code{default}
4127 case.
4129 @item -Wswitch-enum
4130 @opindex Wswitch-enum
4131 @opindex Wno-switch-enum
4132 Warn whenever a @code{switch} statement has an index of enumerated type
4133 and lacks a @code{case} for one or more of the named codes of that
4134 enumeration.  @code{case} labels outside the enumeration range also
4135 provoke warnings when this option is used.  The only difference
4136 between @option{-Wswitch} and this option is that this option gives a
4137 warning about an omitted enumeration code even if there is a
4138 @code{default} label.
4140 @item -Wswitch-bool
4141 @opindex Wswitch-bool
4142 @opindex Wno-switch-bool
4143 Warn whenever a @code{switch} statement has an index of boolean type
4144 and the case values are outside the range of a boolean type.
4145 It is possible to suppress this warning by casting the controlling
4146 expression to a type other than @code{bool}.  For example:
4147 @smallexample
4148 @group
4149 switch ((int) (a == 4))
4150   @{
4151   @dots{}
4152   @}
4153 @end group
4154 @end smallexample
4155 This warning is enabled by default for C and C++ programs.
4157 @item -Wsync-nand @r{(C and C++ only)}
4158 @opindex Wsync-nand
4159 @opindex Wno-sync-nand
4160 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4161 built-in functions are used.  These functions changed semantics in GCC 4.4.
4163 @item -Wtrigraphs
4164 @opindex Wtrigraphs
4165 @opindex Wno-trigraphs
4166 Warn if any trigraphs are encountered that might change the meaning of
4167 the program (trigraphs within comments are not warned about).
4168 This warning is enabled by @option{-Wall}.
4170 @item -Wunused-but-set-parameter
4171 @opindex Wunused-but-set-parameter
4172 @opindex Wno-unused-but-set-parameter
4173 Warn whenever a function parameter is assigned to, but otherwise unused
4174 (aside from its declaration).
4176 To suppress this warning use the @code{unused} attribute
4177 (@pxref{Variable Attributes}).
4179 This warning is also enabled by @option{-Wunused} together with
4180 @option{-Wextra}.
4182 @item -Wunused-but-set-variable
4183 @opindex Wunused-but-set-variable
4184 @opindex Wno-unused-but-set-variable
4185 Warn whenever a local variable is assigned to, but otherwise unused
4186 (aside from its declaration).
4187 This warning is enabled by @option{-Wall}.
4189 To suppress this warning use the @code{unused} attribute
4190 (@pxref{Variable Attributes}).
4192 This warning is also enabled by @option{-Wunused}, which is enabled
4193 by @option{-Wall}.
4195 @item -Wunused-function
4196 @opindex Wunused-function
4197 @opindex Wno-unused-function
4198 Warn whenever a static function is declared but not defined or a
4199 non-inline static function is unused.
4200 This warning is enabled by @option{-Wall}.
4202 @item -Wunused-label
4203 @opindex Wunused-label
4204 @opindex Wno-unused-label
4205 Warn whenever a label is declared but not used.
4206 This warning is enabled by @option{-Wall}.
4208 To suppress this warning use the @code{unused} attribute
4209 (@pxref{Variable Attributes}).
4211 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4212 @opindex Wunused-local-typedefs
4213 Warn when a typedef locally defined in a function is not used.
4214 This warning is enabled by @option{-Wall}.
4216 @item -Wunused-parameter
4217 @opindex Wunused-parameter
4218 @opindex Wno-unused-parameter
4219 Warn whenever a function parameter is unused aside from its declaration.
4221 To suppress this warning use the @code{unused} attribute
4222 (@pxref{Variable Attributes}).
4224 @item -Wno-unused-result
4225 @opindex Wunused-result
4226 @opindex Wno-unused-result
4227 Do not warn if a caller of a function marked with attribute
4228 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4229 its return value. The default is @option{-Wunused-result}.
4231 @item -Wunused-variable
4232 @opindex Wunused-variable
4233 @opindex Wno-unused-variable
4234 Warn whenever a local or static variable is unused aside from its
4235 declaration. This option implies @option{-Wunused-const-variable} for C,
4236 but not for C++. This warning is enabled by @option{-Wall}.
4238 To suppress this warning use the @code{unused} attribute
4239 (@pxref{Variable Attributes}).
4241 @item -Wunused-const-variable
4242 @opindex Wunused-const-variable
4243 @opindex Wno-unused-const-variable
4244 Warn whenever a constant static variable is unused aside from its declaration.
4245 This warning is enabled by @option{-Wunused-variable} for C, but not for C++.
4246 In C++ this is normally not an error since const variables take the place of
4247 @code{#define}s in C++.
4249 To suppress this warning use the @code{unused} attribute
4250 (@pxref{Variable Attributes}).
4252 @item -Wunused-value
4253 @opindex Wunused-value
4254 @opindex Wno-unused-value
4255 Warn whenever a statement computes a result that is explicitly not
4256 used. To suppress this warning cast the unused expression to
4257 @code{void}. This includes an expression-statement or the left-hand
4258 side of a comma expression that contains no side effects. For example,
4259 an expression such as @code{x[i,j]} causes a warning, while
4260 @code{x[(void)i,j]} does not.
4262 This warning is enabled by @option{-Wall}.
4264 @item -Wunused
4265 @opindex Wunused
4266 @opindex Wno-unused
4267 All the above @option{-Wunused} options combined.
4269 In order to get a warning about an unused function parameter, you must
4270 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4271 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4273 @item -Wuninitialized
4274 @opindex Wuninitialized
4275 @opindex Wno-uninitialized
4276 Warn if an automatic variable is used without first being initialized
4277 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4278 warn if a non-static reference or non-static @code{const} member
4279 appears in a class without constructors.
4281 If you want to warn about code that uses the uninitialized value of the
4282 variable in its own initializer, use the @option{-Winit-self} option.
4284 These warnings occur for individual uninitialized or clobbered
4285 elements of structure, union or array variables as well as for
4286 variables that are uninitialized or clobbered as a whole.  They do
4287 not occur for variables or elements declared @code{volatile}.  Because
4288 these warnings depend on optimization, the exact variables or elements
4289 for which there are warnings depends on the precise optimization
4290 options and version of GCC used.
4292 Note that there may be no warning about a variable that is used only
4293 to compute a value that itself is never used, because such
4294 computations may be deleted by data flow analysis before the warnings
4295 are printed.
4297 @item -Wmaybe-uninitialized
4298 @opindex Wmaybe-uninitialized
4299 @opindex Wno-maybe-uninitialized
4300 For an automatic variable, if there exists a path from the function
4301 entry to a use of the variable that is initialized, but there exist
4302 some other paths for which the variable is not initialized, the compiler
4303 emits a warning if it cannot prove the uninitialized paths are not
4304 executed at run time. These warnings are made optional because GCC is
4305 not smart enough to see all the reasons why the code might be correct
4306 in spite of appearing to have an error.  Here is one example of how
4307 this can happen:
4309 @smallexample
4310 @group
4312   int x;
4313   switch (y)
4314     @{
4315     case 1: x = 1;
4316       break;
4317     case 2: x = 4;
4318       break;
4319     case 3: x = 5;
4320     @}
4321   foo (x);
4323 @end group
4324 @end smallexample
4326 @noindent
4327 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4328 always initialized, but GCC doesn't know this. To suppress the
4329 warning, you need to provide a default case with assert(0) or
4330 similar code.
4332 @cindex @code{longjmp} warnings
4333 This option also warns when a non-volatile automatic variable might be
4334 changed by a call to @code{longjmp}.  These warnings as well are possible
4335 only in optimizing compilation.
4337 The compiler sees only the calls to @code{setjmp}.  It cannot know
4338 where @code{longjmp} will be called; in fact, a signal handler could
4339 call it at any point in the code.  As a result, you may get a warning
4340 even when there is in fact no problem because @code{longjmp} cannot
4341 in fact be called at the place that would cause a problem.
4343 Some spurious warnings can be avoided if you declare all the functions
4344 you use that never return as @code{noreturn}.  @xref{Function
4345 Attributes}.
4347 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4349 @item -Wunknown-pragmas
4350 @opindex Wunknown-pragmas
4351 @opindex Wno-unknown-pragmas
4352 @cindex warning for unknown pragmas
4353 @cindex unknown pragmas, warning
4354 @cindex pragmas, warning of unknown
4355 Warn when a @code{#pragma} directive is encountered that is not understood by 
4356 GCC@.  If this command-line option is used, warnings are even issued
4357 for unknown pragmas in system header files.  This is not the case if
4358 the warnings are only enabled by the @option{-Wall} command-line option.
4360 @item -Wno-pragmas
4361 @opindex Wno-pragmas
4362 @opindex Wpragmas
4363 Do not warn about misuses of pragmas, such as incorrect parameters,
4364 invalid syntax, or conflicts between pragmas.  See also
4365 @option{-Wunknown-pragmas}.
4367 @item -Wstrict-aliasing
4368 @opindex Wstrict-aliasing
4369 @opindex Wno-strict-aliasing
4370 This option is only active when @option{-fstrict-aliasing} is active.
4371 It warns about code that might break the strict aliasing rules that the
4372 compiler is using for optimization.  The warning does not catch all
4373 cases, but does attempt to catch the more common pitfalls.  It is
4374 included in @option{-Wall}.
4375 It is equivalent to @option{-Wstrict-aliasing=3}
4377 @item -Wstrict-aliasing=n
4378 @opindex Wstrict-aliasing=n
4379 This option is only active when @option{-fstrict-aliasing} is active.
4380 It warns about code that might break the strict aliasing rules that the
4381 compiler is using for optimization.
4382 Higher levels correspond to higher accuracy (fewer false positives).
4383 Higher levels also correspond to more effort, similar to the way @option{-O} 
4384 works.
4385 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4387 Level 1: Most aggressive, quick, least accurate.
4388 Possibly useful when higher levels
4389 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4390 false negatives.  However, it has many false positives.
4391 Warns for all pointer conversions between possibly incompatible types,
4392 even if never dereferenced.  Runs in the front end only.
4394 Level 2: Aggressive, quick, not too precise.
4395 May still have many false positives (not as many as level 1 though),
4396 and few false negatives (but possibly more than level 1).
4397 Unlike level 1, it only warns when an address is taken.  Warns about
4398 incomplete types.  Runs in the front end only.
4400 Level 3 (default for @option{-Wstrict-aliasing}):
4401 Should have very few false positives and few false
4402 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4403 Takes care of the common pun+dereference pattern in the front end:
4404 @code{*(int*)&some_float}.
4405 If optimization is enabled, it also runs in the back end, where it deals
4406 with multiple statement cases using flow-sensitive points-to information.
4407 Only warns when the converted pointer is dereferenced.
4408 Does not warn about incomplete types.
4410 @item -Wstrict-overflow
4411 @itemx -Wstrict-overflow=@var{n}
4412 @opindex Wstrict-overflow
4413 @opindex Wno-strict-overflow
4414 This option is only active when @option{-fstrict-overflow} is active.
4415 It warns about cases where the compiler optimizes based on the
4416 assumption that signed overflow does not occur.  Note that it does not
4417 warn about all cases where the code might overflow: it only warns
4418 about cases where the compiler implements some optimization.  Thus
4419 this warning depends on the optimization level.
4421 An optimization that assumes that signed overflow does not occur is
4422 perfectly safe if the values of the variables involved are such that
4423 overflow never does, in fact, occur.  Therefore this warning can
4424 easily give a false positive: a warning about code that is not
4425 actually a problem.  To help focus on important issues, several
4426 warning levels are defined.  No warnings are issued for the use of
4427 undefined signed overflow when estimating how many iterations a loop
4428 requires, in particular when determining whether a loop will be
4429 executed at all.
4431 @table @gcctabopt
4432 @item -Wstrict-overflow=1
4433 Warn about cases that are both questionable and easy to avoid.  For
4434 example,  with @option{-fstrict-overflow}, the compiler simplifies
4435 @code{x + 1 > x} to @code{1}.  This level of
4436 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4437 are not, and must be explicitly requested.
4439 @item -Wstrict-overflow=2
4440 Also warn about other cases where a comparison is simplified to a
4441 constant.  For example: @code{abs (x) >= 0}.  This can only be
4442 simplified when @option{-fstrict-overflow} is in effect, because
4443 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4444 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4445 @option{-Wstrict-overflow=2}.
4447 @item -Wstrict-overflow=3
4448 Also warn about other cases where a comparison is simplified.  For
4449 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4451 @item -Wstrict-overflow=4
4452 Also warn about other simplifications not covered by the above cases.
4453 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4455 @item -Wstrict-overflow=5
4456 Also warn about cases where the compiler reduces the magnitude of a
4457 constant involved in a comparison.  For example: @code{x + 2 > y} is
4458 simplified to @code{x + 1 >= y}.  This is reported only at the
4459 highest warning level because this simplification applies to many
4460 comparisons, so this warning level gives a very large number of
4461 false positives.
4462 @end table
4464 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4465 @opindex Wsuggest-attribute=
4466 @opindex Wno-suggest-attribute=
4467 Warn for cases where adding an attribute may be beneficial. The
4468 attributes currently supported are listed below.
4470 @table @gcctabopt
4471 @item -Wsuggest-attribute=pure
4472 @itemx -Wsuggest-attribute=const
4473 @itemx -Wsuggest-attribute=noreturn
4474 @opindex Wsuggest-attribute=pure
4475 @opindex Wno-suggest-attribute=pure
4476 @opindex Wsuggest-attribute=const
4477 @opindex Wno-suggest-attribute=const
4478 @opindex Wsuggest-attribute=noreturn
4479 @opindex Wno-suggest-attribute=noreturn
4481 Warn about functions that might be candidates for attributes
4482 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4483 functions visible in other compilation units or (in the case of @code{pure} and
4484 @code{const}) if it cannot prove that the function returns normally. A function
4485 returns normally if it doesn't contain an infinite loop or return abnormally
4486 by throwing, calling @code{abort} or trapping.  This analysis requires option
4487 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4488 higher.  Higher optimization levels improve the accuracy of the analysis.
4490 @item -Wsuggest-attribute=format
4491 @itemx -Wmissing-format-attribute
4492 @opindex Wsuggest-attribute=format
4493 @opindex Wmissing-format-attribute
4494 @opindex Wno-suggest-attribute=format
4495 @opindex Wno-missing-format-attribute
4496 @opindex Wformat
4497 @opindex Wno-format
4499 Warn about function pointers that might be candidates for @code{format}
4500 attributes.  Note these are only possible candidates, not absolute ones.
4501 GCC guesses that function pointers with @code{format} attributes that
4502 are used in assignment, initialization, parameter passing or return
4503 statements should have a corresponding @code{format} attribute in the
4504 resulting type.  I.e.@: the left-hand side of the assignment or
4505 initialization, the type of the parameter variable, or the return type
4506 of the containing function respectively should also have a @code{format}
4507 attribute to avoid the warning.
4509 GCC also warns about function definitions that might be
4510 candidates for @code{format} attributes.  Again, these are only
4511 possible candidates.  GCC guesses that @code{format} attributes
4512 might be appropriate for any function that calls a function like
4513 @code{vprintf} or @code{vscanf}, but this might not always be the
4514 case, and some functions for which @code{format} attributes are
4515 appropriate may not be detected.
4516 @end table
4518 @item -Wsuggest-final-types
4519 @opindex Wno-suggest-final-types
4520 @opindex Wsuggest-final-types
4521 Warn about types with virtual methods where code quality would be improved
4522 if the type were declared with the C++11 @code{final} specifier, 
4523 or, if possible,
4524 declared in an anonymous namespace. This allows GCC to more aggressively
4525 devirtualize the polymorphic calls. This warning is more effective with link
4526 time optimization, where the information about the class hierarchy graph is
4527 more complete.
4529 @item -Wsuggest-final-methods
4530 @opindex Wno-suggest-final-methods
4531 @opindex Wsuggest-final-methods
4532 Warn about virtual methods where code quality would be improved if the method
4533 were declared with the C++11 @code{final} specifier, 
4534 or, if possible, its type were
4535 declared in an anonymous namespace or with the @code{final} specifier.
4536 This warning is
4537 more effective with link time optimization, where the information about the
4538 class hierarchy graph is more complete. It is recommended to first consider
4539 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4540 annotations.
4542 @item -Wsuggest-override
4543 Warn about overriding virtual functions that are not marked with the override
4544 keyword.
4546 @item -Warray-bounds
4547 @itemx -Warray-bounds=@var{n}
4548 @opindex Wno-array-bounds
4549 @opindex Warray-bounds
4550 This option is only active when @option{-ftree-vrp} is active
4551 (default for @option{-O2} and above). It warns about subscripts to arrays
4552 that are always out of bounds. This warning is enabled by @option{-Wall}.
4554 @table @gcctabopt
4555 @item -Warray-bounds=1
4556 This is the warning level of @option{-Warray-bounds} and is enabled
4557 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4559 @item -Warray-bounds=2
4560 This warning level also warns about out of bounds access for
4561 arrays at the end of a struct and for arrays accessed through
4562 pointers. This warning level may give a larger number of
4563 false positives and is deactivated by default.
4564 @end table
4566 @item -Wbool-compare
4567 @opindex Wno-bool-compare
4568 @opindex Wbool-compare
4569 Warn about boolean expression compared with an integer value different from
4570 @code{true}/@code{false}.  For instance, the following comparison is
4571 always false:
4572 @smallexample
4573 int n = 5;
4574 @dots{}
4575 if ((n > 1) == 2) @{ @dots{} @}
4576 @end smallexample
4577 This warning is enabled by @option{-Wall}.
4579 @item -Wduplicated-cond
4580 @opindex Wno-duplicated-cond
4581 @opindex Wduplicated-cond
4582 Warn about duplicated conditions in an if-else-if chain.  For instance,
4583 warn for the following code:
4584 @smallexample
4585 if (p->q != NULL) @{ @dots{} @}
4586 else if (p->q != NULL) @{ @dots{} @}
4587 @end smallexample
4588 This warning is enabled by @option{-Wall}.
4590 @item -Wframe-address
4591 @opindex Wno-frame-address
4592 @opindex Wframe-address
4593 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
4594 is called with an argument greater than 0.  Such calls may return indeterminate
4595 values or crash the program.  The warning is included in @option{-Wall}.
4597 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4598 @opindex Wno-discarded-qualifiers
4599 @opindex Wdiscarded-qualifiers
4600 Do not warn if type qualifiers on pointers are being discarded.
4601 Typically, the compiler warns if a @code{const char *} variable is
4602 passed to a function that takes a @code{char *} parameter.  This option
4603 can be used to suppress such a warning.
4605 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4606 @opindex Wno-discarded-array-qualifiers
4607 @opindex Wdiscarded-array-qualifiers
4608 Do not warn if type qualifiers on arrays which are pointer targets
4609 are being discarded. Typically, the compiler warns if a
4610 @code{const int (*)[]} variable is passed to a function that
4611 takes a @code{int (*)[]} parameter.  This option can be used to
4612 suppress such a warning.
4614 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4615 @opindex Wno-incompatible-pointer-types
4616 @opindex Wincompatible-pointer-types
4617 Do not warn when there is a conversion between pointers that have incompatible
4618 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4619 which warns for pointer argument passing or assignment with different
4620 signedness.
4622 @item -Wno-int-conversion @r{(C and Objective-C only)}
4623 @opindex Wno-int-conversion
4624 @opindex Wint-conversion
4625 Do not warn about incompatible integer to pointer and pointer to integer
4626 conversions.  This warning is about implicit conversions; for explicit
4627 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4628 @option{-Wno-pointer-to-int-cast} may be used.
4630 @item -Wno-div-by-zero
4631 @opindex Wno-div-by-zero
4632 @opindex Wdiv-by-zero
4633 Do not warn about compile-time integer division by zero.  Floating-point
4634 division by zero is not warned about, as it can be a legitimate way of
4635 obtaining infinities and NaNs.
4637 @item -Wsystem-headers
4638 @opindex Wsystem-headers
4639 @opindex Wno-system-headers
4640 @cindex warnings from system headers
4641 @cindex system headers, warnings from
4642 Print warning messages for constructs found in system header files.
4643 Warnings from system headers are normally suppressed, on the assumption
4644 that they usually do not indicate real problems and would only make the
4645 compiler output harder to read.  Using this command-line option tells
4646 GCC to emit warnings from system headers as if they occurred in user
4647 code.  However, note that using @option{-Wall} in conjunction with this
4648 option does @emph{not} warn about unknown pragmas in system
4649 headers---for that, @option{-Wunknown-pragmas} must also be used.
4651 @item -Wtautological-compare
4652 @opindex Wtautological-compare
4653 @opindex Wno-tautological-compare
4654 Warn if a self-comparison always evaluates to true or false.  This
4655 warning detects various mistakes such as:
4656 @smallexample
4657 int i = 1;
4658 @dots{}
4659 if (i > i) @{ @dots{} @}
4660 @end smallexample
4661 This warning is enabled by @option{-Wall}.
4663 @item -Wtrampolines
4664 @opindex Wtrampolines
4665 @opindex Wno-trampolines
4666 Warn about trampolines generated for pointers to nested functions.
4667 A trampoline is a small piece of data or code that is created at run
4668 time on the stack when the address of a nested function is taken, and is
4669 used to call the nested function indirectly.  For some targets, it is
4670 made up of data only and thus requires no special treatment.  But, for
4671 most targets, it is made up of code and thus requires the stack to be
4672 made executable in order for the program to work properly.
4674 @item -Wfloat-equal
4675 @opindex Wfloat-equal
4676 @opindex Wno-float-equal
4677 Warn if floating-point values are used in equality comparisons.
4679 The idea behind this is that sometimes it is convenient (for the
4680 programmer) to consider floating-point values as approximations to
4681 infinitely precise real numbers.  If you are doing this, then you need
4682 to compute (by analyzing the code, or in some other way) the maximum or
4683 likely maximum error that the computation introduces, and allow for it
4684 when performing comparisons (and when producing output, but that's a
4685 different problem).  In particular, instead of testing for equality, you
4686 should check to see whether the two values have ranges that overlap; and
4687 this is done with the relational operators, so equality comparisons are
4688 probably mistaken.
4690 @item -Wtraditional @r{(C and Objective-C only)}
4691 @opindex Wtraditional
4692 @opindex Wno-traditional
4693 Warn about certain constructs that behave differently in traditional and
4694 ISO C@.  Also warn about ISO C constructs that have no traditional C
4695 equivalent, and/or problematic constructs that should be avoided.
4697 @itemize @bullet
4698 @item
4699 Macro parameters that appear within string literals in the macro body.
4700 In traditional C macro replacement takes place within string literals,
4701 but in ISO C it does not.
4703 @item
4704 In traditional C, some preprocessor directives did not exist.
4705 Traditional preprocessors only considered a line to be a directive
4706 if the @samp{#} appeared in column 1 on the line.  Therefore
4707 @option{-Wtraditional} warns about directives that traditional C
4708 understands but ignores because the @samp{#} does not appear as the
4709 first character on the line.  It also suggests you hide directives like
4710 @code{#pragma} not understood by traditional C by indenting them.  Some
4711 traditional implementations do not recognize @code{#elif}, so this option
4712 suggests avoiding it altogether.
4714 @item
4715 A function-like macro that appears without arguments.
4717 @item
4718 The unary plus operator.
4720 @item
4721 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4722 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4723 constants.)  Note, these suffixes appear in macros defined in the system
4724 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4725 Use of these macros in user code might normally lead to spurious
4726 warnings, however GCC's integrated preprocessor has enough context to
4727 avoid warning in these cases.
4729 @item
4730 A function declared external in one block and then used after the end of
4731 the block.
4733 @item
4734 A @code{switch} statement has an operand of type @code{long}.
4736 @item
4737 A non-@code{static} function declaration follows a @code{static} one.
4738 This construct is not accepted by some traditional C compilers.
4740 @item
4741 The ISO type of an integer constant has a different width or
4742 signedness from its traditional type.  This warning is only issued if
4743 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4744 typically represent bit patterns, are not warned about.
4746 @item
4747 Usage of ISO string concatenation is detected.
4749 @item
4750 Initialization of automatic aggregates.
4752 @item
4753 Identifier conflicts with labels.  Traditional C lacks a separate
4754 namespace for labels.
4756 @item
4757 Initialization of unions.  If the initializer is zero, the warning is
4758 omitted.  This is done under the assumption that the zero initializer in
4759 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4760 initializer warnings and relies on default initialization to zero in the
4761 traditional C case.
4763 @item
4764 Conversions by prototypes between fixed/floating-point values and vice
4765 versa.  The absence of these prototypes when compiling with traditional
4766 C causes serious problems.  This is a subset of the possible
4767 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4769 @item
4770 Use of ISO C style function definitions.  This warning intentionally is
4771 @emph{not} issued for prototype declarations or variadic functions
4772 because these ISO C features appear in your code when using
4773 libiberty's traditional C compatibility macros, @code{PARAMS} and
4774 @code{VPARAMS}.  This warning is also bypassed for nested functions
4775 because that feature is already a GCC extension and thus not relevant to
4776 traditional C compatibility.
4777 @end itemize
4779 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4780 @opindex Wtraditional-conversion
4781 @opindex Wno-traditional-conversion
4782 Warn if a prototype causes a type conversion that is different from what
4783 would happen to the same argument in the absence of a prototype.  This
4784 includes conversions of fixed point to floating and vice versa, and
4785 conversions changing the width or signedness of a fixed-point argument
4786 except when the same as the default promotion.
4788 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4789 @opindex Wdeclaration-after-statement
4790 @opindex Wno-declaration-after-statement
4791 Warn when a declaration is found after a statement in a block.  This
4792 construct, known from C++, was introduced with ISO C99 and is by default
4793 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4795 @item -Wundef
4796 @opindex Wundef
4797 @opindex Wno-undef
4798 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4800 @item -Wno-endif-labels
4801 @opindex Wno-endif-labels
4802 @opindex Wendif-labels
4803 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4805 @item -Wshadow
4806 @opindex Wshadow
4807 @opindex Wno-shadow
4808 Warn whenever a local variable or type declaration shadows another
4809 variable, parameter, type, class member (in C++), or instance variable
4810 (in Objective-C) or whenever a built-in function is shadowed. Note
4811 that in C++, the compiler warns if a local variable shadows an
4812 explicit typedef, but not if it shadows a struct/class/enum.
4814 @item -Wno-shadow-ivar @r{(Objective-C only)}
4815 @opindex Wno-shadow-ivar
4816 @opindex Wshadow-ivar
4817 Do not warn whenever a local variable shadows an instance variable in an
4818 Objective-C method.
4820 @item -Wlarger-than=@var{len}
4821 @opindex Wlarger-than=@var{len}
4822 @opindex Wlarger-than-@var{len}
4823 Warn whenever an object of larger than @var{len} bytes is defined.
4825 @item -Wframe-larger-than=@var{len}
4826 @opindex Wframe-larger-than
4827 Warn if the size of a function frame is larger than @var{len} bytes.
4828 The computation done to determine the stack frame size is approximate
4829 and not conservative.
4830 The actual requirements may be somewhat greater than @var{len}
4831 even if you do not get a warning.  In addition, any space allocated
4832 via @code{alloca}, variable-length arrays, or related constructs
4833 is not included by the compiler when determining
4834 whether or not to issue a warning.
4836 @item -Wno-free-nonheap-object
4837 @opindex Wno-free-nonheap-object
4838 @opindex Wfree-nonheap-object
4839 Do not warn when attempting to free an object that was not allocated
4840 on the heap.
4842 @item -Wstack-usage=@var{len}
4843 @opindex Wstack-usage
4844 Warn if the stack usage of a function might be larger than @var{len} bytes.
4845 The computation done to determine the stack usage is conservative.
4846 Any space allocated via @code{alloca}, variable-length arrays, or related
4847 constructs is included by the compiler when determining whether or not to
4848 issue a warning.
4850 The message is in keeping with the output of @option{-fstack-usage}.
4852 @itemize
4853 @item
4854 If the stack usage is fully static but exceeds the specified amount, it's:
4856 @smallexample
4857   warning: stack usage is 1120 bytes
4858 @end smallexample
4859 @item
4860 If the stack usage is (partly) dynamic but bounded, it's:
4862 @smallexample
4863   warning: stack usage might be 1648 bytes
4864 @end smallexample
4865 @item
4866 If the stack usage is (partly) dynamic and not bounded, it's:
4868 @smallexample
4869   warning: stack usage might be unbounded
4870 @end smallexample
4871 @end itemize
4873 @item -Wunsafe-loop-optimizations
4874 @opindex Wunsafe-loop-optimizations
4875 @opindex Wno-unsafe-loop-optimizations
4876 Warn if the loop cannot be optimized because the compiler cannot
4877 assume anything on the bounds of the loop indices.  With
4878 @option{-funsafe-loop-optimizations} warn if the compiler makes
4879 such assumptions.
4881 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4882 @opindex Wno-pedantic-ms-format
4883 @opindex Wpedantic-ms-format
4884 When used in combination with @option{-Wformat}
4885 and @option{-pedantic} without GNU extensions, this option
4886 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4887 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4888 which depend on the MS runtime.
4890 @item -Wplacement-new
4891 @opindex Wplacement-new
4892 @opindex Wno-placement-new
4893 Warn about placement new expressions with undefined behavior, such as
4894 constructing an object in a buffer that is smaller than the type of
4895 the object.
4897 @item -Wpointer-arith
4898 @opindex Wpointer-arith
4899 @opindex Wno-pointer-arith
4900 Warn about anything that depends on the ``size of'' a function type or
4901 of @code{void}.  GNU C assigns these types a size of 1, for
4902 convenience in calculations with @code{void *} pointers and pointers
4903 to functions.  In C++, warn also when an arithmetic operation involves
4904 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4906 @item -Wtype-limits
4907 @opindex Wtype-limits
4908 @opindex Wno-type-limits
4909 Warn if a comparison is always true or always false due to the limited
4910 range of the data type, but do not warn for constant expressions.  For
4911 example, warn if an unsigned variable is compared against zero with
4912 @code{<} or @code{>=}.  This warning is also enabled by
4913 @option{-Wextra}.
4915 @item -Wbad-function-cast @r{(C and Objective-C only)}
4916 @opindex Wbad-function-cast
4917 @opindex Wno-bad-function-cast
4918 Warn when a function call is cast to a non-matching type.
4919 For example, warn if a call to a function returning an integer type 
4920 is cast to a pointer type.
4922 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4923 @opindex Wc90-c99-compat
4924 @opindex Wno-c90-c99-compat
4925 Warn about features not present in ISO C90, but present in ISO C99.
4926 For instance, warn about use of variable length arrays, @code{long long}
4927 type, @code{bool} type, compound literals, designated initializers, and so
4928 on.  This option is independent of the standards mode.  Warnings are disabled
4929 in the expression that follows @code{__extension__}.
4931 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4932 @opindex Wc99-c11-compat
4933 @opindex Wno-c99-c11-compat
4934 Warn about features not present in ISO C99, but present in ISO C11.
4935 For instance, warn about use of anonymous structures and unions,
4936 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4937 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4938 and so on.  This option is independent of the standards mode.  Warnings are
4939 disabled in the expression that follows @code{__extension__}.
4941 @item -Wc++-compat @r{(C and Objective-C only)}
4942 @opindex Wc++-compat
4943 Warn about ISO C constructs that are outside of the common subset of
4944 ISO C and ISO C++, e.g.@: request for implicit conversion from
4945 @code{void *} to a pointer to non-@code{void} type.
4947 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4948 @opindex Wc++11-compat
4949 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4950 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4951 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4952 enabled by @option{-Wall}.
4954 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4955 @opindex Wc++14-compat
4956 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4957 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4959 @item -Wcast-qual
4960 @opindex Wcast-qual
4961 @opindex Wno-cast-qual
4962 Warn whenever a pointer is cast so as to remove a type qualifier from
4963 the target type.  For example, warn if a @code{const char *} is cast
4964 to an ordinary @code{char *}.
4966 Also warn when making a cast that introduces a type qualifier in an
4967 unsafe way.  For example, casting @code{char **} to @code{const char **}
4968 is unsafe, as in this example:
4970 @smallexample
4971   /* p is char ** value.  */
4972   const char **q = (const char **) p;
4973   /* Assignment of readonly string to const char * is OK.  */
4974   *q = "string";
4975   /* Now char** pointer points to read-only memory.  */
4976   **p = 'b';
4977 @end smallexample
4979 @item -Wcast-align
4980 @opindex Wcast-align
4981 @opindex Wno-cast-align
4982 Warn whenever a pointer is cast such that the required alignment of the
4983 target is increased.  For example, warn if a @code{char *} is cast to
4984 an @code{int *} on machines where integers can only be accessed at
4985 two- or four-byte boundaries.
4987 @item -Wwrite-strings
4988 @opindex Wwrite-strings
4989 @opindex Wno-write-strings
4990 When compiling C, give string constants the type @code{const
4991 char[@var{length}]} so that copying the address of one into a
4992 non-@code{const} @code{char *} pointer produces a warning.  These
4993 warnings help you find at compile time code that can try to write
4994 into a string constant, but only if you have been very careful about
4995 using @code{const} in declarations and prototypes.  Otherwise, it is
4996 just a nuisance. This is why we did not make @option{-Wall} request
4997 these warnings.
4999 When compiling C++, warn about the deprecated conversion from string
5000 literals to @code{char *}.  This warning is enabled by default for C++
5001 programs.
5003 @item -Wclobbered
5004 @opindex Wclobbered
5005 @opindex Wno-clobbered
5006 Warn for variables that might be changed by @code{longjmp} or
5007 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
5009 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
5010 @opindex Wconditionally-supported
5011 @opindex Wno-conditionally-supported
5012 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
5014 @item -Wconversion
5015 @opindex Wconversion
5016 @opindex Wno-conversion
5017 Warn for implicit conversions that may alter a value. This includes
5018 conversions between real and integer, like @code{abs (x)} when
5019 @code{x} is @code{double}; conversions between signed and unsigned,
5020 like @code{unsigned ui = -1}; and conversions to smaller types, like
5021 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
5022 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
5023 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5024 conversions between signed and unsigned integers can be disabled by
5025 using @option{-Wno-sign-conversion}.
5027 For C++, also warn for confusing overload resolution for user-defined
5028 conversions; and conversions that never use a type conversion
5029 operator: conversions to @code{void}, the same type, a base class or a
5030 reference to them. Warnings about conversions between signed and
5031 unsigned integers are disabled by default in C++ unless
5032 @option{-Wsign-conversion} is explicitly enabled.
5034 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5035 @opindex Wconversion-null
5036 @opindex Wno-conversion-null
5037 Do not warn for conversions between @code{NULL} and non-pointer
5038 types. @option{-Wconversion-null} is enabled by default.
5040 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5041 @opindex Wzero-as-null-pointer-constant
5042 @opindex Wno-zero-as-null-pointer-constant
5043 Warn when a literal '0' is used as null pointer constant.  This can
5044 be useful to facilitate the conversion to @code{nullptr} in C++11.
5046 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5047 @opindex Wsubobject-linkage
5048 @opindex Wno-subobject-linkage
5049 Warn if a class type has a base or a field whose type uses the anonymous
5050 namespace or depends on a type with no linkage.  If a type A depends on
5051 a type B with no or internal linkage, defining it in multiple
5052 translation units would be an ODR violation because the meaning of B
5053 is different in each translation unit.  If A only appears in a single
5054 translation unit, the best way to silence the warning is to give it
5055 internal linkage by putting it in an anonymous namespace as well.  The
5056 compiler doesn't give this warning for types defined in the main .C
5057 file, as those are unlikely to have multiple definitions.
5058 @option{-Wsubobject-linkage} is enabled by default.
5060 @item -Wdate-time
5061 @opindex Wdate-time
5062 @opindex Wno-date-time
5063 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5064 are encountered as they might prevent bit-wise-identical reproducible
5065 compilations.
5067 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5068 @opindex Wdelete-incomplete
5069 @opindex Wno-delete-incomplete
5070 Warn when deleting a pointer to incomplete type, which may cause
5071 undefined behavior at runtime.  This warning is enabled by default.
5073 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5074 @opindex Wuseless-cast
5075 @opindex Wno-useless-cast
5076 Warn when an expression is casted to its own type.
5078 @item -Wempty-body
5079 @opindex Wempty-body
5080 @opindex Wno-empty-body
5081 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5082 while} statement.  This warning is also enabled by @option{-Wextra}.
5084 @item -Wenum-compare
5085 @opindex Wenum-compare
5086 @opindex Wno-enum-compare
5087 Warn about a comparison between values of different enumerated types.
5088 In C++ enumeral mismatches in conditional expressions are also
5089 diagnosed and the warning is enabled by default.  In C this warning is 
5090 enabled by @option{-Wall}.
5092 @item -Wjump-misses-init @r{(C, Objective-C only)}
5093 @opindex Wjump-misses-init
5094 @opindex Wno-jump-misses-init
5095 Warn if a @code{goto} statement or a @code{switch} statement jumps
5096 forward across the initialization of a variable, or jumps backward to a
5097 label after the variable has been initialized.  This only warns about
5098 variables that are initialized when they are declared.  This warning is
5099 only supported for C and Objective-C; in C++ this sort of branch is an
5100 error in any case.
5102 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5103 can be disabled with the @option{-Wno-jump-misses-init} option.
5105 @item -Wsign-compare
5106 @opindex Wsign-compare
5107 @opindex Wno-sign-compare
5108 @cindex warning for comparison of signed and unsigned values
5109 @cindex comparison of signed and unsigned values, warning
5110 @cindex signed and unsigned values, comparison warning
5111 Warn when a comparison between signed and unsigned values could produce
5112 an incorrect result when the signed value is converted to unsigned.
5113 This warning is also enabled by @option{-Wextra}; to get the other warnings
5114 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
5116 @item -Wsign-conversion
5117 @opindex Wsign-conversion
5118 @opindex Wno-sign-conversion
5119 Warn for implicit conversions that may change the sign of an integer
5120 value, like assigning a signed integer expression to an unsigned
5121 integer variable. An explicit cast silences the warning. In C, this
5122 option is enabled also by @option{-Wconversion}.
5124 @item -Wfloat-conversion
5125 @opindex Wfloat-conversion
5126 @opindex Wno-float-conversion
5127 Warn for implicit conversions that reduce the precision of a real value.
5128 This includes conversions from real to integer, and from higher precision
5129 real to lower precision real values.  This option is also enabled by
5130 @option{-Wconversion}.
5132 @item -Wno-scalar-storage-order
5133 @opindex -Wno-scalar-storage-order
5134 @opindex -Wscalar-storage-order
5135 Do not warn on suspicious constructs involving reverse scalar storage order.
5137 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5138 @opindex Wsized-deallocation
5139 @opindex Wno-sized-deallocation
5140 Warn about a definition of an unsized deallocation function
5141 @smallexample
5142 void operator delete (void *) noexcept;
5143 void operator delete[] (void *) noexcept;
5144 @end smallexample
5145 without a definition of the corresponding sized deallocation function
5146 @smallexample
5147 void operator delete (void *, std::size_t) noexcept;
5148 void operator delete[] (void *, std::size_t) noexcept;
5149 @end smallexample
5150 or vice versa.  Enabled by @option{-Wextra} along with
5151 @option{-fsized-deallocation}.
5153 @item -Wsizeof-pointer-memaccess
5154 @opindex Wsizeof-pointer-memaccess
5155 @opindex Wno-sizeof-pointer-memaccess
5156 Warn for suspicious length parameters to certain string and memory built-in
5157 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5158 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5159 but a pointer, and suggests a possible fix, or about
5160 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5161 @option{-Wall}.
5163 @item -Wsizeof-array-argument
5164 @opindex Wsizeof-array-argument
5165 @opindex Wno-sizeof-array-argument
5166 Warn when the @code{sizeof} operator is applied to a parameter that is
5167 declared as an array in a function definition.  This warning is enabled by
5168 default for C and C++ programs.
5170 @item -Wmemset-transposed-args
5171 @opindex Wmemset-transposed-args
5172 @opindex Wno-memset-transposed-args
5173 Warn for suspicious calls to the @code{memset} built-in function, if the
5174 second argument is not zero and the third argument is zero.  This warns e.g.@
5175 about @code{memset (buf, sizeof buf, 0)} where most probably
5176 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5177 is only emitted if the third argument is literal zero.  If it is some
5178 expression that is folded to zero, a cast of zero to some type, etc., 
5179 it is far less likely that the user has mistakenly exchanged the arguments 
5180 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5182 @item -Waddress
5183 @opindex Waddress
5184 @opindex Wno-address
5185 Warn about suspicious uses of memory addresses. These include using
5186 the address of a function in a conditional expression, such as
5187 @code{void func(void); if (func)}, and comparisons against the memory
5188 address of a string literal, such as @code{if (x == "abc")}.  Such
5189 uses typically indicate a programmer error: the address of a function
5190 always evaluates to true, so their use in a conditional usually
5191 indicate that the programmer forgot the parentheses in a function
5192 call; and comparisons against string literals result in unspecified
5193 behavior and are not portable in C, so they usually indicate that the
5194 programmer intended to use @code{strcmp}.  This warning is enabled by
5195 @option{-Wall}.
5197 @item -Wlogical-op
5198 @opindex Wlogical-op
5199 @opindex Wno-logical-op
5200 Warn about suspicious uses of logical operators in expressions.
5201 This includes using logical operators in contexts where a
5202 bit-wise operator is likely to be expected.  Also warns when
5203 the operands of a logical operator are the same:
5204 @smallexample
5205 extern int a;
5206 if (a < 0 && a < 0) @{ @dots{} @}
5207 @end smallexample
5209 @item -Wlogical-not-parentheses
5210 @opindex Wlogical-not-parentheses
5211 @opindex Wno-logical-not-parentheses
5212 Warn about logical not used on the left hand side operand of a comparison.
5213 This option does not warn if the RHS operand is of a boolean type.  Its
5214 purpose is to detect suspicious code like the following:
5215 @smallexample
5216 int a;
5217 @dots{}
5218 if (!a > 1) @{ @dots{} @}
5219 @end smallexample
5221 It is possible to suppress the warning by wrapping the LHS into
5222 parentheses:
5223 @smallexample
5224 if ((!a) > 1) @{ @dots{} @}
5225 @end smallexample
5227 This warning is enabled by @option{-Wall}.
5229 @item -Waggregate-return
5230 @opindex Waggregate-return
5231 @opindex Wno-aggregate-return
5232 Warn if any functions that return structures or unions are defined or
5233 called.  (In languages where you can return an array, this also elicits
5234 a warning.)
5236 @item -Wno-aggressive-loop-optimizations
5237 @opindex Wno-aggressive-loop-optimizations
5238 @opindex Waggressive-loop-optimizations
5239 Warn if in a loop with constant number of iterations the compiler detects
5240 undefined behavior in some statement during one or more of the iterations.
5242 @item -Wno-attributes
5243 @opindex Wno-attributes
5244 @opindex Wattributes
5245 Do not warn if an unexpected @code{__attribute__} is used, such as
5246 unrecognized attributes, function attributes applied to variables,
5247 etc.  This does not stop errors for incorrect use of supported
5248 attributes.
5250 @item -Wno-builtin-macro-redefined
5251 @opindex Wno-builtin-macro-redefined
5252 @opindex Wbuiltin-macro-redefined
5253 Do not warn if certain built-in macros are redefined.  This suppresses
5254 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5255 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5257 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5258 @opindex Wstrict-prototypes
5259 @opindex Wno-strict-prototypes
5260 Warn if a function is declared or defined without specifying the
5261 argument types.  (An old-style function definition is permitted without
5262 a warning if preceded by a declaration that specifies the argument
5263 types.)
5265 @item -Wold-style-declaration @r{(C and Objective-C only)}
5266 @opindex Wold-style-declaration
5267 @opindex Wno-old-style-declaration
5268 Warn for obsolescent usages, according to the C Standard, in a
5269 declaration. For example, warn if storage-class specifiers like
5270 @code{static} are not the first things in a declaration.  This warning
5271 is also enabled by @option{-Wextra}.
5273 @item -Wold-style-definition @r{(C and Objective-C only)}
5274 @opindex Wold-style-definition
5275 @opindex Wno-old-style-definition
5276 Warn if an old-style function definition is used.  A warning is given
5277 even if there is a previous prototype.
5279 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5280 @opindex Wmissing-parameter-type
5281 @opindex Wno-missing-parameter-type
5282 A function parameter is declared without a type specifier in K&R-style
5283 functions:
5285 @smallexample
5286 void foo(bar) @{ @}
5287 @end smallexample
5289 This warning is also enabled by @option{-Wextra}.
5291 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5292 @opindex Wmissing-prototypes
5293 @opindex Wno-missing-prototypes
5294 Warn if a global function is defined without a previous prototype
5295 declaration.  This warning is issued even if the definition itself
5296 provides a prototype.  Use this option to detect global functions
5297 that do not have a matching prototype declaration in a header file.
5298 This option is not valid for C++ because all function declarations
5299 provide prototypes and a non-matching declaration declares an
5300 overload rather than conflict with an earlier declaration.
5301 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5303 @item -Wmissing-declarations
5304 @opindex Wmissing-declarations
5305 @opindex Wno-missing-declarations
5306 Warn if a global function is defined without a previous declaration.
5307 Do so even if the definition itself provides a prototype.
5308 Use this option to detect global functions that are not declared in
5309 header files.  In C, no warnings are issued for functions with previous
5310 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5311 missing prototypes.  In C++, no warnings are issued for function templates,
5312 or for inline functions, or for functions in anonymous namespaces.
5314 @item -Wmissing-field-initializers
5315 @opindex Wmissing-field-initializers
5316 @opindex Wno-missing-field-initializers
5317 @opindex W
5318 @opindex Wextra
5319 @opindex Wno-extra
5320 Warn if a structure's initializer has some fields missing.  For
5321 example, the following code causes such a warning, because
5322 @code{x.h} is implicitly zero:
5324 @smallexample
5325 struct s @{ int f, g, h; @};
5326 struct s x = @{ 3, 4 @};
5327 @end smallexample
5329 This option does not warn about designated initializers, so the following
5330 modification does not trigger a warning:
5332 @smallexample
5333 struct s @{ int f, g, h; @};
5334 struct s x = @{ .f = 3, .g = 4 @};
5335 @end smallexample
5337 In C++ this option does not warn either about the empty @{ @}
5338 initializer, for example:
5340 @smallexample
5341 struct s @{ int f, g, h; @};
5342 s x = @{ @};
5343 @end smallexample
5345 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5346 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5348 @item -Wno-multichar
5349 @opindex Wno-multichar
5350 @opindex Wmultichar
5351 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5352 Usually they indicate a typo in the user's code, as they have
5353 implementation-defined values, and should not be used in portable code.
5355 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5356 @opindex Wnormalized=
5357 @opindex Wnormalized
5358 @opindex Wno-normalized
5359 @cindex NFC
5360 @cindex NFKC
5361 @cindex character set, input normalization
5362 In ISO C and ISO C++, two identifiers are different if they are
5363 different sequences of characters.  However, sometimes when characters
5364 outside the basic ASCII character set are used, you can have two
5365 different character sequences that look the same.  To avoid confusion,
5366 the ISO 10646 standard sets out some @dfn{normalization rules} which
5367 when applied ensure that two sequences that look the same are turned into
5368 the same sequence.  GCC can warn you if you are using identifiers that
5369 have not been normalized; this option controls that warning.
5371 There are four levels of warning supported by GCC@.  The default is
5372 @option{-Wnormalized=nfc}, which warns about any identifier that is
5373 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5374 recommended form for most uses.  It is equivalent to
5375 @option{-Wnormalized}.
5377 Unfortunately, there are some characters allowed in identifiers by
5378 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5379 identifiers.  That is, there's no way to use these symbols in portable
5380 ISO C or C++ and have all your identifiers in NFC@.
5381 @option{-Wnormalized=id} suppresses the warning for these characters.
5382 It is hoped that future versions of the standards involved will correct
5383 this, which is why this option is not the default.
5385 You can switch the warning off for all characters by writing
5386 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5387 only do this if you are using some other normalization scheme (like
5388 ``D''), because otherwise you can easily create bugs that are
5389 literally impossible to see.
5391 Some characters in ISO 10646 have distinct meanings but look identical
5392 in some fonts or display methodologies, especially once formatting has
5393 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5394 LETTER N'', displays just like a regular @code{n} that has been
5395 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5396 normalization scheme to convert all these into a standard form as
5397 well, and GCC warns if your code is not in NFKC if you use
5398 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5399 about every identifier that contains the letter O because it might be
5400 confused with the digit 0, and so is not the default, but may be
5401 useful as a local coding convention if the programming environment 
5402 cannot be fixed to display these characters distinctly.
5404 @item -Wno-deprecated
5405 @opindex Wno-deprecated
5406 @opindex Wdeprecated
5407 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5409 @item -Wno-deprecated-declarations
5410 @opindex Wno-deprecated-declarations
5411 @opindex Wdeprecated-declarations
5412 Do not warn about uses of functions (@pxref{Function Attributes}),
5413 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5414 Attributes}) marked as deprecated by using the @code{deprecated}
5415 attribute.
5417 @item -Wno-overflow
5418 @opindex Wno-overflow
5419 @opindex Woverflow
5420 Do not warn about compile-time overflow in constant expressions.
5422 @item -Wno-odr
5423 @opindex Wno-odr
5424 @opindex Wodr
5425 Warn about One Definition Rule violations during link-time optimization.
5426 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5428 @item -Wopenmp-simd
5429 @opindex Wopenm-simd
5430 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5431 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5432 option can be used to relax the cost model.
5434 @item -Woverride-init @r{(C and Objective-C only)}
5435 @opindex Woverride-init
5436 @opindex Wno-override-init
5437 @opindex W
5438 @opindex Wextra
5439 @opindex Wno-extra
5440 Warn if an initialized field without side effects is overridden when
5441 using designated initializers (@pxref{Designated Inits, , Designated
5442 Initializers}).
5444 This warning is included in @option{-Wextra}.  To get other
5445 @option{-Wextra} warnings without this one, use @option{-Wextra
5446 -Wno-override-init}.
5448 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5449 @opindex Woverride-init-side-effects
5450 @opindex Wno-override-init-side-effects
5451 Warn if an initialized field with side effects is overridden when
5452 using designated initializers (@pxref{Designated Inits, , Designated
5453 Initializers}).  This warning is enabled by default.
5455 @item -Wpacked
5456 @opindex Wpacked
5457 @opindex Wno-packed
5458 Warn if a structure is given the packed attribute, but the packed
5459 attribute has no effect on the layout or size of the structure.
5460 Such structures may be mis-aligned for little benefit.  For
5461 instance, in this code, the variable @code{f.x} in @code{struct bar}
5462 is misaligned even though @code{struct bar} does not itself
5463 have the packed attribute:
5465 @smallexample
5466 @group
5467 struct foo @{
5468   int x;
5469   char a, b, c, d;
5470 @} __attribute__((packed));
5471 struct bar @{
5472   char z;
5473   struct foo f;
5475 @end group
5476 @end smallexample
5478 @item -Wpacked-bitfield-compat
5479 @opindex Wpacked-bitfield-compat
5480 @opindex Wno-packed-bitfield-compat
5481 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5482 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5483 the change can lead to differences in the structure layout.  GCC
5484 informs you when the offset of such a field has changed in GCC 4.4.
5485 For example there is no longer a 4-bit padding between field @code{a}
5486 and @code{b} in this structure:
5488 @smallexample
5489 struct foo
5491   char a:4;
5492   char b:8;
5493 @} __attribute__ ((packed));
5494 @end smallexample
5496 This warning is enabled by default.  Use
5497 @option{-Wno-packed-bitfield-compat} to disable this warning.
5499 @item -Wpadded
5500 @opindex Wpadded
5501 @opindex Wno-padded
5502 Warn if padding is included in a structure, either to align an element
5503 of the structure or to align the whole structure.  Sometimes when this
5504 happens it is possible to rearrange the fields of the structure to
5505 reduce the padding and so make the structure smaller.
5507 @item -Wredundant-decls
5508 @opindex Wredundant-decls
5509 @opindex Wno-redundant-decls
5510 Warn if anything is declared more than once in the same scope, even in
5511 cases where multiple declaration is valid and changes nothing.
5513 @item -Wnested-externs @r{(C and Objective-C only)}
5514 @opindex Wnested-externs
5515 @opindex Wno-nested-externs
5516 Warn if an @code{extern} declaration is encountered within a function.
5518 @item -Wno-inherited-variadic-ctor
5519 @opindex Winherited-variadic-ctor
5520 @opindex Wno-inherited-variadic-ctor
5521 Suppress warnings about use of C++11 inheriting constructors when the
5522 base class inherited from has a C variadic constructor; the warning is
5523 on by default because the ellipsis is not inherited.
5525 @item -Winline
5526 @opindex Winline
5527 @opindex Wno-inline
5528 Warn if a function that is declared as inline cannot be inlined.
5529 Even with this option, the compiler does not warn about failures to
5530 inline functions declared in system headers.
5532 The compiler uses a variety of heuristics to determine whether or not
5533 to inline a function.  For example, the compiler takes into account
5534 the size of the function being inlined and the amount of inlining
5535 that has already been done in the current function.  Therefore,
5536 seemingly insignificant changes in the source program can cause the
5537 warnings produced by @option{-Winline} to appear or disappear.
5539 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5540 @opindex Wno-invalid-offsetof
5541 @opindex Winvalid-offsetof
5542 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5543 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5544 to a non-standard-layout type is undefined.  In existing C++ implementations,
5545 however, @code{offsetof} typically gives meaningful results.
5546 This flag is for users who are aware that they are
5547 writing nonportable code and who have deliberately chosen to ignore the
5548 warning about it.
5550 The restrictions on @code{offsetof} may be relaxed in a future version
5551 of the C++ standard.
5553 @item -Wno-int-to-pointer-cast
5554 @opindex Wno-int-to-pointer-cast
5555 @opindex Wint-to-pointer-cast
5556 Suppress warnings from casts to pointer type of an integer of a
5557 different size. In C++, casting to a pointer type of smaller size is
5558 an error. @option{Wint-to-pointer-cast} is enabled by default.
5561 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5562 @opindex Wno-pointer-to-int-cast
5563 @opindex Wpointer-to-int-cast
5564 Suppress warnings from casts from a pointer to an integer type of a
5565 different size.
5567 @item -Winvalid-pch
5568 @opindex Winvalid-pch
5569 @opindex Wno-invalid-pch
5570 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5571 the search path but can't be used.
5573 @item -Wlong-long
5574 @opindex Wlong-long
5575 @opindex Wno-long-long
5576 Warn if @code{long long} type is used.  This is enabled by either
5577 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5578 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5580 @item -Wvariadic-macros
5581 @opindex Wvariadic-macros
5582 @opindex Wno-variadic-macros
5583 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5584 alternate syntax is used in ISO C99 mode.  This is enabled by either
5585 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5586 messages, use @option{-Wno-variadic-macros}.
5588 @item -Wvarargs
5589 @opindex Wvarargs
5590 @opindex Wno-varargs
5591 Warn upon questionable usage of the macros used to handle variable
5592 arguments like @code{va_start}.  This is default.  To inhibit the
5593 warning messages, use @option{-Wno-varargs}.
5595 @item -Wvector-operation-performance
5596 @opindex Wvector-operation-performance
5597 @opindex Wno-vector-operation-performance
5598 Warn if vector operation is not implemented via SIMD capabilities of the
5599 architecture.  Mainly useful for the performance tuning.
5600 Vector operation can be implemented @code{piecewise}, which means that the
5601 scalar operation is performed on every vector element; 
5602 @code{in parallel}, which means that the vector operation is implemented
5603 using scalars of wider type, which normally is more performance efficient;
5604 and @code{as a single scalar}, which means that vector fits into a
5605 scalar type.
5607 @item -Wno-virtual-move-assign
5608 @opindex Wvirtual-move-assign
5609 @opindex Wno-virtual-move-assign
5610 Suppress warnings about inheriting from a virtual base with a
5611 non-trivial C++11 move assignment operator.  This is dangerous because
5612 if the virtual base is reachable along more than one path, it is
5613 moved multiple times, which can mean both objects end up in the
5614 moved-from state.  If the move assignment operator is written to avoid
5615 moving from a moved-from object, this warning can be disabled.
5617 @item -Wvla
5618 @opindex Wvla
5619 @opindex Wno-vla
5620 Warn if variable length array is used in the code.
5621 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5622 the variable length array.
5624 @item -Wvolatile-register-var
5625 @opindex Wvolatile-register-var
5626 @opindex Wno-volatile-register-var
5627 Warn if a register variable is declared volatile.  The volatile
5628 modifier does not inhibit all optimizations that may eliminate reads
5629 and/or writes to register variables.  This warning is enabled by
5630 @option{-Wall}.
5632 @item -Wdisabled-optimization
5633 @opindex Wdisabled-optimization
5634 @opindex Wno-disabled-optimization
5635 Warn if a requested optimization pass is disabled.  This warning does
5636 not generally indicate that there is anything wrong with your code; it
5637 merely indicates that GCC's optimizers are unable to handle the code
5638 effectively.  Often, the problem is that your code is too big or too
5639 complex; GCC refuses to optimize programs when the optimization
5640 itself is likely to take inordinate amounts of time.
5642 @item -Wpointer-sign @r{(C and Objective-C only)}
5643 @opindex Wpointer-sign
5644 @opindex Wno-pointer-sign
5645 Warn for pointer argument passing or assignment with different signedness.
5646 This option is only supported for C and Objective-C@.  It is implied by
5647 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5648 @option{-Wno-pointer-sign}.
5650 @item -Wstack-protector
5651 @opindex Wstack-protector
5652 @opindex Wno-stack-protector
5653 This option is only active when @option{-fstack-protector} is active.  It
5654 warns about functions that are not protected against stack smashing.
5656 @item -Woverlength-strings
5657 @opindex Woverlength-strings
5658 @opindex Wno-overlength-strings
5659 Warn about string constants that are longer than the ``minimum
5660 maximum'' length specified in the C standard.  Modern compilers
5661 generally allow string constants that are much longer than the
5662 standard's minimum limit, but very portable programs should avoid
5663 using longer strings.
5665 The limit applies @emph{after} string constant concatenation, and does
5666 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5667 C99, it was raised to 4095.  C++98 does not specify a normative
5668 minimum maximum, so we do not diagnose overlength strings in C++@.
5670 This option is implied by @option{-Wpedantic}, and can be disabled with
5671 @option{-Wno-overlength-strings}.
5673 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5674 @opindex Wunsuffixed-float-constants
5676 Issue a warning for any floating constant that does not have
5677 a suffix.  When used together with @option{-Wsystem-headers} it
5678 warns about such constants in system header files.  This can be useful
5679 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5680 from the decimal floating-point extension to C99.
5682 @item -Wno-designated-init @r{(C and Objective-C only)}
5683 Suppress warnings when a positional initializer is used to initialize
5684 a structure that has been marked with the @code{designated_init}
5685 attribute.
5687 @end table
5689 @node Debugging Options
5690 @section Options for Debugging Your Program or GCC
5691 @cindex options, debugging
5692 @cindex debugging information options
5694 GCC has various special options that are used for debugging
5695 either your program or GCC:
5697 @table @gcctabopt
5698 @item -g
5699 @opindex g
5700 Produce debugging information in the operating system's native format
5701 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5702 information.
5704 On most systems that use stabs format, @option{-g} enables use of extra
5705 debugging information that only GDB can use; this extra information
5706 makes debugging work better in GDB but probably makes other debuggers
5707 crash or
5708 refuse to read the program.  If you want to control for certain whether
5709 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5710 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5712 GCC allows you to use @option{-g} with
5713 @option{-O}.  The shortcuts taken by optimized code may occasionally
5714 produce surprising results: some variables you declared may not exist
5715 at all; flow of control may briefly move where you did not expect it;
5716 some statements may not be executed because they compute constant
5717 results or their values are already at hand; some statements may
5718 execute in different places because they have been moved out of loops.
5720 Nevertheless it proves possible to debug optimized output.  This makes
5721 it reasonable to use the optimizer for programs that might have bugs.
5723 The following options are useful when GCC is generated with the
5724 capability for more than one debugging format.
5726 @item -gsplit-dwarf
5727 @opindex gsplit-dwarf
5728 Separate as much dwarf debugging information as possible into a
5729 separate output file with the extension .dwo.  This option allows
5730 the build system to avoid linking files with debug information.  To
5731 be useful, this option requires a debugger capable of reading .dwo
5732 files.
5734 @item -ggdb
5735 @opindex ggdb
5736 Produce debugging information for use by GDB@.  This means to use the
5737 most expressive format available (DWARF 2, stabs, or the native format
5738 if neither of those are supported), including GDB extensions if at all
5739 possible.
5741 @item -gpubnames
5742 @opindex gpubnames
5743 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5745 @item -ggnu-pubnames
5746 @opindex ggnu-pubnames
5747 Generate .debug_pubnames and .debug_pubtypes sections in a format
5748 suitable for conversion into a GDB@ index.  This option is only useful
5749 with a linker that can produce GDB@ index version 7.
5751 @item -gstabs
5752 @opindex gstabs
5753 Produce debugging information in stabs format (if that is supported),
5754 without GDB extensions.  This is the format used by DBX on most BSD
5755 systems.  On MIPS, Alpha and System V Release 4 systems this option
5756 produces stabs debugging output that is not understood by DBX or SDB@.
5757 On System V Release 4 systems this option requires the GNU assembler.
5759 @item -feliminate-unused-debug-symbols
5760 @opindex feliminate-unused-debug-symbols
5761 Produce debugging information in stabs format (if that is supported),
5762 for only symbols that are actually used.
5764 @item -femit-class-debug-always
5765 @opindex femit-class-debug-always
5766 Instead of emitting debugging information for a C++ class in only one
5767 object file, emit it in all object files using the class.  This option
5768 should be used only with debuggers that are unable to handle the way GCC
5769 normally emits debugging information for classes because using this
5770 option increases the size of debugging information by as much as a
5771 factor of two.
5773 @item -fdebug-types-section
5774 @opindex fdebug-types-section
5775 @opindex fno-debug-types-section
5776 When using DWARF Version 4 or higher, type DIEs can be put into
5777 their own @code{.debug_types} section instead of making them part of the
5778 @code{.debug_info} section.  It is more efficient to put them in a separate
5779 comdat sections since the linker can then remove duplicates.
5780 But not all DWARF consumers support @code{.debug_types} sections yet
5781 and on some objects @code{.debug_types} produces larger instead of smaller
5782 debugging information.
5784 @item -gstabs+
5785 @opindex gstabs+
5786 Produce debugging information in stabs format (if that is supported),
5787 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5788 use of these extensions is likely to make other debuggers crash or
5789 refuse to read the program.
5791 @item -gcoff
5792 @opindex gcoff
5793 Produce debugging information in COFF format (if that is supported).
5794 This is the format used by SDB on most System V systems prior to
5795 System V Release 4.
5797 @item -gxcoff
5798 @opindex gxcoff
5799 Produce debugging information in XCOFF format (if that is supported).
5800 This is the format used by the DBX debugger on IBM RS/6000 systems.
5802 @item -gxcoff+
5803 @opindex gxcoff+
5804 Produce debugging information in XCOFF format (if that is supported),
5805 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5806 use of these extensions is likely to make other debuggers crash or
5807 refuse to read the program, and may cause assemblers other than the GNU
5808 assembler (GAS) to fail with an error.
5810 @item -gdwarf-@var{version}
5811 @opindex gdwarf-@var{version}
5812 Produce debugging information in DWARF format (if that is supported).
5813 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5814 for most targets is 4.  DWARF Version 5 is only experimental.
5816 Note that with DWARF Version 2, some ports require and always
5817 use some non-conflicting DWARF 3 extensions in the unwind tables.
5819 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5820 for maximum benefit.
5822 @item -grecord-gcc-switches
5823 @opindex grecord-gcc-switches
5824 This switch causes the command-line options used to invoke the
5825 compiler that may affect code generation to be appended to the
5826 DW_AT_producer attribute in DWARF debugging information.  The options
5827 are concatenated with spaces separating them from each other and from
5828 the compiler version.  See also @option{-frecord-gcc-switches} for another
5829 way of storing compiler options into the object file.  This is the default.
5831 @item -gno-record-gcc-switches
5832 @opindex gno-record-gcc-switches
5833 Disallow appending command-line options to the DW_AT_producer attribute
5834 in DWARF debugging information.
5836 @item -gstrict-dwarf
5837 @opindex gstrict-dwarf
5838 Disallow using extensions of later DWARF standard version than selected
5839 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5840 DWARF extensions from later standard versions is allowed.
5842 @item -gno-strict-dwarf
5843 @opindex gno-strict-dwarf
5844 Allow using extensions of later DWARF standard version than selected with
5845 @option{-gdwarf-@var{version}}.
5847 @item -gz@r{[}=@var{type}@r{]}
5848 @opindex gz
5849 Produce compressed debug sections in DWARF format, if that is supported.
5850 If @var{type} is not given, the default type depends on the capabilities
5851 of the assembler and linker used.  @var{type} may be one of
5852 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5853 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5854 compression in traditional GNU format).  If the linker doesn't support
5855 writing compressed debug sections, the option is rejected.  Otherwise,
5856 if the assembler does not support them, @option{-gz} is silently ignored
5857 when producing object files.
5859 @item -gvms
5860 @opindex gvms
5861 Produce debugging information in Alpha/VMS debug format (if that is
5862 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5864 @item -g@var{level}
5865 @itemx -ggdb@var{level}
5866 @itemx -gstabs@var{level}
5867 @itemx -gcoff@var{level}
5868 @itemx -gxcoff@var{level}
5869 @itemx -gvms@var{level}
5870 Request debugging information and also use @var{level} to specify how
5871 much information.  The default level is 2.
5873 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5874 @option{-g}.
5876 Level 1 produces minimal information, enough for making backtraces in
5877 parts of the program that you don't plan to debug.  This includes
5878 descriptions of functions and external variables, and line number
5879 tables, but no information about local variables.
5881 Level 3 includes extra information, such as all the macro definitions
5882 present in the program.  Some debuggers support macro expansion when
5883 you use @option{-g3}.
5885 @option{-gdwarf-2} does not accept a concatenated debug level, because
5886 GCC used to support an option @option{-gdwarf} that meant to generate
5887 debug information in version 1 of the DWARF format (which is very
5888 different from version 2), and it would have been too confusing.  That
5889 debug format is long obsolete, but the option cannot be changed now.
5890 Instead use an additional @option{-g@var{level}} option to change the
5891 debug level for DWARF.
5893 @item -gtoggle
5894 @opindex gtoggle
5895 Turn off generation of debug info, if leaving out this option
5896 generates it, or turn it on at level 2 otherwise.  The position of this
5897 argument in the command line does not matter; it takes effect after all
5898 other options are processed, and it does so only once, no matter how
5899 many times it is given.  This is mainly intended to be used with
5900 @option{-fcompare-debug}.
5902 @item -fsanitize=address
5903 @opindex fsanitize=address
5904 Enable AddressSanitizer, a fast memory error detector.
5905 Memory access instructions are instrumented to detect
5906 out-of-bounds and use-after-free bugs.
5907 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
5908 more details.  The run-time behavior can be influenced using the
5909 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
5910 the available options are shown at startup of the instrumended program.  See
5911 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
5912 for a list of supported options.
5914 @item -fsanitize=kernel-address
5915 @opindex fsanitize=kernel-address
5916 Enable AddressSanitizer for Linux kernel.
5917 See @uref{https://github.com/google/kasan/wiki} for more details.
5919 @item -fsanitize=thread
5920 @opindex fsanitize=thread
5921 Enable ThreadSanitizer, a fast data race detector.
5922 Memory access instructions are instrumented to detect
5923 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
5924 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5925 environment variable; see
5926 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
5927 supported options.
5929 @item -fsanitize=leak
5930 @opindex fsanitize=leak
5931 Enable LeakSanitizer, a memory leak detector.
5932 This option only matters for linking of executables and if neither
5933 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5934 case the executable is linked against a library that overrides @code{malloc}
5935 and other allocator functions.  See
5936 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
5937 details.  The run-time behavior can be influenced using the
5938 @env{LSAN_OPTIONS} environment variable.
5940 @item -fsanitize=undefined
5941 @opindex fsanitize=undefined
5942 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5943 Various computations are instrumented to detect undefined behavior
5944 at runtime.  Current suboptions are:
5946 @table @gcctabopt
5948 @item -fsanitize=shift
5949 @opindex fsanitize=shift
5950 This option enables checking that the result of a shift operation is
5951 not undefined.  Note that what exactly is considered undefined differs
5952 slightly between C and C++, as well as between ISO C90 and C99, etc.
5954 @item -fsanitize=integer-divide-by-zero
5955 @opindex fsanitize=integer-divide-by-zero
5956 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5958 @item -fsanitize=unreachable
5959 @opindex fsanitize=unreachable
5960 With this option, the compiler turns the @code{__builtin_unreachable}
5961 call into a diagnostics message call instead.  When reaching the
5962 @code{__builtin_unreachable} call, the behavior is undefined.
5964 @item -fsanitize=vla-bound
5965 @opindex fsanitize=vla-bound
5966 This option instructs the compiler to check that the size of a variable
5967 length array is positive.
5969 @item -fsanitize=null
5970 @opindex fsanitize=null
5971 This option enables pointer checking.  Particularly, the application
5972 built with this option turned on will issue an error message when it
5973 tries to dereference a NULL pointer, or if a reference (possibly an
5974 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5975 on an object pointed by a NULL pointer.
5977 @item -fsanitize=return
5978 @opindex fsanitize=return
5979 This option enables return statement checking.  Programs
5980 built with this option turned on will issue an error message
5981 when the end of a non-void function is reached without actually
5982 returning a value.  This option works in C++ only.
5984 @item -fsanitize=signed-integer-overflow
5985 @opindex fsanitize=signed-integer-overflow
5986 This option enables signed integer overflow checking.  We check that
5987 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5988 does not overflow in the signed arithmetics.  Note, integer promotion
5989 rules must be taken into account.  That is, the following is not an
5990 overflow:
5991 @smallexample
5992 signed char a = SCHAR_MAX;
5993 a++;
5994 @end smallexample
5996 @item -fsanitize=bounds
5997 @opindex fsanitize=bounds
5998 This option enables instrumentation of array bounds.  Various out of bounds
5999 accesses are detected.  Flexible array members, flexible array member-like
6000 arrays, and initializers of variables with static storage are not instrumented.
6002 @item -fsanitize=bounds-strict
6003 @opindex fsanitize=bounds-strict
6004 This option enables strict instrumentation of array bounds.  Most out of bounds
6005 accesses are detected, including flexible array members and flexible array
6006 member-like arrays.  Initializers of variables with static storage are not
6007 instrumented.
6009 @item -fsanitize=alignment
6010 @opindex fsanitize=alignment
6012 This option enables checking of alignment of pointers when they are
6013 dereferenced, or when a reference is bound to insufficiently aligned target,
6014 or when a method or constructor is invoked on insufficiently aligned object.
6016 @item -fsanitize=object-size
6017 @opindex fsanitize=object-size
6018 This option enables instrumentation of memory references using the
6019 @code{__builtin_object_size} function.  Various out of bounds pointer
6020 accesses are detected.
6022 @item -fsanitize=float-divide-by-zero
6023 @opindex fsanitize=float-divide-by-zero
6024 Detect floating-point division by zero.  Unlike other similar options,
6025 @option{-fsanitize=float-divide-by-zero} is not enabled by
6026 @option{-fsanitize=undefined}, since floating-point division by zero can
6027 be a legitimate way of obtaining infinities and NaNs.
6029 @item -fsanitize=float-cast-overflow
6030 @opindex fsanitize=float-cast-overflow
6031 This option enables floating-point type to integer conversion checking.
6032 We check that the result of the conversion does not overflow.
6033 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
6034 not enabled by @option{-fsanitize=undefined}.
6035 This option does not work well with @code{FE_INVALID} exceptions enabled.
6037 @item -fsanitize=nonnull-attribute
6038 @opindex fsanitize=nonnull-attribute
6040 This option enables instrumentation of calls, checking whether null values
6041 are not passed to arguments marked as requiring a non-null value by the
6042 @code{nonnull} function attribute.
6044 @item -fsanitize=returns-nonnull-attribute
6045 @opindex fsanitize=returns-nonnull-attribute
6047 This option enables instrumentation of return statements in functions
6048 marked with @code{returns_nonnull} function attribute, to detect returning
6049 of null values from such functions.
6051 @item -fsanitize=bool
6052 @opindex fsanitize=bool
6054 This option enables instrumentation of loads from bool.  If a value other
6055 than 0/1 is loaded, a run-time error is issued.
6057 @item -fsanitize=enum
6058 @opindex fsanitize=enum
6060 This option enables instrumentation of loads from an enum type.  If
6061 a value outside the range of values for the enum type is loaded,
6062 a run-time error is issued.
6064 @item -fsanitize=vptr
6065 @opindex fsanitize=vptr
6067 This option enables instrumentation of C++ member function calls, member
6068 accesses and some conversions between pointers to base and derived classes,
6069 to verify the referenced object has the correct dynamic type.
6071 @end table
6073 While @option{-ftrapv} causes traps for signed overflows to be emitted,
6074 @option{-fsanitize=undefined} gives a diagnostic message.
6075 This currently works only for the C family of languages.
6077 @item -fno-sanitize=all
6078 @opindex fno-sanitize=all
6080 This option disables all previously enabled sanitizers.
6081 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
6082 together.
6084 @item -fasan-shadow-offset=@var{number}
6085 @opindex fasan-shadow-offset
6086 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
6087 It is useful for experimenting with different shadow memory layouts in
6088 Kernel AddressSanitizer.
6090 @item -fsanitize-sections=@var{s1},@var{s2},...
6091 @opindex fsanitize-sections
6092 Sanitize global variables in selected user-defined sections.  @var{si} may
6093 contain wildcards.
6095 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
6096 @opindex fsanitize-recover
6097 @opindex fno-sanitize-recover
6098 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
6099 mentioned in comma-separated list of @var{opts}.  Enabling this option
6100 for a sanitizer component causes it to attempt to continue
6101 running the program as if no error happened.  This means multiple
6102 runtime errors can be reported in a single program run, and the exit
6103 code of the program may indicate success even when errors
6104 have been reported.  The @option{-fno-sanitize-recover=} option
6105 can be used to alter
6106 this behavior: only the first detected error is reported
6107 and program then exits with a non-zero exit code.
6109 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
6110 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
6111 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
6112 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
6113 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
6114 accepted, the former enables recovery for all sanitizers that support it,
6115 the latter disables recovery for all sanitizers that support it.
6117 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
6118 @smallexample
6119 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
6120 @end smallexample
6121 @noindent
6122 Similarly @option{-fno-sanitize-recover} is equivalent to
6123 @smallexample
6124 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
6125 @end smallexample
6127 @item -fsanitize-undefined-trap-on-error
6128 @opindex fsanitize-undefined-trap-on-error
6129 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
6130 report undefined behavior using @code{__builtin_trap} rather than
6131 a @code{libubsan} library routine.  The advantage of this is that the
6132 @code{libubsan} library is not needed and is not linked in, so this
6133 is usable even in freestanding environments.
6135 @item -fcheck-pointer-bounds
6136 @opindex fcheck-pointer-bounds
6137 @opindex fno-check-pointer-bounds
6138 @cindex Pointer Bounds Checker options
6139 Enable Pointer Bounds Checker instrumentation.  Each memory reference
6140 is instrumented with checks of the pointer used for memory access against
6141 bounds associated with that pointer.  
6143 Currently there
6144 is only an implementation for Intel MPX available, thus x86 target
6145 and @option{-mmpx} are required to enable this feature.  
6146 MPX-based instrumentation requires
6147 a runtime library to enable MPX in hardware and handle bounds
6148 violation signals.  By default when @option{-fcheck-pointer-bounds}
6149 and @option{-mmpx} options are used to link a program, the GCC driver
6150 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
6151 library.  It also passes '-z bndplt' to a linker in case it supports this
6152 option (which is checked on libmpx configuration).  Note that old versions
6153 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
6154 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
6155 lose passed bounds reducing overall protection level.  It's highly
6156 recommended to use linker with '-z bndplt' support.  In case such linker
6157 is not available it is adviced to always use @option{-static-libmpxwrappers}
6158 for better protection level or use @option{-static} to completely avoid
6159 external calls to dynamic libraries.  MPX-based instrumentation
6160 may be used for debugging and also may be included in production code
6161 to increase program security.  Depending on usage, you may
6162 have different requirements for the runtime library.  The current version
6163 of the MPX runtime library is more oriented for use as a debugging
6164 tool.  MPX runtime library usage implies @option{-lpthread}.  See
6165 also @option{-static-libmpx}.  The runtime library  behavior can be
6166 influenced using various @env{CHKP_RT_*} environment variables.  See
6167 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
6168 for more details.
6170 Generated instrumentation may be controlled by various
6171 @option{-fchkp-*} options and by the @code{bnd_variable_size}
6172 structure field attribute (@pxref{Type Attributes}) and
6173 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
6174 (@pxref{Function Attributes}).  GCC also provides a number of built-in
6175 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
6176 Bounds Checker builtins}, for more information.
6178 @item -fchecking
6179 @opindex fchecking
6180 @opindex fno-checking
6181 Enable internal consistency checking.  The default depends on
6182 the compiler configuration.
6184 @item -fchkp-check-incomplete-type
6185 @opindex fchkp-check-incomplete-type
6186 @opindex fno-chkp-check-incomplete-type
6187 Generate pointer bounds checks for variables with incomplete type.
6188 Enabled by default.
6190 @item -fchkp-narrow-bounds
6191 @opindex fchkp-narrow-bounds
6192 @opindex fno-chkp-narrow-bounds
6193 Controls bounds used by Pointer Bounds Checker for pointers to object
6194 fields.  If narrowing is enabled then field bounds are used.  Otherwise
6195 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
6196 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
6198 @item -fchkp-first-field-has-own-bounds
6199 @opindex fchkp-first-field-has-own-bounds
6200 @opindex fno-chkp-first-field-has-own-bounds
6201 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
6202 first field in the structure.  By default a pointer to the first field has
6203 the same bounds as a pointer to the whole structure.
6205 @item -fchkp-narrow-to-innermost-array
6206 @opindex fchkp-narrow-to-innermost-array
6207 @opindex fno-chkp-narrow-to-innermost-array
6208 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6209 case of nested static array access.  By default this option is disabled and
6210 bounds of the outermost array are used.
6212 @item -fchkp-optimize
6213 @opindex fchkp-optimize
6214 @opindex fno-chkp-optimize
6215 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6216 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6218 @item -fchkp-use-fast-string-functions
6219 @opindex fchkp-use-fast-string-functions
6220 @opindex fno-chkp-use-fast-string-functions
6221 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6222 by Pointer Bounds Checker.  Disabled by default.
6224 @item -fchkp-use-nochk-string-functions
6225 @opindex fchkp-use-nochk-string-functions
6226 @opindex fno-chkp-use-nochk-string-functions
6227 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6228 by Pointer Bounds Checker.  Disabled by default.
6230 @item -fchkp-use-static-bounds
6231 @opindex fchkp-use-static-bounds
6232 @opindex fno-chkp-use-static-bounds
6233 Allow Pointer Bounds Checker to generate static bounds holding
6234 bounds of static variables.  Enabled by default.
6236 @item -fchkp-use-static-const-bounds
6237 @opindex fchkp-use-static-const-bounds
6238 @opindex fno-chkp-use-static-const-bounds
6239 Use statically-initialized bounds for constant bounds instead of
6240 generating them each time they are required.  By default enabled when
6241 @option{-fchkp-use-static-bounds} is enabled.
6243 @item -fchkp-treat-zero-dynamic-size-as-infinite
6244 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6245 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6246 With this option, objects with incomplete type whose
6247 dynamically-obtained size is zero are treated as having infinite size
6248 instead by Pointer Bounds
6249 Checker.  This option may be helpful if a program is linked with a library
6250 missing size information for some symbols.  Disabled by default.
6252 @item -fchkp-check-read
6253 @opindex fchkp-check-read
6254 @opindex fno-chkp-check-read
6255 Instructs Pointer Bounds Checker to generate checks for all read
6256 accesses to memory.  Enabled by default.
6258 @item -fchkp-check-write
6259 @opindex fchkp-check-write
6260 @opindex fno-chkp-check-write
6261 Instructs Pointer Bounds Checker to generate checks for all write
6262 accesses to memory.  Enabled by default.
6264 @item -fchkp-store-bounds
6265 @opindex fchkp-store-bounds
6266 @opindex fno-chkp-store-bounds
6267 Instructs Pointer Bounds Checker to generate bounds stores for
6268 pointer writes.  Enabled by default.
6270 @item -fchkp-instrument-calls
6271 @opindex fchkp-instrument-calls
6272 @opindex fno-chkp-instrument-calls
6273 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6274 Enabled by default.
6276 @item -fchkp-instrument-marked-only
6277 @opindex fchkp-instrument-marked-only
6278 @opindex fno-chkp-instrument-marked-only
6279 Instructs Pointer Bounds Checker to instrument only functions
6280 marked with the @code{bnd_instrument} attribute
6281 (@pxref{Function Attributes}).  Disabled by default.
6283 @item -fchkp-use-wrappers
6284 @opindex fchkp-use-wrappers
6285 @opindex fno-chkp-use-wrappers
6286 Allows Pointer Bounds Checker to replace calls to built-in functions
6287 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6288 is used to link a program, the GCC driver automatically links
6289 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6290 Enabled by default.
6292 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6293 @opindex fdump-final-insns
6294 Dump the final internal representation (RTL) to @var{file}.  If the
6295 optional argument is omitted (or if @var{file} is @code{.}), the name
6296 of the dump file is determined by appending @code{.gkd} to the
6297 compilation output file name.
6299 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6300 @opindex fcompare-debug
6301 @opindex fno-compare-debug
6302 If no error occurs during compilation, run the compiler a second time,
6303 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6304 passed to the second compilation.  Dump the final internal
6305 representation in both compilations, and print an error if they differ.
6307 If the equal sign is omitted, the default @option{-gtoggle} is used.
6309 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6310 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6311 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6312 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6313 is used.
6315 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6316 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6317 of the final representation and the second compilation, preventing even
6318 @env{GCC_COMPARE_DEBUG} from taking effect.
6320 To verify full coverage during @option{-fcompare-debug} testing, set
6321 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6322 which GCC rejects as an invalid option in any actual compilation
6323 (rather than preprocessing, assembly or linking).  To get just a
6324 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6325 not overridden} will do.
6327 @item -fcompare-debug-second
6328 @opindex fcompare-debug-second
6329 This option is implicitly passed to the compiler for the second
6330 compilation requested by @option{-fcompare-debug}, along with options to
6331 silence warnings, and omitting other options that would cause
6332 side-effect compiler outputs to files or to the standard output.  Dump
6333 files and preserved temporary files are renamed so as to contain the
6334 @code{.gk} additional extension during the second compilation, to avoid
6335 overwriting those generated by the first.
6337 When this option is passed to the compiler driver, it causes the
6338 @emph{first} compilation to be skipped, which makes it useful for little
6339 other than debugging the compiler proper.
6341 @item -feliminate-dwarf2-dups
6342 @opindex feliminate-dwarf2-dups
6343 Compress DWARF 2 debugging information by eliminating duplicated
6344 information about each symbol.  This option only makes sense when
6345 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6347 @item -femit-struct-debug-baseonly
6348 @opindex femit-struct-debug-baseonly
6349 Emit debug information for struct-like types
6350 only when the base name of the compilation source file
6351 matches the base name of file in which the struct is defined.
6353 This option substantially reduces the size of debugging information,
6354 but at significant potential loss in type information to the debugger.
6355 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6356 See @option{-femit-struct-debug-detailed} for more detailed control.
6358 This option works only with DWARF 2.
6360 @item -femit-struct-debug-reduced
6361 @opindex femit-struct-debug-reduced
6362 Emit debug information for struct-like types
6363 only when the base name of the compilation source file
6364 matches the base name of file in which the type is defined,
6365 unless the struct is a template or defined in a system header.
6367 This option significantly reduces the size of debugging information,
6368 with some potential loss in type information to the debugger.
6369 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6370 See @option{-femit-struct-debug-detailed} for more detailed control.
6372 This option works only with DWARF 2.
6374 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6375 @opindex femit-struct-debug-detailed
6376 Specify the struct-like types
6377 for which the compiler generates debug information.
6378 The intent is to reduce duplicate struct debug information
6379 between different object files within the same program.
6381 This option is a detailed version of
6382 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6383 which serves for most needs.
6385 A specification has the syntax@*
6386 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6388 The optional first word limits the specification to
6389 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6390 A struct type is used directly when it is the type of a variable, member.
6391 Indirect uses arise through pointers to structs.
6392 That is, when use of an incomplete struct is valid, the use is indirect.
6393 An example is
6394 @samp{struct one direct; struct two * indirect;}.
6396 The optional second word limits the specification to
6397 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6398 Generic structs are a bit complicated to explain.
6399 For C++, these are non-explicit specializations of template classes,
6400 or non-template classes within the above.
6401 Other programming languages have generics,
6402 but @option{-femit-struct-debug-detailed} does not yet implement them.
6404 The third word specifies the source files for those
6405 structs for which the compiler should emit debug information.
6406 The values @samp{none} and @samp{any} have the normal meaning.
6407 The value @samp{base} means that
6408 the base of name of the file in which the type declaration appears
6409 must match the base of the name of the main compilation file.
6410 In practice, this means that when compiling @file{foo.c}, debug information
6411 is generated for types declared in that file and @file{foo.h},
6412 but not other header files.
6413 The value @samp{sys} means those types satisfying @samp{base}
6414 or declared in system or compiler headers.
6416 You may need to experiment to determine the best settings for your application.
6418 The default is @option{-femit-struct-debug-detailed=all}.
6420 This option works only with DWARF 2.
6422 @item -fno-merge-debug-strings
6423 @opindex fmerge-debug-strings
6424 @opindex fno-merge-debug-strings
6425 Direct the linker to not merge together strings in the debugging
6426 information that are identical in different object files.  Merging is
6427 not supported by all assemblers or linkers.  Merging decreases the size
6428 of the debug information in the output file at the cost of increasing
6429 link processing time.  Merging is enabled by default.
6431 @item -fdebug-prefix-map=@var{old}=@var{new}
6432 @opindex fdebug-prefix-map
6433 When compiling files in directory @file{@var{old}}, record debugging
6434 information describing them as in @file{@var{new}} instead.
6436 @item -fno-dwarf2-cfi-asm
6437 @opindex fdwarf2-cfi-asm
6438 @opindex fno-dwarf2-cfi-asm
6439 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6440 instead of using GAS @code{.cfi_*} directives.
6442 @cindex @command{prof}
6443 @item -p
6444 @opindex p
6445 Generate extra code to write profile information suitable for the
6446 analysis program @command{prof}.  You must use this option when compiling
6447 the source files you want data about, and you must also use it when
6448 linking.
6450 @cindex @command{gprof}
6451 @item -pg
6452 @opindex pg
6453 Generate extra code to write profile information suitable for the
6454 analysis program @command{gprof}.  You must use this option when compiling
6455 the source files you want data about, and you must also use it when
6456 linking.
6458 @item -Q
6459 @opindex Q
6460 Makes the compiler print out each function name as it is compiled, and
6461 print some statistics about each pass when it finishes.
6463 @item -ftime-report
6464 @opindex ftime-report
6465 Makes the compiler print some statistics about the time consumed by each
6466 pass when it finishes.
6468 @item -fmem-report
6469 @opindex fmem-report
6470 Makes the compiler print some statistics about permanent memory
6471 allocation when it finishes.
6473 @item -fmem-report-wpa
6474 @opindex fmem-report-wpa
6475 Makes the compiler print some statistics about permanent memory
6476 allocation for the WPA phase only.
6478 @item -fpre-ipa-mem-report
6479 @opindex fpre-ipa-mem-report
6480 @item -fpost-ipa-mem-report
6481 @opindex fpost-ipa-mem-report
6482 Makes the compiler print some statistics about permanent memory
6483 allocation before or after interprocedural optimization.
6485 @item -fprofile-report
6486 @opindex fprofile-report
6487 Makes the compiler print some statistics about consistency of the
6488 (estimated) profile and effect of individual passes.
6490 @item -fstack-usage
6491 @opindex fstack-usage
6492 Makes the compiler output stack usage information for the program, on a
6493 per-function basis.  The filename for the dump is made by appending
6494 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6495 the output file, if explicitly specified and it is not an executable,
6496 otherwise it is the basename of the source file.  An entry is made up
6497 of three fields:
6499 @itemize
6500 @item
6501 The name of the function.
6502 @item
6503 A number of bytes.
6504 @item
6505 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6506 @end itemize
6508 The qualifier @code{static} means that the function manipulates the stack
6509 statically: a fixed number of bytes are allocated for the frame on function
6510 entry and released on function exit; no stack adjustments are otherwise made
6511 in the function.  The second field is this fixed number of bytes.
6513 The qualifier @code{dynamic} means that the function manipulates the stack
6514 dynamically: in addition to the static allocation described above, stack
6515 adjustments are made in the body of the function, for example to push/pop
6516 arguments around function calls.  If the qualifier @code{bounded} is also
6517 present, the amount of these adjustments is bounded at compile time and
6518 the second field is an upper bound of the total amount of stack used by
6519 the function.  If it is not present, the amount of these adjustments is
6520 not bounded at compile time and the second field only represents the
6521 bounded part.
6523 @item -fprofile-arcs
6524 @opindex fprofile-arcs
6525 Add code so that program flow @dfn{arcs} are instrumented.  During
6526 execution the program records how many times each branch and call is
6527 executed and how many times it is taken or returns.  When the compiled
6528 program exits it saves this data to a file called
6529 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6530 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6531 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6532 @var{auxname} is generated from the name of the output file, if
6533 explicitly specified and it is not the final executable, otherwise it is
6534 the basename of the source file.  In both cases any suffix is removed
6535 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6536 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6537 @xref{Cross-profiling}.
6539 @cindex @command{gcov}
6540 @item --coverage
6541 @opindex coverage
6543 This option is used to compile and link code instrumented for coverage
6544 analysis.  The option is a synonym for @option{-fprofile-arcs}
6545 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6546 linking).  See the documentation for those options for more details.
6548 @itemize
6550 @item
6551 Compile the source files with @option{-fprofile-arcs} plus optimization
6552 and code generation options.  For test coverage analysis, use the
6553 additional @option{-ftest-coverage} option.  You do not need to profile
6554 every source file in a program.
6556 @item
6557 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6558 (the latter implies the former).
6560 @item
6561 Run the program on a representative workload to generate the arc profile
6562 information.  This may be repeated any number of times.  You can run
6563 concurrent instances of your program, and provided that the file system
6564 supports locking, the data files will be correctly updated.  Also
6565 @code{fork} calls are detected and correctly handled (double counting
6566 will not happen).
6568 @item
6569 For profile-directed optimizations, compile the source files again with
6570 the same optimization and code generation options plus
6571 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6572 Control Optimization}).
6574 @item
6575 For test coverage analysis, use @command{gcov} to produce human readable
6576 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6577 @command{gcov} documentation for further information.
6579 @end itemize
6581 With @option{-fprofile-arcs}, for each function of your program GCC
6582 creates a program flow graph, then finds a spanning tree for the graph.
6583 Only arcs that are not on the spanning tree have to be instrumented: the
6584 compiler adds code to count the number of times that these arcs are
6585 executed.  When an arc is the only exit or only entrance to a block, the
6586 instrumentation code can be added to the block; otherwise, a new basic
6587 block must be created to hold the instrumentation code.
6589 @need 2000
6590 @item -ftest-coverage
6591 @opindex ftest-coverage
6592 Produce a notes file that the @command{gcov} code-coverage utility
6593 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6594 show program coverage.  Each source file's note file is called
6595 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6596 above for a description of @var{auxname} and instructions on how to
6597 generate test coverage data.  Coverage data matches the source files
6598 more closely if you do not optimize.
6600 @item -fdbg-cnt-list
6601 @opindex fdbg-cnt-list
6602 Print the name and the counter upper bound for all debug counters.
6605 @item -fdbg-cnt=@var{counter-value-list}
6606 @opindex fdbg-cnt
6607 Set the internal debug counter upper bound.  @var{counter-value-list}
6608 is a comma-separated list of @var{name}:@var{value} pairs
6609 which sets the upper bound of each debug counter @var{name} to @var{value}.
6610 All debug counters have the initial upper bound of @code{UINT_MAX};
6611 thus @code{dbg_cnt} returns true always unless the upper bound
6612 is set by this option.
6613 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6614 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6616 @item -fenable-@var{kind}-@var{pass}
6617 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6618 @opindex fdisable-
6619 @opindex fenable-
6621 This is a set of options that are used to explicitly disable/enable
6622 optimization passes.  These options are intended for use for debugging GCC.
6623 Compiler users should use regular options for enabling/disabling
6624 passes instead.
6626 @table @gcctabopt
6628 @item -fdisable-ipa-@var{pass}
6629 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6630 statically invoked in the compiler multiple times, the pass name should be
6631 appended with a sequential number starting from 1.
6633 @item -fdisable-rtl-@var{pass}
6634 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6635 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6636 statically invoked in the compiler multiple times, the pass name should be
6637 appended with a sequential number starting from 1.  @var{range-list} is a 
6638 comma-separated list of function ranges or assembler names.  Each range is a number
6639 pair separated by a colon.  The range is inclusive in both ends.  If the range
6640 is trivial, the number pair can be simplified as a single number.  If the
6641 function's call graph node's @var{uid} falls within one of the specified ranges,
6642 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6643 function header of a dump file, and the pass names can be dumped by using
6644 option @option{-fdump-passes}.
6646 @item -fdisable-tree-@var{pass}
6647 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6648 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6649 option arguments.
6651 @item -fenable-ipa-@var{pass}
6652 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6653 statically invoked in the compiler multiple times, the pass name should be
6654 appended with a sequential number starting from 1.
6656 @item -fenable-rtl-@var{pass}
6657 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6658 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6659 description and examples.
6661 @item -fenable-tree-@var{pass}
6662 @itemx -fenable-tree-@var{pass}=@var{range-list}
6663 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6664 of option arguments.
6666 @end table
6668 Here are some examples showing uses of these options.
6670 @smallexample
6672 # disable ccp1 for all functions
6673    -fdisable-tree-ccp1
6674 # disable complete unroll for function whose cgraph node uid is 1
6675    -fenable-tree-cunroll=1
6676 # disable gcse2 for functions at the following ranges [1,1],
6677 # [300,400], and [400,1000]
6678 # disable gcse2 for functions foo and foo2
6679    -fdisable-rtl-gcse2=foo,foo2
6680 # disable early inlining
6681    -fdisable-tree-einline
6682 # disable ipa inlining
6683    -fdisable-ipa-inline
6684 # enable tree full unroll
6685    -fenable-tree-unroll
6687 @end smallexample
6689 @item -d@var{letters}
6690 @itemx -fdump-rtl-@var{pass}
6691 @itemx -fdump-rtl-@var{pass}=@var{filename}
6692 @opindex d
6693 @opindex fdump-rtl-@var{pass}
6694 Says to make debugging dumps during compilation at times specified by
6695 @var{letters}.  This is used for debugging the RTL-based passes of the
6696 compiler.  The file names for most of the dumps are made by appending
6697 a pass number and a word to the @var{dumpname}, and the files are
6698 created in the directory of the output file.  In case of
6699 @option{=@var{filename}} option, the dump is output on the given file
6700 instead of the pass numbered dump files.  Note that the pass number is
6701 assigned as passes are registered into the pass manager.  Most passes
6702 are registered in the order that they will execute and for these passes
6703 the number corresponds to the pass execution order.  However, passes
6704 registered by plugins, passes specific to compilation targets, or
6705 passes that are otherwise registered after all the other passes are
6706 numbered higher than a pass named "final", even if they are executed
6707 earlier.  @var{dumpname} is generated from the name of the output
6708 file if explicitly specified and not an executable, otherwise it is
6709 the basename of the source file.  These switches may have different
6710 effects when @option{-E} is used for preprocessing.
6712 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6713 @option{-d} option @var{letters}.  Here are the possible
6714 letters for use in @var{pass} and @var{letters}, and their meanings:
6716 @table @gcctabopt
6718 @item -fdump-rtl-alignments
6719 @opindex fdump-rtl-alignments
6720 Dump after branch alignments have been computed.
6722 @item -fdump-rtl-asmcons
6723 @opindex fdump-rtl-asmcons
6724 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6726 @item -fdump-rtl-auto_inc_dec
6727 @opindex fdump-rtl-auto_inc_dec
6728 Dump after auto-inc-dec discovery.  This pass is only run on
6729 architectures that have auto inc or auto dec instructions.
6731 @item -fdump-rtl-barriers
6732 @opindex fdump-rtl-barriers
6733 Dump after cleaning up the barrier instructions.
6735 @item -fdump-rtl-bbpart
6736 @opindex fdump-rtl-bbpart
6737 Dump after partitioning hot and cold basic blocks.
6739 @item -fdump-rtl-bbro
6740 @opindex fdump-rtl-bbro
6741 Dump after block reordering.
6743 @item -fdump-rtl-btl1
6744 @itemx -fdump-rtl-btl2
6745 @opindex fdump-rtl-btl2
6746 @opindex fdump-rtl-btl2
6747 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6748 after the two branch
6749 target load optimization passes.
6751 @item -fdump-rtl-bypass
6752 @opindex fdump-rtl-bypass
6753 Dump after jump bypassing and control flow optimizations.
6755 @item -fdump-rtl-combine
6756 @opindex fdump-rtl-combine
6757 Dump after the RTL instruction combination pass.
6759 @item -fdump-rtl-compgotos
6760 @opindex fdump-rtl-compgotos
6761 Dump after duplicating the computed gotos.
6763 @item -fdump-rtl-ce1
6764 @itemx -fdump-rtl-ce2
6765 @itemx -fdump-rtl-ce3
6766 @opindex fdump-rtl-ce1
6767 @opindex fdump-rtl-ce2
6768 @opindex fdump-rtl-ce3
6769 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6770 @option{-fdump-rtl-ce3} enable dumping after the three
6771 if conversion passes.
6773 @item -fdump-rtl-cprop_hardreg
6774 @opindex fdump-rtl-cprop_hardreg
6775 Dump after hard register copy propagation.
6777 @item -fdump-rtl-csa
6778 @opindex fdump-rtl-csa
6779 Dump after combining stack adjustments.
6781 @item -fdump-rtl-cse1
6782 @itemx -fdump-rtl-cse2
6783 @opindex fdump-rtl-cse1
6784 @opindex fdump-rtl-cse2
6785 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6786 the two common subexpression elimination passes.
6788 @item -fdump-rtl-dce
6789 @opindex fdump-rtl-dce
6790 Dump after the standalone dead code elimination passes.
6792 @item -fdump-rtl-dbr
6793 @opindex fdump-rtl-dbr
6794 Dump after delayed branch scheduling.
6796 @item -fdump-rtl-dce1
6797 @itemx -fdump-rtl-dce2
6798 @opindex fdump-rtl-dce1
6799 @opindex fdump-rtl-dce2
6800 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6801 the two dead store elimination passes.
6803 @item -fdump-rtl-eh
6804 @opindex fdump-rtl-eh
6805 Dump after finalization of EH handling code.
6807 @item -fdump-rtl-eh_ranges
6808 @opindex fdump-rtl-eh_ranges
6809 Dump after conversion of EH handling range regions.
6811 @item -fdump-rtl-expand
6812 @opindex fdump-rtl-expand
6813 Dump after RTL generation.
6815 @item -fdump-rtl-fwprop1
6816 @itemx -fdump-rtl-fwprop2
6817 @opindex fdump-rtl-fwprop1
6818 @opindex fdump-rtl-fwprop2
6819 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6820 dumping after the two forward propagation passes.
6822 @item -fdump-rtl-gcse1
6823 @itemx -fdump-rtl-gcse2
6824 @opindex fdump-rtl-gcse1
6825 @opindex fdump-rtl-gcse2
6826 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6827 after global common subexpression elimination.
6829 @item -fdump-rtl-init-regs
6830 @opindex fdump-rtl-init-regs
6831 Dump after the initialization of the registers.
6833 @item -fdump-rtl-initvals
6834 @opindex fdump-rtl-initvals
6835 Dump after the computation of the initial value sets.
6837 @item -fdump-rtl-into_cfglayout
6838 @opindex fdump-rtl-into_cfglayout
6839 Dump after converting to cfglayout mode.
6841 @item -fdump-rtl-ira
6842 @opindex fdump-rtl-ira
6843 Dump after iterated register allocation.
6845 @item -fdump-rtl-jump
6846 @opindex fdump-rtl-jump
6847 Dump after the second jump optimization.
6849 @item -fdump-rtl-loop2
6850 @opindex fdump-rtl-loop2
6851 @option{-fdump-rtl-loop2} enables dumping after the rtl
6852 loop optimization passes.
6854 @item -fdump-rtl-mach
6855 @opindex fdump-rtl-mach
6856 Dump after performing the machine dependent reorganization pass, if that
6857 pass exists.
6859 @item -fdump-rtl-mode_sw
6860 @opindex fdump-rtl-mode_sw
6861 Dump after removing redundant mode switches.
6863 @item -fdump-rtl-rnreg
6864 @opindex fdump-rtl-rnreg
6865 Dump after register renumbering.
6867 @item -fdump-rtl-outof_cfglayout
6868 @opindex fdump-rtl-outof_cfglayout
6869 Dump after converting from cfglayout mode.
6871 @item -fdump-rtl-peephole2
6872 @opindex fdump-rtl-peephole2
6873 Dump after the peephole pass.
6875 @item -fdump-rtl-postreload
6876 @opindex fdump-rtl-postreload
6877 Dump after post-reload optimizations.
6879 @item -fdump-rtl-pro_and_epilogue
6880 @opindex fdump-rtl-pro_and_epilogue
6881 Dump after generating the function prologues and epilogues.
6883 @item -fdump-rtl-sched1
6884 @itemx -fdump-rtl-sched2
6885 @opindex fdump-rtl-sched1
6886 @opindex fdump-rtl-sched2
6887 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6888 after the basic block scheduling passes.
6890 @item -fdump-rtl-ree
6891 @opindex fdump-rtl-ree
6892 Dump after sign/zero extension elimination.
6894 @item -fdump-rtl-seqabstr
6895 @opindex fdump-rtl-seqabstr
6896 Dump after common sequence discovery.
6898 @item -fdump-rtl-shorten
6899 @opindex fdump-rtl-shorten
6900 Dump after shortening branches.
6902 @item -fdump-rtl-sibling
6903 @opindex fdump-rtl-sibling
6904 Dump after sibling call optimizations.
6906 @item -fdump-rtl-split1
6907 @itemx -fdump-rtl-split2
6908 @itemx -fdump-rtl-split3
6909 @itemx -fdump-rtl-split4
6910 @itemx -fdump-rtl-split5
6911 @opindex fdump-rtl-split1
6912 @opindex fdump-rtl-split2
6913 @opindex fdump-rtl-split3
6914 @opindex fdump-rtl-split4
6915 @opindex fdump-rtl-split5
6916 These options enable dumping after five rounds of
6917 instruction splitting.
6919 @item -fdump-rtl-sms
6920 @opindex fdump-rtl-sms
6921 Dump after modulo scheduling.  This pass is only run on some
6922 architectures.
6924 @item -fdump-rtl-stack
6925 @opindex fdump-rtl-stack
6926 Dump after conversion from GCC's ``flat register file'' registers to the
6927 x87's stack-like registers.  This pass is only run on x86 variants.
6929 @item -fdump-rtl-subreg1
6930 @itemx -fdump-rtl-subreg2
6931 @opindex fdump-rtl-subreg1
6932 @opindex fdump-rtl-subreg2
6933 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6934 the two subreg expansion passes.
6936 @item -fdump-rtl-unshare
6937 @opindex fdump-rtl-unshare
6938 Dump after all rtl has been unshared.
6940 @item -fdump-rtl-vartrack
6941 @opindex fdump-rtl-vartrack
6942 Dump after variable tracking.
6944 @item -fdump-rtl-vregs
6945 @opindex fdump-rtl-vregs
6946 Dump after converting virtual registers to hard registers.
6948 @item -fdump-rtl-web
6949 @opindex fdump-rtl-web
6950 Dump after live range splitting.
6952 @item -fdump-rtl-regclass
6953 @itemx -fdump-rtl-subregs_of_mode_init
6954 @itemx -fdump-rtl-subregs_of_mode_finish
6955 @itemx -fdump-rtl-dfinit
6956 @itemx -fdump-rtl-dfinish
6957 @opindex fdump-rtl-regclass
6958 @opindex fdump-rtl-subregs_of_mode_init
6959 @opindex fdump-rtl-subregs_of_mode_finish
6960 @opindex fdump-rtl-dfinit
6961 @opindex fdump-rtl-dfinish
6962 These dumps are defined but always produce empty files.
6964 @item -da
6965 @itemx -fdump-rtl-all
6966 @opindex da
6967 @opindex fdump-rtl-all
6968 Produce all the dumps listed above.
6970 @item -dA
6971 @opindex dA
6972 Annotate the assembler output with miscellaneous debugging information.
6974 @item -dD
6975 @opindex dD
6976 Dump all macro definitions, at the end of preprocessing, in addition to
6977 normal output.
6979 @item -dH
6980 @opindex dH
6981 Produce a core dump whenever an error occurs.
6983 @item -dp
6984 @opindex dp
6985 Annotate the assembler output with a comment indicating which
6986 pattern and alternative is used.  The length of each instruction is
6987 also printed.
6989 @item -dP
6990 @opindex dP
6991 Dump the RTL in the assembler output as a comment before each instruction.
6992 Also turns on @option{-dp} annotation.
6994 @item -dx
6995 @opindex dx
6996 Just generate RTL for a function instead of compiling it.  Usually used
6997 with @option{-fdump-rtl-expand}.
6998 @end table
7000 @item -fdump-noaddr
7001 @opindex fdump-noaddr
7002 When doing debugging dumps, suppress address output.  This makes it more
7003 feasible to use diff on debugging dumps for compiler invocations with
7004 different compiler binaries and/or different
7005 text / bss / data / heap / stack / dso start locations.
7007 @item -freport-bug
7008 @opindex freport-bug
7009 Collect and dump debug information into temporary file if ICE in C/C++
7010 compiler occured.
7012 @item -fdump-unnumbered
7013 @opindex fdump-unnumbered
7014 When doing debugging dumps, suppress instruction numbers and address output.
7015 This makes it more feasible to use diff on debugging dumps for compiler
7016 invocations with different options, in particular with and without
7017 @option{-g}.
7019 @item -fdump-unnumbered-links
7020 @opindex fdump-unnumbered-links
7021 When doing debugging dumps (see @option{-d} option above), suppress
7022 instruction numbers for the links to the previous and next instructions
7023 in a sequence.
7025 @item -fdump-translation-unit @r{(C++ only)}
7026 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
7027 @opindex fdump-translation-unit
7028 Dump a representation of the tree structure for the entire translation
7029 unit to a file.  The file name is made by appending @file{.tu} to the
7030 source file name, and the file is created in the same directory as the
7031 output file.  If the @samp{-@var{options}} form is used, @var{options}
7032 controls the details of the dump as described for the
7033 @option{-fdump-tree} options.
7035 @item -fdump-class-hierarchy @r{(C++ only)}
7036 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
7037 @opindex fdump-class-hierarchy
7038 Dump a representation of each class's hierarchy and virtual function
7039 table layout to a file.  The file name is made by appending
7040 @file{.class} to the source file name, and the file is created in the
7041 same directory as the output file.  If the @samp{-@var{options}} form
7042 is used, @var{options} controls the details of the dump as described
7043 for the @option{-fdump-tree} options.
7045 @item -fdump-ipa-@var{switch}
7046 @opindex fdump-ipa
7047 Control the dumping at various stages of inter-procedural analysis
7048 language tree to a file.  The file name is generated by appending a
7049 switch specific suffix to the source file name, and the file is created
7050 in the same directory as the output file.  The following dumps are
7051 possible:
7053 @table @samp
7054 @item all
7055 Enables all inter-procedural analysis dumps.
7057 @item cgraph
7058 Dumps information about call-graph optimization, unused function removal,
7059 and inlining decisions.
7061 @item inline
7062 Dump after function inlining.
7064 @end table
7066 @item -fdump-passes
7067 @opindex fdump-passes
7068 Dump the list of optimization passes that are turned on and off by
7069 the current command-line options.
7071 @item -fdump-statistics-@var{option}
7072 @opindex fdump-statistics
7073 Enable and control dumping of pass statistics in a separate file.  The
7074 file name is generated by appending a suffix ending in
7075 @samp{.statistics} to the source file name, and the file is created in
7076 the same directory as the output file.  If the @samp{-@var{option}}
7077 form is used, @samp{-stats} causes counters to be summed over the
7078 whole compilation unit while @samp{-details} dumps every event as
7079 the passes generate them.  The default with no option is to sum
7080 counters for each function compiled.
7082 @item -fdump-tree-@var{switch}
7083 @itemx -fdump-tree-@var{switch}-@var{options}
7084 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
7085 @opindex fdump-tree
7086 Control the dumping at various stages of processing the intermediate
7087 language tree to a file.  The file name is generated by appending a
7088 switch-specific suffix to the source file name, and the file is
7089 created in the same directory as the output file. In case of
7090 @option{=@var{filename}} option, the dump is output on the given file
7091 instead of the auto named dump files.  If the @samp{-@var{options}}
7092 form is used, @var{options} is a list of @samp{-} separated options
7093 which control the details of the dump.  Not all options are applicable
7094 to all dumps; those that are not meaningful are ignored.  The
7095 following options are available
7097 @table @samp
7098 @item address
7099 Print the address of each node.  Usually this is not meaningful as it
7100 changes according to the environment and source file.  Its primary use
7101 is for tying up a dump file with a debug environment.
7102 @item asmname
7103 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
7104 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
7105 use working backward from mangled names in the assembly file.
7106 @item slim
7107 When dumping front-end intermediate representations, inhibit dumping
7108 of members of a scope or body of a function merely because that scope
7109 has been reached.  Only dump such items when they are directly reachable
7110 by some other path.
7112 When dumping pretty-printed trees, this option inhibits dumping the
7113 bodies of control structures.
7115 When dumping RTL, print the RTL in slim (condensed) form instead of
7116 the default LISP-like representation.
7117 @item raw
7118 Print a raw representation of the tree.  By default, trees are
7119 pretty-printed into a C-like representation.
7120 @item details
7121 Enable more detailed dumps (not honored by every dump option). Also
7122 include information from the optimization passes.
7123 @item stats
7124 Enable dumping various statistics about the pass (not honored by every dump
7125 option).
7126 @item blocks
7127 Enable showing basic block boundaries (disabled in raw dumps).
7128 @item graph
7129 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
7130 dump a representation of the control flow graph suitable for viewing with
7131 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
7132 the file is pretty-printed as a subgraph, so that GraphViz can render them
7133 all in a single plot.
7135 This option currently only works for RTL dumps, and the RTL is always
7136 dumped in slim form.
7137 @item vops
7138 Enable showing virtual operands for every statement.
7139 @item lineno
7140 Enable showing line numbers for statements.
7141 @item uid
7142 Enable showing the unique ID (@code{DECL_UID}) for each variable.
7143 @item verbose
7144 Enable showing the tree dump for each statement.
7145 @item eh
7146 Enable showing the EH region number holding each statement.
7147 @item scev
7148 Enable showing scalar evolution analysis details.
7149 @item optimized
7150 Enable showing optimization information (only available in certain
7151 passes).
7152 @item missed
7153 Enable showing missed optimization information (only available in certain
7154 passes).
7155 @item note
7156 Enable other detailed optimization information (only available in
7157 certain passes).
7158 @item =@var{filename}
7159 Instead of an auto named dump file, output into the given file
7160 name. The file names @file{stdout} and @file{stderr} are treated
7161 specially and are considered already open standard streams. For
7162 example,
7164 @smallexample
7165 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
7166      -fdump-tree-pre=stderr file.c
7167 @end smallexample
7169 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
7170 output on to @file{stderr}. If two conflicting dump filenames are
7171 given for the same pass, then the latter option overrides the earlier
7172 one.
7174 @item all
7175 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
7176 and @option{lineno}.
7178 @item optall
7179 Turn on all optimization options, i.e., @option{optimized},
7180 @option{missed}, and @option{note}.
7181 @end table
7183 The following tree dumps are possible:
7184 @table @samp
7186 @item original
7187 @opindex fdump-tree-original
7188 Dump before any tree based optimization, to @file{@var{file}.original}.
7190 @item optimized
7191 @opindex fdump-tree-optimized
7192 Dump after all tree based optimization, to @file{@var{file}.optimized}.
7194 @item gimple
7195 @opindex fdump-tree-gimple
7196 Dump each function before and after the gimplification pass to a file.  The
7197 file name is made by appending @file{.gimple} to the source file name.
7199 @item cfg
7200 @opindex fdump-tree-cfg
7201 Dump the control flow graph of each function to a file.  The file name is
7202 made by appending @file{.cfg} to the source file name.
7204 @item ch
7205 @opindex fdump-tree-ch
7206 Dump each function after copying loop headers.  The file name is made by
7207 appending @file{.ch} to the source file name.
7209 @item ssa
7210 @opindex fdump-tree-ssa
7211 Dump SSA related information to a file.  The file name is made by appending
7212 @file{.ssa} to the source file name.
7214 @item alias
7215 @opindex fdump-tree-alias
7216 Dump aliasing information for each function.  The file name is made by
7217 appending @file{.alias} to the source file name.
7219 @item ccp
7220 @opindex fdump-tree-ccp
7221 Dump each function after CCP@.  The file name is made by appending
7222 @file{.ccp} to the source file name.
7224 @item storeccp
7225 @opindex fdump-tree-storeccp
7226 Dump each function after STORE-CCP@.  The file name is made by appending
7227 @file{.storeccp} to the source file name.
7229 @item pre
7230 @opindex fdump-tree-pre
7231 Dump trees after partial redundancy elimination.  The file name is made
7232 by appending @file{.pre} to the source file name.
7234 @item fre
7235 @opindex fdump-tree-fre
7236 Dump trees after full redundancy elimination.  The file name is made
7237 by appending @file{.fre} to the source file name.
7239 @item copyprop
7240 @opindex fdump-tree-copyprop
7241 Dump trees after copy propagation.  The file name is made
7242 by appending @file{.copyprop} to the source file name.
7244 @item store_copyprop
7245 @opindex fdump-tree-store_copyprop
7246 Dump trees after store copy-propagation.  The file name is made
7247 by appending @file{.store_copyprop} to the source file name.
7249 @item dce
7250 @opindex fdump-tree-dce
7251 Dump each function after dead code elimination.  The file name is made by
7252 appending @file{.dce} to the source file name.
7254 @item sra
7255 @opindex fdump-tree-sra
7256 Dump each function after performing scalar replacement of aggregates.  The
7257 file name is made by appending @file{.sra} to the source file name.
7259 @item sink
7260 @opindex fdump-tree-sink
7261 Dump each function after performing code sinking.  The file name is made
7262 by appending @file{.sink} to the source file name.
7264 @item dom
7265 @opindex fdump-tree-dom
7266 Dump each function after applying dominator tree optimizations.  The file
7267 name is made by appending @file{.dom} to the source file name.
7269 @item dse
7270 @opindex fdump-tree-dse
7271 Dump each function after applying dead store elimination.  The file
7272 name is made by appending @file{.dse} to the source file name.
7274 @item phiopt
7275 @opindex fdump-tree-phiopt
7276 Dump each function after optimizing PHI nodes into straightline code.  The file
7277 name is made by appending @file{.phiopt} to the source file name.
7279 @item backprop
7280 @opindex fdump-tree-backprop
7281 Dump each function after back-propagating use information up the definition
7282 chain.  The file name is made by appending @file{.backprop} to the
7283 source file name.
7285 @item forwprop
7286 @opindex fdump-tree-forwprop
7287 Dump each function after forward propagating single use variables.  The file
7288 name is made by appending @file{.forwprop} to the source file name.
7290 @item nrv
7291 @opindex fdump-tree-nrv
7292 Dump each function after applying the named return value optimization on
7293 generic trees.  The file name is made by appending @file{.nrv} to the source
7294 file name.
7296 @item vect
7297 @opindex fdump-tree-vect
7298 Dump each function after applying vectorization of loops.  The file name is
7299 made by appending @file{.vect} to the source file name.
7301 @item slp
7302 @opindex fdump-tree-slp
7303 Dump each function after applying vectorization of basic blocks.  The file name
7304 is made by appending @file{.slp} to the source file name.
7306 @item vrp
7307 @opindex fdump-tree-vrp
7308 Dump each function after Value Range Propagation (VRP).  The file name
7309 is made by appending @file{.vrp} to the source file name.
7311 @item oaccdevlow
7312 @opindex fdump-tree-oaccdevlow
7313 Dump each function after applying device-specific OpenACC transformations.
7314 The file name is made by appending @file{.oaccdevlow} to the source file name.
7316 @item all
7317 @opindex fdump-tree-all
7318 Enable all the available tree dumps with the flags provided in this option.
7319 @end table
7321 @item -fopt-info
7322 @itemx -fopt-info-@var{options}
7323 @itemx -fopt-info-@var{options}=@var{filename}
7324 @opindex fopt-info
7325 Controls optimization dumps from various optimization passes. If the
7326 @samp{-@var{options}} form is used, @var{options} is a list of
7327 @samp{-} separated option keywords to select the dump details and
7328 optimizations.  
7330 The @var{options} can be divided into two groups: options describing the
7331 verbosity of the dump, and options describing which optimizations
7332 should be included. The options from both the groups can be freely
7333 mixed as they are non-overlapping. However, in case of any conflicts,
7334 the later options override the earlier options on the command
7335 line. 
7337 The following options control the dump verbosity:
7339 @table @samp
7340 @item optimized
7341 Print information when an optimization is successfully applied. It is
7342 up to a pass to decide which information is relevant. For example, the
7343 vectorizer passes print the source location of loops which are
7344 successfully vectorized.
7345 @item missed
7346 Print information about missed optimizations. Individual passes
7347 control which information to include in the output. 
7348 @item note
7349 Print verbose information about optimizations, such as certain
7350 transformations, more detailed messages about decisions etc.
7351 @item all
7352 Print detailed optimization information. This includes
7353 @samp{optimized}, @samp{missed}, and @samp{note}.
7354 @end table
7356 One or more of the following option keywords can be used to describe a
7357 group of optimizations:
7359 @table @samp
7360 @item ipa
7361 Enable dumps from all interprocedural optimizations.
7362 @item loop
7363 Enable dumps from all loop optimizations.
7364 @item inline
7365 Enable dumps from all inlining optimizations.
7366 @item vec
7367 Enable dumps from all vectorization optimizations.
7368 @item optall
7369 Enable dumps from all optimizations. This is a superset of
7370 the optimization groups listed above.
7371 @end table
7373 If @var{options} is
7374 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7375 info about successful optimizations from all the passes.  
7377 If the @var{filename} is provided, then the dumps from all the
7378 applicable optimizations are concatenated into the @var{filename}.
7379 Otherwise the dump is output onto @file{stderr}. Though multiple
7380 @option{-fopt-info} options are accepted, only one of them can include
7381 a @var{filename}. If other filenames are provided then all but the
7382 first such option are ignored.
7384 Note that the output @var{filename} is overwritten
7385 in case of multiple translation units. If a combined output from
7386 multiple translation units is desired, @file{stderr} should be used
7387 instead.
7389 In the following example, the optimization info is output to
7390 @file{stderr}:
7392 @smallexample
7393 gcc -O3 -fopt-info
7394 @end smallexample
7396 This example:
7397 @smallexample
7398 gcc -O3 -fopt-info-missed=missed.all
7399 @end smallexample
7401 @noindent
7402 outputs missed optimization report from all the passes into
7403 @file{missed.all}, and this one:
7405 @smallexample
7406 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7407 @end smallexample
7409 @noindent
7410 prints information about missed optimization opportunities from
7411 vectorization passes on @file{stderr}.  
7412 Note that @option{-fopt-info-vec-missed} is equivalent to 
7413 @option{-fopt-info-missed-vec}.
7415 As another example,
7416 @smallexample
7417 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7418 @end smallexample
7420 @noindent
7421 outputs information about missed optimizations as well as
7422 optimized locations from all the inlining passes into
7423 @file{inline.txt}.
7425 Finally, consider:
7427 @smallexample
7428 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7429 @end smallexample
7431 @noindent
7432 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7433 in conflict since only one output file is allowed. In this case, only
7434 the first option takes effect and the subsequent options are
7435 ignored. Thus only @file{vec.miss} is produced which contains
7436 dumps from the vectorizer about missed opportunities.
7438 @item -frandom-seed=@var{number}
7439 @opindex frandom-seed
7440 This option provides a seed that GCC uses in place of
7441 random numbers in generating certain symbol names
7442 that have to be different in every compiled file.  It is also used to
7443 place unique stamps in coverage data files and the object files that
7444 produce them.  You can use the @option{-frandom-seed} option to produce
7445 reproducibly identical object files.
7447 The @var{number} should be different for every file you compile.
7449 @item -fsched-verbose=@var{n}
7450 @opindex fsched-verbose
7451 On targets that use instruction scheduling, this option controls the
7452 amount of debugging output the scheduler prints to the dump files.
7454 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7455 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7456 For @var{n} greater than one, it also output basic block probabilities,
7457 detailed ready list information and unit/insn info.  For @var{n} greater
7458 than two, it includes RTL at abort point, control-flow and regions info.
7459 And for @var{n} over four, @option{-fsched-verbose} also includes
7460 dependence info.
7462 @item -save-temps
7463 @itemx -save-temps=cwd
7464 @opindex save-temps
7465 Store the usual ``temporary'' intermediate files permanently; place them
7466 in the current directory and name them based on the source file.  Thus,
7467 compiling @file{foo.c} with @option{-c -save-temps} produces files
7468 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7469 preprocessed @file{foo.i} output file even though the compiler now
7470 normally uses an integrated preprocessor.
7472 When used in combination with the @option{-x} command-line option,
7473 @option{-save-temps} is sensible enough to avoid over writing an
7474 input source file with the same extension as an intermediate file.
7475 The corresponding intermediate file may be obtained by renaming the
7476 source file before using @option{-save-temps}.
7478 If you invoke GCC in parallel, compiling several different source
7479 files that share a common base name in different subdirectories or the
7480 same source file compiled for multiple output destinations, it is
7481 likely that the different parallel compilers will interfere with each
7482 other, and overwrite the temporary files.  For instance:
7484 @smallexample
7485 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7486 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7487 @end smallexample
7489 may result in @file{foo.i} and @file{foo.o} being written to
7490 simultaneously by both compilers.
7492 @item -save-temps=obj
7493 @opindex save-temps=obj
7494 Store the usual ``temporary'' intermediate files permanently.  If the
7495 @option{-o} option is used, the temporary files are based on the
7496 object file.  If the @option{-o} option is not used, the
7497 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7499 For example:
7501 @smallexample
7502 gcc -save-temps=obj -c foo.c
7503 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7504 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7505 @end smallexample
7507 @noindent
7508 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7509 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7510 @file{dir2/yfoobar.o}.
7512 @item -time@r{[}=@var{file}@r{]}
7513 @opindex time
7514 Report the CPU time taken by each subprocess in the compilation
7515 sequence.  For C source files, this is the compiler proper and assembler
7516 (plus the linker if linking is done).
7518 Without the specification of an output file, the output looks like this:
7520 @smallexample
7521 # cc1 0.12 0.01
7522 # as 0.00 0.01
7523 @end smallexample
7525 The first number on each line is the ``user time'', that is time spent
7526 executing the program itself.  The second number is ``system time'',
7527 time spent executing operating system routines on behalf of the program.
7528 Both numbers are in seconds.
7530 With the specification of an output file, the output is appended to the
7531 named file, and it looks like this:
7533 @smallexample
7534 0.12 0.01 cc1 @var{options}
7535 0.00 0.01 as @var{options}
7536 @end smallexample
7538 The ``user time'' and the ``system time'' are moved before the program
7539 name, and the options passed to the program are displayed, so that one
7540 can later tell what file was being compiled, and with which options.
7542 @item -fvar-tracking
7543 @opindex fvar-tracking
7544 Run variable tracking pass.  It computes where variables are stored at each
7545 position in code.  Better debugging information is then generated
7546 (if the debugging information format supports this information).
7548 It is enabled by default when compiling with optimization (@option{-Os},
7549 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7550 the debug info format supports it.
7552 @item -fvar-tracking-assignments
7553 @opindex fvar-tracking-assignments
7554 @opindex fno-var-tracking-assignments
7555 Annotate assignments to user variables early in the compilation and
7556 attempt to carry the annotations over throughout the compilation all the
7557 way to the end, in an attempt to improve debug information while
7558 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7560 It can be enabled even if var-tracking is disabled, in which case
7561 annotations are created and maintained, but discarded at the end.
7562 By default, this flag is enabled together with @option{-fvar-tracking},
7563 except when selective scheduling is enabled.
7565 @item -fvar-tracking-assignments-toggle
7566 @opindex fvar-tracking-assignments-toggle
7567 @opindex fno-var-tracking-assignments-toggle
7568 Toggle @option{-fvar-tracking-assignments}, in the same way that
7569 @option{-gtoggle} toggles @option{-g}.
7571 @item -print-file-name=@var{library}
7572 @opindex print-file-name
7573 Print the full absolute name of the library file @var{library} that
7574 would be used when linking---and don't do anything else.  With this
7575 option, GCC does not compile or link anything; it just prints the
7576 file name.
7578 @item -print-multi-directory
7579 @opindex print-multi-directory
7580 Print the directory name corresponding to the multilib selected by any
7581 other switches present in the command line.  This directory is supposed
7582 to exist in @env{GCC_EXEC_PREFIX}.
7584 @item -print-multi-lib
7585 @opindex print-multi-lib
7586 Print the mapping from multilib directory names to compiler switches
7587 that enable them.  The directory name is separated from the switches by
7588 @samp{;}, and each switch starts with an @samp{@@} instead of the
7589 @samp{-}, without spaces between multiple switches.  This is supposed to
7590 ease shell processing.
7592 @item -print-multi-os-directory
7593 @opindex print-multi-os-directory
7594 Print the path to OS libraries for the selected
7595 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7596 present in the @file{lib} subdirectory and no multilibs are used, this is
7597 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7598 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7599 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7600 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7602 @item -print-multiarch
7603 @opindex print-multiarch
7604 Print the path to OS libraries for the selected multiarch,
7605 relative to some @file{lib} subdirectory.
7607 @item -print-prog-name=@var{program}
7608 @opindex print-prog-name
7609 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7611 @item -print-libgcc-file-name
7612 @opindex print-libgcc-file-name
7613 Same as @option{-print-file-name=libgcc.a}.
7615 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7616 but you do want to link with @file{libgcc.a}.  You can do:
7618 @smallexample
7619 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7620 @end smallexample
7622 @item -print-search-dirs
7623 @opindex print-search-dirs
7624 Print the name of the configured installation directory and a list of
7625 program and library directories @command{gcc} searches---and don't do anything else.
7627 This is useful when @command{gcc} prints the error message
7628 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7629 To resolve this you either need to put @file{cpp0} and the other compiler
7630 components where @command{gcc} expects to find them, or you can set the environment
7631 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7632 Don't forget the trailing @samp{/}.
7633 @xref{Environment Variables}.
7635 @item -print-sysroot
7636 @opindex print-sysroot
7637 Print the target sysroot directory that is used during
7638 compilation.  This is the target sysroot specified either at configure
7639 time or using the @option{--sysroot} option, possibly with an extra
7640 suffix that depends on compilation options.  If no target sysroot is
7641 specified, the option prints nothing.
7643 @item -print-sysroot-headers-suffix
7644 @opindex print-sysroot-headers-suffix
7645 Print the suffix added to the target sysroot when searching for
7646 headers, or give an error if the compiler is not configured with such
7647 a suffix---and don't do anything else.
7649 @item -dumpmachine
7650 @opindex dumpmachine
7651 Print the compiler's target machine (for example,
7652 @samp{i686-pc-linux-gnu})---and don't do anything else.
7654 @item -dumpversion
7655 @opindex dumpversion
7656 Print the compiler version (for example, @code{3.0})---and don't do
7657 anything else.
7659 @item -dumpspecs
7660 @opindex dumpspecs
7661 Print the compiler's built-in specs---and don't do anything else.  (This
7662 is used when GCC itself is being built.)  @xref{Spec Files}.
7664 @item -fno-eliminate-unused-debug-types
7665 @opindex feliminate-unused-debug-types
7666 @opindex fno-eliminate-unused-debug-types
7667 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7668 output for types that are nowhere used in the source file being compiled.
7669 Sometimes it is useful to have GCC emit debugging
7670 information for all types declared in a compilation
7671 unit, regardless of whether or not they are actually used
7672 in that compilation unit, for example 
7673 if, in the debugger, you want to cast a value to a type that is
7674 not actually used in your program (but is declared).  More often,
7675 however, this results in a significant amount of wasted space.
7676 @end table
7678 @node Optimize Options
7679 @section Options That Control Optimization
7680 @cindex optimize options
7681 @cindex options, optimization
7683 These options control various sorts of optimizations.
7685 Without any optimization option, the compiler's goal is to reduce the
7686 cost of compilation and to make debugging produce the expected
7687 results.  Statements are independent: if you stop the program with a
7688 breakpoint between statements, you can then assign a new value to any
7689 variable or change the program counter to any other statement in the
7690 function and get exactly the results you expect from the source
7691 code.
7693 Turning on optimization flags makes the compiler attempt to improve
7694 the performance and/or code size at the expense of compilation time
7695 and possibly the ability to debug the program.
7697 The compiler performs optimization based on the knowledge it has of the
7698 program.  Compiling multiple files at once to a single output file mode allows
7699 the compiler to use information gained from all of the files when compiling
7700 each of them.
7702 Not all optimizations are controlled directly by a flag.  Only
7703 optimizations that have a flag are listed in this section.
7705 Most optimizations are only enabled if an @option{-O} level is set on
7706 the command line.  Otherwise they are disabled, even if individual
7707 optimization flags are specified.
7709 Depending on the target and how GCC was configured, a slightly different
7710 set of optimizations may be enabled at each @option{-O} level than
7711 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7712 to find out the exact set of optimizations that are enabled at each level.
7713 @xref{Overall Options}, for examples.
7715 @table @gcctabopt
7716 @item -O
7717 @itemx -O1
7718 @opindex O
7719 @opindex O1
7720 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7721 more memory for a large function.
7723 With @option{-O}, the compiler tries to reduce code size and execution
7724 time, without performing any optimizations that take a great deal of
7725 compilation time.
7727 @option{-O} turns on the following optimization flags:
7728 @gccoptlist{
7729 -fauto-inc-dec @gol
7730 -fbranch-count-reg @gol
7731 -fcombine-stack-adjustments @gol
7732 -fcompare-elim @gol
7733 -fcprop-registers @gol
7734 -fdce @gol
7735 -fdefer-pop @gol
7736 -fdelayed-branch @gol
7737 -fdse @gol
7738 -fforward-propagate @gol
7739 -fguess-branch-probability @gol
7740 -fif-conversion2 @gol
7741 -fif-conversion @gol
7742 -finline-functions-called-once @gol
7743 -fipa-pure-const @gol
7744 -fipa-profile @gol
7745 -fipa-reference @gol
7746 -fmerge-constants @gol
7747 -fmove-loop-invariants @gol
7748 -freorder-blocks @gol
7749 -fshrink-wrap @gol
7750 -fsplit-wide-types @gol
7751 -fssa-backprop @gol
7752 -fssa-phiopt @gol
7753 -ftree-bit-ccp @gol
7754 -ftree-ccp @gol
7755 -ftree-ch @gol
7756 -ftree-coalesce-vars @gol
7757 -ftree-copy-prop @gol
7758 -ftree-dce @gol
7759 -ftree-dominator-opts @gol
7760 -ftree-dse @gol
7761 -ftree-forwprop @gol
7762 -ftree-fre @gol
7763 -ftree-phiprop @gol
7764 -ftree-sink @gol
7765 -ftree-slsr @gol
7766 -ftree-sra @gol
7767 -ftree-pta @gol
7768 -ftree-ter @gol
7769 -funit-at-a-time}
7771 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7772 where doing so does not interfere with debugging.
7774 @item -O2
7775 @opindex O2
7776 Optimize even more.  GCC performs nearly all supported optimizations
7777 that do not involve a space-speed tradeoff.
7778 As compared to @option{-O}, this option increases both compilation time
7779 and the performance of the generated code.
7781 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7782 also turns on the following optimization flags:
7783 @gccoptlist{-fthread-jumps @gol
7784 -falign-functions  -falign-jumps @gol
7785 -falign-loops  -falign-labels @gol
7786 -fcaller-saves @gol
7787 -fcrossjumping @gol
7788 -fcse-follow-jumps  -fcse-skip-blocks @gol
7789 -fdelete-null-pointer-checks @gol
7790 -fdevirtualize -fdevirtualize-speculatively @gol
7791 -fexpensive-optimizations @gol
7792 -fgcse  -fgcse-lm  @gol
7793 -fhoist-adjacent-loads @gol
7794 -finline-small-functions @gol
7795 -findirect-inlining @gol
7796 -fipa-cp @gol
7797 -fipa-cp-alignment @gol
7798 -fipa-sra @gol
7799 -fipa-icf @gol
7800 -fisolate-erroneous-paths-dereference @gol
7801 -flra-remat @gol
7802 -foptimize-sibling-calls @gol
7803 -foptimize-strlen @gol
7804 -fpartial-inlining @gol
7805 -fpeephole2 @gol
7806 -freorder-blocks-algorithm=stc @gol
7807 -freorder-blocks-and-partition -freorder-functions @gol
7808 -frerun-cse-after-loop  @gol
7809 -fsched-interblock  -fsched-spec @gol
7810 -fschedule-insns  -fschedule-insns2 @gol
7811 -fstrict-aliasing -fstrict-overflow @gol
7812 -ftree-builtin-call-dce @gol
7813 -ftree-switch-conversion -ftree-tail-merge @gol
7814 -ftree-pre @gol
7815 -ftree-vrp @gol
7816 -fipa-ra}
7818 Please note the warning under @option{-fgcse} about
7819 invoking @option{-O2} on programs that use computed gotos.
7821 @item -O3
7822 @opindex O3
7823 Optimize yet more.  @option{-O3} turns on all optimizations specified
7824 by @option{-O2} and also turns on the @option{-finline-functions},
7825 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7826 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7827 @option{-ftree-loop-distribute-patterns},
7828 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7829 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7831 @item -O0
7832 @opindex O0
7833 Reduce compilation time and make debugging produce the expected
7834 results.  This is the default.
7836 @item -Os
7837 @opindex Os
7838 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7839 do not typically increase code size.  It also performs further
7840 optimizations designed to reduce code size.
7842 @option{-Os} disables the following optimization flags:
7843 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7844 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7845 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7847 @item -Ofast
7848 @opindex Ofast
7849 Disregard strict standards compliance.  @option{-Ofast} enables all
7850 @option{-O3} optimizations.  It also enables optimizations that are not
7851 valid for all standard-compliant programs.
7852 It turns on @option{-ffast-math} and the Fortran-specific
7853 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7855 @item -Og
7856 @opindex Og
7857 Optimize debugging experience.  @option{-Og} enables optimizations
7858 that do not interfere with debugging. It should be the optimization
7859 level of choice for the standard edit-compile-debug cycle, offering
7860 a reasonable level of optimization while maintaining fast compilation
7861 and a good debugging experience.
7863 If you use multiple @option{-O} options, with or without level numbers,
7864 the last such option is the one that is effective.
7865 @end table
7867 Options of the form @option{-f@var{flag}} specify machine-independent
7868 flags.  Most flags have both positive and negative forms; the negative
7869 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7870 below, only one of the forms is listed---the one you typically 
7871 use.  You can figure out the other form by either removing @samp{no-}
7872 or adding it.
7874 The following options control specific optimizations.  They are either
7875 activated by @option{-O} options or are related to ones that are.  You
7876 can use the following flags in the rare cases when ``fine-tuning'' of
7877 optimizations to be performed is desired.
7879 @table @gcctabopt
7880 @item -fno-defer-pop
7881 @opindex fno-defer-pop
7882 Always pop the arguments to each function call as soon as that function
7883 returns.  For machines that must pop arguments after a function call,
7884 the compiler normally lets arguments accumulate on the stack for several
7885 function calls and pops them all at once.
7887 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7889 @item -fforward-propagate
7890 @opindex fforward-propagate
7891 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7892 instructions and checks if the result can be simplified.  If loop unrolling
7893 is active, two passes are performed and the second is scheduled after
7894 loop unrolling.
7896 This option is enabled by default at optimization levels @option{-O},
7897 @option{-O2}, @option{-O3}, @option{-Os}.
7899 @item -ffp-contract=@var{style}
7900 @opindex ffp-contract
7901 @option{-ffp-contract=off} disables floating-point expression contraction.
7902 @option{-ffp-contract=fast} enables floating-point expression contraction
7903 such as forming of fused multiply-add operations if the target has
7904 native support for them.
7905 @option{-ffp-contract=on} enables floating-point expression contraction
7906 if allowed by the language standard.  This is currently not implemented
7907 and treated equal to @option{-ffp-contract=off}.
7909 The default is @option{-ffp-contract=fast}.
7911 @item -fomit-frame-pointer
7912 @opindex fomit-frame-pointer
7913 Don't keep the frame pointer in a register for functions that
7914 don't need one.  This avoids the instructions to save, set up and
7915 restore frame pointers; it also makes an extra register available
7916 in many functions.  @strong{It also makes debugging impossible on
7917 some machines.}
7919 On some machines, such as the VAX, this flag has no effect, because
7920 the standard calling sequence automatically handles the frame pointer
7921 and nothing is saved by pretending it doesn't exist.  The
7922 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7923 whether a target machine supports this flag.  @xref{Registers,,Register
7924 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7926 The default setting (when not optimizing for
7927 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7928 @option{-fomit-frame-pointer}.  You can configure GCC with the
7929 @option{--enable-frame-pointer} configure option to change the default.
7931 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7933 @item -foptimize-sibling-calls
7934 @opindex foptimize-sibling-calls
7935 Optimize sibling and tail recursive calls.
7937 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7939 @item -foptimize-strlen
7940 @opindex foptimize-strlen
7941 Optimize various standard C string functions (e.g. @code{strlen},
7942 @code{strchr} or @code{strcpy}) and
7943 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7945 Enabled at levels @option{-O2}, @option{-O3}.
7947 @item -fno-inline
7948 @opindex fno-inline
7949 Do not expand any functions inline apart from those marked with
7950 the @code{always_inline} attribute.  This is the default when not
7951 optimizing.
7953 Single functions can be exempted from inlining by marking them
7954 with the @code{noinline} attribute.
7956 @item -finline-small-functions
7957 @opindex finline-small-functions
7958 Integrate functions into their callers when their body is smaller than expected
7959 function call code (so overall size of program gets smaller).  The compiler
7960 heuristically decides which functions are simple enough to be worth integrating
7961 in this way.  This inlining applies to all functions, even those not declared
7962 inline.
7964 Enabled at level @option{-O2}.
7966 @item -findirect-inlining
7967 @opindex findirect-inlining
7968 Inline also indirect calls that are discovered to be known at compile
7969 time thanks to previous inlining.  This option has any effect only
7970 when inlining itself is turned on by the @option{-finline-functions}
7971 or @option{-finline-small-functions} options.
7973 Enabled at level @option{-O2}.
7975 @item -finline-functions
7976 @opindex finline-functions
7977 Consider all functions for inlining, even if they are not declared inline.
7978 The compiler heuristically decides which functions are worth integrating
7979 in this way.
7981 If all calls to a given function are integrated, and the function is
7982 declared @code{static}, then the function is normally not output as
7983 assembler code in its own right.
7985 Enabled at level @option{-O3}.
7987 @item -finline-functions-called-once
7988 @opindex finline-functions-called-once
7989 Consider all @code{static} functions called once for inlining into their
7990 caller even if they are not marked @code{inline}.  If a call to a given
7991 function is integrated, then the function is not output as assembler code
7992 in its own right.
7994 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7996 @item -fearly-inlining
7997 @opindex fearly-inlining
7998 Inline functions marked by @code{always_inline} and functions whose body seems
7999 smaller than the function call overhead early before doing
8000 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
8001 makes profiling significantly cheaper and usually inlining faster on programs
8002 having large chains of nested wrapper functions.
8004 Enabled by default.
8006 @item -fipa-sra
8007 @opindex fipa-sra
8008 Perform interprocedural scalar replacement of aggregates, removal of
8009 unused parameters and replacement of parameters passed by reference
8010 by parameters passed by value.
8012 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
8014 @item -finline-limit=@var{n}
8015 @opindex finline-limit
8016 By default, GCC limits the size of functions that can be inlined.  This flag
8017 allows coarse control of this limit.  @var{n} is the size of functions that
8018 can be inlined in number of pseudo instructions.
8020 Inlining is actually controlled by a number of parameters, which may be
8021 specified individually by using @option{--param @var{name}=@var{value}}.
8022 The @option{-finline-limit=@var{n}} option sets some of these parameters
8023 as follows:
8025 @table @gcctabopt
8026 @item max-inline-insns-single
8027 is set to @var{n}/2.
8028 @item max-inline-insns-auto
8029 is set to @var{n}/2.
8030 @end table
8032 See below for a documentation of the individual
8033 parameters controlling inlining and for the defaults of these parameters.
8035 @emph{Note:} there may be no value to @option{-finline-limit} that results
8036 in default behavior.
8038 @emph{Note:} pseudo instruction represents, in this particular context, an
8039 abstract measurement of function's size.  In no way does it represent a count
8040 of assembly instructions and as such its exact meaning might change from one
8041 release to an another.
8043 @item -fno-keep-inline-dllexport
8044 @opindex fno-keep-inline-dllexport
8045 This is a more fine-grained version of @option{-fkeep-inline-functions},
8046 which applies only to functions that are declared using the @code{dllexport}
8047 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
8048 Functions}.)
8050 @item -fkeep-inline-functions
8051 @opindex fkeep-inline-functions
8052 In C, emit @code{static} functions that are declared @code{inline}
8053 into the object file, even if the function has been inlined into all
8054 of its callers.  This switch does not affect functions using the
8055 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
8056 inline functions into the object file.
8058 @item -fkeep-static-functions
8059 @opindex fkeep-static-functions
8060 Emit @code{static} functions into the object file, even if the function
8061 is never used.
8063 @item -fkeep-static-consts
8064 @opindex fkeep-static-consts
8065 Emit variables declared @code{static const} when optimization isn't turned
8066 on, even if the variables aren't referenced.
8068 GCC enables this option by default.  If you want to force the compiler to
8069 check if a variable is referenced, regardless of whether or not
8070 optimization is turned on, use the @option{-fno-keep-static-consts} option.
8072 @item -fmerge-constants
8073 @opindex fmerge-constants
8074 Attempt to merge identical constants (string constants and floating-point
8075 constants) across compilation units.
8077 This option is the default for optimized compilation if the assembler and
8078 linker support it.  Use @option{-fno-merge-constants} to inhibit this
8079 behavior.
8081 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8083 @item -fmerge-all-constants
8084 @opindex fmerge-all-constants
8085 Attempt to merge identical constants and identical variables.
8087 This option implies @option{-fmerge-constants}.  In addition to
8088 @option{-fmerge-constants} this considers e.g.@: even constant initialized
8089 arrays or initialized constant variables with integral or floating-point
8090 types.  Languages like C or C++ require each variable, including multiple
8091 instances of the same variable in recursive calls, to have distinct locations,
8092 so using this option results in non-conforming
8093 behavior.
8095 @item -fmodulo-sched
8096 @opindex fmodulo-sched
8097 Perform swing modulo scheduling immediately before the first scheduling
8098 pass.  This pass looks at innermost loops and reorders their
8099 instructions by overlapping different iterations.
8101 @item -fmodulo-sched-allow-regmoves
8102 @opindex fmodulo-sched-allow-regmoves
8103 Perform more aggressive SMS-based modulo scheduling with register moves
8104 allowed.  By setting this flag certain anti-dependences edges are
8105 deleted, which triggers the generation of reg-moves based on the
8106 life-range analysis.  This option is effective only with
8107 @option{-fmodulo-sched} enabled.
8109 @item -fno-branch-count-reg
8110 @opindex fno-branch-count-reg
8111 Do not use ``decrement and branch'' instructions on a count register,
8112 but instead generate a sequence of instructions that decrement a
8113 register, compare it against zero, then branch based upon the result.
8114 This option is only meaningful on architectures that support such
8115 instructions, which include x86, PowerPC, IA-64 and S/390.
8117 Enabled by default at @option{-O1} and higher.
8119 The default is @option{-fbranch-count-reg}.
8121 @item -fno-function-cse
8122 @opindex fno-function-cse
8123 Do not put function addresses in registers; make each instruction that
8124 calls a constant function contain the function's address explicitly.
8126 This option results in less efficient code, but some strange hacks
8127 that alter the assembler output may be confused by the optimizations
8128 performed when this option is not used.
8130 The default is @option{-ffunction-cse}
8132 @item -fno-zero-initialized-in-bss
8133 @opindex fno-zero-initialized-in-bss
8134 If the target supports a BSS section, GCC by default puts variables that
8135 are initialized to zero into BSS@.  This can save space in the resulting
8136 code.
8138 This option turns off this behavior because some programs explicitly
8139 rely on variables going to the data section---e.g., so that the
8140 resulting executable can find the beginning of that section and/or make
8141 assumptions based on that.
8143 The default is @option{-fzero-initialized-in-bss}.
8145 @item -fthread-jumps
8146 @opindex fthread-jumps
8147 Perform optimizations that check to see if a jump branches to a
8148 location where another comparison subsumed by the first is found.  If
8149 so, the first branch is redirected to either the destination of the
8150 second branch or a point immediately following it, depending on whether
8151 the condition is known to be true or false.
8153 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8155 @item -fsplit-wide-types
8156 @opindex fsplit-wide-types
8157 When using a type that occupies multiple registers, such as @code{long
8158 long} on a 32-bit system, split the registers apart and allocate them
8159 independently.  This normally generates better code for those types,
8160 but may make debugging more difficult.
8162 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8163 @option{-Os}.
8165 @item -fcse-follow-jumps
8166 @opindex fcse-follow-jumps
8167 In common subexpression elimination (CSE), scan through jump instructions
8168 when the target of the jump is not reached by any other path.  For
8169 example, when CSE encounters an @code{if} statement with an
8170 @code{else} clause, CSE follows the jump when the condition
8171 tested is false.
8173 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8175 @item -fcse-skip-blocks
8176 @opindex fcse-skip-blocks
8177 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8178 follow jumps that conditionally skip over blocks.  When CSE
8179 encounters a simple @code{if} statement with no else clause,
8180 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8181 body of the @code{if}.
8183 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8185 @item -frerun-cse-after-loop
8186 @opindex frerun-cse-after-loop
8187 Re-run common subexpression elimination after loop optimizations are
8188 performed.
8190 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8192 @item -fgcse
8193 @opindex fgcse
8194 Perform a global common subexpression elimination pass.
8195 This pass also performs global constant and copy propagation.
8197 @emph{Note:} When compiling a program using computed gotos, a GCC
8198 extension, you may get better run-time performance if you disable
8199 the global common subexpression elimination pass by adding
8200 @option{-fno-gcse} to the command line.
8202 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8204 @item -fgcse-lm
8205 @opindex fgcse-lm
8206 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8207 attempts to move loads that are only killed by stores into themselves.  This
8208 allows a loop containing a load/store sequence to be changed to a load outside
8209 the loop, and a copy/store within the loop.
8211 Enabled by default when @option{-fgcse} is enabled.
8213 @item -fgcse-sm
8214 @opindex fgcse-sm
8215 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8216 global common subexpression elimination.  This pass attempts to move
8217 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8218 loops containing a load/store sequence can be changed to a load before
8219 the loop and a store after the loop.
8221 Not enabled at any optimization level.
8223 @item -fgcse-las
8224 @opindex fgcse-las
8225 When @option{-fgcse-las} is enabled, the global common subexpression
8226 elimination pass eliminates redundant loads that come after stores to the
8227 same memory location (both partial and full redundancies).
8229 Not enabled at any optimization level.
8231 @item -fgcse-after-reload
8232 @opindex fgcse-after-reload
8233 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8234 pass is performed after reload.  The purpose of this pass is to clean up
8235 redundant spilling.
8237 @item -faggressive-loop-optimizations
8238 @opindex faggressive-loop-optimizations
8239 This option tells the loop optimizer to use language constraints to
8240 derive bounds for the number of iterations of a loop.  This assumes that
8241 loop code does not invoke undefined behavior by for example causing signed
8242 integer overflows or out-of-bound array accesses.  The bounds for the
8243 number of iterations of a loop are used to guide loop unrolling and peeling
8244 and loop exit test optimizations.
8245 This option is enabled by default.
8247 @item -funsafe-loop-optimizations
8248 @opindex funsafe-loop-optimizations
8249 This option tells the loop optimizer to assume that loop indices do not
8250 overflow, and that loops with nontrivial exit condition are not
8251 infinite.  This enables a wider range of loop optimizations even if
8252 the loop optimizer itself cannot prove that these assumptions are valid.
8253 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8254 if it finds this kind of loop.
8256 @item -fcrossjumping
8257 @opindex fcrossjumping
8258 Perform cross-jumping transformation.
8259 This transformation unifies equivalent code and saves code size.  The
8260 resulting code may or may not perform better than without cross-jumping.
8262 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8264 @item -fauto-inc-dec
8265 @opindex fauto-inc-dec
8266 Combine increments or decrements of addresses with memory accesses.
8267 This pass is always skipped on architectures that do not have
8268 instructions to support this.  Enabled by default at @option{-O} and
8269 higher on architectures that support this.
8271 @item -fdce
8272 @opindex fdce
8273 Perform dead code elimination (DCE) on RTL@.
8274 Enabled by default at @option{-O} and higher.
8276 @item -fdse
8277 @opindex fdse
8278 Perform dead store elimination (DSE) on RTL@.
8279 Enabled by default at @option{-O} and higher.
8281 @item -fif-conversion
8282 @opindex fif-conversion
8283 Attempt to transform conditional jumps into branch-less equivalents.  This
8284 includes use of conditional moves, min, max, set flags and abs instructions, and
8285 some tricks doable by standard arithmetics.  The use of conditional execution
8286 on chips where it is available is controlled by @option{-fif-conversion2}.
8288 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8290 @item -fif-conversion2
8291 @opindex fif-conversion2
8292 Use conditional execution (where available) to transform conditional jumps into
8293 branch-less equivalents.
8295 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8297 @item -fdeclone-ctor-dtor
8298 @opindex fdeclone-ctor-dtor
8299 The C++ ABI requires multiple entry points for constructors and
8300 destructors: one for a base subobject, one for a complete object, and
8301 one for a virtual destructor that calls operator delete afterwards.
8302 For a hierarchy with virtual bases, the base and complete variants are
8303 clones, which means two copies of the function.  With this option, the
8304 base and complete variants are changed to be thunks that call a common
8305 implementation.
8307 Enabled by @option{-Os}.
8309 @item -fdelete-null-pointer-checks
8310 @opindex fdelete-null-pointer-checks
8311 Assume that programs cannot safely dereference null pointers, and that
8312 no code or data element resides at address zero.
8313 This option enables simple constant
8314 folding optimizations at all optimization levels.  In addition, other
8315 optimization passes in GCC use this flag to control global dataflow
8316 analyses that eliminate useless checks for null pointers; these assume
8317 that a memory access to address zero always results in a trap, so
8318 that if a pointer is checked after it has already been dereferenced,
8319 it cannot be null.
8321 Note however that in some environments this assumption is not true.
8322 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8323 for programs that depend on that behavior.
8325 This option is enabled by default on most targets.  On Nios II ELF, it
8326 defaults to off.  On AVR and CR16, this option is completely disabled.  
8328 Passes that use the dataflow information
8329 are enabled independently at different optimization levels.
8331 @item -fdevirtualize
8332 @opindex fdevirtualize
8333 Attempt to convert calls to virtual functions to direct calls.  This
8334 is done both within a procedure and interprocedurally as part of
8335 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8336 propagation (@option{-fipa-cp}).
8337 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8339 @item -fdevirtualize-speculatively
8340 @opindex fdevirtualize-speculatively
8341 Attempt to convert calls to virtual functions to speculative direct calls.
8342 Based on the analysis of the type inheritance graph, determine for a given call
8343 the set of likely targets. If the set is small, preferably of size 1, change
8344 the call into a conditional deciding between direct and indirect calls.  The
8345 speculative calls enable more optimizations, such as inlining.  When they seem
8346 useless after further optimization, they are converted back into original form.
8348 @item -fdevirtualize-at-ltrans
8349 @opindex fdevirtualize-at-ltrans
8350 Stream extra information needed for aggressive devirtualization when running
8351 the link-time optimizer in local transformation mode.  
8352 This option enables more devirtualization but
8353 significantly increases the size of streamed data. For this reason it is
8354 disabled by default.
8356 @item -fexpensive-optimizations
8357 @opindex fexpensive-optimizations
8358 Perform a number of minor optimizations that are relatively expensive.
8360 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8362 @item -free
8363 @opindex free
8364 Attempt to remove redundant extension instructions.  This is especially
8365 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8366 registers after writing to their lower 32-bit half.
8368 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8369 @option{-O3}, @option{-Os}.
8371 @item -fno-lifetime-dse
8372 @opindex fno-lifetime-dse
8373 In C++ the value of an object is only affected by changes within its
8374 lifetime: when the constructor begins, the object has an indeterminate
8375 value, and any changes during the lifetime of the object are dead when
8376 the object is destroyed.  Normally dead store elimination will take
8377 advantage of this; if your code relies on the value of the object
8378 storage persisting beyond the lifetime of the object, you can use this
8379 flag to disable this optimization.
8381 @item -flive-range-shrinkage
8382 @opindex flive-range-shrinkage
8383 Attempt to decrease register pressure through register live range
8384 shrinkage.  This is helpful for fast processors with small or moderate
8385 size register sets.
8387 @item -fira-algorithm=@var{algorithm}
8388 @opindex fira-algorithm
8389 Use the specified coloring algorithm for the integrated register
8390 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8391 specifies Chow's priority coloring, or @samp{CB}, which specifies
8392 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8393 for all architectures, but for those targets that do support it, it is
8394 the default because it generates better code.
8396 @item -fira-region=@var{region}
8397 @opindex fira-region
8398 Use specified regions for the integrated register allocator.  The
8399 @var{region} argument should be one of the following:
8401 @table @samp
8403 @item all
8404 Use all loops as register allocation regions.
8405 This can give the best results for machines with a small and/or
8406 irregular register set.
8408 @item mixed
8409 Use all loops except for loops with small register pressure 
8410 as the regions.  This value usually gives
8411 the best results in most cases and for most architectures,
8412 and is enabled by default when compiling with optimization for speed
8413 (@option{-O}, @option{-O2}, @dots{}).
8415 @item one
8416 Use all functions as a single region.  
8417 This typically results in the smallest code size, and is enabled by default for
8418 @option{-Os} or @option{-O0}.
8420 @end table
8422 @item -fira-hoist-pressure
8423 @opindex fira-hoist-pressure
8424 Use IRA to evaluate register pressure in the code hoisting pass for
8425 decisions to hoist expressions.  This option usually results in smaller
8426 code, but it can slow the compiler down.
8428 This option is enabled at level @option{-Os} for all targets.
8430 @item -fira-loop-pressure
8431 @opindex fira-loop-pressure
8432 Use IRA to evaluate register pressure in loops for decisions to move
8433 loop invariants.  This option usually results in generation
8434 of faster and smaller code on machines with large register files (>= 32
8435 registers), but it can slow the compiler down.
8437 This option is enabled at level @option{-O3} for some targets.
8439 @item -fno-ira-share-save-slots
8440 @opindex fno-ira-share-save-slots
8441 Disable sharing of stack slots used for saving call-used hard
8442 registers living through a call.  Each hard register gets a
8443 separate stack slot, and as a result function stack frames are
8444 larger.
8446 @item -fno-ira-share-spill-slots
8447 @opindex fno-ira-share-spill-slots
8448 Disable sharing of stack slots allocated for pseudo-registers.  Each
8449 pseudo-register that does not get a hard register gets a separate
8450 stack slot, and as a result function stack frames are larger.
8452 @item -fira-verbose=@var{n}
8453 @opindex fira-verbose
8454 Control the verbosity of the dump file for the integrated register allocator.
8455 The default value is 5.  If the value @var{n} is greater or equal to 10,
8456 the dump output is sent to stderr using the same format as @var{n} minus 10.
8458 @item -flra-remat
8459 @opindex flra-remat
8460 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8461 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8462 values if it is profitable.
8464 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8466 @item -fdelayed-branch
8467 @opindex fdelayed-branch
8468 If supported for the target machine, attempt to reorder instructions
8469 to exploit instruction slots available after delayed branch
8470 instructions.
8472 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8474 @item -fschedule-insns
8475 @opindex fschedule-insns
8476 If supported for the target machine, attempt to reorder instructions to
8477 eliminate execution stalls due to required data being unavailable.  This
8478 helps machines that have slow floating point or memory load instructions
8479 by allowing other instructions to be issued until the result of the load
8480 or floating-point instruction is required.
8482 Enabled at levels @option{-O2}, @option{-O3}.
8484 @item -fschedule-insns2
8485 @opindex fschedule-insns2
8486 Similar to @option{-fschedule-insns}, but requests an additional pass of
8487 instruction scheduling after register allocation has been done.  This is
8488 especially useful on machines with a relatively small number of
8489 registers and where memory load instructions take more than one cycle.
8491 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8493 @item -fno-sched-interblock
8494 @opindex fno-sched-interblock
8495 Don't schedule instructions across basic blocks.  This is normally
8496 enabled by default when scheduling before register allocation, i.e.@:
8497 with @option{-fschedule-insns} or at @option{-O2} or higher.
8499 @item -fno-sched-spec
8500 @opindex fno-sched-spec
8501 Don't allow speculative motion of non-load instructions.  This is normally
8502 enabled by default when scheduling before register allocation, i.e.@:
8503 with @option{-fschedule-insns} or at @option{-O2} or higher.
8505 @item -fsched-pressure
8506 @opindex fsched-pressure
8507 Enable register pressure sensitive insn scheduling before register
8508 allocation.  This only makes sense when scheduling before register
8509 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8510 @option{-O2} or higher.  Usage of this option can improve the
8511 generated code and decrease its size by preventing register pressure
8512 increase above the number of available hard registers and subsequent
8513 spills in register allocation.
8515 @item -fsched-spec-load
8516 @opindex fsched-spec-load
8517 Allow speculative motion of some load instructions.  This only makes
8518 sense when scheduling before register allocation, i.e.@: with
8519 @option{-fschedule-insns} or at @option{-O2} or higher.
8521 @item -fsched-spec-load-dangerous
8522 @opindex fsched-spec-load-dangerous
8523 Allow speculative motion of more load instructions.  This only makes
8524 sense when scheduling before register allocation, i.e.@: with
8525 @option{-fschedule-insns} or at @option{-O2} or higher.
8527 @item -fsched-stalled-insns
8528 @itemx -fsched-stalled-insns=@var{n}
8529 @opindex fsched-stalled-insns
8530 Define how many insns (if any) can be moved prematurely from the queue
8531 of stalled insns into the ready list during the second scheduling pass.
8532 @option{-fno-sched-stalled-insns} means that no insns are moved
8533 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8534 on how many queued insns can be moved prematurely.
8535 @option{-fsched-stalled-insns} without a value is equivalent to
8536 @option{-fsched-stalled-insns=1}.
8538 @item -fsched-stalled-insns-dep
8539 @itemx -fsched-stalled-insns-dep=@var{n}
8540 @opindex fsched-stalled-insns-dep
8541 Define how many insn groups (cycles) are examined for a dependency
8542 on a stalled insn that is a candidate for premature removal from the queue
8543 of stalled insns.  This has an effect only during the second scheduling pass,
8544 and only if @option{-fsched-stalled-insns} is used.
8545 @option{-fno-sched-stalled-insns-dep} is equivalent to
8546 @option{-fsched-stalled-insns-dep=0}.
8547 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8548 @option{-fsched-stalled-insns-dep=1}.
8550 @item -fsched2-use-superblocks
8551 @opindex fsched2-use-superblocks
8552 When scheduling after register allocation, use superblock scheduling.
8553 This allows motion across basic block boundaries,
8554 resulting in faster schedules.  This option is experimental, as not all machine
8555 descriptions used by GCC model the CPU closely enough to avoid unreliable
8556 results from the algorithm.
8558 This only makes sense when scheduling after register allocation, i.e.@: with
8559 @option{-fschedule-insns2} or at @option{-O2} or higher.
8561 @item -fsched-group-heuristic
8562 @opindex fsched-group-heuristic
8563 Enable the group heuristic in the scheduler.  This heuristic favors
8564 the instruction that belongs to a schedule group.  This is enabled
8565 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8566 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8568 @item -fsched-critical-path-heuristic
8569 @opindex fsched-critical-path-heuristic
8570 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8571 instructions on the critical path.  This is enabled by default when
8572 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8573 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8575 @item -fsched-spec-insn-heuristic
8576 @opindex fsched-spec-insn-heuristic
8577 Enable the speculative instruction heuristic in the scheduler.  This
8578 heuristic favors speculative instructions with greater dependency weakness.
8579 This is enabled by default when scheduling is enabled, i.e.@:
8580 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8581 or at @option{-O2} or higher.
8583 @item -fsched-rank-heuristic
8584 @opindex fsched-rank-heuristic
8585 Enable the rank heuristic in the scheduler.  This heuristic favors
8586 the instruction belonging to a basic block with greater size or frequency.
8587 This is enabled by default when scheduling is enabled, i.e.@:
8588 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8589 at @option{-O2} or higher.
8591 @item -fsched-last-insn-heuristic
8592 @opindex fsched-last-insn-heuristic
8593 Enable the last-instruction heuristic in the scheduler.  This heuristic
8594 favors the instruction that is less dependent on the last instruction
8595 scheduled.  This is enabled by default when scheduling is enabled,
8596 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8597 at @option{-O2} or higher.
8599 @item -fsched-dep-count-heuristic
8600 @opindex fsched-dep-count-heuristic
8601 Enable the dependent-count heuristic in the scheduler.  This heuristic
8602 favors the instruction that has more instructions depending on it.
8603 This is enabled by default when scheduling is enabled, i.e.@:
8604 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8605 at @option{-O2} or higher.
8607 @item -freschedule-modulo-scheduled-loops
8608 @opindex freschedule-modulo-scheduled-loops
8609 Modulo scheduling is performed before traditional scheduling.  If a loop
8610 is modulo scheduled, later scheduling passes may change its schedule.  
8611 Use this option to control that behavior.
8613 @item -fselective-scheduling
8614 @opindex fselective-scheduling
8615 Schedule instructions using selective scheduling algorithm.  Selective
8616 scheduling runs instead of the first scheduler pass.
8618 @item -fselective-scheduling2
8619 @opindex fselective-scheduling2
8620 Schedule instructions using selective scheduling algorithm.  Selective
8621 scheduling runs instead of the second scheduler pass.
8623 @item -fsel-sched-pipelining
8624 @opindex fsel-sched-pipelining
8625 Enable software pipelining of innermost loops during selective scheduling.
8626 This option has no effect unless one of @option{-fselective-scheduling} or
8627 @option{-fselective-scheduling2} is turned on.
8629 @item -fsel-sched-pipelining-outer-loops
8630 @opindex fsel-sched-pipelining-outer-loops
8631 When pipelining loops during selective scheduling, also pipeline outer loops.
8632 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8634 @item -fsemantic-interposition
8635 @opindex fsemantic-interposition
8636 Some object formats, like ELF, allow interposing of symbols by the 
8637 dynamic linker.
8638 This means that for symbols exported from the DSO, the compiler cannot perform
8639 interprocedural propagation, inlining and other optimizations in anticipation
8640 that the function or variable in question may change. While this feature is
8641 useful, for example, to rewrite memory allocation functions by a debugging
8642 implementation, it is expensive in the terms of code quality.
8643 With @option{-fno-semantic-interposition} the compiler assumes that 
8644 if interposition happens for functions the overwriting function will have 
8645 precisely the same semantics (and side effects). 
8646 Similarly if interposition happens
8647 for variables, the constructor of the variable will be the same. The flag
8648 has no effect for functions explicitly declared inline 
8649 (where it is never allowed for interposition to change semantics) 
8650 and for symbols explicitly declared weak.
8652 @item -fshrink-wrap
8653 @opindex fshrink-wrap
8654 Emit function prologues only before parts of the function that need it,
8655 rather than at the top of the function.  This flag is enabled by default at
8656 @option{-O} and higher.
8658 @item -fcaller-saves
8659 @opindex fcaller-saves
8660 Enable allocation of values to registers that are clobbered by
8661 function calls, by emitting extra instructions to save and restore the
8662 registers around such calls.  Such allocation is done only when it
8663 seems to result in better code.
8665 This option is always enabled by default on certain machines, usually
8666 those which have no call-preserved registers to use instead.
8668 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8670 @item -fcombine-stack-adjustments
8671 @opindex fcombine-stack-adjustments
8672 Tracks stack adjustments (pushes and pops) and stack memory references
8673 and then tries to find ways to combine them.
8675 Enabled by default at @option{-O1} and higher.
8677 @item -fipa-ra
8678 @opindex fipa-ra
8679 Use caller save registers for allocation if those registers are not used by
8680 any called function.  In that case it is not necessary to save and restore
8681 them around calls.  This is only possible if called functions are part of
8682 same compilation unit as current function and they are compiled before it.
8684 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8686 @item -fconserve-stack
8687 @opindex fconserve-stack
8688 Attempt to minimize stack usage.  The compiler attempts to use less
8689 stack space, even if that makes the program slower.  This option
8690 implies setting the @option{large-stack-frame} parameter to 100
8691 and the @option{large-stack-frame-growth} parameter to 400.
8693 @item -ftree-reassoc
8694 @opindex ftree-reassoc
8695 Perform reassociation on trees.  This flag is enabled by default
8696 at @option{-O} and higher.
8698 @item -ftree-pre
8699 @opindex ftree-pre
8700 Perform partial redundancy elimination (PRE) on trees.  This flag is
8701 enabled by default at @option{-O2} and @option{-O3}.
8703 @item -ftree-partial-pre
8704 @opindex ftree-partial-pre
8705 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8706 enabled by default at @option{-O3}.
8708 @item -ftree-forwprop
8709 @opindex ftree-forwprop
8710 Perform forward propagation on trees.  This flag is enabled by default
8711 at @option{-O} and higher.
8713 @item -ftree-fre
8714 @opindex ftree-fre
8715 Perform full redundancy elimination (FRE) on trees.  The difference
8716 between FRE and PRE is that FRE only considers expressions
8717 that are computed on all paths leading to the redundant computation.
8718 This analysis is faster than PRE, though it exposes fewer redundancies.
8719 This flag is enabled by default at @option{-O} and higher.
8721 @item -ftree-phiprop
8722 @opindex ftree-phiprop
8723 Perform hoisting of loads from conditional pointers on trees.  This
8724 pass is enabled by default at @option{-O} and higher.
8726 @item -fhoist-adjacent-loads
8727 @opindex fhoist-adjacent-loads
8728 Speculatively hoist loads from both branches of an if-then-else if the
8729 loads are from adjacent locations in the same structure and the target
8730 architecture has a conditional move instruction.  This flag is enabled
8731 by default at @option{-O2} and higher.
8733 @item -ftree-copy-prop
8734 @opindex ftree-copy-prop
8735 Perform copy propagation on trees.  This pass eliminates unnecessary
8736 copy operations.  This flag is enabled by default at @option{-O} and
8737 higher.
8739 @item -fipa-pure-const
8740 @opindex fipa-pure-const
8741 Discover which functions are pure or constant.
8742 Enabled by default at @option{-O} and higher.
8744 @item -fipa-reference
8745 @opindex fipa-reference
8746 Discover which static variables do not escape the
8747 compilation unit.
8748 Enabled by default at @option{-O} and higher.
8750 @item -fipa-pta
8751 @opindex fipa-pta
8752 Perform interprocedural pointer analysis and interprocedural modification
8753 and reference analysis.  This option can cause excessive memory and
8754 compile-time usage on large compilation units.  It is not enabled by
8755 default at any optimization level.
8757 @item -fipa-profile
8758 @opindex fipa-profile
8759 Perform interprocedural profile propagation.  The functions called only from
8760 cold functions are marked as cold. Also functions executed once (such as
8761 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8762 functions and loop less parts of functions executed once are then optimized for
8763 size.
8764 Enabled by default at @option{-O} and higher.
8766 @item -fipa-cp
8767 @opindex fipa-cp
8768 Perform interprocedural constant propagation.
8769 This optimization analyzes the program to determine when values passed
8770 to functions are constants and then optimizes accordingly.
8771 This optimization can substantially increase performance
8772 if the application has constants passed to functions.
8773 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8775 @item -fipa-cp-clone
8776 @opindex fipa-cp-clone
8777 Perform function cloning to make interprocedural constant propagation stronger.
8778 When enabled, interprocedural constant propagation performs function cloning
8779 when externally visible function can be called with constant arguments.
8780 Because this optimization can create multiple copies of functions,
8781 it may significantly increase code size
8782 (see @option{--param ipcp-unit-growth=@var{value}}).
8783 This flag is enabled by default at @option{-O3}.
8785 @item -fipa-cp-alignment
8786 @opindex -fipa-cp-alignment
8787 When enabled, this optimization propagates alignment of function
8788 parameters to support better vectorization and string operations.
8790 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8791 requires that @option{-fipa-cp} is enabled.
8793 @item -fipa-icf
8794 @opindex fipa-icf
8795 Perform Identical Code Folding for functions and read-only variables.
8796 The optimization reduces code size and may disturb unwind stacks by replacing
8797 a function by equivalent one with a different name. The optimization works
8798 more effectively with link time optimization enabled.
8800 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8801 works on different levels and thus the optimizations are not same - there are
8802 equivalences that are found only by GCC and equivalences found only by Gold.
8804 This flag is enabled by default at @option{-O2} and @option{-Os}.
8806 @item -fisolate-erroneous-paths-dereference
8807 @opindex fisolate-erroneous-paths-dereference
8808 Detect paths that trigger erroneous or undefined behavior due to
8809 dereferencing a null pointer.  Isolate those paths from the main control
8810 flow and turn the statement with erroneous or undefined behavior into a trap.
8811 This flag is enabled by default at @option{-O2} and higher and depends on
8812 @option{-fdelete-null-pointer-checks} also being enabled.
8814 @item -fisolate-erroneous-paths-attribute
8815 @opindex fisolate-erroneous-paths-attribute
8816 Detect paths that trigger erroneous or undefined behavior due a null value
8817 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8818 attribute.  Isolate those paths from the main control flow and turn the
8819 statement with erroneous or undefined behavior into a trap.  This is not
8820 currently enabled, but may be enabled by @option{-O2} in the future.
8822 @item -ftree-sink
8823 @opindex ftree-sink
8824 Perform forward store motion  on trees.  This flag is
8825 enabled by default at @option{-O} and higher.
8827 @item -ftree-bit-ccp
8828 @opindex ftree-bit-ccp
8829 Perform sparse conditional bit constant propagation on trees and propagate
8830 pointer alignment information.
8831 This pass only operates on local scalar variables and is enabled by default
8832 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8834 @item -ftree-ccp
8835 @opindex ftree-ccp
8836 Perform sparse conditional constant propagation (CCP) on trees.  This
8837 pass only operates on local scalar variables and is enabled by default
8838 at @option{-O} and higher.
8840 @item -fssa-backprop
8841 @opindex fssa-backprop
8842 Propagate information about uses of a value up the definition chain
8843 in order to simplify the definitions.  For example, this pass strips
8844 sign operations if the sign of a value never matters.  The flag is
8845 enabled by default at @option{-O} and higher.
8847 @item -fssa-phiopt
8848 @opindex fssa-phiopt
8849 Perform pattern matching on SSA PHI nodes to optimize conditional
8850 code.  This pass is enabled by default at @option{-O} and higher.
8852 @item -ftree-switch-conversion
8853 @opindex ftree-switch-conversion
8854 Perform conversion of simple initializations in a switch to
8855 initializations from a scalar array.  This flag is enabled by default
8856 at @option{-O2} and higher.
8858 @item -ftree-tail-merge
8859 @opindex ftree-tail-merge
8860 Look for identical code sequences.  When found, replace one with a jump to the
8861 other.  This optimization is known as tail merging or cross jumping.  This flag
8862 is enabled by default at @option{-O2} and higher.  The compilation time
8863 in this pass can
8864 be limited using @option{max-tail-merge-comparisons} parameter and
8865 @option{max-tail-merge-iterations} parameter.
8867 @item -ftree-dce
8868 @opindex ftree-dce
8869 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8870 default at @option{-O} and higher.
8872 @item -ftree-builtin-call-dce
8873 @opindex ftree-builtin-call-dce
8874 Perform conditional dead code elimination (DCE) for calls to built-in functions
8875 that may set @code{errno} but are otherwise side-effect free.  This flag is
8876 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8877 specified.
8879 @item -ftree-dominator-opts
8880 @opindex ftree-dominator-opts
8881 Perform a variety of simple scalar cleanups (constant/copy
8882 propagation, redundancy elimination, range propagation and expression
8883 simplification) based on a dominator tree traversal.  This also
8884 performs jump threading (to reduce jumps to jumps). This flag is
8885 enabled by default at @option{-O} and higher.
8887 @item -ftree-dse
8888 @opindex ftree-dse
8889 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8890 a memory location that is later overwritten by another store without
8891 any intervening loads.  In this case the earlier store can be deleted.  This
8892 flag is enabled by default at @option{-O} and higher.
8894 @item -ftree-ch
8895 @opindex ftree-ch
8896 Perform loop header copying on trees.  This is beneficial since it increases
8897 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8898 is enabled by default at @option{-O} and higher.  It is not enabled
8899 for @option{-Os}, since it usually increases code size.
8901 @item -ftree-loop-optimize
8902 @opindex ftree-loop-optimize
8903 Perform loop optimizations on trees.  This flag is enabled by default
8904 at @option{-O} and higher.
8906 @item -ftree-loop-linear
8907 @itemx -floop-interchange
8908 @itemx -floop-strip-mine
8909 @itemx -floop-block
8910 @itemx -floop-unroll-and-jam
8911 @opindex ftree-loop-linear
8912 @opindex floop-interchange
8913 @opindex floop-strip-mine
8914 @opindex floop-block
8915 @opindex floop-unroll-and-jam
8916 Perform loop nest optimizations.  Same as
8917 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8918 to be configured with @option{--with-isl} to enable the Graphite loop
8919 transformation infrastructure.
8921 @item -fgraphite-identity
8922 @opindex fgraphite-identity
8923 Enable the identity transformation for graphite.  For every SCoP we generate
8924 the polyhedral representation and transform it back to gimple.  Using
8925 @option{-fgraphite-identity} we can check the costs or benefits of the
8926 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8927 are also performed by the code generator ISL, like index splitting and
8928 dead code elimination in loops.
8930 @item -floop-nest-optimize
8931 @opindex floop-nest-optimize
8932 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8933 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8934 structure optimized for data-locality and parallelism.  This option
8935 is experimental.
8937 @item -floop-parallelize-all
8938 @opindex floop-parallelize-all
8939 Use the Graphite data dependence analysis to identify loops that can
8940 be parallelized.  Parallelize all the loops that can be analyzed to
8941 not contain loop carried dependences without checking that it is
8942 profitable to parallelize the loops.
8944 @item -ftree-coalesce-vars
8945 @opindex ftree-coalesce-vars
8946 While transforming the program out of the SSA representation, attempt to
8947 reduce copying by coalescing versions of different user-defined
8948 variables, instead of just compiler temporaries.  This may severely
8949 limit the ability to debug an optimized program compiled with
8950 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8951 prevents SSA coalescing of user variables.  This option is enabled by
8952 default if optimization is enabled, and it does very little otherwise.
8954 @item -ftree-loop-if-convert
8955 @opindex ftree-loop-if-convert
8956 Attempt to transform conditional jumps in the innermost loops to
8957 branch-less equivalents.  The intent is to remove control-flow from
8958 the innermost loops in order to improve the ability of the
8959 vectorization pass to handle these loops.  This is enabled by default
8960 if vectorization is enabled.
8962 @item -ftree-loop-if-convert-stores
8963 @opindex ftree-loop-if-convert-stores
8964 Attempt to also if-convert conditional jumps containing memory writes.
8965 This transformation can be unsafe for multi-threaded programs as it
8966 transforms conditional memory writes into unconditional memory writes.
8967 For example,
8968 @smallexample
8969 for (i = 0; i < N; i++)
8970   if (cond)
8971     A[i] = expr;
8972 @end smallexample
8973 is transformed to
8974 @smallexample
8975 for (i = 0; i < N; i++)
8976   A[i] = cond ? expr : A[i];
8977 @end smallexample
8978 potentially producing data races.
8980 @item -ftree-loop-distribution
8981 @opindex ftree-loop-distribution
8982 Perform loop distribution.  This flag can improve cache performance on
8983 big loop bodies and allow further loop optimizations, like
8984 parallelization or vectorization, to take place.  For example, the loop
8985 @smallexample
8986 DO I = 1, N
8987   A(I) = B(I) + C
8988   D(I) = E(I) * F
8989 ENDDO
8990 @end smallexample
8991 is transformed to
8992 @smallexample
8993 DO I = 1, N
8994    A(I) = B(I) + C
8995 ENDDO
8996 DO I = 1, N
8997    D(I) = E(I) * F
8998 ENDDO
8999 @end smallexample
9001 @item -ftree-loop-distribute-patterns
9002 @opindex ftree-loop-distribute-patterns
9003 Perform loop distribution of patterns that can be code generated with
9004 calls to a library.  This flag is enabled by default at @option{-O3}.
9006 This pass distributes the initialization loops and generates a call to
9007 memset zero.  For example, the loop
9008 @smallexample
9009 DO I = 1, N
9010   A(I) = 0
9011   B(I) = A(I) + I
9012 ENDDO
9013 @end smallexample
9014 is transformed to
9015 @smallexample
9016 DO I = 1, N
9017    A(I) = 0
9018 ENDDO
9019 DO I = 1, N
9020    B(I) = A(I) + I
9021 ENDDO
9022 @end smallexample
9023 and the initialization loop is transformed into a call to memset zero.
9025 @item -ftree-loop-im
9026 @opindex ftree-loop-im
9027 Perform loop invariant motion on trees.  This pass moves only invariants that
9028 are hard to handle at RTL level (function calls, operations that expand to
9029 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
9030 operands of conditions that are invariant out of the loop, so that we can use
9031 just trivial invariantness analysis in loop unswitching.  The pass also includes
9032 store motion.
9034 @item -ftree-loop-ivcanon
9035 @opindex ftree-loop-ivcanon
9036 Create a canonical counter for number of iterations in loops for which
9037 determining number of iterations requires complicated analysis.  Later
9038 optimizations then may determine the number easily.  Useful especially
9039 in connection with unrolling.
9041 @item -fivopts
9042 @opindex fivopts
9043 Perform induction variable optimizations (strength reduction, induction
9044 variable merging and induction variable elimination) on trees.
9046 @item -ftree-parallelize-loops=n
9047 @opindex ftree-parallelize-loops
9048 Parallelize loops, i.e., split their iteration space to run in n threads.
9049 This is only possible for loops whose iterations are independent
9050 and can be arbitrarily reordered.  The optimization is only
9051 profitable on multiprocessor machines, for loops that are CPU-intensive,
9052 rather than constrained e.g.@: by memory bandwidth.  This option
9053 implies @option{-pthread}, and thus is only supported on targets
9054 that have support for @option{-pthread}.
9056 @item -ftree-pta
9057 @opindex ftree-pta
9058 Perform function-local points-to analysis on trees.  This flag is
9059 enabled by default at @option{-O} and higher.
9061 @item -ftree-sra
9062 @opindex ftree-sra
9063 Perform scalar replacement of aggregates.  This pass replaces structure
9064 references with scalars to prevent committing structures to memory too
9065 early.  This flag is enabled by default at @option{-O} and higher.
9067 @item -ftree-ter
9068 @opindex ftree-ter
9069 Perform temporary expression replacement during the SSA->normal phase.  Single
9070 use/single def temporaries are replaced at their use location with their
9071 defining expression.  This results in non-GIMPLE code, but gives the expanders
9072 much more complex trees to work on resulting in better RTL generation.  This is
9073 enabled by default at @option{-O} and higher.
9075 @item -ftree-slsr
9076 @opindex ftree-slsr
9077 Perform straight-line strength reduction on trees.  This recognizes related
9078 expressions involving multiplications and replaces them by less expensive
9079 calculations when possible.  This is enabled by default at @option{-O} and
9080 higher.
9082 @item -ftree-vectorize
9083 @opindex ftree-vectorize
9084 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
9085 and @option{-ftree-slp-vectorize} if not explicitly specified.
9087 @item -ftree-loop-vectorize
9088 @opindex ftree-loop-vectorize
9089 Perform loop vectorization on trees. This flag is enabled by default at
9090 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9092 @item -ftree-slp-vectorize
9093 @opindex ftree-slp-vectorize
9094 Perform basic block vectorization on trees. This flag is enabled by default at
9095 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9097 @item -fvect-cost-model=@var{model}
9098 @opindex fvect-cost-model
9099 Alter the cost model used for vectorization.  The @var{model} argument
9100 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
9101 With the @samp{unlimited} model the vectorized code-path is assumed
9102 to be profitable while with the @samp{dynamic} model a runtime check
9103 guards the vectorized code-path to enable it only for iteration
9104 counts that will likely execute faster than when executing the original
9105 scalar loop.  The @samp{cheap} model disables vectorization of
9106 loops where doing so would be cost prohibitive for example due to
9107 required runtime checks for data dependence or alignment but otherwise
9108 is equal to the @samp{dynamic} model.
9109 The default cost model depends on other optimization flags and is
9110 either @samp{dynamic} or @samp{cheap}.
9112 @item -fsimd-cost-model=@var{model}
9113 @opindex fsimd-cost-model
9114 Alter the cost model used for vectorization of loops marked with the OpenMP
9115 or Cilk Plus simd directive.  The @var{model} argument should be one of
9116 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9117 have the same meaning as described in @option{-fvect-cost-model} and by
9118 default a cost model defined with @option{-fvect-cost-model} is used.
9120 @item -ftree-vrp
9121 @opindex ftree-vrp
9122 Perform Value Range Propagation on trees.  This is similar to the
9123 constant propagation pass, but instead of values, ranges of values are
9124 propagated.  This allows the optimizers to remove unnecessary range
9125 checks like array bound checks and null pointer checks.  This is
9126 enabled by default at @option{-O2} and higher.  Null pointer check
9127 elimination is only done if @option{-fdelete-null-pointer-checks} is
9128 enabled.
9130 @item -fsplit-ivs-in-unroller
9131 @opindex fsplit-ivs-in-unroller
9132 Enables expression of values of induction variables in later iterations
9133 of the unrolled loop using the value in the first iteration.  This breaks
9134 long dependency chains, thus improving efficiency of the scheduling passes.
9136 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9137 same effect.  However, that is not reliable in cases where the loop body
9138 is more complicated than a single basic block.  It also does not work at all
9139 on some architectures due to restrictions in the CSE pass.
9141 This optimization is enabled by default.
9143 @item -fvariable-expansion-in-unroller
9144 @opindex fvariable-expansion-in-unroller
9145 With this option, the compiler creates multiple copies of some
9146 local variables when unrolling a loop, which can result in superior code.
9148 @item -fpartial-inlining
9149 @opindex fpartial-inlining
9150 Inline parts of functions.  This option has any effect only
9151 when inlining itself is turned on by the @option{-finline-functions}
9152 or @option{-finline-small-functions} options.
9154 Enabled at level @option{-O2}.
9156 @item -fpredictive-commoning
9157 @opindex fpredictive-commoning
9158 Perform predictive commoning optimization, i.e., reusing computations
9159 (especially memory loads and stores) performed in previous
9160 iterations of loops.
9162 This option is enabled at level @option{-O3}.
9164 @item -fprefetch-loop-arrays
9165 @opindex fprefetch-loop-arrays
9166 If supported by the target machine, generate instructions to prefetch
9167 memory to improve the performance of loops that access large arrays.
9169 This option may generate better or worse code; results are highly
9170 dependent on the structure of loops within the source code.
9172 Disabled at level @option{-Os}.
9174 @item -fno-peephole
9175 @itemx -fno-peephole2
9176 @opindex fno-peephole
9177 @opindex fno-peephole2
9178 Disable any machine-specific peephole optimizations.  The difference
9179 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9180 are implemented in the compiler; some targets use one, some use the
9181 other, a few use both.
9183 @option{-fpeephole} is enabled by default.
9184 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9186 @item -fno-guess-branch-probability
9187 @opindex fno-guess-branch-probability
9188 Do not guess branch probabilities using heuristics.
9190 GCC uses heuristics to guess branch probabilities if they are
9191 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9192 heuristics are based on the control flow graph.  If some branch probabilities
9193 are specified by @code{__builtin_expect}, then the heuristics are
9194 used to guess branch probabilities for the rest of the control flow graph,
9195 taking the @code{__builtin_expect} info into account.  The interactions
9196 between the heuristics and @code{__builtin_expect} can be complex, and in
9197 some cases, it may be useful to disable the heuristics so that the effects
9198 of @code{__builtin_expect} are easier to understand.
9200 The default is @option{-fguess-branch-probability} at levels
9201 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9203 @item -freorder-blocks
9204 @opindex freorder-blocks
9205 Reorder basic blocks in the compiled function in order to reduce number of
9206 taken branches and improve code locality.
9208 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9210 @item -freorder-blocks-algorithm=@var{algorithm}
9211 @opindex freorder-blocks-algorithm
9212 Use the specified algorithm for basic block reordering.  The
9213 @var{algorithm} argument can be @samp{simple}, which does not increase
9214 code size (except sometimes due to secondary effects like alignment),
9215 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9216 put all often executed code together, minimizing the number of branches
9217 executed by making extra copies of code.
9219 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9220 @samp{stc} at levels @option{-O2}, @option{-O3}.
9222 @item -freorder-blocks-and-partition
9223 @opindex freorder-blocks-and-partition
9224 In addition to reordering basic blocks in the compiled function, in order
9225 to reduce number of taken branches, partitions hot and cold basic blocks
9226 into separate sections of the assembly and .o files, to improve
9227 paging and cache locality performance.
9229 This optimization is automatically turned off in the presence of
9230 exception handling, for linkonce sections, for functions with a user-defined
9231 section attribute and on any architecture that does not support named
9232 sections.
9234 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9236 @item -freorder-functions
9237 @opindex freorder-functions
9238 Reorder functions in the object file in order to
9239 improve code locality.  This is implemented by using special
9240 subsections @code{.text.hot} for most frequently executed functions and
9241 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9242 the linker so object file format must support named sections and linker must
9243 place them in a reasonable way.
9245 Also profile feedback must be available to make this option effective.  See
9246 @option{-fprofile-arcs} for details.
9248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9250 @item -fstrict-aliasing
9251 @opindex fstrict-aliasing
9252 Allow the compiler to assume the strictest aliasing rules applicable to
9253 the language being compiled.  For C (and C++), this activates
9254 optimizations based on the type of expressions.  In particular, an
9255 object of one type is assumed never to reside at the same address as an
9256 object of a different type, unless the types are almost the same.  For
9257 example, an @code{unsigned int} can alias an @code{int}, but not a
9258 @code{void*} or a @code{double}.  A character type may alias any other
9259 type.
9261 @anchor{Type-punning}Pay special attention to code like this:
9262 @smallexample
9263 union a_union @{
9264   int i;
9265   double d;
9268 int f() @{
9269   union a_union t;
9270   t.d = 3.0;
9271   return t.i;
9273 @end smallexample
9274 The practice of reading from a different union member than the one most
9275 recently written to (called ``type-punning'') is common.  Even with
9276 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9277 is accessed through the union type.  So, the code above works as
9278 expected.  @xref{Structures unions enumerations and bit-fields
9279 implementation}.  However, this code might not:
9280 @smallexample
9281 int f() @{
9282   union a_union t;
9283   int* ip;
9284   t.d = 3.0;
9285   ip = &t.i;
9286   return *ip;
9288 @end smallexample
9290 Similarly, access by taking the address, casting the resulting pointer
9291 and dereferencing the result has undefined behavior, even if the cast
9292 uses a union type, e.g.:
9293 @smallexample
9294 int f() @{
9295   double d = 3.0;
9296   return ((union a_union *) &d)->i;
9298 @end smallexample
9300 The @option{-fstrict-aliasing} option is enabled at levels
9301 @option{-O2}, @option{-O3}, @option{-Os}.
9303 @item -fstrict-overflow
9304 @opindex fstrict-overflow
9305 Allow the compiler to assume strict signed overflow rules, depending
9306 on the language being compiled.  For C (and C++) this means that
9307 overflow when doing arithmetic with signed numbers is undefined, which
9308 means that the compiler may assume that it does not happen.  This
9309 permits various optimizations.  For example, the compiler assumes
9310 that an expression like @code{i + 10 > i} is always true for
9311 signed @code{i}.  This assumption is only valid if signed overflow is
9312 undefined, as the expression is false if @code{i + 10} overflows when
9313 using twos complement arithmetic.  When this option is in effect any
9314 attempt to determine whether an operation on signed numbers 
9315 overflows must be written carefully to not actually involve overflow.
9317 This option also allows the compiler to assume strict pointer
9318 semantics: given a pointer to an object, if adding an offset to that
9319 pointer does not produce a pointer to the same object, the addition is
9320 undefined.  This permits the compiler to conclude that @code{p + u >
9321 p} is always true for a pointer @code{p} and unsigned integer
9322 @code{u}.  This assumption is only valid because pointer wraparound is
9323 undefined, as the expression is false if @code{p + u} overflows using
9324 twos complement arithmetic.
9326 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9327 that integer signed overflow is fully defined: it wraps.  When
9328 @option{-fwrapv} is used, there is no difference between
9329 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9330 integers.  With @option{-fwrapv} certain types of overflow are
9331 permitted.  For example, if the compiler gets an overflow when doing
9332 arithmetic on constants, the overflowed value can still be used with
9333 @option{-fwrapv}, but not otherwise.
9335 The @option{-fstrict-overflow} option is enabled at levels
9336 @option{-O2}, @option{-O3}, @option{-Os}.
9338 @item -falign-functions
9339 @itemx -falign-functions=@var{n}
9340 @opindex falign-functions
9341 Align the start of functions to the next power-of-two greater than
9342 @var{n}, skipping up to @var{n} bytes.  For instance,
9343 @option{-falign-functions=32} aligns functions to the next 32-byte
9344 boundary, but @option{-falign-functions=24} aligns to the next
9345 32-byte boundary only if this can be done by skipping 23 bytes or less.
9347 @option{-fno-align-functions} and @option{-falign-functions=1} are
9348 equivalent and mean that functions are not aligned.
9350 Some assemblers only support this flag when @var{n} is a power of two;
9351 in that case, it is rounded up.
9353 If @var{n} is not specified or is zero, use a machine-dependent default.
9355 Enabled at levels @option{-O2}, @option{-O3}.
9357 @item -falign-labels
9358 @itemx -falign-labels=@var{n}
9359 @opindex falign-labels
9360 Align all branch targets to a power-of-two boundary, skipping up to
9361 @var{n} bytes like @option{-falign-functions}.  This option can easily
9362 make code slower, because it must insert dummy operations for when the
9363 branch target is reached in the usual flow of the code.
9365 @option{-fno-align-labels} and @option{-falign-labels=1} are
9366 equivalent and mean that labels are not aligned.
9368 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9369 are greater than this value, then their values are used instead.
9371 If @var{n} is not specified or is zero, use a machine-dependent default
9372 which is very likely to be @samp{1}, meaning no alignment.
9374 Enabled at levels @option{-O2}, @option{-O3}.
9376 @item -falign-loops
9377 @itemx -falign-loops=@var{n}
9378 @opindex falign-loops
9379 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9380 like @option{-falign-functions}.  If the loops are
9381 executed many times, this makes up for any execution of the dummy
9382 operations.
9384 @option{-fno-align-loops} and @option{-falign-loops=1} are
9385 equivalent and mean that loops are not aligned.
9387 If @var{n} is not specified or is zero, use a machine-dependent default.
9389 Enabled at levels @option{-O2}, @option{-O3}.
9391 @item -falign-jumps
9392 @itemx -falign-jumps=@var{n}
9393 @opindex falign-jumps
9394 Align branch targets to a power-of-two boundary, for branch targets
9395 where the targets can only be reached by jumping, skipping up to @var{n}
9396 bytes like @option{-falign-functions}.  In this case, no dummy operations
9397 need be executed.
9399 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9400 equivalent and mean that loops are not aligned.
9402 If @var{n} is not specified or is zero, use a machine-dependent default.
9404 Enabled at levels @option{-O2}, @option{-O3}.
9406 @item -funit-at-a-time
9407 @opindex funit-at-a-time
9408 This option is left for compatibility reasons. @option{-funit-at-a-time}
9409 has no effect, while @option{-fno-unit-at-a-time} implies
9410 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9412 Enabled by default.
9414 @item -fno-toplevel-reorder
9415 @opindex fno-toplevel-reorder
9416 Do not reorder top-level functions, variables, and @code{asm}
9417 statements.  Output them in the same order that they appear in the
9418 input file.  When this option is used, unreferenced static variables
9419 are not removed.  This option is intended to support existing code
9420 that relies on a particular ordering.  For new code, it is better to
9421 use attributes when possible.
9423 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9424 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9425 targets.
9427 @item -fweb
9428 @opindex fweb
9429 Constructs webs as commonly used for register allocation purposes and assign
9430 each web individual pseudo register.  This allows the register allocation pass
9431 to operate on pseudos directly, but also strengthens several other optimization
9432 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9433 however, make debugging impossible, since variables no longer stay in a
9434 ``home register''.
9436 Enabled by default with @option{-funroll-loops}.
9438 @item -fwhole-program
9439 @opindex fwhole-program
9440 Assume that the current compilation unit represents the whole program being
9441 compiled.  All public functions and variables with the exception of @code{main}
9442 and those merged by attribute @code{externally_visible} become static functions
9443 and in effect are optimized more aggressively by interprocedural optimizers.
9445 This option should not be used in combination with @option{-flto}.
9446 Instead relying on a linker plugin should provide safer and more precise
9447 information.
9449 @item -flto[=@var{n}]
9450 @opindex flto
9451 This option runs the standard link-time optimizer.  When invoked
9452 with source code, it generates GIMPLE (one of GCC's internal
9453 representations) and writes it to special ELF sections in the object
9454 file.  When the object files are linked together, all the function
9455 bodies are read from these ELF sections and instantiated as if they
9456 had been part of the same translation unit.
9458 To use the link-time optimizer, @option{-flto} and optimization
9459 options should be specified at compile time and during the final link.
9460 For example:
9462 @smallexample
9463 gcc -c -O2 -flto foo.c
9464 gcc -c -O2 -flto bar.c
9465 gcc -o myprog -flto -O2 foo.o bar.o
9466 @end smallexample
9468 The first two invocations to GCC save a bytecode representation
9469 of GIMPLE into special ELF sections inside @file{foo.o} and
9470 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9471 @file{foo.o} and @file{bar.o}, merges the two files into a single
9472 internal image, and compiles the result as usual.  Since both
9473 @file{foo.o} and @file{bar.o} are merged into a single image, this
9474 causes all the interprocedural analyses and optimizations in GCC to
9475 work across the two files as if they were a single one.  This means,
9476 for example, that the inliner is able to inline functions in
9477 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9479 Another (simpler) way to enable link-time optimization is:
9481 @smallexample
9482 gcc -o myprog -flto -O2 foo.c bar.c
9483 @end smallexample
9485 The above generates bytecode for @file{foo.c} and @file{bar.c},
9486 merges them together into a single GIMPLE representation and optimizes
9487 them as usual to produce @file{myprog}.
9489 The only important thing to keep in mind is that to enable link-time
9490 optimizations you need to use the GCC driver to perform the link-step.
9491 GCC then automatically performs link-time optimization if any of the
9492 objects involved were compiled with the @option{-flto} command-line option.  
9493 You generally
9494 should specify the optimization options to be used for link-time
9495 optimization though GCC tries to be clever at guessing an
9496 optimization level to use from the options used at compile-time
9497 if you fail to specify one at link-time.  You can always override
9498 the automatic decision to do link-time optimization at link-time
9499 by passing @option{-fno-lto} to the link command.
9501 To make whole program optimization effective, it is necessary to make
9502 certain whole program assumptions.  The compiler needs to know
9503 what functions and variables can be accessed by libraries and runtime
9504 outside of the link-time optimized unit.  When supported by the linker,
9505 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9506 to the compiler about used and externally visible symbols.  When
9507 the linker plugin is not available, @option{-fwhole-program} should be
9508 used to allow the compiler to make these assumptions, which leads
9509 to more aggressive optimization decisions.
9511 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9512 compiled with @option{-flto}, the generated object file is larger than
9513 a regular object file because it contains GIMPLE bytecodes and the usual
9514 final code (see @option{-ffat-lto-objects}.  This means that
9515 object files with LTO information can be linked as normal object
9516 files; if @option{-fno-lto} is passed to the linker, no
9517 interprocedural optimizations are applied.  Note that when
9518 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9519 but you cannot perform a regular, non-LTO link on them.
9521 Additionally, the optimization flags used to compile individual files
9522 are not necessarily related to those used at link time.  For instance,
9524 @smallexample
9525 gcc -c -O0 -ffat-lto-objects -flto foo.c
9526 gcc -c -O0 -ffat-lto-objects -flto bar.c
9527 gcc -o myprog -O3 foo.o bar.o
9528 @end smallexample
9530 This produces individual object files with unoptimized assembler
9531 code, but the resulting binary @file{myprog} is optimized at
9532 @option{-O3}.  If, instead, the final binary is generated with
9533 @option{-fno-lto}, then @file{myprog} is not optimized.
9535 When producing the final binary, GCC only
9536 applies link-time optimizations to those files that contain bytecode.
9537 Therefore, you can mix and match object files and libraries with
9538 GIMPLE bytecodes and final object code.  GCC automatically selects
9539 which files to optimize in LTO mode and which files to link without
9540 further processing.
9542 There are some code generation flags preserved by GCC when
9543 generating bytecodes, as they need to be used during the final link
9544 stage.  Generally options specified at link-time override those
9545 specified at compile-time.
9547 If you do not specify an optimization level option @option{-O} at
9548 link-time then GCC computes one based on the optimization levels
9549 used when compiling the object files.  The highest optimization
9550 level wins here.
9552 Currently, the following options and their setting are take from
9553 the first object file that explicitely specified it: 
9554 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9555 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9556 and all the @option{-m} target flags.
9558 Certain ABI changing flags are required to match in all compilation-units
9559 and trying to override this at link-time with a conflicting value
9560 is ignored.  This includes options such as @option{-freg-struct-return}
9561 and @option{-fpcc-struct-return}. 
9563 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9564 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9565 are passed through to the link stage and merged conservatively for
9566 conflicting translation units.  Specifically
9567 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9568 precedence and for example @option{-ffp-contract=off} takes precedence
9569 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9571 It is recommended that you compile all the files participating in the
9572 same link with the same options and also specify those options at
9573 link time.
9575 If LTO encounters objects with C linkage declared with incompatible
9576 types in separate translation units to be linked together (undefined
9577 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9578 issued.  The behavior is still undefined at run time.  Similar
9579 diagnostics may be raised for other languages.
9581 Another feature of LTO is that it is possible to apply interprocedural
9582 optimizations on files written in different languages:
9584 @smallexample
9585 gcc -c -flto foo.c
9586 g++ -c -flto bar.cc
9587 gfortran -c -flto baz.f90
9588 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9589 @end smallexample
9591 Notice that the final link is done with @command{g++} to get the C++
9592 runtime libraries and @option{-lgfortran} is added to get the Fortran
9593 runtime libraries.  In general, when mixing languages in LTO mode, you
9594 should use the same link command options as when mixing languages in a
9595 regular (non-LTO) compilation.
9597 If object files containing GIMPLE bytecode are stored in a library archive, say
9598 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9599 are using a linker with plugin support.  To create static libraries suitable
9600 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9601 and @command{ranlib}; 
9602 to show the symbols of object files with GIMPLE bytecode, use
9603 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9604 and @command{nm} have been compiled with plugin support.  At link time, use the the
9605 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9606 the LTO optimization process:
9608 @smallexample
9609 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9610 @end smallexample
9612 With the linker plugin enabled, the linker extracts the needed
9613 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9614 to make them part of the aggregated GIMPLE image to be optimized.
9616 If you are not using a linker with plugin support and/or do not
9617 enable the linker plugin, then the objects inside @file{libfoo.a}
9618 are extracted and linked as usual, but they do not participate
9619 in the LTO optimization process.  In order to make a static library suitable
9620 for both LTO optimization and usual linkage, compile its object files with
9621 @option{-flto} @option{-ffat-lto-objects}.
9623 Link-time optimizations do not require the presence of the whole program to
9624 operate.  If the program does not require any symbols to be exported, it is
9625 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9626 the interprocedural optimizers to use more aggressive assumptions which may
9627 lead to improved optimization opportunities.
9628 Use of @option{-fwhole-program} is not needed when linker plugin is
9629 active (see @option{-fuse-linker-plugin}).
9631 The current implementation of LTO makes no
9632 attempt to generate bytecode that is portable between different
9633 types of hosts.  The bytecode files are versioned and there is a
9634 strict version check, so bytecode files generated in one version of
9635 GCC do not work with an older or newer version of GCC.
9637 Link-time optimization does not work well with generation of debugging
9638 information.  Combining @option{-flto} with
9639 @option{-g} is currently experimental and expected to produce unexpected
9640 results.
9642 If you specify the optional @var{n}, the optimization and code
9643 generation done at link time is executed in parallel using @var{n}
9644 parallel jobs by utilizing an installed @command{make} program.  The
9645 environment variable @env{MAKE} may be used to override the program
9646 used.  The default value for @var{n} is 1.
9648 You can also specify @option{-flto=jobserver} to use GNU make's
9649 job server mode to determine the number of parallel jobs. This
9650 is useful when the Makefile calling GCC is already executing in parallel.
9651 You must prepend a @samp{+} to the command recipe in the parent Makefile
9652 for this to work.  This option likely only works if @env{MAKE} is
9653 GNU make.
9655 @item -flto-partition=@var{alg}
9656 @opindex flto-partition
9657 Specify the partitioning algorithm used by the link-time optimizer.
9658 The value is either @samp{1to1} to specify a partitioning mirroring
9659 the original source files or @samp{balanced} to specify partitioning
9660 into equally sized chunks (whenever possible) or @samp{max} to create
9661 new partition for every symbol where possible.  Specifying @samp{none}
9662 as an algorithm disables partitioning and streaming completely. 
9663 The default value is @samp{balanced}. While @samp{1to1} can be used
9664 as an workaround for various code ordering issues, the @samp{max}
9665 partitioning is intended for internal testing only.
9666 The value @samp{one} specifies that exactly one partition should be
9667 used while the value @samp{none} bypasses partitioning and executes
9668 the link-time optimization step directly from the WPA phase.
9670 @item -flto-odr-type-merging
9671 @opindex flto-odr-type-merging
9672 Enable streaming of mangled types names of C++ types and their unification
9673 at linktime.  This increases size of LTO object files, but enable
9674 diagnostics about One Definition Rule violations.
9676 @item -flto-compression-level=@var{n}
9677 @opindex flto-compression-level
9678 This option specifies the level of compression used for intermediate
9679 language written to LTO object files, and is only meaningful in
9680 conjunction with LTO mode (@option{-flto}).  Valid
9681 values are 0 (no compression) to 9 (maximum compression).  Values
9682 outside this range are clamped to either 0 or 9.  If the option is not
9683 given, a default balanced compression setting is used.
9685 @item -flto-report
9686 @opindex flto-report
9687 Prints a report with internal details on the workings of the link-time
9688 optimizer.  The contents of this report vary from version to version.
9689 It is meant to be useful to GCC developers when processing object
9690 files in LTO mode (via @option{-flto}).
9692 Disabled by default.
9694 @item -flto-report-wpa
9695 @opindex flto-report-wpa
9696 Like @option{-flto-report}, but only print for the WPA phase of Link
9697 Time Optimization.
9699 @item -fuse-linker-plugin
9700 @opindex fuse-linker-plugin
9701 Enables the use of a linker plugin during link-time optimization.  This
9702 option relies on plugin support in the linker, which is available in gold
9703 or in GNU ld 2.21 or newer.
9705 This option enables the extraction of object files with GIMPLE bytecode out
9706 of library archives. This improves the quality of optimization by exposing
9707 more code to the link-time optimizer.  This information specifies what
9708 symbols can be accessed externally (by non-LTO object or during dynamic
9709 linking).  Resulting code quality improvements on binaries (and shared
9710 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9711 See @option{-flto} for a description of the effect of this flag and how to
9712 use it.
9714 This option is enabled by default when LTO support in GCC is enabled
9715 and GCC was configured for use with
9716 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9718 @item -ffat-lto-objects
9719 @opindex ffat-lto-objects
9720 Fat LTO objects are object files that contain both the intermediate language
9721 and the object code. This makes them usable for both LTO linking and normal
9722 linking. This option is effective only when compiling with @option{-flto}
9723 and is ignored at link time.
9725 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9726 requires the complete toolchain to be aware of LTO. It requires a linker with
9727 linker plugin support for basic functionality.  Additionally,
9728 @command{nm}, @command{ar} and @command{ranlib}
9729 need to support linker plugins to allow a full-featured build environment
9730 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9731 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9732 to these tools. With non fat LTO makefiles need to be modified to use them.
9734 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9735 support.
9737 @item -fcompare-elim
9738 @opindex fcompare-elim
9739 After register allocation and post-register allocation instruction splitting,
9740 identify arithmetic instructions that compute processor flags similar to a
9741 comparison operation based on that arithmetic.  If possible, eliminate the
9742 explicit comparison operation.
9744 This pass only applies to certain targets that cannot explicitly represent
9745 the comparison operation before register allocation is complete.
9747 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9749 @item -fcprop-registers
9750 @opindex fcprop-registers
9751 After register allocation and post-register allocation instruction splitting,
9752 perform a copy-propagation pass to try to reduce scheduling dependencies
9753 and occasionally eliminate the copy.
9755 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9757 @item -fprofile-correction
9758 @opindex fprofile-correction
9759 Profiles collected using an instrumented binary for multi-threaded programs may
9760 be inconsistent due to missed counter updates. When this option is specified,
9761 GCC uses heuristics to correct or smooth out such inconsistencies. By
9762 default, GCC emits an error message when an inconsistent profile is detected.
9764 @item -fprofile-dir=@var{path}
9765 @opindex fprofile-dir
9767 Set the directory to search for the profile data files in to @var{path}.
9768 This option affects only the profile data generated by
9769 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9770 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9771 and its related options.  Both absolute and relative paths can be used.
9772 By default, GCC uses the current directory as @var{path}, thus the
9773 profile data file appears in the same directory as the object file.
9775 @item -fprofile-generate
9776 @itemx -fprofile-generate=@var{path}
9777 @opindex fprofile-generate
9779 Enable options usually used for instrumenting application to produce
9780 profile useful for later recompilation with profile feedback based
9781 optimization.  You must use @option{-fprofile-generate} both when
9782 compiling and when linking your program.
9784 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9786 If @var{path} is specified, GCC looks at the @var{path} to find
9787 the profile feedback data files. See @option{-fprofile-dir}.
9789 @item -fprofile-use
9790 @itemx -fprofile-use=@var{path}
9791 @opindex fprofile-use
9792 Enable profile feedback-directed optimizations, 
9793 and the following optimizations
9794 which are generally profitable only with profile feedback available:
9795 @option{-fbranch-probabilities}, @option{-fvpt},
9796 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9797 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9799 By default, GCC emits an error message if the feedback profiles do not
9800 match the source code.  This error can be turned into a warning by using
9801 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9802 code.
9804 If @var{path} is specified, GCC looks at the @var{path} to find
9805 the profile feedback data files. See @option{-fprofile-dir}.
9807 @item -fauto-profile
9808 @itemx -fauto-profile=@var{path}
9809 @opindex fauto-profile
9810 Enable sampling-based feedback-directed optimizations, 
9811 and the following optimizations
9812 which are generally profitable only with profile feedback available:
9813 @option{-fbranch-probabilities}, @option{-fvpt},
9814 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9815 @option{-ftree-vectorize},
9816 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9817 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9818 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9820 @var{path} is the name of a file containing AutoFDO profile information.
9821 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9823 Producing an AutoFDO profile data file requires running your program
9824 with the @command{perf} utility on a supported GNU/Linux target system.
9825 For more information, see @uref{https://perf.wiki.kernel.org/}.
9827 E.g.
9828 @smallexample
9829 perf record -e br_inst_retired:near_taken -b -o perf.data \
9830     -- your_program
9831 @end smallexample
9833 Then use the @command{create_gcov} tool to convert the raw profile data
9834 to a format that can be used by GCC.@  You must also supply the 
9835 unstripped binary for your program to this tool.  
9836 See @uref{https://github.com/google/autofdo}.
9838 E.g.
9839 @smallexample
9840 create_gcov --binary=your_program.unstripped --profile=perf.data \
9841     --gcov=profile.afdo
9842 @end smallexample
9843 @end table
9845 The following options control compiler behavior regarding floating-point 
9846 arithmetic.  These options trade off between speed and
9847 correctness.  All must be specifically enabled.
9849 @table @gcctabopt
9850 @item -ffloat-store
9851 @opindex ffloat-store
9852 Do not store floating-point variables in registers, and inhibit other
9853 options that might change whether a floating-point value is taken from a
9854 register or memory.
9856 @cindex floating-point precision
9857 This option prevents undesirable excess precision on machines such as
9858 the 68000 where the floating registers (of the 68881) keep more
9859 precision than a @code{double} is supposed to have.  Similarly for the
9860 x86 architecture.  For most programs, the excess precision does only
9861 good, but a few programs rely on the precise definition of IEEE floating
9862 point.  Use @option{-ffloat-store} for such programs, after modifying
9863 them to store all pertinent intermediate computations into variables.
9865 @item -fexcess-precision=@var{style}
9866 @opindex fexcess-precision
9867 This option allows further control over excess precision on machines
9868 where floating-point registers have more precision than the IEEE
9869 @code{float} and @code{double} types and the processor does not
9870 support operations rounding to those types.  By default,
9871 @option{-fexcess-precision=fast} is in effect; this means that
9872 operations are carried out in the precision of the registers and that
9873 it is unpredictable when rounding to the types specified in the source
9874 code takes place.  When compiling C, if
9875 @option{-fexcess-precision=standard} is specified then excess
9876 precision follows the rules specified in ISO C99; in particular,
9877 both casts and assignments cause values to be rounded to their
9878 semantic types (whereas @option{-ffloat-store} only affects
9879 assignments).  This option is enabled by default for C if a strict
9880 conformance option such as @option{-std=c99} is used.
9882 @opindex mfpmath
9883 @option{-fexcess-precision=standard} is not implemented for languages
9884 other than C, and has no effect if
9885 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9886 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9887 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9888 semantics apply without excess precision, and in the latter, rounding
9889 is unpredictable.
9891 @item -ffast-math
9892 @opindex ffast-math
9893 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9894 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9895 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9897 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9899 This option is not turned on by any @option{-O} option besides
9900 @option{-Ofast} since it can result in incorrect output for programs
9901 that depend on an exact implementation of IEEE or ISO rules/specifications
9902 for math functions. It may, however, yield faster code for programs
9903 that do not require the guarantees of these specifications.
9905 @item -fno-math-errno
9906 @opindex fno-math-errno
9907 Do not set @code{errno} after calling math functions that are executed
9908 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9909 IEEE exceptions for math error handling may want to use this flag
9910 for speed while maintaining IEEE arithmetic compatibility.
9912 This option is not turned on by any @option{-O} option since
9913 it can result in incorrect output for programs that depend on
9914 an exact implementation of IEEE or ISO rules/specifications for
9915 math functions. It may, however, yield faster code for programs
9916 that do not require the guarantees of these specifications.
9918 The default is @option{-fmath-errno}.
9920 On Darwin systems, the math library never sets @code{errno}.  There is
9921 therefore no reason for the compiler to consider the possibility that
9922 it might, and @option{-fno-math-errno} is the default.
9924 @item -funsafe-math-optimizations
9925 @opindex funsafe-math-optimizations
9927 Allow optimizations for floating-point arithmetic that (a) assume
9928 that arguments and results are valid and (b) may violate IEEE or
9929 ANSI standards.  When used at link-time, it may include libraries
9930 or startup files that change the default FPU control word or other
9931 similar optimizations.
9933 This option is not turned on by any @option{-O} option since
9934 it can result in incorrect output for programs that depend on
9935 an exact implementation of IEEE or ISO rules/specifications for
9936 math functions. It may, however, yield faster code for programs
9937 that do not require the guarantees of these specifications.
9938 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9939 @option{-fassociative-math} and @option{-freciprocal-math}.
9941 The default is @option{-fno-unsafe-math-optimizations}.
9943 @item -fassociative-math
9944 @opindex fassociative-math
9946 Allow re-association of operands in series of floating-point operations.
9947 This violates the ISO C and C++ language standard by possibly changing
9948 computation result.  NOTE: re-ordering may change the sign of zero as
9949 well as ignore NaNs and inhibit or create underflow or overflow (and
9950 thus cannot be used on code that relies on rounding behavior like
9951 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9952 and thus may not be used when ordered comparisons are required.
9953 This option requires that both @option{-fno-signed-zeros} and
9954 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9955 much sense with @option{-frounding-math}. For Fortran the option
9956 is automatically enabled when both @option{-fno-signed-zeros} and
9957 @option{-fno-trapping-math} are in effect.
9959 The default is @option{-fno-associative-math}.
9961 @item -freciprocal-math
9962 @opindex freciprocal-math
9964 Allow the reciprocal of a value to be used instead of dividing by
9965 the value if this enables optimizations.  For example @code{x / y}
9966 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9967 is subject to common subexpression elimination.  Note that this loses
9968 precision and increases the number of flops operating on the value.
9970 The default is @option{-fno-reciprocal-math}.
9972 @item -ffinite-math-only
9973 @opindex ffinite-math-only
9974 Allow optimizations for floating-point arithmetic that assume
9975 that arguments and results are not NaNs or +-Infs.
9977 This option is not turned on by any @option{-O} option since
9978 it can result in incorrect output for programs that depend on
9979 an exact implementation of IEEE or ISO rules/specifications for
9980 math functions. It may, however, yield faster code for programs
9981 that do not require the guarantees of these specifications.
9983 The default is @option{-fno-finite-math-only}.
9985 @item -fno-signed-zeros
9986 @opindex fno-signed-zeros
9987 Allow optimizations for floating-point arithmetic that ignore the
9988 signedness of zero.  IEEE arithmetic specifies the behavior of
9989 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9990 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9991 This option implies that the sign of a zero result isn't significant.
9993 The default is @option{-fsigned-zeros}.
9995 @item -fno-trapping-math
9996 @opindex fno-trapping-math
9997 Compile code assuming that floating-point operations cannot generate
9998 user-visible traps.  These traps include division by zero, overflow,
9999 underflow, inexact result and invalid operation.  This option requires
10000 that @option{-fno-signaling-nans} be in effect.  Setting this option may
10001 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
10003 This option should never be turned on by any @option{-O} option since
10004 it can result in incorrect output for programs that depend on
10005 an exact implementation of IEEE or ISO rules/specifications for
10006 math functions.
10008 The default is @option{-ftrapping-math}.
10010 @item -frounding-math
10011 @opindex frounding-math
10012 Disable transformations and optimizations that assume default floating-point
10013 rounding behavior.  This is round-to-zero for all floating point
10014 to integer conversions, and round-to-nearest for all other arithmetic
10015 truncations.  This option should be specified for programs that change
10016 the FP rounding mode dynamically, or that may be executed with a
10017 non-default rounding mode.  This option disables constant folding of
10018 floating-point expressions at compile time (which may be affected by
10019 rounding mode) and arithmetic transformations that are unsafe in the
10020 presence of sign-dependent rounding modes.
10022 The default is @option{-fno-rounding-math}.
10024 This option is experimental and does not currently guarantee to
10025 disable all GCC optimizations that are affected by rounding mode.
10026 Future versions of GCC may provide finer control of this setting
10027 using C99's @code{FENV_ACCESS} pragma.  This command-line option
10028 will be used to specify the default state for @code{FENV_ACCESS}.
10030 @item -fsignaling-nans
10031 @opindex fsignaling-nans
10032 Compile code assuming that IEEE signaling NaNs may generate user-visible
10033 traps during floating-point operations.  Setting this option disables
10034 optimizations that may change the number of exceptions visible with
10035 signaling NaNs.  This option implies @option{-ftrapping-math}.
10037 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
10038 be defined.
10040 The default is @option{-fno-signaling-nans}.
10042 This option is experimental and does not currently guarantee to
10043 disable all GCC optimizations that affect signaling NaN behavior.
10045 @item -fsingle-precision-constant
10046 @opindex fsingle-precision-constant
10047 Treat floating-point constants as single precision instead of
10048 implicitly converting them to double-precision constants.
10050 @item -fcx-limited-range
10051 @opindex fcx-limited-range
10052 When enabled, this option states that a range reduction step is not
10053 needed when performing complex division.  Also, there is no checking
10054 whether the result of a complex multiplication or division is @code{NaN
10055 + I*NaN}, with an attempt to rescue the situation in that case.  The
10056 default is @option{-fno-cx-limited-range}, but is enabled by
10057 @option{-ffast-math}.
10059 This option controls the default setting of the ISO C99
10060 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
10061 all languages.
10063 @item -fcx-fortran-rules
10064 @opindex fcx-fortran-rules
10065 Complex multiplication and division follow Fortran rules.  Range
10066 reduction is done as part of complex division, but there is no checking
10067 whether the result of a complex multiplication or division is @code{NaN
10068 + I*NaN}, with an attempt to rescue the situation in that case.
10070 The default is @option{-fno-cx-fortran-rules}.
10072 @end table
10074 The following options control optimizations that may improve
10075 performance, but are not enabled by any @option{-O} options.  This
10076 section includes experimental options that may produce broken code.
10078 @table @gcctabopt
10079 @item -fbranch-probabilities
10080 @opindex fbranch-probabilities
10081 After running a program compiled with @option{-fprofile-arcs}
10082 (@pxref{Debugging Options,, Options for Debugging Your Program or
10083 @command{gcc}}), you can compile it a second time using
10084 @option{-fbranch-probabilities}, to improve optimizations based on
10085 the number of times each branch was taken.  When a program
10086 compiled with @option{-fprofile-arcs} exits, it saves arc execution
10087 counts to a file called @file{@var{sourcename}.gcda} for each source
10088 file.  The information in this data file is very dependent on the
10089 structure of the generated code, so you must use the same source code
10090 and the same optimization options for both compilations.
10092 With @option{-fbranch-probabilities}, GCC puts a
10093 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
10094 These can be used to improve optimization.  Currently, they are only
10095 used in one place: in @file{reorg.c}, instead of guessing which path a
10096 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
10097 exactly determine which path is taken more often.
10099 @item -fprofile-values
10100 @opindex fprofile-values
10101 If combined with @option{-fprofile-arcs}, it adds code so that some
10102 data about values of expressions in the program is gathered.
10104 With @option{-fbranch-probabilities}, it reads back the data gathered
10105 from profiling values of expressions for usage in optimizations.
10107 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
10109 @item -fprofile-reorder-functions
10110 @opindex fprofile-reorder-functions
10111 Function reordering based on profile instrumentation collects
10112 first time of execution of a function and orders these functions
10113 in ascending order.
10115 Enabled with @option{-fprofile-use}.
10117 @item -fvpt
10118 @opindex fvpt
10119 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10120 to add code to gather information about values of expressions.
10122 With @option{-fbranch-probabilities}, it reads back the data gathered
10123 and actually performs the optimizations based on them.
10124 Currently the optimizations include specialization of division operations
10125 using the knowledge about the value of the denominator.
10127 @item -frename-registers
10128 @opindex frename-registers
10129 Attempt to avoid false dependencies in scheduled code by making use
10130 of registers left over after register allocation.  This optimization
10131 most benefits processors with lots of registers.  Depending on the
10132 debug information format adopted by the target, however, it can
10133 make debugging impossible, since variables no longer stay in
10134 a ``home register''.
10136 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
10138 @item -fschedule-fusion
10139 @opindex fschedule-fusion
10140 Performs a target dependent pass over the instruction stream to schedule
10141 instructions of same type together because target machine can execute them
10142 more efficiently if they are adjacent to each other in the instruction flow.
10144 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10146 @item -ftracer
10147 @opindex ftracer
10148 Perform tail duplication to enlarge superblock size.  This transformation
10149 simplifies the control flow of the function allowing other optimizations to do
10150 a better job.
10152 Enabled with @option{-fprofile-use}.
10154 @item -funroll-loops
10155 @opindex funroll-loops
10156 Unroll loops whose number of iterations can be determined at compile time or
10157 upon entry to the loop.  @option{-funroll-loops} implies
10158 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10159 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10160 a small constant number of iterations).  This option makes code larger, and may
10161 or may not make it run faster.
10163 Enabled with @option{-fprofile-use}.
10165 @item -funroll-all-loops
10166 @opindex funroll-all-loops
10167 Unroll all loops, even if their number of iterations is uncertain when
10168 the loop is entered.  This usually makes programs run more slowly.
10169 @option{-funroll-all-loops} implies the same options as
10170 @option{-funroll-loops}.
10172 @item -fpeel-loops
10173 @opindex fpeel-loops
10174 Peels loops for which there is enough information that they do not
10175 roll much (from profile feedback).  It also turns on complete loop peeling
10176 (i.e.@: complete removal of loops with small constant number of iterations).
10178 Enabled with @option{-fprofile-use}.
10180 @item -fmove-loop-invariants
10181 @opindex fmove-loop-invariants
10182 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10183 at level @option{-O1}
10185 @item -funswitch-loops
10186 @opindex funswitch-loops
10187 Move branches with loop invariant conditions out of the loop, with duplicates
10188 of the loop on both branches (modified according to result of the condition).
10190 @item -ffunction-sections
10191 @itemx -fdata-sections
10192 @opindex ffunction-sections
10193 @opindex fdata-sections
10194 Place each function or data item into its own section in the output
10195 file if the target supports arbitrary sections.  The name of the
10196 function or the name of the data item determines the section's name
10197 in the output file.
10199 Use these options on systems where the linker can perform optimizations
10200 to improve locality of reference in the instruction space.  Most systems
10201 using the ELF object format and SPARC processors running Solaris 2 have
10202 linkers with such optimizations.  AIX may have these optimizations in
10203 the future.
10205 Only use these options when there are significant benefits from doing
10206 so.  When you specify these options, the assembler and linker
10207 create larger object and executable files and are also slower.
10208 You cannot use @command{gprof} on all systems if you
10209 specify this option, and you may have problems with debugging if
10210 you specify both this option and @option{-g}.
10212 @item -fbranch-target-load-optimize
10213 @opindex fbranch-target-load-optimize
10214 Perform branch target register load optimization before prologue / epilogue
10215 threading.
10216 The use of target registers can typically be exposed only during reload,
10217 thus hoisting loads out of loops and doing inter-block scheduling needs
10218 a separate optimization pass.
10220 @item -fbranch-target-load-optimize2
10221 @opindex fbranch-target-load-optimize2
10222 Perform branch target register load optimization after prologue / epilogue
10223 threading.
10225 @item -fbtr-bb-exclusive
10226 @opindex fbtr-bb-exclusive
10227 When performing branch target register load optimization, don't reuse
10228 branch target registers within any basic block.
10230 @item -fstack-protector
10231 @opindex fstack-protector
10232 Emit extra code to check for buffer overflows, such as stack smashing
10233 attacks.  This is done by adding a guard variable to functions with
10234 vulnerable objects.  This includes functions that call @code{alloca}, and
10235 functions with buffers larger than 8 bytes.  The guards are initialized
10236 when a function is entered and then checked when the function exits.
10237 If a guard check fails, an error message is printed and the program exits.
10239 @item -fstack-protector-all
10240 @opindex fstack-protector-all
10241 Like @option{-fstack-protector} except that all functions are protected.
10243 @item -fstack-protector-strong
10244 @opindex fstack-protector-strong
10245 Like @option{-fstack-protector} but includes additional functions to
10246 be protected --- those that have local array definitions, or have
10247 references to local frame addresses.
10249 @item -fstack-protector-explicit
10250 @opindex fstack-protector-explicit
10251 Like @option{-fstack-protector} but only protects those functions which
10252 have the @code{stack_protect} attribute
10254 @item -fstdarg-opt
10255 @opindex fstdarg-opt
10256 Optimize the prologue of variadic argument functions with respect to usage of
10257 those arguments.
10259 @item -fsection-anchors
10260 @opindex fsection-anchors
10261 Try to reduce the number of symbolic address calculations by using
10262 shared ``anchor'' symbols to address nearby objects.  This transformation
10263 can help to reduce the number of GOT entries and GOT accesses on some
10264 targets.
10266 For example, the implementation of the following function @code{foo}:
10268 @smallexample
10269 static int a, b, c;
10270 int foo (void) @{ return a + b + c; @}
10271 @end smallexample
10273 @noindent
10274 usually calculates the addresses of all three variables, but if you
10275 compile it with @option{-fsection-anchors}, it accesses the variables
10276 from a common anchor point instead.  The effect is similar to the
10277 following pseudocode (which isn't valid C):
10279 @smallexample
10280 int foo (void)
10282   register int *xr = &x;
10283   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10285 @end smallexample
10287 Not all targets support this option.
10289 @item --param @var{name}=@var{value}
10290 @opindex param
10291 In some places, GCC uses various constants to control the amount of
10292 optimization that is done.  For example, GCC does not inline functions
10293 that contain more than a certain number of instructions.  You can
10294 control some of these constants on the command line using the
10295 @option{--param} option.
10297 The names of specific parameters, and the meaning of the values, are
10298 tied to the internals of the compiler, and are subject to change
10299 without notice in future releases.
10301 In each case, the @var{value} is an integer.  The allowable choices for
10302 @var{name} are:
10304 @table @gcctabopt
10305 @item predictable-branch-outcome
10306 When branch is predicted to be taken with probability lower than this threshold
10307 (in percent), then it is considered well predictable. The default is 10.
10309 @item max-crossjump-edges
10310 The maximum number of incoming edges to consider for cross-jumping.
10311 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10312 the number of edges incoming to each block.  Increasing values mean
10313 more aggressive optimization, making the compilation time increase with
10314 probably small improvement in executable size.
10316 @item min-crossjump-insns
10317 The minimum number of instructions that must be matched at the end
10318 of two blocks before cross-jumping is performed on them.  This
10319 value is ignored in the case where all instructions in the block being
10320 cross-jumped from are matched.  The default value is 5.
10322 @item max-grow-copy-bb-insns
10323 The maximum code size expansion factor when copying basic blocks
10324 instead of jumping.  The expansion is relative to a jump instruction.
10325 The default value is 8.
10327 @item max-goto-duplication-insns
10328 The maximum number of instructions to duplicate to a block that jumps
10329 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10330 passes, GCC factors computed gotos early in the compilation process,
10331 and unfactors them as late as possible.  Only computed jumps at the
10332 end of a basic blocks with no more than max-goto-duplication-insns are
10333 unfactored.  The default value is 8.
10335 @item max-delay-slot-insn-search
10336 The maximum number of instructions to consider when looking for an
10337 instruction to fill a delay slot.  If more than this arbitrary number of
10338 instructions are searched, the time savings from filling the delay slot
10339 are minimal, so stop searching.  Increasing values mean more
10340 aggressive optimization, making the compilation time increase with probably
10341 small improvement in execution time.
10343 @item max-delay-slot-live-search
10344 When trying to fill delay slots, the maximum number of instructions to
10345 consider when searching for a block with valid live register
10346 information.  Increasing this arbitrarily chosen value means more
10347 aggressive optimization, increasing the compilation time.  This parameter
10348 should be removed when the delay slot code is rewritten to maintain the
10349 control-flow graph.
10351 @item max-gcse-memory
10352 The approximate maximum amount of memory that can be allocated in
10353 order to perform the global common subexpression elimination
10354 optimization.  If more memory than specified is required, the
10355 optimization is not done.
10357 @item max-gcse-insertion-ratio
10358 If the ratio of expression insertions to deletions is larger than this value
10359 for any expression, then RTL PRE inserts or removes the expression and thus
10360 leaves partially redundant computations in the instruction stream.  The default value is 20.
10362 @item max-pending-list-length
10363 The maximum number of pending dependencies scheduling allows
10364 before flushing the current state and starting over.  Large functions
10365 with few branches or calls can create excessively large lists which
10366 needlessly consume memory and resources.
10368 @item max-modulo-backtrack-attempts
10369 The maximum number of backtrack attempts the scheduler should make
10370 when modulo scheduling a loop.  Larger values can exponentially increase
10371 compilation time.
10373 @item max-inline-insns-single
10374 Several parameters control the tree inliner used in GCC@.
10375 This number sets the maximum number of instructions (counted in GCC's
10376 internal representation) in a single function that the tree inliner
10377 considers for inlining.  This only affects functions declared
10378 inline and methods implemented in a class declaration (C++).
10379 The default value is 400.
10381 @item max-inline-insns-auto
10382 When you use @option{-finline-functions} (included in @option{-O3}),
10383 a lot of functions that would otherwise not be considered for inlining
10384 by the compiler are investigated.  To those functions, a different
10385 (more restrictive) limit compared to functions declared inline can
10386 be applied.
10387 The default value is 40.
10389 @item inline-min-speedup
10390 When estimated performance improvement of caller + callee runtime exceeds this
10391 threshold (in precent), the function can be inlined regardless the limit on
10392 @option{--param max-inline-insns-single} and @option{--param
10393 max-inline-insns-auto}.
10395 @item large-function-insns
10396 The limit specifying really large functions.  For functions larger than this
10397 limit after inlining, inlining is constrained by
10398 @option{--param large-function-growth}.  This parameter is useful primarily
10399 to avoid extreme compilation time caused by non-linear algorithms used by the
10400 back end.
10401 The default value is 2700.
10403 @item large-function-growth
10404 Specifies maximal growth of large function caused by inlining in percents.
10405 The default value is 100 which limits large function growth to 2.0 times
10406 the original size.
10408 @item large-unit-insns
10409 The limit specifying large translation unit.  Growth caused by inlining of
10410 units larger than this limit is limited by @option{--param inline-unit-growth}.
10411 For small units this might be too tight.
10412 For example, consider a unit consisting of function A
10413 that is inline and B that just calls A three times.  If B is small relative to
10414 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10415 large units consisting of small inlineable functions, however, the overall unit
10416 growth limit is needed to avoid exponential explosion of code size.  Thus for
10417 smaller units, the size is increased to @option{--param large-unit-insns}
10418 before applying @option{--param inline-unit-growth}.  The default is 10000.
10420 @item inline-unit-growth
10421 Specifies maximal overall growth of the compilation unit caused by inlining.
10422 The default value is 20 which limits unit growth to 1.2 times the original
10423 size. Cold functions (either marked cold via an attribute or by profile
10424 feedback) are not accounted into the unit size.
10426 @item ipcp-unit-growth
10427 Specifies maximal overall growth of the compilation unit caused by
10428 interprocedural constant propagation.  The default value is 10 which limits
10429 unit growth to 1.1 times the original size.
10431 @item large-stack-frame
10432 The limit specifying large stack frames.  While inlining the algorithm is trying
10433 to not grow past this limit too much.  The default value is 256 bytes.
10435 @item large-stack-frame-growth
10436 Specifies maximal growth of large stack frames caused by inlining in percents.
10437 The default value is 1000 which limits large stack frame growth to 11 times
10438 the original size.
10440 @item max-inline-insns-recursive
10441 @itemx max-inline-insns-recursive-auto
10442 Specifies the maximum number of instructions an out-of-line copy of a
10443 self-recursive inline
10444 function can grow into by performing recursive inlining.
10446 @option{--param max-inline-insns-recursive} applies to functions
10447 declared inline.
10448 For functions not declared inline, recursive inlining
10449 happens only when @option{-finline-functions} (included in @option{-O3}) is
10450 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10451 default value is 450.
10453 @item max-inline-recursive-depth
10454 @itemx max-inline-recursive-depth-auto
10455 Specifies the maximum recursion depth used for recursive inlining.
10457 @option{--param max-inline-recursive-depth} applies to functions
10458 declared inline.  For functions not declared inline, recursive inlining
10459 happens only when @option{-finline-functions} (included in @option{-O3}) is
10460 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10461 default value is 8.
10463 @item min-inline-recursive-probability
10464 Recursive inlining is profitable only for function having deep recursion
10465 in average and can hurt for function having little recursion depth by
10466 increasing the prologue size or complexity of function body to other
10467 optimizers.
10469 When profile feedback is available (see @option{-fprofile-generate}) the actual
10470 recursion depth can be guessed from probability that function recurses via a
10471 given call expression.  This parameter limits inlining only to call expressions
10472 whose probability exceeds the given threshold (in percents).
10473 The default value is 10.
10475 @item early-inlining-insns
10476 Specify growth that the early inliner can make.  In effect it increases
10477 the amount of inlining for code having a large abstraction penalty.
10478 The default value is 14.
10480 @item max-early-inliner-iterations
10481 Limit of iterations of the early inliner.  This basically bounds
10482 the number of nested indirect calls the early inliner can resolve.
10483 Deeper chains are still handled by late inlining.
10485 @item comdat-sharing-probability
10486 Probability (in percent) that C++ inline function with comdat visibility
10487 are shared across multiple compilation units.  The default value is 20.
10489 @item profile-func-internal-id
10490 A parameter to control whether to use function internal id in profile
10491 database lookup. If the value is 0, the compiler uses an id that
10492 is based on function assembler name and filename, which makes old profile
10493 data more tolerant to source changes such as function reordering etc.
10494 The default value is 0.
10496 @item min-vect-loop-bound
10497 The minimum number of iterations under which loops are not vectorized
10498 when @option{-ftree-vectorize} is used.  The number of iterations after
10499 vectorization needs to be greater than the value specified by this option
10500 to allow vectorization.  The default value is 0.
10502 @item gcse-cost-distance-ratio
10503 Scaling factor in calculation of maximum distance an expression
10504 can be moved by GCSE optimizations.  This is currently supported only in the
10505 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10506 is with simple expressions, i.e., the expressions that have cost
10507 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10508 hoisting of simple expressions.  The default value is 10.
10510 @item gcse-unrestricted-cost
10511 Cost, roughly measured as the cost of a single typical machine
10512 instruction, at which GCSE optimizations do not constrain
10513 the distance an expression can travel.  This is currently
10514 supported only in the code hoisting pass.  The lesser the cost,
10515 the more aggressive code hoisting is.  Specifying 0 
10516 allows all expressions to travel unrestricted distances.
10517 The default value is 3.
10519 @item max-hoist-depth
10520 The depth of search in the dominator tree for expressions to hoist.
10521 This is used to avoid quadratic behavior in hoisting algorithm.
10522 The value of 0 does not limit on the search, but may slow down compilation
10523 of huge functions.  The default value is 30.
10525 @item max-tail-merge-comparisons
10526 The maximum amount of similar bbs to compare a bb with.  This is used to
10527 avoid quadratic behavior in tree tail merging.  The default value is 10.
10529 @item max-tail-merge-iterations
10530 The maximum amount of iterations of the pass over the function.  This is used to
10531 limit compilation time in tree tail merging.  The default value is 2.
10533 @item max-unrolled-insns
10534 The maximum number of instructions that a loop may have to be unrolled.
10535 If a loop is unrolled, this parameter also determines how many times
10536 the loop code is unrolled.
10538 @item max-average-unrolled-insns
10539 The maximum number of instructions biased by probabilities of their execution
10540 that a loop may have to be unrolled.  If a loop is unrolled,
10541 this parameter also determines how many times the loop code is unrolled.
10543 @item max-unroll-times
10544 The maximum number of unrollings of a single loop.
10546 @item max-peeled-insns
10547 The maximum number of instructions that a loop may have to be peeled.
10548 If a loop is peeled, this parameter also determines how many times
10549 the loop code is peeled.
10551 @item max-peel-times
10552 The maximum number of peelings of a single loop.
10554 @item max-peel-branches
10555 The maximum number of branches on the hot path through the peeled sequence.
10557 @item max-completely-peeled-insns
10558 The maximum number of insns of a completely peeled loop.
10560 @item max-completely-peel-times
10561 The maximum number of iterations of a loop to be suitable for complete peeling.
10563 @item max-completely-peel-loop-nest-depth
10564 The maximum depth of a loop nest suitable for complete peeling.
10566 @item max-unswitch-insns
10567 The maximum number of insns of an unswitched loop.
10569 @item max-unswitch-level
10570 The maximum number of branches unswitched in a single loop.
10572 @item lim-expensive
10573 The minimum cost of an expensive expression in the loop invariant motion.
10575 @item iv-consider-all-candidates-bound
10576 Bound on number of candidates for induction variables, below which
10577 all candidates are considered for each use in induction variable
10578 optimizations.  If there are more candidates than this,
10579 only the most relevant ones are considered to avoid quadratic time complexity.
10581 @item iv-max-considered-uses
10582 The induction variable optimizations give up on loops that contain more
10583 induction variable uses.
10585 @item iv-always-prune-cand-set-bound
10586 If the number of candidates in the set is smaller than this value,
10587 always try to remove unnecessary ivs from the set
10588 when adding a new one.
10590 @item scev-max-expr-size
10591 Bound on size of expressions used in the scalar evolutions analyzer.
10592 Large expressions slow the analyzer.
10594 @item scev-max-expr-complexity
10595 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10596 Complex expressions slow the analyzer.
10598 @item vect-max-version-for-alignment-checks
10599 The maximum number of run-time checks that can be performed when
10600 doing loop versioning for alignment in the vectorizer.
10602 @item vect-max-version-for-alias-checks
10603 The maximum number of run-time checks that can be performed when
10604 doing loop versioning for alias in the vectorizer.
10606 @item vect-max-peeling-for-alignment
10607 The maximum number of loop peels to enhance access alignment
10608 for vectorizer. Value -1 means 'no limit'.
10610 @item max-iterations-to-track
10611 The maximum number of iterations of a loop the brute-force algorithm
10612 for analysis of the number of iterations of the loop tries to evaluate.
10614 @item hot-bb-count-ws-permille
10615 A basic block profile count is considered hot if it contributes to 
10616 the given permillage (i.e. 0...1000) of the entire profiled execution.
10618 @item hot-bb-frequency-fraction
10619 Select fraction of the entry block frequency of executions of basic block in
10620 function given basic block needs to have to be considered hot.
10622 @item max-predicted-iterations
10623 The maximum number of loop iterations we predict statically.  This is useful
10624 in cases where a function contains a single loop with known bound and
10625 another loop with unknown bound.
10626 The known number of iterations is predicted correctly, while
10627 the unknown number of iterations average to roughly 10.  This means that the
10628 loop without bounds appears artificially cold relative to the other one.
10630 @item builtin-expect-probability
10631 Control the probability of the expression having the specified value. This
10632 parameter takes a percentage (i.e. 0 ... 100) as input.
10633 The default probability of 90 is obtained empirically.
10635 @item align-threshold
10637 Select fraction of the maximal frequency of executions of a basic block in
10638 a function to align the basic block.
10640 @item align-loop-iterations
10642 A loop expected to iterate at least the selected number of iterations is
10643 aligned.
10645 @item tracer-dynamic-coverage
10646 @itemx tracer-dynamic-coverage-feedback
10648 This value is used to limit superblock formation once the given percentage of
10649 executed instructions is covered.  This limits unnecessary code size
10650 expansion.
10652 The @option{tracer-dynamic-coverage-feedback} parameter
10653 is used only when profile
10654 feedback is available.  The real profiles (as opposed to statically estimated
10655 ones) are much less balanced allowing the threshold to be larger value.
10657 @item tracer-max-code-growth
10658 Stop tail duplication once code growth has reached given percentage.  This is
10659 a rather artificial limit, as most of the duplicates are eliminated later in
10660 cross jumping, so it may be set to much higher values than is the desired code
10661 growth.
10663 @item tracer-min-branch-ratio
10665 Stop reverse growth when the reverse probability of best edge is less than this
10666 threshold (in percent).
10668 @item tracer-min-branch-ratio
10669 @itemx tracer-min-branch-ratio-feedback
10671 Stop forward growth if the best edge has probability lower than this
10672 threshold.
10674 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10675 compilation for profile feedback and one for compilation without.  The value
10676 for compilation with profile feedback needs to be more conservative (higher) in
10677 order to make tracer effective.
10679 @item max-cse-path-length
10681 The maximum number of basic blocks on path that CSE considers.
10682 The default is 10.
10684 @item max-cse-insns
10685 The maximum number of instructions CSE processes before flushing.
10686 The default is 1000.
10688 @item ggc-min-expand
10690 GCC uses a garbage collector to manage its own memory allocation.  This
10691 parameter specifies the minimum percentage by which the garbage
10692 collector's heap should be allowed to expand between collections.
10693 Tuning this may improve compilation speed; it has no effect on code
10694 generation.
10696 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10697 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10698 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10699 GCC is not able to calculate RAM on a particular platform, the lower
10700 bound of 30% is used.  Setting this parameter and
10701 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10702 every opportunity.  This is extremely slow, but can be useful for
10703 debugging.
10705 @item ggc-min-heapsize
10707 Minimum size of the garbage collector's heap before it begins bothering
10708 to collect garbage.  The first collection occurs after the heap expands
10709 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10710 tuning this may improve compilation speed, and has no effect on code
10711 generation.
10713 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10714 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10715 with a lower bound of 4096 (four megabytes) and an upper bound of
10716 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10717 particular platform, the lower bound is used.  Setting this parameter
10718 very large effectively disables garbage collection.  Setting this
10719 parameter and @option{ggc-min-expand} to zero causes a full collection
10720 to occur at every opportunity.
10722 @item max-reload-search-insns
10723 The maximum number of instruction reload should look backward for equivalent
10724 register.  Increasing values mean more aggressive optimization, making the
10725 compilation time increase with probably slightly better performance.
10726 The default value is 100.
10728 @item max-cselib-memory-locations
10729 The maximum number of memory locations cselib should take into account.
10730 Increasing values mean more aggressive optimization, making the compilation time
10731 increase with probably slightly better performance.  The default value is 500.
10733 @item reorder-blocks-duplicate
10734 @itemx reorder-blocks-duplicate-feedback
10736 Used by the basic block reordering pass to decide whether to use unconditional
10737 branch or duplicate the code on its destination.  Code is duplicated when its
10738 estimated size is smaller than this value multiplied by the estimated size of
10739 unconditional jump in the hot spots of the program.
10741 The @option{reorder-block-duplicate-feedback} parameter
10742 is used only when profile
10743 feedback is available.  It may be set to higher values than
10744 @option{reorder-block-duplicate} since information about the hot spots is more
10745 accurate.
10747 @item max-sched-ready-insns
10748 The maximum number of instructions ready to be issued the scheduler should
10749 consider at any given time during the first scheduling pass.  Increasing
10750 values mean more thorough searches, making the compilation time increase
10751 with probably little benefit.  The default value is 100.
10753 @item max-sched-region-blocks
10754 The maximum number of blocks in a region to be considered for
10755 interblock scheduling.  The default value is 10.
10757 @item max-pipeline-region-blocks
10758 The maximum number of blocks in a region to be considered for
10759 pipelining in the selective scheduler.  The default value is 15.
10761 @item max-sched-region-insns
10762 The maximum number of insns in a region to be considered for
10763 interblock scheduling.  The default value is 100.
10765 @item max-pipeline-region-insns
10766 The maximum number of insns in a region to be considered for
10767 pipelining in the selective scheduler.  The default value is 200.
10769 @item min-spec-prob
10770 The minimum probability (in percents) of reaching a source block
10771 for interblock speculative scheduling.  The default value is 40.
10773 @item max-sched-extend-regions-iters
10774 The maximum number of iterations through CFG to extend regions.
10775 A value of 0 (the default) disables region extensions.
10777 @item max-sched-insn-conflict-delay
10778 The maximum conflict delay for an insn to be considered for speculative motion.
10779 The default value is 3.
10781 @item sched-spec-prob-cutoff
10782 The minimal probability of speculation success (in percents), so that
10783 speculative insns are scheduled.
10784 The default value is 40.
10786 @item sched-spec-state-edge-prob-cutoff
10787 The minimum probability an edge must have for the scheduler to save its
10788 state across it.
10789 The default value is 10.
10791 @item sched-mem-true-dep-cost
10792 Minimal distance (in CPU cycles) between store and load targeting same
10793 memory locations.  The default value is 1.
10795 @item selsched-max-lookahead
10796 The maximum size of the lookahead window of selective scheduling.  It is a
10797 depth of search for available instructions.
10798 The default value is 50.
10800 @item selsched-max-sched-times
10801 The maximum number of times that an instruction is scheduled during
10802 selective scheduling.  This is the limit on the number of iterations
10803 through which the instruction may be pipelined.  The default value is 2.
10805 @item selsched-max-insns-to-rename
10806 The maximum number of best instructions in the ready list that are considered
10807 for renaming in the selective scheduler.  The default value is 2.
10809 @item sms-min-sc
10810 The minimum value of stage count that swing modulo scheduler
10811 generates.  The default value is 2.
10813 @item max-last-value-rtl
10814 The maximum size measured as number of RTLs that can be recorded in an expression
10815 in combiner for a pseudo register as last known value of that register.  The default
10816 is 10000.
10818 @item max-combine-insns
10819 The maximum number of instructions the RTL combiner tries to combine.
10820 The default value is 2 at @option{-Og} and 4 otherwise.
10822 @item integer-share-limit
10823 Small integer constants can use a shared data structure, reducing the
10824 compiler's memory usage and increasing its speed.  This sets the maximum
10825 value of a shared integer constant.  The default value is 256.
10827 @item ssp-buffer-size
10828 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10829 protection when @option{-fstack-protection} is used.
10831 @item min-size-for-stack-sharing
10832 The minimum size of variables taking part in stack slot sharing when not
10833 optimizing. The default value is 32.
10835 @item max-jump-thread-duplication-stmts
10836 Maximum number of statements allowed in a block that needs to be
10837 duplicated when threading jumps.
10839 @item max-fields-for-field-sensitive
10840 Maximum number of fields in a structure treated in
10841 a field sensitive manner during pointer analysis.  The default is zero
10842 for @option{-O0} and @option{-O1},
10843 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10845 @item prefetch-latency
10846 Estimate on average number of instructions that are executed before
10847 prefetch finishes.  The distance prefetched ahead is proportional
10848 to this constant.  Increasing this number may also lead to less
10849 streams being prefetched (see @option{simultaneous-prefetches}).
10851 @item simultaneous-prefetches
10852 Maximum number of prefetches that can run at the same time.
10854 @item l1-cache-line-size
10855 The size of cache line in L1 cache, in bytes.
10857 @item l1-cache-size
10858 The size of L1 cache, in kilobytes.
10860 @item l2-cache-size
10861 The size of L2 cache, in kilobytes.
10863 @item min-insn-to-prefetch-ratio
10864 The minimum ratio between the number of instructions and the
10865 number of prefetches to enable prefetching in a loop.
10867 @item prefetch-min-insn-to-mem-ratio
10868 The minimum ratio between the number of instructions and the
10869 number of memory references to enable prefetching in a loop.
10871 @item use-canonical-types
10872 Whether the compiler should use the ``canonical'' type system.  By
10873 default, this should always be 1, which uses a more efficient internal
10874 mechanism for comparing types in C++ and Objective-C++.  However, if
10875 bugs in the canonical type system are causing compilation failures,
10876 set this value to 0 to disable canonical types.
10878 @item switch-conversion-max-branch-ratio
10879 Switch initialization conversion refuses to create arrays that are
10880 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10881 branches in the switch.
10883 @item max-partial-antic-length
10884 Maximum length of the partial antic set computed during the tree
10885 partial redundancy elimination optimization (@option{-ftree-pre}) when
10886 optimizing at @option{-O3} and above.  For some sorts of source code
10887 the enhanced partial redundancy elimination optimization can run away,
10888 consuming all of the memory available on the host machine.  This
10889 parameter sets a limit on the length of the sets that are computed,
10890 which prevents the runaway behavior.  Setting a value of 0 for
10891 this parameter allows an unlimited set length.
10893 @item sccvn-max-scc-size
10894 Maximum size of a strongly connected component (SCC) during SCCVN
10895 processing.  If this limit is hit, SCCVN processing for the whole
10896 function is not done and optimizations depending on it are
10897 disabled.  The default maximum SCC size is 10000.
10899 @item sccvn-max-alias-queries-per-access
10900 Maximum number of alias-oracle queries we perform when looking for
10901 redundancies for loads and stores.  If this limit is hit the search
10902 is aborted and the load or store is not considered redundant.  The
10903 number of queries is algorithmically limited to the number of
10904 stores on all paths from the load to the function entry.
10905 The default maxmimum number of queries is 1000.
10907 @item ira-max-loops-num
10908 IRA uses regional register allocation by default.  If a function
10909 contains more loops than the number given by this parameter, only at most
10910 the given number of the most frequently-executed loops form regions
10911 for regional register allocation.  The default value of the
10912 parameter is 100.
10914 @item ira-max-conflict-table-size 
10915 Although IRA uses a sophisticated algorithm to compress the conflict
10916 table, the table can still require excessive amounts of memory for
10917 huge functions.  If the conflict table for a function could be more
10918 than the size in MB given by this parameter, the register allocator
10919 instead uses a faster, simpler, and lower-quality
10920 algorithm that does not require building a pseudo-register conflict table.  
10921 The default value of the parameter is 2000.
10923 @item ira-loop-reserved-regs
10924 IRA can be used to evaluate more accurate register pressure in loops
10925 for decisions to move loop invariants (see @option{-O3}).  The number
10926 of available registers reserved for some other purposes is given
10927 by this parameter.  The default value of the parameter is 2, which is
10928 the minimal number of registers needed by typical instructions.
10929 This value is the best found from numerous experiments.
10931 @item lra-inheritance-ebb-probability-cutoff
10932 LRA tries to reuse values reloaded in registers in subsequent insns.
10933 This optimization is called inheritance.  EBB is used as a region to
10934 do this optimization.  The parameter defines a minimal fall-through
10935 edge probability in percentage used to add BB to inheritance EBB in
10936 LRA.  The default value of the parameter is 40.  The value was chosen
10937 from numerous runs of SPEC2000 on x86-64.
10939 @item loop-invariant-max-bbs-in-loop
10940 Loop invariant motion can be very expensive, both in compilation time and
10941 in amount of needed compile-time memory, with very large loops.  Loops
10942 with more basic blocks than this parameter won't have loop invariant
10943 motion optimization performed on them.  The default value of the
10944 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10946 @item loop-max-datarefs-for-datadeps
10947 Building data dapendencies is expensive for very large loops.  This
10948 parameter limits the number of data references in loops that are
10949 considered for data dependence analysis.  These large loops are no
10950 handled by the optimizations using loop data dependencies.
10951 The default value is 1000.
10953 @item max-vartrack-size
10954 Sets a maximum number of hash table slots to use during variable
10955 tracking dataflow analysis of any function.  If this limit is exceeded
10956 with variable tracking at assignments enabled, analysis for that
10957 function is retried without it, after removing all debug insns from
10958 the function.  If the limit is exceeded even without debug insns, var
10959 tracking analysis is completely disabled for the function.  Setting
10960 the parameter to zero makes it unlimited.
10962 @item max-vartrack-expr-depth
10963 Sets a maximum number of recursion levels when attempting to map
10964 variable names or debug temporaries to value expressions.  This trades
10965 compilation time for more complete debug information.  If this is set too
10966 low, value expressions that are available and could be represented in
10967 debug information may end up not being used; setting this higher may
10968 enable the compiler to find more complex debug expressions, but compile
10969 time and memory use may grow.  The default is 12.
10971 @item min-nondebug-insn-uid
10972 Use uids starting at this parameter for nondebug insns.  The range below
10973 the parameter is reserved exclusively for debug insns created by
10974 @option{-fvar-tracking-assignments}, but debug insns may get
10975 (non-overlapping) uids above it if the reserved range is exhausted.
10977 @item ipa-sra-ptr-growth-factor
10978 IPA-SRA replaces a pointer to an aggregate with one or more new
10979 parameters only when their cumulative size is less or equal to
10980 @option{ipa-sra-ptr-growth-factor} times the size of the original
10981 pointer parameter.
10983 @item sra-max-scalarization-size-Ospeed
10984 @item sra-max-scalarization-size-Osize
10985 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10986 replace scalar parts of aggregates with uses of independent scalar
10987 variables.  These parameters control the maximum size, in storage units,
10988 of aggregate which is considered for replacement when compiling for
10989 speed
10990 (@option{sra-max-scalarization-size-Ospeed}) or size
10991 (@option{sra-max-scalarization-size-Osize}) respectively.
10993 @item tm-max-aggregate-size
10994 When making copies of thread-local variables in a transaction, this
10995 parameter specifies the size in bytes after which variables are
10996 saved with the logging functions as opposed to save/restore code
10997 sequence pairs.  This option only applies when using
10998 @option{-fgnu-tm}.
11000 @item graphite-max-nb-scop-params
11001 To avoid exponential effects in the Graphite loop transforms, the
11002 number of parameters in a Static Control Part (SCoP) is bounded.  The
11003 default value is 10 parameters.  A variable whose value is unknown at
11004 compilation time and defined outside a SCoP is a parameter of the SCoP.
11006 @item graphite-max-bbs-per-function
11007 To avoid exponential effects in the detection of SCoPs, the size of
11008 the functions analyzed by Graphite is bounded.  The default value is
11009 100 basic blocks.
11011 @item loop-block-tile-size
11012 Loop blocking or strip mining transforms, enabled with
11013 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
11014 loop in the loop nest by a given number of iterations.  The strip
11015 length can be changed using the @option{loop-block-tile-size}
11016 parameter.  The default value is 51 iterations.
11018 @item loop-unroll-jam-size
11019 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
11020 default value is 4.
11022 @item loop-unroll-jam-depth
11023 Specify the dimension to be unrolled (counting from the most inner loop)
11024 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
11026 @item ipa-cp-value-list-size
11027 IPA-CP attempts to track all possible values and types passed to a function's
11028 parameter in order to propagate them and perform devirtualization.
11029 @option{ipa-cp-value-list-size} is the maximum number of values and types it
11030 stores per one formal parameter of a function.
11032 @item ipa-cp-eval-threshold
11033 IPA-CP calculates its own score of cloning profitability heuristics
11034 and performs those cloning opportunities with scores that exceed
11035 @option{ipa-cp-eval-threshold}.
11037 @item ipa-cp-recursion-penalty
11038 Percentage penalty the recursive functions will receive when they
11039 are evaluated for cloning.
11041 @item ipa-cp-single-call-penalty
11042 Percentage penalty functions containg a single call to another
11043 function will receive when they are evaluated for cloning.
11046 @item ipa-max-agg-items
11047 IPA-CP is also capable to propagate a number of scalar values passed
11048 in an aggregate. @option{ipa-max-agg-items} controls the maximum
11049 number of such values per one parameter.
11051 @item ipa-cp-loop-hint-bonus
11052 When IPA-CP determines that a cloning candidate would make the number
11053 of iterations of a loop known, it adds a bonus of
11054 @option{ipa-cp-loop-hint-bonus} to the profitability score of
11055 the candidate.
11057 @item ipa-cp-array-index-hint-bonus
11058 When IPA-CP determines that a cloning candidate would make the index of
11059 an array access known, it adds a bonus of
11060 @option{ipa-cp-array-index-hint-bonus} to the profitability
11061 score of the candidate.
11063 @item ipa-max-aa-steps
11064 During its analysis of function bodies, IPA-CP employs alias analysis
11065 in order to track values pointed to by function parameters.  In order
11066 not spend too much time analyzing huge functions, it gives up and
11067 consider all memory clobbered after examining
11068 @option{ipa-max-aa-steps} statements modifying memory.
11070 @item lto-partitions
11071 Specify desired number of partitions produced during WHOPR compilation.
11072 The number of partitions should exceed the number of CPUs used for compilation.
11073 The default value is 32.
11075 @item lto-minpartition
11076 Size of minimal partition for WHOPR (in estimated instructions).
11077 This prevents expenses of splitting very small programs into too many
11078 partitions.
11080 @item cxx-max-namespaces-for-diagnostic-help
11081 The maximum number of namespaces to consult for suggestions when C++
11082 name lookup fails for an identifier.  The default is 1000.
11084 @item sink-frequency-threshold
11085 The maximum relative execution frequency (in percents) of the target block
11086 relative to a statement's original block to allow statement sinking of a
11087 statement.  Larger numbers result in more aggressive statement sinking.
11088 The default value is 75.  A small positive adjustment is applied for
11089 statements with memory operands as those are even more profitable so sink.
11091 @item max-stores-to-sink
11092 The maximum number of conditional stores paires that can be sunk.  Set to 0
11093 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11094 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11096 @item allow-store-data-races
11097 Allow optimizers to introduce new data races on stores.
11098 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11099 at optimization level @option{-Ofast}.
11101 @item case-values-threshold
11102 The smallest number of different values for which it is best to use a
11103 jump-table instead of a tree of conditional branches.  If the value is
11104 0, use the default for the machine.  The default is 0.
11106 @item tree-reassoc-width
11107 Set the maximum number of instructions executed in parallel in
11108 reassociated tree. This parameter overrides target dependent
11109 heuristics used by default if has non zero value.
11111 @item sched-pressure-algorithm
11112 Choose between the two available implementations of
11113 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11114 and is the more likely to prevent instructions from being reordered.
11115 Algorithm 2 was designed to be a compromise between the relatively
11116 conservative approach taken by algorithm 1 and the rather aggressive
11117 approach taken by the default scheduler.  It relies more heavily on
11118 having a regular register file and accurate register pressure classes.
11119 See @file{haifa-sched.c} in the GCC sources for more details.
11121 The default choice depends on the target.
11123 @item max-slsr-cand-scan
11124 Set the maximum number of existing candidates that are considered when
11125 seeking a basis for a new straight-line strength reduction candidate.
11127 @item asan-globals
11128 Enable buffer overflow detection for global objects.  This kind
11129 of protection is enabled by default if you are using
11130 @option{-fsanitize=address} option.
11131 To disable global objects protection use @option{--param asan-globals=0}.
11133 @item asan-stack
11134 Enable buffer overflow detection for stack objects.  This kind of
11135 protection is enabled by default when using @option{-fsanitize=address}.
11136 To disable stack protection use @option{--param asan-stack=0} option.
11138 @item asan-instrument-reads
11139 Enable buffer overflow detection for memory reads.  This kind of
11140 protection is enabled by default when using @option{-fsanitize=address}.
11141 To disable memory reads protection use
11142 @option{--param asan-instrument-reads=0}.
11144 @item asan-instrument-writes
11145 Enable buffer overflow detection for memory writes.  This kind of
11146 protection is enabled by default when using @option{-fsanitize=address}.
11147 To disable memory writes protection use
11148 @option{--param asan-instrument-writes=0} option.
11150 @item asan-memintrin
11151 Enable detection for built-in functions.  This kind of protection
11152 is enabled by default when using @option{-fsanitize=address}.
11153 To disable built-in functions protection use
11154 @option{--param asan-memintrin=0}.
11156 @item asan-use-after-return
11157 Enable detection of use-after-return.  This kind of protection
11158 is enabled by default when using @option{-fsanitize=address} option.
11159 To disable use-after-return detection use 
11160 @option{--param asan-use-after-return=0}.
11162 @item asan-instrumentation-with-call-threshold
11163 If number of memory accesses in function being instrumented
11164 is greater or equal to this number, use callbacks instead of inline checks.
11165 E.g. to disable inline code use
11166 @option{--param asan-instrumentation-with-call-threshold=0}.
11168 @item chkp-max-ctor-size
11169 Static constructors generated by Pointer Bounds Checker may become very
11170 large and significantly increase compile time at optimization level
11171 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
11172 in a single generated constructor.  Default value is 5000.
11174 @item max-fsm-thread-path-insns
11175 Maximum number of instructions to copy when duplicating blocks on a
11176 finite state automaton jump thread path.  The default is 100.
11178 @item max-fsm-thread-length
11179 Maximum number of basic blocks on a finite state automaton jump thread
11180 path.  The default is 10.
11182 @item max-fsm-thread-paths
11183 Maximum number of new jump thread paths to create for a finite state
11184 automaton.  The default is 50.
11186 @item parloops-chunk-size
11187 Chunk size of omp schedule for loops parallelized by parloops.  The default
11188 is 0.
11190 @item parloops-schedule
11191 Schedule type of omp schedule for loops parallelized by parloops (static,
11192 dynamic, guided, auto, runtime).  The default is static.
11194 @item max-ssa-name-query-depth
11195 Maximum depth of recursion when querying properties of SSA names in things
11196 like fold routines.  One level of recursion corresponds to following a
11197 use-def chain.
11198 @end table
11199 @end table
11201 @node Preprocessor Options
11202 @section Options Controlling the Preprocessor
11203 @cindex preprocessor options
11204 @cindex options, preprocessor
11206 These options control the C preprocessor, which is run on each C source
11207 file before actual compilation.
11209 If you use the @option{-E} option, nothing is done except preprocessing.
11210 Some of these options make sense only together with @option{-E} because
11211 they cause the preprocessor output to be unsuitable for actual
11212 compilation.
11214 @table @gcctabopt
11215 @item -Wp,@var{option}
11216 @opindex Wp
11217 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11218 and pass @var{option} directly through to the preprocessor.  If
11219 @var{option} contains commas, it is split into multiple options at the
11220 commas.  However, many options are modified, translated or interpreted
11221 by the compiler driver before being passed to the preprocessor, and
11222 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11223 interface is undocumented and subject to change, so whenever possible
11224 you should avoid using @option{-Wp} and let the driver handle the
11225 options instead.
11227 @item -Xpreprocessor @var{option}
11228 @opindex Xpreprocessor
11229 Pass @var{option} as an option to the preprocessor.  You can use this to
11230 supply system-specific preprocessor options that GCC does not 
11231 recognize.
11233 If you want to pass an option that takes an argument, you must use
11234 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11236 @item -no-integrated-cpp
11237 @opindex no-integrated-cpp
11238 Perform preprocessing as a separate pass before compilation.
11239 By default, GCC performs preprocessing as an integrated part of
11240 input tokenization and parsing.
11241 If this option is provided, the appropriate language front end
11242 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11243 and Objective-C, respectively) is instead invoked twice,
11244 once for preprocessing only and once for actual compilation
11245 of the preprocessed input.
11246 This option may be useful in conjunction with the @option{-B} or
11247 @option{-wrapper} options to specify an alternate preprocessor or
11248 perform additional processing of the program source between
11249 normal preprocessing and compilation.
11250 @end table
11252 @include cppopts.texi
11254 @node Assembler Options
11255 @section Passing Options to the Assembler
11257 @c prevent bad page break with this line
11258 You can pass options to the assembler.
11260 @table @gcctabopt
11261 @item -Wa,@var{option}
11262 @opindex Wa
11263 Pass @var{option} as an option to the assembler.  If @var{option}
11264 contains commas, it is split into multiple options at the commas.
11266 @item -Xassembler @var{option}
11267 @opindex Xassembler
11268 Pass @var{option} as an option to the assembler.  You can use this to
11269 supply system-specific assembler options that GCC does not
11270 recognize.
11272 If you want to pass an option that takes an argument, you must use
11273 @option{-Xassembler} twice, once for the option and once for the argument.
11275 @end table
11277 @node Link Options
11278 @section Options for Linking
11279 @cindex link options
11280 @cindex options, linking
11282 These options come into play when the compiler links object files into
11283 an executable output file.  They are meaningless if the compiler is
11284 not doing a link step.
11286 @table @gcctabopt
11287 @cindex file names
11288 @item @var{object-file-name}
11289 A file name that does not end in a special recognized suffix is
11290 considered to name an object file or library.  (Object files are
11291 distinguished from libraries by the linker according to the file
11292 contents.)  If linking is done, these object files are used as input
11293 to the linker.
11295 @item -c
11296 @itemx -S
11297 @itemx -E
11298 @opindex c
11299 @opindex S
11300 @opindex E
11301 If any of these options is used, then the linker is not run, and
11302 object file names should not be used as arguments.  @xref{Overall
11303 Options}.
11305 @item -fuse-ld=bfd
11306 @opindex fuse-ld=bfd
11307 Use the @command{bfd} linker instead of the default linker.
11309 @item -fuse-ld=gold
11310 @opindex fuse-ld=gold
11311 Use the @command{gold} linker instead of the default linker.
11313 @cindex Libraries
11314 @item -l@var{library}
11315 @itemx -l @var{library}
11316 @opindex l
11317 Search the library named @var{library} when linking.  (The second
11318 alternative with the library as a separate argument is only for
11319 POSIX compliance and is not recommended.)
11321 It makes a difference where in the command you write this option; the
11322 linker searches and processes libraries and object files in the order they
11323 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11324 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11325 to functions in @samp{z}, those functions may not be loaded.
11327 The linker searches a standard list of directories for the library,
11328 which is actually a file named @file{lib@var{library}.a}.  The linker
11329 then uses this file as if it had been specified precisely by name.
11331 The directories searched include several standard system directories
11332 plus any that you specify with @option{-L}.
11334 Normally the files found this way are library files---archive files
11335 whose members are object files.  The linker handles an archive file by
11336 scanning through it for members which define symbols that have so far
11337 been referenced but not defined.  But if the file that is found is an
11338 ordinary object file, it is linked in the usual fashion.  The only
11339 difference between using an @option{-l} option and specifying a file name
11340 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11341 and searches several directories.
11343 @item -lobjc
11344 @opindex lobjc
11345 You need this special case of the @option{-l} option in order to
11346 link an Objective-C or Objective-C++ program.
11348 @item -nostartfiles
11349 @opindex nostartfiles
11350 Do not use the standard system startup files when linking.
11351 The standard system libraries are used normally, unless @option{-nostdlib}
11352 or @option{-nodefaultlibs} is used.
11354 @item -nodefaultlibs
11355 @opindex nodefaultlibs
11356 Do not use the standard system libraries when linking.
11357 Only the libraries you specify are passed to the linker, and options
11358 specifying linkage of the system libraries, such as @option{-static-libgcc}
11359 or @option{-shared-libgcc}, are ignored.  
11360 The standard startup files are used normally, unless @option{-nostartfiles}
11361 is used.  
11363 The compiler may generate calls to @code{memcmp},
11364 @code{memset}, @code{memcpy} and @code{memmove}.
11365 These entries are usually resolved by entries in
11366 libc.  These entry points should be supplied through some other
11367 mechanism when this option is specified.
11369 @item -nostdlib
11370 @opindex nostdlib
11371 Do not use the standard system startup files or libraries when linking.
11372 No startup files and only the libraries you specify are passed to
11373 the linker, and options specifying linkage of the system libraries, such as
11374 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11376 The compiler may generate calls to @code{memcmp}, @code{memset},
11377 @code{memcpy} and @code{memmove}.
11378 These entries are usually resolved by entries in
11379 libc.  These entry points should be supplied through some other
11380 mechanism when this option is specified.
11382 @cindex @option{-lgcc}, use with @option{-nostdlib}
11383 @cindex @option{-nostdlib} and unresolved references
11384 @cindex unresolved references and @option{-nostdlib}
11385 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11386 @cindex @option{-nodefaultlibs} and unresolved references
11387 @cindex unresolved references and @option{-nodefaultlibs}
11388 One of the standard libraries bypassed by @option{-nostdlib} and
11389 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11390 which GCC uses to overcome shortcomings of particular machines, or special
11391 needs for some languages.
11392 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11393 Collection (GCC) Internals},
11394 for more discussion of @file{libgcc.a}.)
11395 In most cases, you need @file{libgcc.a} even when you want to avoid
11396 other standard libraries.  In other words, when you specify @option{-nostdlib}
11397 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11398 This ensures that you have no unresolved references to internal GCC
11399 library subroutines.
11400 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11401 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11402 GNU Compiler Collection (GCC) Internals}.)
11404 @item -pie
11405 @opindex pie
11406 Produce a position independent executable on targets that support it.
11407 For predictable results, you must also specify the same set of options
11408 used for compilation (@option{-fpie}, @option{-fPIE},
11409 or model suboptions) when you specify this linker option.
11411 @item -no-pie
11412 @opindex no-pie
11413 Don't produce a position independent executable.
11415 @item -rdynamic
11416 @opindex rdynamic
11417 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11418 that support it. This instructs the linker to add all symbols, not
11419 only used ones, to the dynamic symbol table. This option is needed
11420 for some uses of @code{dlopen} or to allow obtaining backtraces
11421 from within a program.
11423 @item -s
11424 @opindex s
11425 Remove all symbol table and relocation information from the executable.
11427 @item -static
11428 @opindex static
11429 On systems that support dynamic linking, this prevents linking with the shared
11430 libraries.  On other systems, this option has no effect.
11432 @item -shared
11433 @opindex shared
11434 Produce a shared object which can then be linked with other objects to
11435 form an executable.  Not all systems support this option.  For predictable
11436 results, you must also specify the same set of options used for compilation
11437 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11438 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11439 needs to build supplementary stub code for constructors to work.  On
11440 multi-libbed systems, @samp{gcc -shared} must select the correct support
11441 libraries to link against.  Failing to supply the correct flags may lead
11442 to subtle defects.  Supplying them in cases where they are not necessary
11443 is innocuous.}
11445 @item -shared-libgcc
11446 @itemx -static-libgcc
11447 @opindex shared-libgcc
11448 @opindex static-libgcc
11449 On systems that provide @file{libgcc} as a shared library, these options
11450 force the use of either the shared or static version, respectively.
11451 If no shared version of @file{libgcc} was built when the compiler was
11452 configured, these options have no effect.
11454 There are several situations in which an application should use the
11455 shared @file{libgcc} instead of the static version.  The most common
11456 of these is when the application wishes to throw and catch exceptions
11457 across different shared libraries.  In that case, each of the libraries
11458 as well as the application itself should use the shared @file{libgcc}.
11460 Therefore, the G++ and GCJ drivers automatically add
11461 @option{-shared-libgcc} whenever you build a shared library or a main
11462 executable, because C++ and Java programs typically use exceptions, so
11463 this is the right thing to do.
11465 If, instead, you use the GCC driver to create shared libraries, you may
11466 find that they are not always linked with the shared @file{libgcc}.
11467 If GCC finds, at its configuration time, that you have a non-GNU linker
11468 or a GNU linker that does not support option @option{--eh-frame-hdr},
11469 it links the shared version of @file{libgcc} into shared libraries
11470 by default.  Otherwise, it takes advantage of the linker and optimizes
11471 away the linking with the shared version of @file{libgcc}, linking with
11472 the static version of libgcc by default.  This allows exceptions to
11473 propagate through such shared libraries, without incurring relocation
11474 costs at library load time.
11476 However, if a library or main executable is supposed to throw or catch
11477 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11478 for the languages used in the program, or using the option
11479 @option{-shared-libgcc}, such that it is linked with the shared
11480 @file{libgcc}.
11482 @item -static-libasan
11483 @opindex static-libasan
11484 When the @option{-fsanitize=address} option is used to link a program,
11485 the GCC driver automatically links against @option{libasan}.  If
11486 @file{libasan} is available as a shared library, and the @option{-static}
11487 option is not used, then this links against the shared version of
11488 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11489 driver to link @file{libasan} statically, without necessarily linking
11490 other libraries statically.
11492 @item -static-libtsan
11493 @opindex static-libtsan
11494 When the @option{-fsanitize=thread} option is used to link a program,
11495 the GCC driver automatically links against @option{libtsan}.  If
11496 @file{libtsan} is available as a shared library, and the @option{-static}
11497 option is not used, then this links against the shared version of
11498 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11499 driver to link @file{libtsan} statically, without necessarily linking
11500 other libraries statically.
11502 @item -static-liblsan
11503 @opindex static-liblsan
11504 When the @option{-fsanitize=leak} option is used to link a program,
11505 the GCC driver automatically links against @option{liblsan}.  If
11506 @file{liblsan} is available as a shared library, and the @option{-static}
11507 option is not used, then this links against the shared version of
11508 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11509 driver to link @file{liblsan} statically, without necessarily linking
11510 other libraries statically.
11512 @item -static-libubsan
11513 @opindex static-libubsan
11514 When the @option{-fsanitize=undefined} option is used to link a program,
11515 the GCC driver automatically links against @option{libubsan}.  If
11516 @file{libubsan} is available as a shared library, and the @option{-static}
11517 option is not used, then this links against the shared version of
11518 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11519 driver to link @file{libubsan} statically, without necessarily linking
11520 other libraries statically.
11522 @item -static-libmpx
11523 @opindex static-libmpx
11524 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11525 used to link a program, the GCC driver automatically links against
11526 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11527 and the @option{-static} option is not used, then this links against
11528 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11529 option directs the GCC driver to link @file{libmpx} statically,
11530 without necessarily linking other libraries statically.
11532 @item -static-libmpxwrappers
11533 @opindex static-libmpxwrappers
11534 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11535 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11536 GCC driver automatically links against @file{libmpxwrappers}.  If
11537 @file{libmpxwrappers} is available as a shared library, and the
11538 @option{-static} option is not used, then this links against the shared
11539 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11540 option directs the GCC driver to link @file{libmpxwrappers} statically,
11541 without necessarily linking other libraries statically.
11543 @item -static-libstdc++
11544 @opindex static-libstdc++
11545 When the @command{g++} program is used to link a C++ program, it
11546 normally automatically links against @option{libstdc++}.  If
11547 @file{libstdc++} is available as a shared library, and the
11548 @option{-static} option is not used, then this links against the
11549 shared version of @file{libstdc++}.  That is normally fine.  However, it
11550 is sometimes useful to freeze the version of @file{libstdc++} used by
11551 the program without going all the way to a fully static link.  The
11552 @option{-static-libstdc++} option directs the @command{g++} driver to
11553 link @file{libstdc++} statically, without necessarily linking other
11554 libraries statically.
11556 @item -symbolic
11557 @opindex symbolic
11558 Bind references to global symbols when building a shared object.  Warn
11559 about any unresolved references (unless overridden by the link editor
11560 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11561 this option.
11563 @item -T @var{script}
11564 @opindex T
11565 @cindex linker script
11566 Use @var{script} as the linker script.  This option is supported by most
11567 systems using the GNU linker.  On some targets, such as bare-board
11568 targets without an operating system, the @option{-T} option may be required
11569 when linking to avoid references to undefined symbols.
11571 @item -Xlinker @var{option}
11572 @opindex Xlinker
11573 Pass @var{option} as an option to the linker.  You can use this to
11574 supply system-specific linker options that GCC does not recognize.
11576 If you want to pass an option that takes a separate argument, you must use
11577 @option{-Xlinker} twice, once for the option and once for the argument.
11578 For example, to pass @option{-assert definitions}, you must write
11579 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11580 @option{-Xlinker "-assert definitions"}, because this passes the entire
11581 string as a single argument, which is not what the linker expects.
11583 When using the GNU linker, it is usually more convenient to pass
11584 arguments to linker options using the @option{@var{option}=@var{value}}
11585 syntax than as separate arguments.  For example, you can specify
11586 @option{-Xlinker -Map=output.map} rather than
11587 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11588 this syntax for command-line options.
11590 @item -Wl,@var{option}
11591 @opindex Wl
11592 Pass @var{option} as an option to the linker.  If @var{option} contains
11593 commas, it is split into multiple options at the commas.  You can use this
11594 syntax to pass an argument to the option.
11595 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11596 linker.  When using the GNU linker, you can also get the same effect with
11597 @option{-Wl,-Map=output.map}.
11599 @item -u @var{symbol}
11600 @opindex u
11601 Pretend the symbol @var{symbol} is undefined, to force linking of
11602 library modules to define it.  You can use @option{-u} multiple times with
11603 different symbols to force loading of additional library modules.
11605 @item -z @var{keyword}
11606 @opindex z
11607 @option{-z} is passed directly on to the linker along with the keyword
11608 @var{keyword}. See the section in the documentation of your linker for
11609 permitted values and their meanings.
11610 @end table
11612 @node Directory Options
11613 @section Options for Directory Search
11614 @cindex directory options
11615 @cindex options, directory search
11616 @cindex search path
11618 These options specify directories to search for header files, for
11619 libraries and for parts of the compiler:
11621 @table @gcctabopt
11622 @item -I@var{dir}
11623 @opindex I
11624 Add the directory @var{dir} to the head of the list of directories to be
11625 searched for header files.  This can be used to override a system header
11626 file, substituting your own version, since these directories are
11627 searched before the system header file directories.  However, you should
11628 not use this option to add directories that contain vendor-supplied
11629 system header files (use @option{-isystem} for that).  If you use more than
11630 one @option{-I} option, the directories are scanned in left-to-right
11631 order; the standard system directories come after.
11633 If a standard system include directory, or a directory specified with
11634 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11635 option is ignored.  The directory is still searched but as a
11636 system directory at its normal position in the system include chain.
11637 This is to ensure that GCC's procedure to fix buggy system headers and
11638 the ordering for the @code{include_next} directive are not inadvertently changed.
11639 If you really need to change the search order for system directories,
11640 use the @option{-nostdinc} and/or @option{-isystem} options.
11642 @item -iplugindir=@var{dir}
11643 @opindex iplugindir=
11644 Set the directory to search for plugins that are passed
11645 by @option{-fplugin=@var{name}} instead of
11646 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11647 to be used by the user, but only passed by the driver.
11649 @item -iquote@var{dir}
11650 @opindex iquote
11651 Add the directory @var{dir} to the head of the list of directories to
11652 be searched for header files only for the case of @code{#include
11653 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11654 otherwise just like @option{-I}.
11656 @item -L@var{dir}
11657 @opindex L
11658 Add directory @var{dir} to the list of directories to be searched
11659 for @option{-l}.
11661 @item -B@var{prefix}
11662 @opindex B
11663 This option specifies where to find the executables, libraries,
11664 include files, and data files of the compiler itself.
11666 The compiler driver program runs one or more of the subprograms
11667 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11668 @var{prefix} as a prefix for each program it tries to run, both with and
11669 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11671 For each subprogram to be run, the compiler driver first tries the
11672 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11673 is not specified, the driver tries two standard prefixes, 
11674 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11675 those results in a file name that is found, the unmodified program
11676 name is searched for using the directories specified in your
11677 @env{PATH} environment variable.
11679 The compiler checks to see if the path provided by @option{-B}
11680 refers to a directory, and if necessary it adds a directory
11681 separator character at the end of the path.
11683 @option{-B} prefixes that effectively specify directory names also apply
11684 to libraries in the linker, because the compiler translates these
11685 options into @option{-L} options for the linker.  They also apply to
11686 include files in the preprocessor, because the compiler translates these
11687 options into @option{-isystem} options for the preprocessor.  In this case,
11688 the compiler appends @samp{include} to the prefix.
11690 The runtime support file @file{libgcc.a} can also be searched for using
11691 the @option{-B} prefix, if needed.  If it is not found there, the two
11692 standard prefixes above are tried, and that is all.  The file is left
11693 out of the link if it is not found by those means.
11695 Another way to specify a prefix much like the @option{-B} prefix is to use
11696 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11697 Variables}.
11699 As a special kludge, if the path provided by @option{-B} is
11700 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11701 9, then it is replaced by @file{[dir/]include}.  This is to help
11702 with boot-strapping the compiler.
11704 @item -specs=@var{file}
11705 @opindex specs
11706 Process @var{file} after the compiler reads in the standard @file{specs}
11707 file, in order to override the defaults which the @command{gcc} driver
11708 program uses when determining what switches to pass to @command{cc1},
11709 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11710 @option{-specs=@var{file}} can be specified on the command line, and they
11711 are processed in order, from left to right.
11713 @item --sysroot=@var{dir}
11714 @opindex sysroot
11715 Use @var{dir} as the logical root directory for headers and libraries.
11716 For example, if the compiler normally searches for headers in
11717 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11718 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11720 If you use both this option and the @option{-isysroot} option, then
11721 the @option{--sysroot} option applies to libraries, but the
11722 @option{-isysroot} option applies to header files.
11724 The GNU linker (beginning with version 2.16) has the necessary support
11725 for this option.  If your linker does not support this option, the
11726 header file aspect of @option{--sysroot} still works, but the
11727 library aspect does not.
11729 @item --no-sysroot-suffix
11730 @opindex no-sysroot-suffix
11731 For some targets, a suffix is added to the root directory specified
11732 with @option{--sysroot}, depending on the other options used, so that
11733 headers may for example be found in
11734 @file{@var{dir}/@var{suffix}/usr/include} instead of
11735 @file{@var{dir}/usr/include}.  This option disables the addition of
11736 such a suffix.
11738 @item -I-
11739 @opindex I-
11740 This option has been deprecated.  Please use @option{-iquote} instead for
11741 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11742 option.
11743 Any directories you specify with @option{-I} options before the @option{-I-}
11744 option are searched only for the case of @code{#include "@var{file}"};
11745 they are not searched for @code{#include <@var{file}>}.
11747 If additional directories are specified with @option{-I} options after
11748 the @option{-I-} option, these directories are searched for all @code{#include}
11749 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11750 this way.)
11752 In addition, the @option{-I-} option inhibits the use of the current
11753 directory (where the current input file came from) as the first search
11754 directory for @code{#include "@var{file}"}.  There is no way to
11755 override this effect of @option{-I-}.  With @option{-I.} you can specify
11756 searching the directory that is current when the compiler is
11757 invoked.  That is not exactly the same as what the preprocessor does
11758 by default, but it is often satisfactory.
11760 @option{-I-} does not inhibit the use of the standard system directories
11761 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11762 independent.
11763 @end table
11765 @c man end
11767 @node Spec Files
11768 @section Specifying Subprocesses and the Switches to Pass to Them
11769 @cindex Spec Files
11771 @command{gcc} is a driver program.  It performs its job by invoking a
11772 sequence of other programs to do the work of compiling, assembling and
11773 linking.  GCC interprets its command-line parameters and uses these to
11774 deduce which programs it should invoke, and which command-line options
11775 it ought to place on their command lines.  This behavior is controlled
11776 by @dfn{spec strings}.  In most cases there is one spec string for each
11777 program that GCC can invoke, but a few programs have multiple spec
11778 strings to control their behavior.  The spec strings built into GCC can
11779 be overridden by using the @option{-specs=} command-line switch to specify
11780 a spec file.
11782 @dfn{Spec files} are plaintext files that are used to construct spec
11783 strings.  They consist of a sequence of directives separated by blank
11784 lines.  The type of directive is determined by the first non-whitespace
11785 character on the line, which can be one of the following:
11787 @table @code
11788 @item %@var{command}
11789 Issues a @var{command} to the spec file processor.  The commands that can
11790 appear here are:
11792 @table @code
11793 @item %include <@var{file}>
11794 @cindex @code{%include}
11795 Search for @var{file} and insert its text at the current point in the
11796 specs file.
11798 @item %include_noerr <@var{file}>
11799 @cindex @code{%include_noerr}
11800 Just like @samp{%include}, but do not generate an error message if the include
11801 file cannot be found.
11803 @item %rename @var{old_name} @var{new_name}
11804 @cindex @code{%rename}
11805 Rename the spec string @var{old_name} to @var{new_name}.
11807 @end table
11809 @item *[@var{spec_name}]:
11810 This tells the compiler to create, override or delete the named spec
11811 string.  All lines after this directive up to the next directive or
11812 blank line are considered to be the text for the spec string.  If this
11813 results in an empty string then the spec is deleted.  (Or, if the
11814 spec did not exist, then nothing happens.)  Otherwise, if the spec
11815 does not currently exist a new spec is created.  If the spec does
11816 exist then its contents are overridden by the text of this
11817 directive, unless the first character of that text is the @samp{+}
11818 character, in which case the text is appended to the spec.
11820 @item [@var{suffix}]:
11821 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11822 and up to the next directive or blank line are considered to make up the
11823 spec string for the indicated suffix.  When the compiler encounters an
11824 input file with the named suffix, it processes the spec string in
11825 order to work out how to compile that file.  For example:
11827 @smallexample
11828 .ZZ:
11829 z-compile -input %i
11830 @end smallexample
11832 This says that any input file whose name ends in @samp{.ZZ} should be
11833 passed to the program @samp{z-compile}, which should be invoked with the
11834 command-line switch @option{-input} and with the result of performing the
11835 @samp{%i} substitution.  (See below.)
11837 As an alternative to providing a spec string, the text following a
11838 suffix directive can be one of the following:
11840 @table @code
11841 @item @@@var{language}
11842 This says that the suffix is an alias for a known @var{language}.  This is
11843 similar to using the @option{-x} command-line switch to GCC to specify a
11844 language explicitly.  For example:
11846 @smallexample
11847 .ZZ:
11848 @@c++
11849 @end smallexample
11851 Says that .ZZ files are, in fact, C++ source files.
11853 @item #@var{name}
11854 This causes an error messages saying:
11856 @smallexample
11857 @var{name} compiler not installed on this system.
11858 @end smallexample
11859 @end table
11861 GCC already has an extensive list of suffixes built into it.
11862 This directive adds an entry to the end of the list of suffixes, but
11863 since the list is searched from the end backwards, it is effectively
11864 possible to override earlier entries using this technique.
11866 @end table
11868 GCC has the following spec strings built into it.  Spec files can
11869 override these strings or create their own.  Note that individual
11870 targets can also add their own spec strings to this list.
11872 @smallexample
11873 asm          Options to pass to the assembler
11874 asm_final    Options to pass to the assembler post-processor
11875 cpp          Options to pass to the C preprocessor
11876 cc1          Options to pass to the C compiler
11877 cc1plus      Options to pass to the C++ compiler
11878 endfile      Object files to include at the end of the link
11879 link         Options to pass to the linker
11880 lib          Libraries to include on the command line to the linker
11881 libgcc       Decides which GCC support library to pass to the linker
11882 linker       Sets the name of the linker
11883 predefines   Defines to be passed to the C preprocessor
11884 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11885              by default
11886 startfile    Object files to include at the start of the link
11887 @end smallexample
11889 Here is a small example of a spec file:
11891 @smallexample
11892 %rename lib                 old_lib
11894 *lib:
11895 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11896 @end smallexample
11898 This example renames the spec called @samp{lib} to @samp{old_lib} and
11899 then overrides the previous definition of @samp{lib} with a new one.
11900 The new definition adds in some extra command-line options before
11901 including the text of the old definition.
11903 @dfn{Spec strings} are a list of command-line options to be passed to their
11904 corresponding program.  In addition, the spec strings can contain
11905 @samp{%}-prefixed sequences to substitute variable text or to
11906 conditionally insert text into the command line.  Using these constructs
11907 it is possible to generate quite complex command lines.
11909 Here is a table of all defined @samp{%}-sequences for spec
11910 strings.  Note that spaces are not generated automatically around the
11911 results of expanding these sequences.  Therefore you can concatenate them
11912 together or combine them with constant text in a single argument.
11914 @table @code
11915 @item %%
11916 Substitute one @samp{%} into the program name or argument.
11918 @item %i
11919 Substitute the name of the input file being processed.
11921 @item %b
11922 Substitute the basename of the input file being processed.
11923 This is the substring up to (and not including) the last period
11924 and not including the directory.
11926 @item %B
11927 This is the same as @samp{%b}, but include the file suffix (text after
11928 the last period).
11930 @item %d
11931 Marks the argument containing or following the @samp{%d} as a
11932 temporary file name, so that that file is deleted if GCC exits
11933 successfully.  Unlike @samp{%g}, this contributes no text to the
11934 argument.
11936 @item %g@var{suffix}
11937 Substitute a file name that has suffix @var{suffix} and is chosen
11938 once per compilation, and mark the argument in the same way as
11939 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11940 name is now chosen in a way that is hard to predict even when previously
11941 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11942 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11943 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11944 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11945 was simply substituted with a file name chosen once per compilation,
11946 without regard to any appended suffix (which was therefore treated
11947 just like ordinary text), making such attacks more likely to succeed.
11949 @item %u@var{suffix}
11950 Like @samp{%g}, but generates a new temporary file name
11951 each time it appears instead of once per compilation.
11953 @item %U@var{suffix}
11954 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11955 new one if there is no such last file name.  In the absence of any
11956 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11957 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11958 involves the generation of two distinct file names, one
11959 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11960 simply substituted with a file name chosen for the previous @samp{%u},
11961 without regard to any appended suffix.
11963 @item %j@var{suffix}
11964 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11965 writable, and if @option{-save-temps} is not used; 
11966 otherwise, substitute the name
11967 of a temporary file, just like @samp{%u}.  This temporary file is not
11968 meant for communication between processes, but rather as a junk
11969 disposal mechanism.
11971 @item %|@var{suffix}
11972 @itemx %m@var{suffix}
11973 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11974 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11975 all.  These are the two most common ways to instruct a program that it
11976 should read from standard input or write to standard output.  If you
11977 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11978 construct: see for example @file{f/lang-specs.h}.
11980 @item %.@var{SUFFIX}
11981 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11982 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11983 terminated by the next space or %.
11985 @item %w
11986 Marks the argument containing or following the @samp{%w} as the
11987 designated output file of this compilation.  This puts the argument
11988 into the sequence of arguments that @samp{%o} substitutes.
11990 @item %o
11991 Substitutes the names of all the output files, with spaces
11992 automatically placed around them.  You should write spaces
11993 around the @samp{%o} as well or the results are undefined.
11994 @samp{%o} is for use in the specs for running the linker.
11995 Input files whose names have no recognized suffix are not compiled
11996 at all, but they are included among the output files, so they are
11997 linked.
11999 @item %O
12000 Substitutes the suffix for object files.  Note that this is
12001 handled specially when it immediately follows @samp{%g, %u, or %U},
12002 because of the need for those to form complete file names.  The
12003 handling is such that @samp{%O} is treated exactly as if it had already
12004 been substituted, except that @samp{%g, %u, and %U} do not currently
12005 support additional @var{suffix} characters following @samp{%O} as they do
12006 following, for example, @samp{.o}.
12008 @item %p
12009 Substitutes the standard macro predefinitions for the
12010 current target machine.  Use this when running @command{cpp}.
12012 @item %P
12013 Like @samp{%p}, but puts @samp{__} before and after the name of each
12014 predefined macro, except for macros that start with @samp{__} or with
12015 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
12018 @item %I
12019 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
12020 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
12021 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
12022 and @option{-imultilib} as necessary.
12024 @item %s
12025 Current argument is the name of a library or startup file of some sort.
12026 Search for that file in a standard list of directories and substitute
12027 the full name found.  The current working directory is included in the
12028 list of directories scanned.
12030 @item %T
12031 Current argument is the name of a linker script.  Search for that file
12032 in the current list of directories to scan for libraries. If the file
12033 is located insert a @option{--script} option into the command line
12034 followed by the full path name found.  If the file is not found then
12035 generate an error message.  Note: the current working directory is not
12036 searched.
12038 @item %e@var{str}
12039 Print @var{str} as an error message.  @var{str} is terminated by a newline.
12040 Use this when inconsistent options are detected.
12042 @item %(@var{name})
12043 Substitute the contents of spec string @var{name} at this point.
12045 @item %x@{@var{option}@}
12046 Accumulate an option for @samp{%X}.
12048 @item %X
12049 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
12050 spec string.
12052 @item %Y
12053 Output the accumulated assembler options specified by @option{-Wa}.
12055 @item %Z
12056 Output the accumulated preprocessor options specified by @option{-Wp}.
12058 @item %a
12059 Process the @code{asm} spec.  This is used to compute the
12060 switches to be passed to the assembler.
12062 @item %A
12063 Process the @code{asm_final} spec.  This is a spec string for
12064 passing switches to an assembler post-processor, if such a program is
12065 needed.
12067 @item %l
12068 Process the @code{link} spec.  This is the spec for computing the
12069 command line passed to the linker.  Typically it makes use of the
12070 @samp{%L %G %S %D and %E} sequences.
12072 @item %D
12073 Dump out a @option{-L} option for each directory that GCC believes might
12074 contain startup files.  If the target supports multilibs then the
12075 current multilib directory is prepended to each of these paths.
12077 @item %L
12078 Process the @code{lib} spec.  This is a spec string for deciding which
12079 libraries are included on the command line to the linker.
12081 @item %G
12082 Process the @code{libgcc} spec.  This is a spec string for deciding
12083 which GCC support library is included on the command line to the linker.
12085 @item %S
12086 Process the @code{startfile} spec.  This is a spec for deciding which
12087 object files are the first ones passed to the linker.  Typically
12088 this might be a file named @file{crt0.o}.
12090 @item %E
12091 Process the @code{endfile} spec.  This is a spec string that specifies
12092 the last object files that are passed to the linker.
12094 @item %C
12095 Process the @code{cpp} spec.  This is used to construct the arguments
12096 to be passed to the C preprocessor.
12098 @item %1
12099 Process the @code{cc1} spec.  This is used to construct the options to be
12100 passed to the actual C compiler (@command{cc1}).
12102 @item %2
12103 Process the @code{cc1plus} spec.  This is used to construct the options to be
12104 passed to the actual C++ compiler (@command{cc1plus}).
12106 @item %*
12107 Substitute the variable part of a matched option.  See below.
12108 Note that each comma in the substituted string is replaced by
12109 a single space.
12111 @item %<@code{S}
12112 Remove all occurrences of @code{-S} from the command line.  Note---this
12113 command is position dependent.  @samp{%} commands in the spec string
12114 before this one see @code{-S}, @samp{%} commands in the spec string
12115 after this one do not.
12117 @item %:@var{function}(@var{args})
12118 Call the named function @var{function}, passing it @var{args}.
12119 @var{args} is first processed as a nested spec string, then split
12120 into an argument vector in the usual fashion.  The function returns
12121 a string which is processed as if it had appeared literally as part
12122 of the current spec.
12124 The following built-in spec functions are provided:
12126 @table @code
12127 @item @code{getenv}
12128 The @code{getenv} spec function takes two arguments: an environment
12129 variable name and a string.  If the environment variable is not
12130 defined, a fatal error is issued.  Otherwise, the return value is the
12131 value of the environment variable concatenated with the string.  For
12132 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
12134 @smallexample
12135 %:getenv(TOPDIR /include)
12136 @end smallexample
12138 expands to @file{/path/to/top/include}.
12140 @item @code{if-exists}
12141 The @code{if-exists} spec function takes one argument, an absolute
12142 pathname to a file.  If the file exists, @code{if-exists} returns the
12143 pathname.  Here is a small example of its usage:
12145 @smallexample
12146 *startfile:
12147 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
12148 @end smallexample
12150 @item @code{if-exists-else}
12151 The @code{if-exists-else} spec function is similar to the @code{if-exists}
12152 spec function, except that it takes two arguments.  The first argument is
12153 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
12154 returns the pathname.  If it does not exist, it returns the second argument.
12155 This way, @code{if-exists-else} can be used to select one file or another,
12156 based on the existence of the first.  Here is a small example of its usage:
12158 @smallexample
12159 *startfile:
12160 crt0%O%s %:if-exists(crti%O%s) \
12161 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
12162 @end smallexample
12164 @item @code{replace-outfile}
12165 The @code{replace-outfile} spec function takes two arguments.  It looks for the
12166 first argument in the outfiles array and replaces it with the second argument.  Here
12167 is a small example of its usage:
12169 @smallexample
12170 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
12171 @end smallexample
12173 @item @code{remove-outfile}
12174 The @code{remove-outfile} spec function takes one argument.  It looks for the
12175 first argument in the outfiles array and removes it.  Here is a small example
12176 its usage:
12178 @smallexample
12179 %:remove-outfile(-lm)
12180 @end smallexample
12182 @item @code{pass-through-libs}
12183 The @code{pass-through-libs} spec function takes any number of arguments.  It
12184 finds any @option{-l} options and any non-options ending in @file{.a} (which it
12185 assumes are the names of linker input library archive files) and returns a
12186 result containing all the found arguments each prepended by
12187 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
12188 intended to be passed to the LTO linker plugin.
12190 @smallexample
12191 %:pass-through-libs(%G %L %G)
12192 @end smallexample
12194 @item @code{print-asm-header}
12195 The @code{print-asm-header} function takes no arguments and simply
12196 prints a banner like:
12198 @smallexample
12199 Assembler options
12200 =================
12202 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12203 @end smallexample
12205 It is used to separate compiler options from assembler options
12206 in the @option{--target-help} output.
12207 @end table
12209 @item %@{@code{S}@}
12210 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12211 If that switch is not specified, this substitutes nothing.  Note that
12212 the leading dash is omitted when specifying this option, and it is
12213 automatically inserted if the substitution is performed.  Thus the spec
12214 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12215 and outputs the command-line option @option{-foo}.
12217 @item %W@{@code{S}@}
12218 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12219 deleted on failure.
12221 @item %@{@code{S}*@}
12222 Substitutes all the switches specified to GCC whose names start
12223 with @code{-S}, but which also take an argument.  This is used for
12224 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12225 GCC considers @option{-o foo} as being
12226 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12227 text, including the space.  Thus two arguments are generated.
12229 @item %@{@code{S}*&@code{T}*@}
12230 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12231 (the order of @code{S} and @code{T} in the spec is not significant).
12232 There can be any number of ampersand-separated variables; for each the
12233 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12235 @item %@{@code{S}:@code{X}@}
12236 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12238 @item %@{!@code{S}:@code{X}@}
12239 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12241 @item %@{@code{S}*:@code{X}@}
12242 Substitutes @code{X} if one or more switches whose names start with
12243 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12244 once, no matter how many such switches appeared.  However, if @code{%*}
12245 appears somewhere in @code{X}, then @code{X} is substituted once
12246 for each matching switch, with the @code{%*} replaced by the part of
12247 that switch matching the @code{*}.
12249 If @code{%*} appears as the last part of a spec sequence then a space
12250 is added after the end of the last substitution.  If there is more
12251 text in the sequence, however, then a space is not generated.  This
12252 allows the @code{%*} substitution to be used as part of a larger
12253 string.  For example, a spec string like this:
12255 @smallexample
12256 %@{mcu=*:--script=%*/memory.ld@}
12257 @end smallexample
12259 @noindent
12260 when matching an option like @option{-mcu=newchip} produces:
12262 @smallexample
12263 --script=newchip/memory.ld
12264 @end smallexample
12266 @item %@{.@code{S}:@code{X}@}
12267 Substitutes @code{X}, if processing a file with suffix @code{S}.
12269 @item %@{!.@code{S}:@code{X}@}
12270 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12272 @item %@{,@code{S}:@code{X}@}
12273 Substitutes @code{X}, if processing a file for language @code{S}.
12275 @item %@{!,@code{S}:@code{X}@}
12276 Substitutes @code{X}, if not processing a file for language @code{S}.
12278 @item %@{@code{S}|@code{P}:@code{X}@}
12279 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12280 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12281 @code{*} sequences as well, although they have a stronger binding than
12282 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12283 alternatives must be starred, and only the first matching alternative
12284 is substituted.
12286 For example, a spec string like this:
12288 @smallexample
12289 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12290 @end smallexample
12292 @noindent
12293 outputs the following command-line options from the following input
12294 command-line options:
12296 @smallexample
12297 fred.c        -foo -baz
12298 jim.d         -bar -boggle
12299 -d fred.c     -foo -baz -boggle
12300 -d jim.d      -bar -baz -boggle
12301 @end smallexample
12303 @item %@{S:X; T:Y; :D@}
12305 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12306 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12307 be as many clauses as you need.  This may be combined with @code{.},
12308 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12311 @end table
12313 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12314 construct may contain other nested @samp{%} constructs or spaces, or
12315 even newlines.  They are processed as usual, as described above.
12316 Trailing white space in @code{X} is ignored.  White space may also
12317 appear anywhere on the left side of the colon in these constructs,
12318 except between @code{.} or @code{*} and the corresponding word.
12320 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12321 handled specifically in these constructs.  If another value of
12322 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12323 @option{-W} switch is found later in the command line, the earlier
12324 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12325 just one letter, which passes all matching options.
12327 The character @samp{|} at the beginning of the predicate text is used to
12328 indicate that a command should be piped to the following command, but
12329 only if @option{-pipe} is specified.
12331 It is built into GCC which switches take arguments and which do not.
12332 (You might think it would be useful to generalize this to allow each
12333 compiler's spec to say which switches take arguments.  But this cannot
12334 be done in a consistent fashion.  GCC cannot even decide which input
12335 files have been specified without knowing which switches take arguments,
12336 and it must know which input files to compile in order to tell which
12337 compilers to run).
12339 GCC also knows implicitly that arguments starting in @option{-l} are to be
12340 treated as compiler output files, and passed to the linker in their
12341 proper position among the other output files.
12343 @c man begin OPTIONS
12345 @node Target Options
12346 @section Specifying Target Machine and Compiler Version
12347 @cindex target options
12348 @cindex cross compiling
12349 @cindex specifying machine version
12350 @cindex specifying compiler version and target machine
12351 @cindex compiler version, specifying
12352 @cindex target machine, specifying
12354 The usual way to run GCC is to run the executable called @command{gcc}, or
12355 @command{@var{machine}-gcc} when cross-compiling, or
12356 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12357 one that was installed last.
12359 @node Submodel Options
12360 @section Hardware Models and Configurations
12361 @cindex submodel options
12362 @cindex specifying hardware config
12363 @cindex hardware models and configurations, specifying
12364 @cindex machine dependent options
12366 Each target machine types can have its own
12367 special options, starting with @samp{-m}, to choose among various
12368 hardware models or configurations---for example, 68010 vs 68020,
12369 floating coprocessor or none.  A single installed version of the
12370 compiler can compile for any model or configuration, according to the
12371 options specified.
12373 Some configurations of the compiler also support additional special
12374 options, usually for compatibility with other compilers on the same
12375 platform.
12377 @c This list is ordered alphanumerically by subsection name.
12378 @c It should be the same order and spelling as these options are listed
12379 @c in Machine Dependent Options
12381 @menu
12382 * AArch64 Options::
12383 * Adapteva Epiphany Options::
12384 * ARC Options::
12385 * ARM Options::
12386 * AVR Options::
12387 * Blackfin Options::
12388 * C6X Options::
12389 * CRIS Options::
12390 * CR16 Options::
12391 * Darwin Options::
12392 * DEC Alpha Options::
12393 * FR30 Options::
12394 * FT32 Options::
12395 * FRV Options::
12396 * GNU/Linux Options::
12397 * H8/300 Options::
12398 * HPPA Options::
12399 * IA-64 Options::
12400 * LM32 Options::
12401 * M32C Options::
12402 * M32R/D Options::
12403 * M680x0 Options::
12404 * MCore Options::
12405 * MeP Options::
12406 * MicroBlaze Options::
12407 * MIPS Options::
12408 * MMIX Options::
12409 * MN10300 Options::
12410 * Moxie Options::
12411 * MSP430 Options::
12412 * NDS32 Options::
12413 * Nios II Options::
12414 * Nvidia PTX Options::
12415 * PDP-11 Options::
12416 * picoChip Options::
12417 * PowerPC Options::
12418 * RL78 Options::
12419 * RS/6000 and PowerPC Options::
12420 * RX Options::
12421 * S/390 and zSeries Options::
12422 * Score Options::
12423 * SH Options::
12424 * Solaris 2 Options::
12425 * SPARC Options::
12426 * SPU Options::
12427 * System V Options::
12428 * TILE-Gx Options::
12429 * TILEPro Options::
12430 * V850 Options::
12431 * VAX Options::
12432 * Visium Options::
12433 * VMS Options::
12434 * VxWorks Options::
12435 * x86 Options::
12436 * x86 Windows Options::
12437 * Xstormy16 Options::
12438 * Xtensa Options::
12439 * zSeries Options::
12440 @end menu
12442 @node AArch64 Options
12443 @subsection AArch64 Options
12444 @cindex AArch64 Options
12446 These options are defined for AArch64 implementations:
12448 @table @gcctabopt
12450 @item -mabi=@var{name}
12451 @opindex mabi
12452 Generate code for the specified data model.  Permissible values
12453 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12454 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12455 but long int and pointer are 64-bit.
12457 The default depends on the specific target configuration.  Note that
12458 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12459 entire program with the same ABI, and link with a compatible set of libraries.
12461 @item -mbig-endian
12462 @opindex mbig-endian
12463 Generate big-endian code.  This is the default when GCC is configured for an
12464 @samp{aarch64_be-*-*} target.
12466 @item -mgeneral-regs-only
12467 @opindex mgeneral-regs-only
12468 Generate code which uses only the general-purpose registers.  This is equivalent
12469 to feature modifier @option{nofp} of @option{-march} or @option{-mcpu}, except
12470 that @option{-mgeneral-regs-only} takes precedence over any conflicting feature
12471 modifier regardless of sequence.
12473 @item -mlittle-endian
12474 @opindex mlittle-endian
12475 Generate little-endian code.  This is the default when GCC is configured for an
12476 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12478 @item -mcmodel=tiny
12479 @opindex mcmodel=tiny
12480 Generate code for the tiny code model.  The program and its statically defined
12481 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12482 be statically or dynamically linked.  This model is not fully implemented and
12483 mostly treated as @samp{small}.
12485 @item -mcmodel=small
12486 @opindex mcmodel=small
12487 Generate code for the small code model.  The program and its statically defined
12488 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12489 be statically or dynamically linked.  This is the default code model.
12491 @item -mcmodel=large
12492 @opindex mcmodel=large
12493 Generate code for the large code model.  This makes no assumptions about
12494 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12495 statically linked only.
12497 @item -mstrict-align
12498 @opindex mstrict-align
12499 Do not assume that unaligned memory references are handled by the system.
12501 @item -momit-leaf-frame-pointer
12502 @itemx -mno-omit-leaf-frame-pointer
12503 @opindex momit-leaf-frame-pointer
12504 @opindex mno-omit-leaf-frame-pointer
12505 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12506 default.
12508 @item -mtls-dialect=desc
12509 @opindex mtls-dialect=desc
12510 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12511 of TLS variables.  This is the default.
12513 @item -mtls-dialect=traditional
12514 @opindex mtls-dialect=traditional
12515 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12516 of TLS variables.
12518 @item -mtls-size=@var{size}
12519 @opindex mtls-size
12520 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
12521 This option depends on binutils higher than 2.25.
12523 @item -mfix-cortex-a53-835769
12524 @itemx -mno-fix-cortex-a53-835769
12525 @opindex mfix-cortex-a53-835769
12526 @opindex mno-fix-cortex-a53-835769
12527 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12528 This involves inserting a NOP instruction between memory instructions and
12529 64-bit integer multiply-accumulate instructions.
12531 @item -mfix-cortex-a53-843419
12532 @itemx -mno-fix-cortex-a53-843419
12533 @opindex mfix-cortex-a53-843419
12534 @opindex mno-fix-cortex-a53-843419
12535 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12536 This erratum workaround is made at link time and this will only pass the
12537 corresponding flag to the linker.
12539 @item -mlow-precision-recip-sqrt
12540 @item -mno-low-precision-recip-sqrt
12541 @opindex -mlow-precision-recip-sqrt
12542 @opindex -mno-low-precision-recip-sqrt
12543 The square root estimate uses two steps instead of three for double-precision,
12544 and one step instead of two for single-precision.
12545 Thus reducing latency and precision.
12546 This is only relevant if @option{-ffast-math} activates
12547 reciprocal square root estimate instructions.
12548 Which in turn depends on the target processor.
12550 @item -march=@var{name}
12551 @opindex march
12552 Specify the name of the target architecture, optionally suffixed by one or
12553 more feature modifiers.  This option has the form
12554 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
12556 The permissible values for @var{arch} are @samp{armv8-a} or
12557 @samp{armv8.1-a}.
12559 For the permissible values for @var{feature}, see the sub-section on
12560 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12561 Feature Modifiers}.  Where conflicting feature modifiers are
12562 specified, the right-most feature is used.
12564 Additionally on native AArch64 GNU/Linux systems the value
12565 @samp{native} is available.  This option causes the compiler to pick the
12566 architecture of the host system.  If the compiler is unable to recognize the
12567 architecture of the host system this option has no effect.
12569 GCC uses @var{name} to determine what kind of instructions it can emit
12570 when generating assembly code.  If @option{-march} is specified
12571 without either of @option{-mtune} or @option{-mcpu} also being
12572 specified, the code is tuned to perform well across a range of target
12573 processors implementing the target architecture.
12575 @item -mtune=@var{name}
12576 @opindex mtune
12577 Specify the name of the target processor for which GCC should tune the
12578 performance of the code.  Permissible values for this option are:
12579 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12580 @samp{exynos-m1}, @samp{qdf24xx}, @samp{thunderx}, @samp{xgene1}.
12582 Additionally, this option can specify that GCC should tune the performance
12583 of the code for a big.LITTLE system.  Permissible values for this
12584 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12586 Additionally on native AArch64 GNU/Linux systems the value
12587 @samp{native} is available.  This option causes the compiler to pick
12588 the architecture of and tune the performance of the code for the
12589 processor of the host system.  If the compiler is unable to recognize
12590 the processor of the host system this option has no effect.
12592 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12593 are specified, the code is tuned to perform well across a range
12594 of target processors.
12596 This option cannot be suffixed by feature modifiers.
12598 @item -mcpu=@var{name}
12599 @opindex mcpu
12600 Specify the name of the target processor, optionally suffixed by one
12601 or more feature modifiers.  This option has the form
12602 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
12603 the permissible values for @var{cpu} are the same as those available
12604 for @option{-mtune}.  The permissible values for @var{feature} are
12605 documented in the sub-section on
12606 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12607 Feature Modifiers}.  Where conflicting feature modifiers are
12608 specified, the right-most feature is used.
12610 Additionally on native AArch64 GNU/Linux systems the value
12611 @samp{native} is available.  This option causes the compiler to tune
12612 the performance of the code for the processor of the host system.  If
12613 the compiler is unable to recognize the processor of the host system
12614 this option has no effect.
12616 GCC uses @var{name} to determine what kind of instructions it can emit when
12617 generating assembly code (as if by @option{-march}) and to determine
12618 the target processor for which to tune for performance (as if
12619 by @option{-mtune}).  Where this option is used in conjunction
12620 with @option{-march} or @option{-mtune}, those options take precedence
12621 over the appropriate part of this option.
12623 @item -moverride=@var{string}
12624 @opindex moverride
12625 Override tuning decisions made by the back-end in response to a
12626 @option{-mtune=} switch.  The syntax, semantics, and accepted values
12627 for @var{string} in this option are not guaranteed to be consistent
12628 across releases.
12630 This option is only intended to be useful when developing GCC.
12632 @item -mpc-relative-literal-loads
12633 @opindex mpcrelativeliteralloads
12634 Enable PC relative literal loads. If this option is used, literal
12635 pools are assumed to have a range of up to 1MiB and an appropriate
12636 instruction sequence is used. This option has no impact when used
12637 with @option{-mcmodel=tiny}.
12639 @end table
12641 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12642 @anchor{aarch64-feature-modifiers}
12643 @cindex @option{-march} feature modifiers
12644 @cindex @option{-mcpu} feature modifiers
12645 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
12646 the following and their inverses @option{no@var{feature}}:
12648 @table @samp
12649 @item crc
12650 Enable CRC extension.
12651 @item crypto
12652 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
12653 instructions.
12654 @item fp
12655 Enable floating-point instructions.  This is on by default for all possible
12656 values for options @option{-march} and @option{-mcpu}.
12657 @item simd
12658 Enable Advanced SIMD instructions.  This also enables floating-point
12659 instructions.  This is on by default for all possible values for options
12660 @option{-march} and @option{-mcpu}.
12661 @item lse
12662 Enable Large System Extension instructions.
12663 @item pan
12664 Enable Privileged Access Never support.
12665 @item lor
12666 Enable Limited Ordering Regions support.
12667 @item rdma
12668 Enable ARMv8.1 Advanced SIMD instructions.  This implies Advanced SIMD
12669 is enabled.
12671 @end table
12673 That is, @option{crypto} implies @option{simd} implies @option{fp}.
12674 Conversely, @option{nofp} (or equivalently, @option{-mgeneral-regs-only})
12675 implies @option{nosimd} implies @option{nocrypto}.
12677 @node Adapteva Epiphany Options
12678 @subsection Adapteva Epiphany Options
12680 These @samp{-m} options are defined for Adapteva Epiphany:
12682 @table @gcctabopt
12683 @item -mhalf-reg-file
12684 @opindex mhalf-reg-file
12685 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12686 That allows code to run on hardware variants that lack these registers.
12688 @item -mprefer-short-insn-regs
12689 @opindex mprefer-short-insn-regs
12690 Preferrentially allocate registers that allow short instruction generation.
12691 This can result in increased instruction count, so this may either reduce or
12692 increase overall code size.
12694 @item -mbranch-cost=@var{num}
12695 @opindex mbranch-cost
12696 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12697 This cost is only a heuristic and is not guaranteed to produce
12698 consistent results across releases.
12700 @item -mcmove
12701 @opindex mcmove
12702 Enable the generation of conditional moves.
12704 @item -mnops=@var{num}
12705 @opindex mnops
12706 Emit @var{num} NOPs before every other generated instruction.
12708 @item -mno-soft-cmpsf
12709 @opindex mno-soft-cmpsf
12710 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12711 and test the flags.  This is faster than a software comparison, but can
12712 get incorrect results in the presence of NaNs, or when two different small
12713 numbers are compared such that their difference is calculated as zero.
12714 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12715 software comparisons.
12717 @item -mstack-offset=@var{num}
12718 @opindex mstack-offset
12719 Set the offset between the top of the stack and the stack pointer.
12720 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12721 can be used by leaf functions without stack allocation.
12722 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12723 Note also that this option changes the ABI; compiling a program with a
12724 different stack offset than the libraries have been compiled with
12725 generally does not work.
12726 This option can be useful if you want to evaluate if a different stack
12727 offset would give you better code, but to actually use a different stack
12728 offset to build working programs, it is recommended to configure the
12729 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12731 @item -mno-round-nearest
12732 @opindex mno-round-nearest
12733 Make the scheduler assume that the rounding mode has been set to
12734 truncating.  The default is @option{-mround-nearest}.
12736 @item -mlong-calls
12737 @opindex mlong-calls
12738 If not otherwise specified by an attribute, assume all calls might be beyond
12739 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12740 function address into a register before performing a (otherwise direct) call.
12741 This is the default.
12743 @item -mshort-calls
12744 @opindex short-calls
12745 If not otherwise specified by an attribute, assume all direct calls are
12746 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12747 for direct calls.  The default is @option{-mlong-calls}.
12749 @item -msmall16
12750 @opindex msmall16
12751 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12752 apply to function addresses for which @option{-mlong-calls} semantics
12753 are in effect.
12755 @item -mfp-mode=@var{mode}
12756 @opindex mfp-mode
12757 Set the prevailing mode of the floating-point unit.
12758 This determines the floating-point mode that is provided and expected
12759 at function call and return time.  Making this mode match the mode you
12760 predominantly need at function start can make your programs smaller and
12761 faster by avoiding unnecessary mode switches.
12763 @var{mode} can be set to one the following values:
12765 @table @samp
12766 @item caller
12767 Any mode at function entry is valid, and retained or restored when
12768 the function returns, and when it calls other functions.
12769 This mode is useful for compiling libraries or other compilation units
12770 you might want to incorporate into different programs with different
12771 prevailing FPU modes, and the convenience of being able to use a single
12772 object file outweighs the size and speed overhead for any extra
12773 mode switching that might be needed, compared with what would be needed
12774 with a more specific choice of prevailing FPU mode.
12776 @item truncate
12777 This is the mode used for floating-point calculations with
12778 truncating (i.e.@: round towards zero) rounding mode.  That includes
12779 conversion from floating point to integer.
12781 @item round-nearest
12782 This is the mode used for floating-point calculations with
12783 round-to-nearest-or-even rounding mode.
12785 @item int
12786 This is the mode used to perform integer calculations in the FPU, e.g.@:
12787 integer multiply, or integer multiply-and-accumulate.
12788 @end table
12790 The default is @option{-mfp-mode=caller}
12792 @item -mnosplit-lohi
12793 @itemx -mno-postinc
12794 @itemx -mno-postmodify
12795 @opindex mnosplit-lohi
12796 @opindex mno-postinc
12797 @opindex mno-postmodify
12798 Code generation tweaks that disable, respectively, splitting of 32-bit
12799 loads, generation of post-increment addresses, and generation of
12800 post-modify addresses.  The defaults are @option{msplit-lohi},
12801 @option{-mpost-inc}, and @option{-mpost-modify}.
12803 @item -mnovect-double
12804 @opindex mno-vect-double
12805 Change the preferred SIMD mode to SImode.  The default is
12806 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12808 @item -max-vect-align=@var{num}
12809 @opindex max-vect-align
12810 The maximum alignment for SIMD vector mode types.
12811 @var{num} may be 4 or 8.  The default is 8.
12812 Note that this is an ABI change, even though many library function
12813 interfaces are unaffected if they don't use SIMD vector modes
12814 in places that affect size and/or alignment of relevant types.
12816 @item -msplit-vecmove-early
12817 @opindex msplit-vecmove-early
12818 Split vector moves into single word moves before reload.  In theory this
12819 can give better register allocation, but so far the reverse seems to be
12820 generally the case.
12822 @item -m1reg-@var{reg}
12823 @opindex m1reg-
12824 Specify a register to hold the constant @minus{}1, which makes loading small negative
12825 constants and certain bitmasks faster.
12826 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12827 which specify use of that register as a fixed register,
12828 and @samp{none}, which means that no register is used for this
12829 purpose.  The default is @option{-m1reg-none}.
12831 @end table
12833 @node ARC Options
12834 @subsection ARC Options
12835 @cindex ARC options
12837 The following options control the architecture variant for which code
12838 is being compiled:
12840 @c architecture variants
12841 @table @gcctabopt
12843 @item -mbarrel-shifter
12844 @opindex mbarrel-shifter
12845 Generate instructions supported by barrel shifter.  This is the default
12846 unless @option{-mcpu=ARC601} or @samp{-mcpu=ARCEM} is in effect.
12848 @item -mcpu=@var{cpu}
12849 @opindex mcpu
12850 Set architecture type, register usage, and instruction scheduling
12851 parameters for @var{cpu}.  There are also shortcut alias options
12852 available for backward compatibility and convenience.  Supported
12853 values for @var{cpu} are
12855 @table @samp
12856 @opindex mA6
12857 @opindex mARC600
12858 @item ARC600
12859 @item arc600
12860 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12862 @item ARC601
12863 @item arc601
12864 @opindex mARC601
12865 Compile for ARC601.  Alias: @option{-mARC601}.
12867 @item ARC700
12868 @item arc700
12869 @opindex mA7
12870 @opindex mARC700
12871 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12872 This is the default when configured with @option{--with-cpu=arc700}@.
12874 @item ARCEM
12875 @item arcem
12876 Compile for ARC EM.
12878 @item ARCHS
12879 @item archs
12880 Compile for ARC HS.
12881 @end table
12883 @item -mdpfp
12884 @opindex mdpfp
12885 @itemx -mdpfp-compact
12886 @opindex mdpfp-compact
12887 FPX: Generate Double Precision FPX instructions, tuned for the compact
12888 implementation.
12890 @item -mdpfp-fast
12891 @opindex mdpfp-fast
12892 FPX: Generate Double Precision FPX instructions, tuned for the fast
12893 implementation.
12895 @item -mno-dpfp-lrsr
12896 @opindex mno-dpfp-lrsr
12897 Disable LR and SR instructions from using FPX extension aux registers.
12899 @item -mea
12900 @opindex mea
12901 Generate Extended arithmetic instructions.  Currently only
12902 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12903 supported.  This is always enabled for @option{-mcpu=ARC700}.
12905 @item -mno-mpy
12906 @opindex mno-mpy
12907 Do not generate mpy instructions for ARC700.
12909 @item -mmul32x16
12910 @opindex mmul32x16
12911 Generate 32x16 bit multiply and mac instructions.
12913 @item -mmul64
12914 @opindex mmul64
12915 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12917 @item -mnorm
12918 @opindex mnorm
12919 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12920 is in effect.
12922 @item -mspfp
12923 @opindex mspfp
12924 @itemx -mspfp-compact
12925 @opindex mspfp-compact
12926 FPX: Generate Single Precision FPX instructions, tuned for the compact
12927 implementation.
12929 @item -mspfp-fast
12930 @opindex mspfp-fast
12931 FPX: Generate Single Precision FPX instructions, tuned for the fast
12932 implementation.
12934 @item -msimd
12935 @opindex msimd
12936 Enable generation of ARC SIMD instructions via target-specific
12937 builtins.  Only valid for @option{-mcpu=ARC700}.
12939 @item -msoft-float
12940 @opindex msoft-float
12941 This option ignored; it is provided for compatibility purposes only.
12942 Software floating point code is emitted by default, and this default
12943 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12944 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12945 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12947 @item -mswap
12948 @opindex mswap
12949 Generate swap instructions.
12951 @item -mdiv-rem
12952 @opindex mdiv-rem
12953 Enable DIV/REM instructions for ARCv2 cores.
12955 @item -mcode-density
12956 @opindex mcode-density
12957 Enable code density instructions for ARC EM, default on for ARC HS.
12959 @item -mmpy-option=@var{multo}
12960 @opindex mmpy-option
12961 Compile ARCv2 code with a multiplier design option.  @samp{wlh1} is
12962 the default value.  The recognized values for @var{multo} are:
12964 @table @samp
12965 @item 0
12966 No multiplier available.
12968 @item 1
12969 @opindex w
12970 The multiply option is set to w: 16x16 multiplier, fully pipelined.
12971 The following instructions are enabled: MPYW, and MPYUW.
12973 @item 2
12974 @opindex wlh1
12975 The multiply option is set to wlh1: 32x32 multiplier, fully
12976 pipelined (1 stage).  The following instructions are additionaly
12977 enabled: MPY, MPYU, MPYM, MPYMU, and MPY_S.
12979 @item 3
12980 @opindex wlh2
12981 The multiply option is set to wlh2: 32x32 multiplier, fully pipelined
12982 (2 stages).  The following instructions are additionaly enabled: MPY,
12983 MPYU, MPYM, MPYMU, and MPY_S.
12985 @item 4
12986 @opindex wlh3
12987 The multiply option is set to wlh3: Two 16x16 multiplier, blocking,
12988 sequential.  The following instructions are additionaly enabled: MPY,
12989 MPYU, MPYM, MPYMU, and MPY_S.
12991 @item 5
12992 @opindex wlh4
12993 The multiply option is set to wlh4: One 16x16 multiplier, blocking,
12994 sequential.  The following instructions are additionaly enabled: MPY,
12995 MPYU, MPYM, MPYMU, and MPY_S.
12997 @item 6
12998 @opindex wlh5
12999 The multiply option is set to wlh5: One 32x4 multiplier, blocking,
13000 sequential.  The following instructions are additionaly enabled: MPY,
13001 MPYU, MPYM, MPYMU, and MPY_S.
13003 @end table
13005 This option is only available for ARCv2 cores@.
13007 @end table
13009 The following options are passed through to the assembler, and also
13010 define preprocessor macro symbols.
13012 @c Flags used by the assembler, but for which we define preprocessor
13013 @c macro symbols as well.
13014 @table @gcctabopt
13015 @item -mdsp-packa
13016 @opindex mdsp-packa
13017 Passed down to the assembler to enable the DSP Pack A extensions.
13018 Also sets the preprocessor symbol @code{__Xdsp_packa}.
13020 @item -mdvbf
13021 @opindex mdvbf
13022 Passed down to the assembler to enable the dual viterbi butterfly
13023 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
13025 @c ARC700 4.10 extension instruction
13026 @item -mlock
13027 @opindex mlock
13028 Passed down to the assembler to enable the Locked Load/Store
13029 Conditional extension.  Also sets the preprocessor symbol
13030 @code{__Xlock}.
13032 @item -mmac-d16
13033 @opindex mmac-d16
13034 Passed down to the assembler.  Also sets the preprocessor symbol
13035 @code{__Xxmac_d16}.
13037 @item -mmac-24
13038 @opindex mmac-24
13039 Passed down to the assembler.  Also sets the preprocessor symbol
13040 @code{__Xxmac_24}.
13042 @c ARC700 4.10 extension instruction
13043 @item -mrtsc
13044 @opindex mrtsc
13045 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
13046 extension instruction.  Also sets the preprocessor symbol
13047 @code{__Xrtsc}.
13049 @c ARC700 4.10 extension instruction
13050 @item -mswape
13051 @opindex mswape
13052 Passed down to the assembler to enable the swap byte ordering
13053 extension instruction.  Also sets the preprocessor symbol
13054 @code{__Xswape}.
13056 @item -mtelephony
13057 @opindex mtelephony
13058 Passed down to the assembler to enable dual and single operand
13059 instructions for telephony.  Also sets the preprocessor symbol
13060 @code{__Xtelephony}.
13062 @item -mxy
13063 @opindex mxy
13064 Passed down to the assembler to enable the XY Memory extension.  Also
13065 sets the preprocessor symbol @code{__Xxy}.
13067 @end table
13069 The following options control how the assembly code is annotated:
13071 @c Assembly annotation options
13072 @table @gcctabopt
13073 @item -misize
13074 @opindex misize
13075 Annotate assembler instructions with estimated addresses.
13077 @item -mannotate-align
13078 @opindex mannotate-align
13079 Explain what alignment considerations lead to the decision to make an
13080 instruction short or long.
13082 @end table
13084 The following options are passed through to the linker:
13086 @c options passed through to the linker
13087 @table @gcctabopt
13088 @item -marclinux
13089 @opindex marclinux
13090 Passed through to the linker, to specify use of the @code{arclinux} emulation.
13091 This option is enabled by default in tool chains built for
13092 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
13093 when profiling is not requested.
13095 @item -marclinux_prof
13096 @opindex marclinux_prof
13097 Passed through to the linker, to specify use of the
13098 @code{arclinux_prof} emulation.  This option is enabled by default in
13099 tool chains built for @w{@code{arc-linux-uclibc}} and
13100 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
13102 @end table
13104 The following options control the semantics of generated code:
13106 @c semantically relevant code generation options
13107 @table @gcctabopt
13108 @item -mepilogue-cfi
13109 @opindex mepilogue-cfi
13110 Enable generation of call frame information for epilogues.
13112 @item -mno-epilogue-cfi
13113 @opindex mno-epilogue-cfi
13114 Disable generation of call frame information for epilogues.
13116 @item -mlong-calls
13117 @opindex mlong-calls
13118 Generate call insns as register indirect calls, thus providing access
13119 to the full 32-bit address range.
13121 @item -mmedium-calls
13122 @opindex mmedium-calls
13123 Don't use less than 25 bit addressing range for calls, which is the
13124 offset available for an unconditional branch-and-link
13125 instruction.  Conditional execution of function calls is suppressed, to
13126 allow use of the 25-bit range, rather than the 21-bit range with
13127 conditional branch-and-link.  This is the default for tool chains built
13128 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
13130 @item -mno-sdata
13131 @opindex mno-sdata
13132 Do not generate sdata references.  This is the default for tool chains
13133 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
13134 targets.
13136 @item -mucb-mcount
13137 @opindex mucb-mcount
13138 Instrument with mcount calls as used in UCB code.  I.e. do the
13139 counting in the callee, not the caller.  By default ARC instrumentation
13140 counts in the caller.
13142 @item -mvolatile-cache
13143 @opindex mvolatile-cache
13144 Use ordinarily cached memory accesses for volatile references.  This is the
13145 default.
13147 @item -mno-volatile-cache
13148 @opindex mno-volatile-cache
13149 Enable cache bypass for volatile references.
13151 @end table
13153 The following options fine tune code generation:
13154 @c code generation tuning options
13155 @table @gcctabopt
13156 @item -malign-call
13157 @opindex malign-call
13158 Do alignment optimizations for call instructions.
13160 @item -mauto-modify-reg
13161 @opindex mauto-modify-reg
13162 Enable the use of pre/post modify with register displacement.
13164 @item -mbbit-peephole
13165 @opindex mbbit-peephole
13166 Enable bbit peephole2.
13168 @item -mno-brcc
13169 @opindex mno-brcc
13170 This option disables a target-specific pass in @file{arc_reorg} to
13171 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
13172 generation driven by the combiner pass.
13174 @item -mcase-vector-pcrel
13175 @opindex mcase-vector-pcrel
13176 Use pc-relative switch case tables - this enables case table shortening.
13177 This is the default for @option{-Os}.
13179 @item -mcompact-casesi
13180 @opindex mcompact-casesi
13181 Enable compact casesi pattern.
13182 This is the default for @option{-Os}.
13184 @item -mno-cond-exec
13185 @opindex mno-cond-exec
13186 Disable ARCompact specific pass to generate conditional execution instructions.
13187 Due to delay slot scheduling and interactions between operand numbers,
13188 literal sizes, instruction lengths, and the support for conditional execution,
13189 the target-independent pass to generate conditional execution is often lacking,
13190 so the ARC port has kept a special pass around that tries to find more
13191 conditional execution generating opportunities after register allocation,
13192 branch shortening, and delay slot scheduling have been done.  This pass
13193 generally, but not always, improves performance and code size, at the cost of
13194 extra compilation time, which is why there is an option to switch it off.
13195 If you have a problem with call instructions exceeding their allowable
13196 offset range because they are conditionalized, you should consider using
13197 @option{-mmedium-calls} instead.
13199 @item -mearly-cbranchsi
13200 @opindex mearly-cbranchsi
13201 Enable pre-reload use of the cbranchsi pattern.
13203 @item -mexpand-adddi
13204 @opindex mexpand-adddi
13205 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
13206 @code{add.f}, @code{adc} etc.
13208 @item -mindexed-loads
13209 @opindex mindexed-loads
13210 Enable the use of indexed loads.  This can be problematic because some
13211 optimizers then assume that indexed stores exist, which is not
13212 the case.
13214 @item -mlra
13215 @opindex mlra
13216 Enable Local Register Allocation.  This is still experimental for ARC,
13217 so by default the compiler uses standard reload
13218 (i.e. @option{-mno-lra}).
13220 @item -mlra-priority-none
13221 @opindex mlra-priority-none
13222 Don't indicate any priority for target registers.
13224 @item -mlra-priority-compact
13225 @opindex mlra-priority-compact
13226 Indicate target register priority for r0..r3 / r12..r15.
13228 @item -mlra-priority-noncompact
13229 @opindex mlra-priority-noncompact
13230 Reduce target regsiter priority for r0..r3 / r12..r15.
13232 @item -mno-millicode
13233 @opindex mno-millicode
13234 When optimizing for size (using @option{-Os}), prologues and epilogues
13235 that have to save or restore a large number of registers are often
13236 shortened by using call to a special function in libgcc; this is
13237 referred to as a @emph{millicode} call.  As these calls can pose
13238 performance issues, and/or cause linking issues when linking in a
13239 nonstandard way, this option is provided to turn off millicode call
13240 generation.
13242 @item -mmixed-code
13243 @opindex mmixed-code
13244 Tweak register allocation to help 16-bit instruction generation.
13245 This generally has the effect of decreasing the average instruction size
13246 while increasing the instruction count.
13248 @item -mq-class
13249 @opindex mq-class
13250 Enable 'q' instruction alternatives.
13251 This is the default for @option{-Os}.
13253 @item -mRcq
13254 @opindex mRcq
13255 Enable Rcq constraint handling - most short code generation depends on this.
13256 This is the default.
13258 @item -mRcw
13259 @opindex mRcw
13260 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
13261 This is the default.
13263 @item -msize-level=@var{level}
13264 @opindex msize-level
13265 Fine-tune size optimization with regards to instruction lengths and alignment.
13266 The recognized values for @var{level} are:
13267 @table @samp
13268 @item 0
13269 No size optimization.  This level is deprecated and treated like @samp{1}.
13271 @item 1
13272 Short instructions are used opportunistically.
13274 @item 2
13275 In addition, alignment of loops and of code after barriers are dropped.
13277 @item 3
13278 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13280 @end table
13282 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13283 the behavior when this is not set is equivalent to level @samp{1}.
13285 @item -mtune=@var{cpu}
13286 @opindex mtune
13287 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13288 by @option{-mcpu=}.
13290 Supported values for @var{cpu} are
13292 @table @samp
13293 @item ARC600
13294 Tune for ARC600 cpu.
13296 @item ARC601
13297 Tune for ARC601 cpu.
13299 @item ARC700
13300 Tune for ARC700 cpu with standard multiplier block.
13302 @item ARC700-xmac
13303 Tune for ARC700 cpu with XMAC block.
13305 @item ARC725D
13306 Tune for ARC725D cpu.
13308 @item ARC750D
13309 Tune for ARC750D cpu.
13311 @end table
13313 @item -mmultcost=@var{num}
13314 @opindex mmultcost
13315 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13316 normal instruction.
13318 @item -munalign-prob-threshold=@var{probability}
13319 @opindex munalign-prob-threshold
13320 Set probability threshold for unaligning branches.
13321 When tuning for @samp{ARC700} and optimizing for speed, branches without
13322 filled delay slot are preferably emitted unaligned and long, unless
13323 profiling indicates that the probability for the branch to be taken
13324 is below @var{probability}.  @xref{Cross-profiling}.
13325 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13327 @end table
13329 The following options are maintained for backward compatibility, but
13330 are now deprecated and will be removed in a future release:
13332 @c Deprecated options
13333 @table @gcctabopt
13335 @item -margonaut
13336 @opindex margonaut
13337 Obsolete FPX.
13339 @item -mbig-endian
13340 @opindex mbig-endian
13341 @itemx -EB
13342 @opindex EB
13343 Compile code for big endian targets.  Use of these options is now
13344 deprecated.  Users wanting big-endian code, should use the
13345 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13346 building the tool chain, for which big-endian is the default.
13348 @item -mlittle-endian
13349 @opindex mlittle-endian
13350 @itemx -EL
13351 @opindex EL
13352 Compile code for little endian targets.  Use of these options is now
13353 deprecated.  Users wanting little-endian code should use the
13354 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13355 building the tool chain, for which little-endian is the default.
13357 @item -mbarrel_shifter
13358 @opindex mbarrel_shifter
13359 Replaced by @option{-mbarrel-shifter}.
13361 @item -mdpfp_compact
13362 @opindex mdpfp_compact
13363 Replaced by @option{-mdpfp-compact}.
13365 @item -mdpfp_fast
13366 @opindex mdpfp_fast
13367 Replaced by @option{-mdpfp-fast}.
13369 @item -mdsp_packa
13370 @opindex mdsp_packa
13371 Replaced by @option{-mdsp-packa}.
13373 @item -mEA
13374 @opindex mEA
13375 Replaced by @option{-mea}.
13377 @item -mmac_24
13378 @opindex mmac_24
13379 Replaced by @option{-mmac-24}.
13381 @item -mmac_d16
13382 @opindex mmac_d16
13383 Replaced by @option{-mmac-d16}.
13385 @item -mspfp_compact
13386 @opindex mspfp_compact
13387 Replaced by @option{-mspfp-compact}.
13389 @item -mspfp_fast
13390 @opindex mspfp_fast
13391 Replaced by @option{-mspfp-fast}.
13393 @item -mtune=@var{cpu}
13394 @opindex mtune
13395 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13396 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13397 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13399 @item -multcost=@var{num}
13400 @opindex multcost
13401 Replaced by @option{-mmultcost}.
13403 @end table
13405 @node ARM Options
13406 @subsection ARM Options
13407 @cindex ARM options
13409 These @samp{-m} options are defined for the ARM port:
13411 @table @gcctabopt
13412 @item -mabi=@var{name}
13413 @opindex mabi
13414 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13415 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13417 @item -mapcs-frame
13418 @opindex mapcs-frame
13419 Generate a stack frame that is compliant with the ARM Procedure Call
13420 Standard for all functions, even if this is not strictly necessary for
13421 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13422 with this option causes the stack frames not to be generated for
13423 leaf functions.  The default is @option{-mno-apcs-frame}.
13424 This option is deprecated.
13426 @item -mapcs
13427 @opindex mapcs
13428 This is a synonym for @option{-mapcs-frame} and is deprecated.
13430 @ignore
13431 @c not currently implemented
13432 @item -mapcs-stack-check
13433 @opindex mapcs-stack-check
13434 Generate code to check the amount of stack space available upon entry to
13435 every function (that actually uses some stack space).  If there is
13436 insufficient space available then either the function
13437 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13438 called, depending upon the amount of stack space required.  The runtime
13439 system is required to provide these functions.  The default is
13440 @option{-mno-apcs-stack-check}, since this produces smaller code.
13442 @c not currently implemented
13443 @item -mapcs-float
13444 @opindex mapcs-float
13445 Pass floating-point arguments using the floating-point registers.  This is
13446 one of the variants of the APCS@.  This option is recommended if the
13447 target hardware has a floating-point unit or if a lot of floating-point
13448 arithmetic is going to be performed by the code.  The default is
13449 @option{-mno-apcs-float}, since the size of integer-only code is 
13450 slightly increased if @option{-mapcs-float} is used.
13452 @c not currently implemented
13453 @item -mapcs-reentrant
13454 @opindex mapcs-reentrant
13455 Generate reentrant, position-independent code.  The default is
13456 @option{-mno-apcs-reentrant}.
13457 @end ignore
13459 @item -mthumb-interwork
13460 @opindex mthumb-interwork
13461 Generate code that supports calling between the ARM and Thumb
13462 instruction sets.  Without this option, on pre-v5 architectures, the
13463 two instruction sets cannot be reliably used inside one program.  The
13464 default is @option{-mno-thumb-interwork}, since slightly larger code
13465 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13466 configurations this option is meaningless.
13468 @item -mno-sched-prolog
13469 @opindex mno-sched-prolog
13470 Prevent the reordering of instructions in the function prologue, or the
13471 merging of those instruction with the instructions in the function's
13472 body.  This means that all functions start with a recognizable set
13473 of instructions (or in fact one of a choice from a small set of
13474 different function prologues), and this information can be used to
13475 locate the start of functions inside an executable piece of code.  The
13476 default is @option{-msched-prolog}.
13478 @item -mfloat-abi=@var{name}
13479 @opindex mfloat-abi
13480 Specifies which floating-point ABI to use.  Permissible values
13481 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13483 Specifying @samp{soft} causes GCC to generate output containing
13484 library calls for floating-point operations.
13485 @samp{softfp} allows the generation of code using hardware floating-point
13486 instructions, but still uses the soft-float calling conventions.
13487 @samp{hard} allows generation of floating-point instructions
13488 and uses FPU-specific calling conventions.
13490 The default depends on the specific target configuration.  Note that
13491 the hard-float and soft-float ABIs are not link-compatible; you must
13492 compile your entire program with the same ABI, and link with a
13493 compatible set of libraries.
13495 @item -mlittle-endian
13496 @opindex mlittle-endian
13497 Generate code for a processor running in little-endian mode.  This is
13498 the default for all standard configurations.
13500 @item -mbig-endian
13501 @opindex mbig-endian
13502 Generate code for a processor running in big-endian mode; the default is
13503 to compile code for a little-endian processor.
13505 @item -march=@var{name}
13506 @opindex march
13507 This specifies the name of the target ARM architecture.  GCC uses this
13508 name to determine what kind of instructions it can emit when generating
13509 assembly code.  This option can be used in conjunction with or instead
13510 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13511 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13512 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13513 @samp{armv6}, @samp{armv6j},
13514 @samp{armv6t2}, @samp{armv6z}, @samp{armv6kz}, @samp{armv6-m},
13515 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13516 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13517 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13519 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13520 extensions.
13522 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13523 architecture together with the optional CRC32 extensions.
13525 @option{-march=native} causes the compiler to auto-detect the architecture
13526 of the build computer.  At present, this feature is only supported on
13527 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13528 is unsuccessful the option has no effect.
13530 @item -mtune=@var{name}
13531 @opindex mtune
13532 This option specifies the name of the target ARM processor for
13533 which GCC should tune the performance of the code.
13534 For some ARM implementations better performance can be obtained by using
13535 this option.
13536 Permissible names are: @samp{arm2}, @samp{arm250},
13537 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13538 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13539 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13540 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13541 @samp{arm720},
13542 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13543 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13544 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13545 @samp{strongarm1110},
13546 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13547 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13548 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13549 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13550 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13551 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13552 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13553 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13554 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13555 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13556 @samp{cortex-r4},
13557 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13558 @samp{cortex-m4},
13559 @samp{cortex-m3},
13560 @samp{cortex-m1},
13561 @samp{cortex-m0},
13562 @samp{cortex-m0plus},
13563 @samp{cortex-m1.small-multiply},
13564 @samp{cortex-m0.small-multiply},
13565 @samp{cortex-m0plus.small-multiply},
13566 @samp{exynos-m1},
13567 @samp{qdf24xx},
13568 @samp{marvell-pj4},
13569 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13570 @samp{fa526}, @samp{fa626},
13571 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13572 @samp{xgene1}.
13574 Additionally, this option can specify that GCC should tune the performance
13575 of the code for a big.LITTLE system.  Permissible names are:
13576 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13577 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13579 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13580 performance for a blend of processors within architecture @var{arch}.
13581 The aim is to generate code that run well on the current most popular
13582 processors, balancing between optimizations that benefit some CPUs in the
13583 range, and avoiding performance pitfalls of other CPUs.  The effects of
13584 this option may change in future GCC versions as CPU models come and go.
13586 @option{-mtune=native} causes the compiler to auto-detect the CPU
13587 of the build computer.  At present, this feature is only supported on
13588 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13589 unsuccessful the option has no effect.
13591 @item -mcpu=@var{name}
13592 @opindex mcpu
13593 This specifies the name of the target ARM processor.  GCC uses this name
13594 to derive the name of the target ARM architecture (as if specified
13595 by @option{-march}) and the ARM processor type for which to tune for
13596 performance (as if specified by @option{-mtune}).  Where this option
13597 is used in conjunction with @option{-march} or @option{-mtune},
13598 those options take precedence over the appropriate part of this option.
13600 Permissible names for this option are the same as those for
13601 @option{-mtune}.
13603 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13604 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13605 See @option{-mtune} for more information.
13607 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13608 of the build computer.  At present, this feature is only supported on
13609 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13610 is unsuccessful the option has no effect.
13612 @item -mfpu=@var{name}
13613 @opindex mfpu
13614 This specifies what floating-point hardware (or hardware emulation) is
13615 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13616 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13617 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13618 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13619 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13620 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13622 If @option{-msoft-float} is specified this specifies the format of
13623 floating-point values.
13625 If the selected floating-point hardware includes the NEON extension
13626 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13627 operations are not generated by GCC's auto-vectorization pass unless
13628 @option{-funsafe-math-optimizations} is also specified.  This is
13629 because NEON hardware does not fully implement the IEEE 754 standard for
13630 floating-point arithmetic (in particular denormal values are treated as
13631 zero), so the use of NEON instructions may lead to a loss of precision.
13633 @item -mfp16-format=@var{name}
13634 @opindex mfp16-format
13635 Specify the format of the @code{__fp16} half-precision floating-point type.
13636 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13637 the default is @samp{none}, in which case the @code{__fp16} type is not
13638 defined.  @xref{Half-Precision}, for more information.
13640 @item -mstructure-size-boundary=@var{n}
13641 @opindex mstructure-size-boundary
13642 The sizes of all structures and unions are rounded up to a multiple
13643 of the number of bits set by this option.  Permissible values are 8, 32
13644 and 64.  The default value varies for different toolchains.  For the COFF
13645 targeted toolchain the default value is 8.  A value of 64 is only allowed
13646 if the underlying ABI supports it.
13648 Specifying a larger number can produce faster, more efficient code, but
13649 can also increase the size of the program.  Different values are potentially
13650 incompatible.  Code compiled with one value cannot necessarily expect to
13651 work with code or libraries compiled with another value, if they exchange
13652 information using structures or unions.
13654 @item -mabort-on-noreturn
13655 @opindex mabort-on-noreturn
13656 Generate a call to the function @code{abort} at the end of a
13657 @code{noreturn} function.  It is executed if the function tries to
13658 return.
13660 @item -mlong-calls
13661 @itemx -mno-long-calls
13662 @opindex mlong-calls
13663 @opindex mno-long-calls
13664 Tells the compiler to perform function calls by first loading the
13665 address of the function into a register and then performing a subroutine
13666 call on this register.  This switch is needed if the target function
13667 lies outside of the 64-megabyte addressing range of the offset-based
13668 version of subroutine call instruction.
13670 Even if this switch is enabled, not all function calls are turned
13671 into long calls.  The heuristic is that static functions, functions
13672 that have the @code{short_call} attribute, functions that are inside
13673 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13674 definitions have already been compiled within the current compilation
13675 unit are not turned into long calls.  The exceptions to this rule are
13676 that weak function definitions, functions with the @code{long_call}
13677 attribute or the @code{section} attribute, and functions that are within
13678 the scope of a @code{#pragma long_calls} directive are always
13679 turned into long calls.
13681 This feature is not enabled by default.  Specifying
13682 @option{-mno-long-calls} restores the default behavior, as does
13683 placing the function calls within the scope of a @code{#pragma
13684 long_calls_off} directive.  Note these switches have no effect on how
13685 the compiler generates code to handle function calls via function
13686 pointers.
13688 @item -msingle-pic-base
13689 @opindex msingle-pic-base
13690 Treat the register used for PIC addressing as read-only, rather than
13691 loading it in the prologue for each function.  The runtime system is
13692 responsible for initializing this register with an appropriate value
13693 before execution begins.
13695 @item -mpic-register=@var{reg}
13696 @opindex mpic-register
13697 Specify the register to be used for PIC addressing.
13698 For standard PIC base case, the default is any suitable register
13699 determined by compiler.  For single PIC base case, the default is
13700 @samp{R9} if target is EABI based or stack-checking is enabled,
13701 otherwise the default is @samp{R10}.
13703 @item -mpic-data-is-text-relative
13704 @opindex mpic-data-is-text-relative
13705 Assume that each data segments are relative to text segment at load time.
13706 Therefore, it permits addressing data using PC-relative operations.
13707 This option is on by default for targets other than VxWorks RTP.
13709 @item -mpoke-function-name
13710 @opindex mpoke-function-name
13711 Write the name of each function into the text section, directly
13712 preceding the function prologue.  The generated code is similar to this:
13714 @smallexample
13715      t0
13716          .ascii "arm_poke_function_name", 0
13717          .align
13718      t1
13719          .word 0xff000000 + (t1 - t0)
13720      arm_poke_function_name
13721          mov     ip, sp
13722          stmfd   sp!, @{fp, ip, lr, pc@}
13723          sub     fp, ip, #4
13724 @end smallexample
13726 When performing a stack backtrace, code can inspect the value of
13727 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13728 location @code{pc - 12} and the top 8 bits are set, then we know that
13729 there is a function name embedded immediately preceding this location
13730 and has length @code{((pc[-3]) & 0xff000000)}.
13732 @item -mthumb
13733 @itemx -marm
13734 @opindex marm
13735 @opindex mthumb
13737 Select between generating code that executes in ARM and Thumb
13738 states.  The default for most configurations is to generate code
13739 that executes in ARM state, but the default can be changed by
13740 configuring GCC with the @option{--with-mode=}@var{state}
13741 configure option.
13743 You can also override the ARM and Thumb mode for each function
13744 by using the @code{target("thumb")} and @code{target("arm")} function attributes
13745 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
13747 @item -mtpcs-frame
13748 @opindex mtpcs-frame
13749 Generate a stack frame that is compliant with the Thumb Procedure Call
13750 Standard for all non-leaf functions.  (A leaf function is one that does
13751 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13753 @item -mtpcs-leaf-frame
13754 @opindex mtpcs-leaf-frame
13755 Generate a stack frame that is compliant with the Thumb Procedure Call
13756 Standard for all leaf functions.  (A leaf function is one that does
13757 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13759 @item -mcallee-super-interworking
13760 @opindex mcallee-super-interworking
13761 Gives all externally visible functions in the file being compiled an ARM
13762 instruction set header which switches to Thumb mode before executing the
13763 rest of the function.  This allows these functions to be called from
13764 non-interworking code.  This option is not valid in AAPCS configurations
13765 because interworking is enabled by default.
13767 @item -mcaller-super-interworking
13768 @opindex mcaller-super-interworking
13769 Allows calls via function pointers (including virtual functions) to
13770 execute correctly regardless of whether the target code has been
13771 compiled for interworking or not.  There is a small overhead in the cost
13772 of executing a function pointer if this option is enabled.  This option
13773 is not valid in AAPCS configurations because interworking is enabled
13774 by default.
13776 @item -mtp=@var{name}
13777 @opindex mtp
13778 Specify the access model for the thread local storage pointer.  The valid
13779 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13780 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13781 (supported in the arm6k architecture), and @samp{auto}, which uses the
13782 best available method for the selected processor.  The default setting is
13783 @samp{auto}.
13785 @item -mtls-dialect=@var{dialect}
13786 @opindex mtls-dialect
13787 Specify the dialect to use for accessing thread local storage.  Two
13788 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13789 @samp{gnu} dialect selects the original GNU scheme for supporting
13790 local and global dynamic TLS models.  The @samp{gnu2} dialect
13791 selects the GNU descriptor scheme, which provides better performance
13792 for shared libraries.  The GNU descriptor scheme is compatible with
13793 the original scheme, but does require new assembler, linker and
13794 library support.  Initial and local exec TLS models are unaffected by
13795 this option and always use the original scheme.
13797 @item -mword-relocations
13798 @opindex mword-relocations
13799 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13800 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13801 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13802 is specified.
13804 @item -mfix-cortex-m3-ldrd
13805 @opindex mfix-cortex-m3-ldrd
13806 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13807 with overlapping destination and base registers are used.  This option avoids
13808 generating these instructions.  This option is enabled by default when
13809 @option{-mcpu=cortex-m3} is specified.
13811 @item -munaligned-access
13812 @itemx -mno-unaligned-access
13813 @opindex munaligned-access
13814 @opindex mno-unaligned-access
13815 Enables (or disables) reading and writing of 16- and 32- bit values
13816 from addresses that are not 16- or 32- bit aligned.  By default
13817 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13818 architectures, and enabled for all other architectures.  If unaligned
13819 access is not enabled then words in packed data structures are
13820 accessed a byte at a time.
13822 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13823 generated object file to either true or false, depending upon the
13824 setting of this option.  If unaligned access is enabled then the
13825 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13826 defined.
13828 @item -mneon-for-64bits
13829 @opindex mneon-for-64bits
13830 Enables using Neon to handle scalar 64-bits operations. This is
13831 disabled by default since the cost of moving data from core registers
13832 to Neon is high.
13834 @item -mslow-flash-data
13835 @opindex mslow-flash-data
13836 Assume loading data from flash is slower than fetching instruction.
13837 Therefore literal load is minimized for better performance.
13838 This option is only supported when compiling for ARMv7 M-profile and
13839 off by default.
13841 @item -masm-syntax-unified
13842 @opindex masm-syntax-unified
13843 Assume inline assembler is using unified asm syntax.  The default is
13844 currently off which implies divided syntax.  This option has no impact
13845 on Thumb2. However, this may change in future releases of GCC.
13846 Divided syntax should be considered deprecated.
13848 @item -mrestrict-it
13849 @opindex mrestrict-it
13850 Restricts generation of IT blocks to conform to the rules of ARMv8.
13851 IT blocks can only contain a single 16-bit instruction from a select
13852 set of instructions. This option is on by default for ARMv8 Thumb mode.
13854 @item -mprint-tune-info
13855 @opindex mprint-tune-info
13856 Print CPU tuning information as comment in assembler file.  This is
13857 an option used only for regression testing of the compiler and not
13858 intended for ordinary use in compiling code.  This option is disabled
13859 by default.
13860 @end table
13862 @node AVR Options
13863 @subsection AVR Options
13864 @cindex AVR Options
13866 These options are defined for AVR implementations:
13868 @table @gcctabopt
13869 @item -mmcu=@var{mcu}
13870 @opindex mmcu
13871 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13873 The default for this option is@tie{}@samp{avr2}.
13875 GCC supports the following AVR devices and ISAs:
13877 @include avr-mmcu.texi
13879 @item -maccumulate-args
13880 @opindex maccumulate-args
13881 Accumulate outgoing function arguments and acquire/release the needed
13882 stack space for outgoing function arguments once in function
13883 prologue/epilogue.  Without this option, outgoing arguments are pushed
13884 before calling a function and popped afterwards.
13886 Popping the arguments after the function call can be expensive on
13887 AVR so that accumulating the stack space might lead to smaller
13888 executables because arguments need not to be removed from the
13889 stack after such a function call.
13891 This option can lead to reduced code size for functions that perform
13892 several calls to functions that get their arguments on the stack like
13893 calls to printf-like functions.
13895 @item -mbranch-cost=@var{cost}
13896 @opindex mbranch-cost
13897 Set the branch costs for conditional branch instructions to
13898 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13899 integers. The default branch cost is 0.
13901 @item -mcall-prologues
13902 @opindex mcall-prologues
13903 Functions prologues/epilogues are expanded as calls to appropriate
13904 subroutines.  Code size is smaller.
13906 @item -mint8
13907 @opindex mint8
13908 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13909 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13910 and @code{long long} is 4 bytes.  Please note that this option does not
13911 conform to the C standards, but it results in smaller code
13912 size.
13914 @item -mn-flash=@var{num}
13915 @opindex mn-flash
13916 Assume that the flash memory has a size of 
13917 @var{num} times 64@tie{}KiB.
13919 @item -mno-interrupts
13920 @opindex mno-interrupts
13921 Generated code is not compatible with hardware interrupts.
13922 Code size is smaller.
13924 @item -mrelax
13925 @opindex mrelax
13926 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13927 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13928 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13929 the assembler's command line and the @option{--relax} option to the
13930 linker's command line.
13932 Jump relaxing is performed by the linker because jump offsets are not
13933 known before code is located. Therefore, the assembler code generated by the
13934 compiler is the same, but the instructions in the executable may
13935 differ from instructions in the assembler code.
13937 Relaxing must be turned on if linker stubs are needed, see the
13938 section on @code{EIND} and linker stubs below.
13940 @item -mrmw
13941 @opindex mrmw
13942 Assume that the device supports the Read-Modify-Write
13943 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13945 @item -msp8
13946 @opindex msp8
13947 Treat the stack pointer register as an 8-bit register,
13948 i.e.@: assume the high byte of the stack pointer is zero.
13949 In general, you don't need to set this option by hand.
13951 This option is used internally by the compiler to select and
13952 build multilibs for architectures @code{avr2} and @code{avr25}.
13953 These architectures mix devices with and without @code{SPH}.
13954 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13955 the compiler driver adds or removes this option from the compiler
13956 proper's command line, because the compiler then knows if the device
13957 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13958 register or not.
13960 @item -mstrict-X
13961 @opindex mstrict-X
13962 Use address register @code{X} in a way proposed by the hardware.  This means
13963 that @code{X} is only used in indirect, post-increment or
13964 pre-decrement addressing.
13966 Without this option, the @code{X} register may be used in the same way
13967 as @code{Y} or @code{Z} which then is emulated by additional
13968 instructions.  
13969 For example, loading a value with @code{X+const} addressing with a
13970 small non-negative @code{const < 64} to a register @var{Rn} is
13971 performed as
13973 @example
13974 adiw r26, const   ; X += const
13975 ld   @var{Rn}, X        ; @var{Rn} = *X
13976 sbiw r26, const   ; X -= const
13977 @end example
13979 @item -mtiny-stack
13980 @opindex mtiny-stack
13981 Only change the lower 8@tie{}bits of the stack pointer.
13983 @item -nodevicelib
13984 @opindex nodevicelib
13985 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13987 @item -Waddr-space-convert
13988 @opindex Waddr-space-convert
13989 Warn about conversions between address spaces in the case where the
13990 resulting address space is not contained in the incoming address space.
13991 @end table
13993 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13994 @cindex @code{EIND}
13995 Pointers in the implementation are 16@tie{}bits wide.
13996 The address of a function or label is represented as word address so
13997 that indirect jumps and calls can target any code address in the
13998 range of 64@tie{}Ki words.
14000 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
14001 bytes of program memory space, there is a special function register called
14002 @code{EIND} that serves as most significant part of the target address
14003 when @code{EICALL} or @code{EIJMP} instructions are used.
14005 Indirect jumps and calls on these devices are handled as follows by
14006 the compiler and are subject to some limitations:
14008 @itemize @bullet
14010 @item
14011 The compiler never sets @code{EIND}.
14013 @item
14014 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
14015 instructions or might read @code{EIND} directly in order to emulate an
14016 indirect call/jump by means of a @code{RET} instruction.
14018 @item
14019 The compiler assumes that @code{EIND} never changes during the startup
14020 code or during the application. In particular, @code{EIND} is not
14021 saved/restored in function or interrupt service routine
14022 prologue/epilogue.
14024 @item
14025 For indirect calls to functions and computed goto, the linker
14026 generates @emph{stubs}. Stubs are jump pads sometimes also called
14027 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
14028 The stub contains a direct jump to the desired address.
14030 @item
14031 Linker relaxation must be turned on so that the linker generates
14032 the stubs correctly in all situations. See the compiler option
14033 @option{-mrelax} and the linker option @option{--relax}.
14034 There are corner cases where the linker is supposed to generate stubs
14035 but aborts without relaxation and without a helpful error message.
14037 @item
14038 The default linker script is arranged for code with @code{EIND = 0}.
14039 If code is supposed to work for a setup with @code{EIND != 0}, a custom
14040 linker script has to be used in order to place the sections whose
14041 name start with @code{.trampolines} into the segment where @code{EIND}
14042 points to.
14044 @item
14045 The startup code from libgcc never sets @code{EIND}.
14046 Notice that startup code is a blend of code from libgcc and AVR-LibC.
14047 For the impact of AVR-LibC on @code{EIND}, see the
14048 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
14050 @item
14051 It is legitimate for user-specific startup code to set up @code{EIND}
14052 early, for example by means of initialization code located in
14053 section @code{.init3}. Such code runs prior to general startup code
14054 that initializes RAM and calls constructors, but after the bit
14055 of startup code from AVR-LibC that sets @code{EIND} to the segment
14056 where the vector table is located.
14057 @example
14058 #include <avr/io.h>
14060 static void
14061 __attribute__((section(".init3"),naked,used,no_instrument_function))
14062 init3_set_eind (void)
14064   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
14065                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
14067 @end example
14069 @noindent
14070 The @code{__trampolines_start} symbol is defined in the linker script.
14072 @item
14073 Stubs are generated automatically by the linker if
14074 the following two conditions are met:
14075 @itemize @minus
14077 @item The address of a label is taken by means of the @code{gs} modifier
14078 (short for @emph{generate stubs}) like so:
14079 @example
14080 LDI r24, lo8(gs(@var{func}))
14081 LDI r25, hi8(gs(@var{func}))
14082 @end example
14083 @item The final location of that label is in a code segment
14084 @emph{outside} the segment where the stubs are located.
14085 @end itemize
14087 @item
14088 The compiler emits such @code{gs} modifiers for code labels in the
14089 following situations:
14090 @itemize @minus
14091 @item Taking address of a function or code label.
14092 @item Computed goto.
14093 @item If prologue-save function is used, see @option{-mcall-prologues}
14094 command-line option.
14095 @item Switch/case dispatch tables. If you do not want such dispatch
14096 tables you can specify the @option{-fno-jump-tables} command-line option.
14097 @item C and C++ constructors/destructors called during startup/shutdown.
14098 @item If the tools hit a @code{gs()} modifier explained above.
14099 @end itemize
14101 @item
14102 Jumping to non-symbolic addresses like so is @emph{not} supported:
14104 @example
14105 int main (void)
14107     /* Call function at word address 0x2 */
14108     return ((int(*)(void)) 0x2)();
14110 @end example
14112 Instead, a stub has to be set up, i.e.@: the function has to be called
14113 through a symbol (@code{func_4} in the example):
14115 @example
14116 int main (void)
14118     extern int func_4 (void);
14120     /* Call function at byte address 0x4 */
14121     return func_4();
14123 @end example
14125 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
14126 Alternatively, @code{func_4} can be defined in the linker script.
14127 @end itemize
14129 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
14130 @cindex @code{RAMPD}
14131 @cindex @code{RAMPX}
14132 @cindex @code{RAMPY}
14133 @cindex @code{RAMPZ}
14134 Some AVR devices support memories larger than the 64@tie{}KiB range
14135 that can be accessed with 16-bit pointers.  To access memory locations
14136 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
14137 register is used as high part of the address:
14138 The @code{X}, @code{Y}, @code{Z} address register is concatenated
14139 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
14140 register, respectively, to get a wide address. Similarly,
14141 @code{RAMPD} is used together with direct addressing.
14143 @itemize
14144 @item
14145 The startup code initializes the @code{RAMP} special function
14146 registers with zero.
14148 @item
14149 If a @ref{AVR Named Address Spaces,named address space} other than
14150 generic or @code{__flash} is used, then @code{RAMPZ} is set
14151 as needed before the operation.
14153 @item
14154 If the device supports RAM larger than 64@tie{}KiB and the compiler
14155 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
14156 is reset to zero after the operation.
14158 @item
14159 If the device comes with a specific @code{RAMP} register, the ISR
14160 prologue/epilogue saves/restores that SFR and initializes it with
14161 zero in case the ISR code might (implicitly) use it.
14163 @item
14164 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
14165 If you use inline assembler to read from locations outside the
14166 16-bit address range and change one of the @code{RAMP} registers,
14167 you must reset it to zero after the access.
14169 @end itemize
14171 @subsubsection AVR Built-in Macros
14173 GCC defines several built-in macros so that the user code can test
14174 for the presence or absence of features.  Almost any of the following
14175 built-in macros are deduced from device capabilities and thus
14176 triggered by the @option{-mmcu=} command-line option.
14178 For even more AVR-specific built-in macros see
14179 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
14181 @table @code
14183 @item __AVR_ARCH__
14184 Build-in macro that resolves to a decimal number that identifies the
14185 architecture and depends on the @option{-mmcu=@var{mcu}} option.
14186 Possible values are:
14188 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
14189 @code{4}, @code{5}, @code{51}, @code{6}
14191 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
14192 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
14194 respectively and
14196 @code{100}, @code{102}, @code{104},
14197 @code{105}, @code{106}, @code{107}
14199 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
14200 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
14201 If @var{mcu} specifies a device, this built-in macro is set
14202 accordingly. For example, with @option{-mmcu=atmega8} the macro is
14203 defined to @code{4}.
14205 @item __AVR_@var{Device}__
14206 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
14207 the device's name. For example, @option{-mmcu=atmega8} defines the
14208 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
14209 @code{__AVR_ATtiny261A__}, etc.
14211 The built-in macros' names follow
14212 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
14213 the device name as from the AVR user manual. The difference between
14214 @var{Device} in the built-in macro and @var{device} in
14215 @option{-mmcu=@var{device}} is that the latter is always lowercase.
14217 If @var{device} is not a device but only a core architecture like
14218 @samp{avr51}, this macro is not defined.
14220 @item __AVR_DEVICE_NAME__
14221 Setting @option{-mmcu=@var{device}} defines this built-in macro to
14222 the device's name. For example, with @option{-mmcu=atmega8} the macro
14223 is defined to @code{atmega8}.
14225 If @var{device} is not a device but only a core architecture like
14226 @samp{avr51}, this macro is not defined.
14228 @item __AVR_XMEGA__
14229 The device / architecture belongs to the XMEGA family of devices.
14231 @item __AVR_HAVE_ELPM__
14232 The device has the @code{ELPM} instruction.
14234 @item __AVR_HAVE_ELPMX__
14235 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
14236 R@var{n},Z+} instructions.
14238 @item __AVR_HAVE_MOVW__
14239 The device has the @code{MOVW} instruction to perform 16-bit
14240 register-register moves.
14242 @item __AVR_HAVE_LPMX__
14243 The device has the @code{LPM R@var{n},Z} and
14244 @code{LPM R@var{n},Z+} instructions.
14246 @item __AVR_HAVE_MUL__
14247 The device has a hardware multiplier. 
14249 @item __AVR_HAVE_JMP_CALL__
14250 The device has the @code{JMP} and @code{CALL} instructions.
14251 This is the case for devices with at least 16@tie{}KiB of program
14252 memory.
14254 @item __AVR_HAVE_EIJMP_EICALL__
14255 @itemx __AVR_3_BYTE_PC__
14256 The device has the @code{EIJMP} and @code{EICALL} instructions.
14257 This is the case for devices with more than 128@tie{}KiB of program memory.
14258 This also means that the program counter
14259 (PC) is 3@tie{}bytes wide.
14261 @item __AVR_2_BYTE_PC__
14262 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
14263 with up to 128@tie{}KiB of program memory.
14265 @item __AVR_HAVE_8BIT_SP__
14266 @itemx __AVR_HAVE_16BIT_SP__
14267 The stack pointer (SP) register is treated as 8-bit respectively
14268 16-bit register by the compiler.
14269 The definition of these macros is affected by @option{-mtiny-stack}.
14271 @item __AVR_HAVE_SPH__
14272 @itemx __AVR_SP8__
14273 The device has the SPH (high part of stack pointer) special function
14274 register or has an 8-bit stack pointer, respectively.
14275 The definition of these macros is affected by @option{-mmcu=} and
14276 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14277 by @option{-msp8}.
14279 @item __AVR_HAVE_RAMPD__
14280 @itemx __AVR_HAVE_RAMPX__
14281 @itemx __AVR_HAVE_RAMPY__
14282 @itemx __AVR_HAVE_RAMPZ__
14283 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14284 @code{RAMPZ} special function register, respectively.
14286 @item __NO_INTERRUPTS__
14287 This macro reflects the @option{-mno-interrupts} command-line option.
14289 @item __AVR_ERRATA_SKIP__
14290 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14291 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14292 instructions because of a hardware erratum.  Skip instructions are
14293 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14294 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14295 set.
14297 @item __AVR_ISA_RMW__
14298 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14300 @item __AVR_SFR_OFFSET__=@var{offset}
14301 Instructions that can address I/O special function registers directly
14302 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14303 address as if addressed by an instruction to access RAM like @code{LD}
14304 or @code{STS}. This offset depends on the device architecture and has
14305 to be subtracted from the RAM address in order to get the
14306 respective I/O@tie{}address.
14308 @item __WITH_AVRLIBC__
14309 The compiler is configured to be used together with AVR-Libc.
14310 See the @option{--with-avrlibc} configure option.
14312 @end table
14314 @node Blackfin Options
14315 @subsection Blackfin Options
14316 @cindex Blackfin Options
14318 @table @gcctabopt
14319 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14320 @opindex mcpu=
14321 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14322 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14323 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14324 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14325 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14326 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14327 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14328 @samp{bf561}, @samp{bf592}.
14330 The optional @var{sirevision} specifies the silicon revision of the target
14331 Blackfin processor.  Any workarounds available for the targeted silicon revision
14332 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14333 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14334 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14335 hexadecimal digits representing the major and minor numbers in the silicon
14336 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14337 is not defined.  If @var{sirevision} is @samp{any}, the
14338 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14339 If this optional @var{sirevision} is not used, GCC assumes the latest known
14340 silicon revision of the targeted Blackfin processor.
14342 GCC defines a preprocessor macro for the specified @var{cpu}.
14343 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14344 provided by libgloss to be linked in if @option{-msim} is not given.
14346 Without this option, @samp{bf532} is used as the processor by default.
14348 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14349 only the preprocessor macro is defined.
14351 @item -msim
14352 @opindex msim
14353 Specifies that the program will be run on the simulator.  This causes
14354 the simulator BSP provided by libgloss to be linked in.  This option
14355 has effect only for @samp{bfin-elf} toolchain.
14356 Certain other options, such as @option{-mid-shared-library} and
14357 @option{-mfdpic}, imply @option{-msim}.
14359 @item -momit-leaf-frame-pointer
14360 @opindex momit-leaf-frame-pointer
14361 Don't keep the frame pointer in a register for leaf functions.  This
14362 avoids the instructions to save, set up and restore frame pointers and
14363 makes an extra register available in leaf functions.  The option
14364 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14365 which might make debugging harder.
14367 @item -mspecld-anomaly
14368 @opindex mspecld-anomaly
14369 When enabled, the compiler ensures that the generated code does not
14370 contain speculative loads after jump instructions. If this option is used,
14371 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14373 @item -mno-specld-anomaly
14374 @opindex mno-specld-anomaly
14375 Don't generate extra code to prevent speculative loads from occurring.
14377 @item -mcsync-anomaly
14378 @opindex mcsync-anomaly
14379 When enabled, the compiler ensures that the generated code does not
14380 contain CSYNC or SSYNC instructions too soon after conditional branches.
14381 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14383 @item -mno-csync-anomaly
14384 @opindex mno-csync-anomaly
14385 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14386 occurring too soon after a conditional branch.
14388 @item -mlow-64k
14389 @opindex mlow-64k
14390 When enabled, the compiler is free to take advantage of the knowledge that
14391 the entire program fits into the low 64k of memory.
14393 @item -mno-low-64k
14394 @opindex mno-low-64k
14395 Assume that the program is arbitrarily large.  This is the default.
14397 @item -mstack-check-l1
14398 @opindex mstack-check-l1
14399 Do stack checking using information placed into L1 scratchpad memory by the
14400 uClinux kernel.
14402 @item -mid-shared-library
14403 @opindex mid-shared-library
14404 Generate code that supports shared libraries via the library ID method.
14405 This allows for execute in place and shared libraries in an environment
14406 without virtual memory management.  This option implies @option{-fPIC}.
14407 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14409 @item -mno-id-shared-library
14410 @opindex mno-id-shared-library
14411 Generate code that doesn't assume ID-based shared libraries are being used.
14412 This is the default.
14414 @item -mleaf-id-shared-library
14415 @opindex mleaf-id-shared-library
14416 Generate code that supports shared libraries via the library ID method,
14417 but assumes that this library or executable won't link against any other
14418 ID shared libraries.  That allows the compiler to use faster code for jumps
14419 and calls.
14421 @item -mno-leaf-id-shared-library
14422 @opindex mno-leaf-id-shared-library
14423 Do not assume that the code being compiled won't link against any ID shared
14424 libraries.  Slower code is generated for jump and call insns.
14426 @item -mshared-library-id=n
14427 @opindex mshared-library-id
14428 Specifies the identification number of the ID-based shared library being
14429 compiled.  Specifying a value of 0 generates more compact code; specifying
14430 other values forces the allocation of that number to the current
14431 library but is no more space- or time-efficient than omitting this option.
14433 @item -msep-data
14434 @opindex msep-data
14435 Generate code that allows the data segment to be located in a different
14436 area of memory from the text segment.  This allows for execute in place in
14437 an environment without virtual memory management by eliminating relocations
14438 against the text section.
14440 @item -mno-sep-data
14441 @opindex mno-sep-data
14442 Generate code that assumes that the data segment follows the text segment.
14443 This is the default.
14445 @item -mlong-calls
14446 @itemx -mno-long-calls
14447 @opindex mlong-calls
14448 @opindex mno-long-calls
14449 Tells the compiler to perform function calls by first loading the
14450 address of the function into a register and then performing a subroutine
14451 call on this register.  This switch is needed if the target function
14452 lies outside of the 24-bit addressing range of the offset-based
14453 version of subroutine call instruction.
14455 This feature is not enabled by default.  Specifying
14456 @option{-mno-long-calls} restores the default behavior.  Note these
14457 switches have no effect on how the compiler generates code to handle
14458 function calls via function pointers.
14460 @item -mfast-fp
14461 @opindex mfast-fp
14462 Link with the fast floating-point library. This library relaxes some of
14463 the IEEE floating-point standard's rules for checking inputs against
14464 Not-a-Number (NAN), in the interest of performance.
14466 @item -minline-plt
14467 @opindex minline-plt
14468 Enable inlining of PLT entries in function calls to functions that are
14469 not known to bind locally.  It has no effect without @option{-mfdpic}.
14471 @item -mmulticore
14472 @opindex mmulticore
14473 Build a standalone application for multicore Blackfin processors. 
14474 This option causes proper start files and link scripts supporting 
14475 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14476 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14478 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14479 selects the one-application-per-core programming model.  Without
14480 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14481 programming model is used. In this model, the main function of Core B
14482 should be named as @code{coreb_main}.
14484 If this option is not used, the single-core application programming
14485 model is used.
14487 @item -mcorea
14488 @opindex mcorea
14489 Build a standalone application for Core A of BF561 when using
14490 the one-application-per-core programming model. Proper start files
14491 and link scripts are used to support Core A, and the macro
14492 @code{__BFIN_COREA} is defined.
14493 This option can only be used in conjunction with @option{-mmulticore}.
14495 @item -mcoreb
14496 @opindex mcoreb
14497 Build a standalone application for Core B of BF561 when using
14498 the one-application-per-core programming model. Proper start files
14499 and link scripts are used to support Core B, and the macro
14500 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14501 should be used instead of @code{main}. 
14502 This option can only be used in conjunction with @option{-mmulticore}.
14504 @item -msdram
14505 @opindex msdram
14506 Build a standalone application for SDRAM. Proper start files and
14507 link scripts are used to put the application into SDRAM, and the macro
14508 @code{__BFIN_SDRAM} is defined.
14509 The loader should initialize SDRAM before loading the application.
14511 @item -micplb
14512 @opindex micplb
14513 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14514 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14515 are enabled; for standalone applications the default is off.
14516 @end table
14518 @node C6X Options
14519 @subsection C6X Options
14520 @cindex C6X Options
14522 @table @gcctabopt
14523 @item -march=@var{name}
14524 @opindex march
14525 This specifies the name of the target architecture.  GCC uses this
14526 name to determine what kind of instructions it can emit when generating
14527 assembly code.  Permissible names are: @samp{c62x},
14528 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14530 @item -mbig-endian
14531 @opindex mbig-endian
14532 Generate code for a big-endian target.
14534 @item -mlittle-endian
14535 @opindex mlittle-endian
14536 Generate code for a little-endian target.  This is the default.
14538 @item -msim
14539 @opindex msim
14540 Choose startup files and linker script suitable for the simulator.
14542 @item -msdata=default
14543 @opindex msdata=default
14544 Put small global and static data in the @code{.neardata} section,
14545 which is pointed to by register @code{B14}.  Put small uninitialized
14546 global and static data in the @code{.bss} section, which is adjacent
14547 to the @code{.neardata} section.  Put small read-only data into the
14548 @code{.rodata} section.  The corresponding sections used for large
14549 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14551 @item -msdata=all
14552 @opindex msdata=all
14553 Put all data, not just small objects, into the sections reserved for
14554 small data, and use addressing relative to the @code{B14} register to
14555 access them.
14557 @item -msdata=none
14558 @opindex msdata=none
14559 Make no use of the sections reserved for small data, and use absolute
14560 addresses to access all data.  Put all initialized global and static
14561 data in the @code{.fardata} section, and all uninitialized data in the
14562 @code{.far} section.  Put all constant data into the @code{.const}
14563 section.
14564 @end table
14566 @node CRIS Options
14567 @subsection CRIS Options
14568 @cindex CRIS Options
14570 These options are defined specifically for the CRIS ports.
14572 @table @gcctabopt
14573 @item -march=@var{architecture-type}
14574 @itemx -mcpu=@var{architecture-type}
14575 @opindex march
14576 @opindex mcpu
14577 Generate code for the specified architecture.  The choices for
14578 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14579 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14580 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14581 @samp{v10}.
14583 @item -mtune=@var{architecture-type}
14584 @opindex mtune
14585 Tune to @var{architecture-type} everything applicable about the generated
14586 code, except for the ABI and the set of available instructions.  The
14587 choices for @var{architecture-type} are the same as for
14588 @option{-march=@var{architecture-type}}.
14590 @item -mmax-stack-frame=@var{n}
14591 @opindex mmax-stack-frame
14592 Warn when the stack frame of a function exceeds @var{n} bytes.
14594 @item -metrax4
14595 @itemx -metrax100
14596 @opindex metrax4
14597 @opindex metrax100
14598 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14599 @option{-march=v3} and @option{-march=v8} respectively.
14601 @item -mmul-bug-workaround
14602 @itemx -mno-mul-bug-workaround
14603 @opindex mmul-bug-workaround
14604 @opindex mno-mul-bug-workaround
14605 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14606 models where it applies.  This option is active by default.
14608 @item -mpdebug
14609 @opindex mpdebug
14610 Enable CRIS-specific verbose debug-related information in the assembly
14611 code.  This option also has the effect of turning off the @samp{#NO_APP}
14612 formatted-code indicator to the assembler at the beginning of the
14613 assembly file.
14615 @item -mcc-init
14616 @opindex mcc-init
14617 Do not use condition-code results from previous instruction; always emit
14618 compare and test instructions before use of condition codes.
14620 @item -mno-side-effects
14621 @opindex mno-side-effects
14622 Do not emit instructions with side effects in addressing modes other than
14623 post-increment.
14625 @item -mstack-align
14626 @itemx -mno-stack-align
14627 @itemx -mdata-align
14628 @itemx -mno-data-align
14629 @itemx -mconst-align
14630 @itemx -mno-const-align
14631 @opindex mstack-align
14632 @opindex mno-stack-align
14633 @opindex mdata-align
14634 @opindex mno-data-align
14635 @opindex mconst-align
14636 @opindex mno-const-align
14637 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14638 stack frame, individual data and constants to be aligned for the maximum
14639 single data access size for the chosen CPU model.  The default is to
14640 arrange for 32-bit alignment.  ABI details such as structure layout are
14641 not affected by these options.
14643 @item -m32-bit
14644 @itemx -m16-bit
14645 @itemx -m8-bit
14646 @opindex m32-bit
14647 @opindex m16-bit
14648 @opindex m8-bit
14649 Similar to the stack- data- and const-align options above, these options
14650 arrange for stack frame, writable data and constants to all be 32-bit,
14651 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14653 @item -mno-prologue-epilogue
14654 @itemx -mprologue-epilogue
14655 @opindex mno-prologue-epilogue
14656 @opindex mprologue-epilogue
14657 With @option{-mno-prologue-epilogue}, the normal function prologue and
14658 epilogue which set up the stack frame are omitted and no return
14659 instructions or return sequences are generated in the code.  Use this
14660 option only together with visual inspection of the compiled code: no
14661 warnings or errors are generated when call-saved registers must be saved,
14662 or storage for local variables needs to be allocated.
14664 @item -mno-gotplt
14665 @itemx -mgotplt
14666 @opindex mno-gotplt
14667 @opindex mgotplt
14668 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14669 instruction sequences that load addresses for functions from the PLT part
14670 of the GOT rather than (traditional on other architectures) calls to the
14671 PLT@.  The default is @option{-mgotplt}.
14673 @item -melf
14674 @opindex melf
14675 Legacy no-op option only recognized with the cris-axis-elf and
14676 cris-axis-linux-gnu targets.
14678 @item -mlinux
14679 @opindex mlinux
14680 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14682 @item -sim
14683 @opindex sim
14684 This option, recognized for the cris-axis-elf, arranges
14685 to link with input-output functions from a simulator library.  Code,
14686 initialized data and zero-initialized data are allocated consecutively.
14688 @item -sim2
14689 @opindex sim2
14690 Like @option{-sim}, but pass linker options to locate initialized data at
14691 0x40000000 and zero-initialized data at 0x80000000.
14692 @end table
14694 @node CR16 Options
14695 @subsection CR16 Options
14696 @cindex CR16 Options
14698 These options are defined specifically for the CR16 ports.
14700 @table @gcctabopt
14702 @item -mmac
14703 @opindex mmac
14704 Enable the use of multiply-accumulate instructions. Disabled by default.
14706 @item -mcr16cplus
14707 @itemx -mcr16c
14708 @opindex mcr16cplus
14709 @opindex mcr16c
14710 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14711 is default.
14713 @item -msim
14714 @opindex msim
14715 Links the library libsim.a which is in compatible with simulator. Applicable
14716 to ELF compiler only.
14718 @item -mint32
14719 @opindex mint32
14720 Choose integer type as 32-bit wide.
14722 @item -mbit-ops
14723 @opindex mbit-ops
14724 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14726 @item -mdata-model=@var{model}
14727 @opindex mdata-model
14728 Choose a data model. The choices for @var{model} are @samp{near},
14729 @samp{far} or @samp{medium}. @samp{medium} is default.
14730 However, @samp{far} is not valid with @option{-mcr16c}, as the
14731 CR16C architecture does not support the far data model.
14732 @end table
14734 @node Darwin Options
14735 @subsection Darwin Options
14736 @cindex Darwin options
14738 These options are defined for all architectures running the Darwin operating
14739 system.
14741 FSF GCC on Darwin does not create ``fat'' object files; it creates
14742 an object file for the single architecture that GCC was built to
14743 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14744 @option{-arch} options are used; it does so by running the compiler or
14745 linker multiple times and joining the results together with
14746 @file{lipo}.
14748 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14749 @samp{i686}) is determined by the flags that specify the ISA
14750 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14751 @option{-force_cpusubtype_ALL} option can be used to override this.
14753 The Darwin tools vary in their behavior when presented with an ISA
14754 mismatch.  The assembler, @file{as}, only permits instructions to
14755 be used that are valid for the subtype of the file it is generating,
14756 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14757 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14758 and prints an error if asked to create a shared library with a less
14759 restrictive subtype than its input files (for instance, trying to put
14760 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14761 for executables, @command{ld}, quietly gives the executable the most
14762 restrictive subtype of any of its input files.
14764 @table @gcctabopt
14765 @item -F@var{dir}
14766 @opindex F
14767 Add the framework directory @var{dir} to the head of the list of
14768 directories to be searched for header files.  These directories are
14769 interleaved with those specified by @option{-I} options and are
14770 scanned in a left-to-right order.
14772 A framework directory is a directory with frameworks in it.  A
14773 framework is a directory with a @file{Headers} and/or
14774 @file{PrivateHeaders} directory contained directly in it that ends
14775 in @file{.framework}.  The name of a framework is the name of this
14776 directory excluding the @file{.framework}.  Headers associated with
14777 the framework are found in one of those two directories, with
14778 @file{Headers} being searched first.  A subframework is a framework
14779 directory that is in a framework's @file{Frameworks} directory.
14780 Includes of subframework headers can only appear in a header of a
14781 framework that contains the subframework, or in a sibling subframework
14782 header.  Two subframeworks are siblings if they occur in the same
14783 framework.  A subframework should not have the same name as a
14784 framework; a warning is issued if this is violated.  Currently a
14785 subframework cannot have subframeworks; in the future, the mechanism
14786 may be extended to support this.  The standard frameworks can be found
14787 in @file{/System/Library/Frameworks} and
14788 @file{/Library/Frameworks}.  An example include looks like
14789 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14790 the name of the framework and @file{header.h} is found in the
14791 @file{PrivateHeaders} or @file{Headers} directory.
14793 @item -iframework@var{dir}
14794 @opindex iframework
14795 Like @option{-F} except the directory is a treated as a system
14796 directory.  The main difference between this @option{-iframework} and
14797 @option{-F} is that with @option{-iframework} the compiler does not
14798 warn about constructs contained within header files found via
14799 @var{dir}.  This option is valid only for the C family of languages.
14801 @item -gused
14802 @opindex gused
14803 Emit debugging information for symbols that are used.  For stabs
14804 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14805 This is by default ON@.
14807 @item -gfull
14808 @opindex gfull
14809 Emit debugging information for all symbols and types.
14811 @item -mmacosx-version-min=@var{version}
14812 The earliest version of MacOS X that this executable will run on
14813 is @var{version}.  Typical values of @var{version} include @code{10.1},
14814 @code{10.2}, and @code{10.3.9}.
14816 If the compiler was built to use the system's headers by default,
14817 then the default for this option is the system version on which the
14818 compiler is running, otherwise the default is to make choices that
14819 are compatible with as many systems and code bases as possible.
14821 @item -mkernel
14822 @opindex mkernel
14823 Enable kernel development mode.  The @option{-mkernel} option sets
14824 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14825 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14826 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14827 applicable.  This mode also sets @option{-mno-altivec},
14828 @option{-msoft-float}, @option{-fno-builtin} and
14829 @option{-mlong-branch} for PowerPC targets.
14831 @item -mone-byte-bool
14832 @opindex mone-byte-bool
14833 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14834 By default @code{sizeof(bool)} is @code{4} when compiling for
14835 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14836 option has no effect on x86.
14838 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14839 to generate code that is not binary compatible with code generated
14840 without that switch.  Using this switch may require recompiling all
14841 other modules in a program, including system libraries.  Use this
14842 switch to conform to a non-default data model.
14844 @item -mfix-and-continue
14845 @itemx -ffix-and-continue
14846 @itemx -findirect-data
14847 @opindex mfix-and-continue
14848 @opindex ffix-and-continue
14849 @opindex findirect-data
14850 Generate code suitable for fast turnaround development, such as to
14851 allow GDB to dynamically load @file{.o} files into already-running
14852 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14853 are provided for backwards compatibility.
14855 @item -all_load
14856 @opindex all_load
14857 Loads all members of static archive libraries.
14858 See man ld(1) for more information.
14860 @item -arch_errors_fatal
14861 @opindex arch_errors_fatal
14862 Cause the errors having to do with files that have the wrong architecture
14863 to be fatal.
14865 @item -bind_at_load
14866 @opindex bind_at_load
14867 Causes the output file to be marked such that the dynamic linker will
14868 bind all undefined references when the file is loaded or launched.
14870 @item -bundle
14871 @opindex bundle
14872 Produce a Mach-o bundle format file.
14873 See man ld(1) for more information.
14875 @item -bundle_loader @var{executable}
14876 @opindex bundle_loader
14877 This option specifies the @var{executable} that will load the build
14878 output file being linked.  See man ld(1) for more information.
14880 @item -dynamiclib
14881 @opindex dynamiclib
14882 When passed this option, GCC produces a dynamic library instead of
14883 an executable when linking, using the Darwin @file{libtool} command.
14885 @item -force_cpusubtype_ALL
14886 @opindex force_cpusubtype_ALL
14887 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14888 one controlled by the @option{-mcpu} or @option{-march} option.
14890 @item -allowable_client  @var{client_name}
14891 @itemx -client_name
14892 @itemx -compatibility_version
14893 @itemx -current_version
14894 @itemx -dead_strip
14895 @itemx -dependency-file
14896 @itemx -dylib_file
14897 @itemx -dylinker_install_name
14898 @itemx -dynamic
14899 @itemx -exported_symbols_list
14900 @itemx -filelist
14901 @need 800
14902 @itemx -flat_namespace
14903 @itemx -force_flat_namespace
14904 @itemx -headerpad_max_install_names
14905 @itemx -image_base
14906 @itemx -init
14907 @itemx -install_name
14908 @itemx -keep_private_externs
14909 @itemx -multi_module
14910 @itemx -multiply_defined
14911 @itemx -multiply_defined_unused
14912 @need 800
14913 @itemx -noall_load
14914 @itemx -no_dead_strip_inits_and_terms
14915 @itemx -nofixprebinding
14916 @itemx -nomultidefs
14917 @itemx -noprebind
14918 @itemx -noseglinkedit
14919 @itemx -pagezero_size
14920 @itemx -prebind
14921 @itemx -prebind_all_twolevel_modules
14922 @itemx -private_bundle
14923 @need 800
14924 @itemx -read_only_relocs
14925 @itemx -sectalign
14926 @itemx -sectobjectsymbols
14927 @itemx -whyload
14928 @itemx -seg1addr
14929 @itemx -sectcreate
14930 @itemx -sectobjectsymbols
14931 @itemx -sectorder
14932 @itemx -segaddr
14933 @itemx -segs_read_only_addr
14934 @need 800
14935 @itemx -segs_read_write_addr
14936 @itemx -seg_addr_table
14937 @itemx -seg_addr_table_filename
14938 @itemx -seglinkedit
14939 @itemx -segprot
14940 @itemx -segs_read_only_addr
14941 @itemx -segs_read_write_addr
14942 @itemx -single_module
14943 @itemx -static
14944 @itemx -sub_library
14945 @need 800
14946 @itemx -sub_umbrella
14947 @itemx -twolevel_namespace
14948 @itemx -umbrella
14949 @itemx -undefined
14950 @itemx -unexported_symbols_list
14951 @itemx -weak_reference_mismatches
14952 @itemx -whatsloaded
14953 @opindex allowable_client
14954 @opindex client_name
14955 @opindex compatibility_version
14956 @opindex current_version
14957 @opindex dead_strip
14958 @opindex dependency-file
14959 @opindex dylib_file
14960 @opindex dylinker_install_name
14961 @opindex dynamic
14962 @opindex exported_symbols_list
14963 @opindex filelist
14964 @opindex flat_namespace
14965 @opindex force_flat_namespace
14966 @opindex headerpad_max_install_names
14967 @opindex image_base
14968 @opindex init
14969 @opindex install_name
14970 @opindex keep_private_externs
14971 @opindex multi_module
14972 @opindex multiply_defined
14973 @opindex multiply_defined_unused
14974 @opindex noall_load
14975 @opindex no_dead_strip_inits_and_terms
14976 @opindex nofixprebinding
14977 @opindex nomultidefs
14978 @opindex noprebind
14979 @opindex noseglinkedit
14980 @opindex pagezero_size
14981 @opindex prebind
14982 @opindex prebind_all_twolevel_modules
14983 @opindex private_bundle
14984 @opindex read_only_relocs
14985 @opindex sectalign
14986 @opindex sectobjectsymbols
14987 @opindex whyload
14988 @opindex seg1addr
14989 @opindex sectcreate
14990 @opindex sectobjectsymbols
14991 @opindex sectorder
14992 @opindex segaddr
14993 @opindex segs_read_only_addr
14994 @opindex segs_read_write_addr
14995 @opindex seg_addr_table
14996 @opindex seg_addr_table_filename
14997 @opindex seglinkedit
14998 @opindex segprot
14999 @opindex segs_read_only_addr
15000 @opindex segs_read_write_addr
15001 @opindex single_module
15002 @opindex static
15003 @opindex sub_library
15004 @opindex sub_umbrella
15005 @opindex twolevel_namespace
15006 @opindex umbrella
15007 @opindex undefined
15008 @opindex unexported_symbols_list
15009 @opindex weak_reference_mismatches
15010 @opindex whatsloaded
15011 These options are passed to the Darwin linker.  The Darwin linker man page
15012 describes them in detail.
15013 @end table
15015 @node DEC Alpha Options
15016 @subsection DEC Alpha Options
15018 These @samp{-m} options are defined for the DEC Alpha implementations:
15020 @table @gcctabopt
15021 @item -mno-soft-float
15022 @itemx -msoft-float
15023 @opindex mno-soft-float
15024 @opindex msoft-float
15025 Use (do not use) the hardware floating-point instructions for
15026 floating-point operations.  When @option{-msoft-float} is specified,
15027 functions in @file{libgcc.a} are used to perform floating-point
15028 operations.  Unless they are replaced by routines that emulate the
15029 floating-point operations, or compiled in such a way as to call such
15030 emulations routines, these routines issue floating-point
15031 operations.   If you are compiling for an Alpha without floating-point
15032 operations, you must ensure that the library is built so as not to call
15033 them.
15035 Note that Alpha implementations without floating-point operations are
15036 required to have floating-point registers.
15038 @item -mfp-reg
15039 @itemx -mno-fp-regs
15040 @opindex mfp-reg
15041 @opindex mno-fp-regs
15042 Generate code that uses (does not use) the floating-point register set.
15043 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
15044 register set is not used, floating-point operands are passed in integer
15045 registers as if they were integers and floating-point results are passed
15046 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
15047 so any function with a floating-point argument or return value called by code
15048 compiled with @option{-mno-fp-regs} must also be compiled with that
15049 option.
15051 A typical use of this option is building a kernel that does not use,
15052 and hence need not save and restore, any floating-point registers.
15054 @item -mieee
15055 @opindex mieee
15056 The Alpha architecture implements floating-point hardware optimized for
15057 maximum performance.  It is mostly compliant with the IEEE floating-point
15058 standard.  However, for full compliance, software assistance is
15059 required.  This option generates code fully IEEE-compliant code
15060 @emph{except} that the @var{inexact-flag} is not maintained (see below).
15061 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
15062 defined during compilation.  The resulting code is less efficient but is
15063 able to correctly support denormalized numbers and exceptional IEEE
15064 values such as not-a-number and plus/minus infinity.  Other Alpha
15065 compilers call this option @option{-ieee_with_no_inexact}.
15067 @item -mieee-with-inexact
15068 @opindex mieee-with-inexact
15069 This is like @option{-mieee} except the generated code also maintains
15070 the IEEE @var{inexact-flag}.  Turning on this option causes the
15071 generated code to implement fully-compliant IEEE math.  In addition to
15072 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
15073 macro.  On some Alpha implementations the resulting code may execute
15074 significantly slower than the code generated by default.  Since there is
15075 very little code that depends on the @var{inexact-flag}, you should
15076 normally not specify this option.  Other Alpha compilers call this
15077 option @option{-ieee_with_inexact}.
15079 @item -mfp-trap-mode=@var{trap-mode}
15080 @opindex mfp-trap-mode
15081 This option controls what floating-point related traps are enabled.
15082 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
15083 The trap mode can be set to one of four values:
15085 @table @samp
15086 @item n
15087 This is the default (normal) setting.  The only traps that are enabled
15088 are the ones that cannot be disabled in software (e.g., division by zero
15089 trap).
15091 @item u
15092 In addition to the traps enabled by @samp{n}, underflow traps are enabled
15093 as well.
15095 @item su
15096 Like @samp{u}, but the instructions are marked to be safe for software
15097 completion (see Alpha architecture manual for details).
15099 @item sui
15100 Like @samp{su}, but inexact traps are enabled as well.
15101 @end table
15103 @item -mfp-rounding-mode=@var{rounding-mode}
15104 @opindex mfp-rounding-mode
15105 Selects the IEEE rounding mode.  Other Alpha compilers call this option
15106 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
15109 @table @samp
15110 @item n
15111 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
15112 the nearest machine number or towards the even machine number in case
15113 of a tie.
15115 @item m
15116 Round towards minus infinity.
15118 @item c
15119 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
15121 @item d
15122 Dynamic rounding mode.  A field in the floating-point control register
15123 (@var{fpcr}, see Alpha architecture reference manual) controls the
15124 rounding mode in effect.  The C library initializes this register for
15125 rounding towards plus infinity.  Thus, unless your program modifies the
15126 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
15127 @end table
15129 @item -mtrap-precision=@var{trap-precision}
15130 @opindex mtrap-precision
15131 In the Alpha architecture, floating-point traps are imprecise.  This
15132 means without software assistance it is impossible to recover from a
15133 floating trap and program execution normally needs to be terminated.
15134 GCC can generate code that can assist operating system trap handlers
15135 in determining the exact location that caused a floating-point trap.
15136 Depending on the requirements of an application, different levels of
15137 precisions can be selected:
15139 @table @samp
15140 @item p
15141 Program precision.  This option is the default and means a trap handler
15142 can only identify which program caused a floating-point exception.
15144 @item f
15145 Function precision.  The trap handler can determine the function that
15146 caused a floating-point exception.
15148 @item i
15149 Instruction precision.  The trap handler can determine the exact
15150 instruction that caused a floating-point exception.
15151 @end table
15153 Other Alpha compilers provide the equivalent options called
15154 @option{-scope_safe} and @option{-resumption_safe}.
15156 @item -mieee-conformant
15157 @opindex mieee-conformant
15158 This option marks the generated code as IEEE conformant.  You must not
15159 use this option unless you also specify @option{-mtrap-precision=i} and either
15160 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
15161 is to emit the line @samp{.eflag 48} in the function prologue of the
15162 generated assembly file.
15164 @item -mbuild-constants
15165 @opindex mbuild-constants
15166 Normally GCC examines a 32- or 64-bit integer constant to
15167 see if it can construct it from smaller constants in two or three
15168 instructions.  If it cannot, it outputs the constant as a literal and
15169 generates code to load it from the data segment at run time.
15171 Use this option to require GCC to construct @emph{all} integer constants
15172 using code, even if it takes more instructions (the maximum is six).
15174 You typically use this option to build a shared library dynamic
15175 loader.  Itself a shared library, it must relocate itself in memory
15176 before it can find the variables and constants in its own data segment.
15178 @item -mbwx
15179 @itemx -mno-bwx
15180 @itemx -mcix
15181 @itemx -mno-cix
15182 @itemx -mfix
15183 @itemx -mno-fix
15184 @itemx -mmax
15185 @itemx -mno-max
15186 @opindex mbwx
15187 @opindex mno-bwx
15188 @opindex mcix
15189 @opindex mno-cix
15190 @opindex mfix
15191 @opindex mno-fix
15192 @opindex mmax
15193 @opindex mno-max
15194 Indicate whether GCC should generate code to use the optional BWX,
15195 CIX, FIX and MAX instruction sets.  The default is to use the instruction
15196 sets supported by the CPU type specified via @option{-mcpu=} option or that
15197 of the CPU on which GCC was built if none is specified.
15199 @item -mfloat-vax
15200 @itemx -mfloat-ieee
15201 @opindex mfloat-vax
15202 @opindex mfloat-ieee
15203 Generate code that uses (does not use) VAX F and G floating-point
15204 arithmetic instead of IEEE single and double precision.
15206 @item -mexplicit-relocs
15207 @itemx -mno-explicit-relocs
15208 @opindex mexplicit-relocs
15209 @opindex mno-explicit-relocs
15210 Older Alpha assemblers provided no way to generate symbol relocations
15211 except via assembler macros.  Use of these macros does not allow
15212 optimal instruction scheduling.  GNU binutils as of version 2.12
15213 supports a new syntax that allows the compiler to explicitly mark
15214 which relocations should apply to which instructions.  This option
15215 is mostly useful for debugging, as GCC detects the capabilities of
15216 the assembler when it is built and sets the default accordingly.
15218 @item -msmall-data
15219 @itemx -mlarge-data
15220 @opindex msmall-data
15221 @opindex mlarge-data
15222 When @option{-mexplicit-relocs} is in effect, static data is
15223 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
15224 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
15225 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
15226 16-bit relocations off of the @code{$gp} register.  This limits the
15227 size of the small data area to 64KB, but allows the variables to be
15228 directly accessed via a single instruction.
15230 The default is @option{-mlarge-data}.  With this option the data area
15231 is limited to just below 2GB@.  Programs that require more than 2GB of
15232 data must use @code{malloc} or @code{mmap} to allocate the data in the
15233 heap instead of in the program's data segment.
15235 When generating code for shared libraries, @option{-fpic} implies
15236 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
15238 @item -msmall-text
15239 @itemx -mlarge-text
15240 @opindex msmall-text
15241 @opindex mlarge-text
15242 When @option{-msmall-text} is used, the compiler assumes that the
15243 code of the entire program (or shared library) fits in 4MB, and is
15244 thus reachable with a branch instruction.  When @option{-msmall-data}
15245 is used, the compiler can assume that all local symbols share the
15246 same @code{$gp} value, and thus reduce the number of instructions
15247 required for a function call from 4 to 1.
15249 The default is @option{-mlarge-text}.
15251 @item -mcpu=@var{cpu_type}
15252 @opindex mcpu
15253 Set the instruction set and instruction scheduling parameters for
15254 machine type @var{cpu_type}.  You can specify either the @samp{EV}
15255 style name or the corresponding chip number.  GCC supports scheduling
15256 parameters for the EV4, EV5 and EV6 family of processors and
15257 chooses the default values for the instruction set from the processor
15258 you specify.  If you do not specify a processor type, GCC defaults
15259 to the processor on which the compiler was built.
15261 Supported values for @var{cpu_type} are
15263 @table @samp
15264 @item ev4
15265 @itemx ev45
15266 @itemx 21064
15267 Schedules as an EV4 and has no instruction set extensions.
15269 @item ev5
15270 @itemx 21164
15271 Schedules as an EV5 and has no instruction set extensions.
15273 @item ev56
15274 @itemx 21164a
15275 Schedules as an EV5 and supports the BWX extension.
15277 @item pca56
15278 @itemx 21164pc
15279 @itemx 21164PC
15280 Schedules as an EV5 and supports the BWX and MAX extensions.
15282 @item ev6
15283 @itemx 21264
15284 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15286 @item ev67
15287 @itemx 21264a
15288 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15289 @end table
15291 Native toolchains also support the value @samp{native},
15292 which selects the best architecture option for the host processor.
15293 @option{-mcpu=native} has no effect if GCC does not recognize
15294 the processor.
15296 @item -mtune=@var{cpu_type}
15297 @opindex mtune
15298 Set only the instruction scheduling parameters for machine type
15299 @var{cpu_type}.  The instruction set is not changed.
15301 Native toolchains also support the value @samp{native},
15302 which selects the best architecture option for the host processor.
15303 @option{-mtune=native} has no effect if GCC does not recognize
15304 the processor.
15306 @item -mmemory-latency=@var{time}
15307 @opindex mmemory-latency
15308 Sets the latency the scheduler should assume for typical memory
15309 references as seen by the application.  This number is highly
15310 dependent on the memory access patterns used by the application
15311 and the size of the external cache on the machine.
15313 Valid options for @var{time} are
15315 @table @samp
15316 @item @var{number}
15317 A decimal number representing clock cycles.
15319 @item L1
15320 @itemx L2
15321 @itemx L3
15322 @itemx main
15323 The compiler contains estimates of the number of clock cycles for
15324 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15325 (also called Dcache, Scache, and Bcache), as well as to main memory.
15326 Note that L3 is only valid for EV5.
15328 @end table
15329 @end table
15331 @node FR30 Options
15332 @subsection FR30 Options
15333 @cindex FR30 Options
15335 These options are defined specifically for the FR30 port.
15337 @table @gcctabopt
15339 @item -msmall-model
15340 @opindex msmall-model
15341 Use the small address space model.  This can produce smaller code, but
15342 it does assume that all symbolic values and addresses fit into a
15343 20-bit range.
15345 @item -mno-lsim
15346 @opindex mno-lsim
15347 Assume that runtime support has been provided and so there is no need
15348 to include the simulator library (@file{libsim.a}) on the linker
15349 command line.
15351 @end table
15353 @node FT32 Options
15354 @subsection FT32 Options
15355 @cindex FT32 Options
15357 These options are defined specifically for the FT32 port.
15359 @table @gcctabopt
15361 @item -msim
15362 @opindex msim
15363 Specifies that the program will be run on the simulator.  This causes
15364 an alternate runtime startup and library to be linked.
15365 You must not use this option when generating programs that will run on
15366 real hardware; you must provide your own runtime library for whatever
15367 I/O functions are needed.
15369 @item -mlra
15370 @opindex mlra
15371 Enable Local Register Allocation.  This is still experimental for FT32,
15372 so by default the compiler uses standard reload.
15374 @end table
15376 @node FRV Options
15377 @subsection FRV Options
15378 @cindex FRV Options
15380 @table @gcctabopt
15381 @item -mgpr-32
15382 @opindex mgpr-32
15384 Only use the first 32 general-purpose registers.
15386 @item -mgpr-64
15387 @opindex mgpr-64
15389 Use all 64 general-purpose registers.
15391 @item -mfpr-32
15392 @opindex mfpr-32
15394 Use only the first 32 floating-point registers.
15396 @item -mfpr-64
15397 @opindex mfpr-64
15399 Use all 64 floating-point registers.
15401 @item -mhard-float
15402 @opindex mhard-float
15404 Use hardware instructions for floating-point operations.
15406 @item -msoft-float
15407 @opindex msoft-float
15409 Use library routines for floating-point operations.
15411 @item -malloc-cc
15412 @opindex malloc-cc
15414 Dynamically allocate condition code registers.
15416 @item -mfixed-cc
15417 @opindex mfixed-cc
15419 Do not try to dynamically allocate condition code registers, only
15420 use @code{icc0} and @code{fcc0}.
15422 @item -mdword
15423 @opindex mdword
15425 Change ABI to use double word insns.
15427 @item -mno-dword
15428 @opindex mno-dword
15430 Do not use double word instructions.
15432 @item -mdouble
15433 @opindex mdouble
15435 Use floating-point double instructions.
15437 @item -mno-double
15438 @opindex mno-double
15440 Do not use floating-point double instructions.
15442 @item -mmedia
15443 @opindex mmedia
15445 Use media instructions.
15447 @item -mno-media
15448 @opindex mno-media
15450 Do not use media instructions.
15452 @item -mmuladd
15453 @opindex mmuladd
15455 Use multiply and add/subtract instructions.
15457 @item -mno-muladd
15458 @opindex mno-muladd
15460 Do not use multiply and add/subtract instructions.
15462 @item -mfdpic
15463 @opindex mfdpic
15465 Select the FDPIC ABI, which uses function descriptors to represent
15466 pointers to functions.  Without any PIC/PIE-related options, it
15467 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15468 assumes GOT entries and small data are within a 12-bit range from the
15469 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15470 are computed with 32 bits.
15471 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15473 @item -minline-plt
15474 @opindex minline-plt
15476 Enable inlining of PLT entries in function calls to functions that are
15477 not known to bind locally.  It has no effect without @option{-mfdpic}.
15478 It's enabled by default if optimizing for speed and compiling for
15479 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15480 optimization option such as @option{-O3} or above is present in the
15481 command line.
15483 @item -mTLS
15484 @opindex mTLS
15486 Assume a large TLS segment when generating thread-local code.
15488 @item -mtls
15489 @opindex mtls
15491 Do not assume a large TLS segment when generating thread-local code.
15493 @item -mgprel-ro
15494 @opindex mgprel-ro
15496 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15497 that is known to be in read-only sections.  It's enabled by default,
15498 except for @option{-fpic} or @option{-fpie}: even though it may help
15499 make the global offset table smaller, it trades 1 instruction for 4.
15500 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15501 one of which may be shared by multiple symbols, and it avoids the need
15502 for a GOT entry for the referenced symbol, so it's more likely to be a
15503 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15505 @item -multilib-library-pic
15506 @opindex multilib-library-pic
15508 Link with the (library, not FD) pic libraries.  It's implied by
15509 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15510 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15511 it explicitly.
15513 @item -mlinked-fp
15514 @opindex mlinked-fp
15516 Follow the EABI requirement of always creating a frame pointer whenever
15517 a stack frame is allocated.  This option is enabled by default and can
15518 be disabled with @option{-mno-linked-fp}.
15520 @item -mlong-calls
15521 @opindex mlong-calls
15523 Use indirect addressing to call functions outside the current
15524 compilation unit.  This allows the functions to be placed anywhere
15525 within the 32-bit address space.
15527 @item -malign-labels
15528 @opindex malign-labels
15530 Try to align labels to an 8-byte boundary by inserting NOPs into the
15531 previous packet.  This option only has an effect when VLIW packing
15532 is enabled.  It doesn't create new packets; it merely adds NOPs to
15533 existing ones.
15535 @item -mlibrary-pic
15536 @opindex mlibrary-pic
15538 Generate position-independent EABI code.
15540 @item -macc-4
15541 @opindex macc-4
15543 Use only the first four media accumulator registers.
15545 @item -macc-8
15546 @opindex macc-8
15548 Use all eight media accumulator registers.
15550 @item -mpack
15551 @opindex mpack
15553 Pack VLIW instructions.
15555 @item -mno-pack
15556 @opindex mno-pack
15558 Do not pack VLIW instructions.
15560 @item -mno-eflags
15561 @opindex mno-eflags
15563 Do not mark ABI switches in e_flags.
15565 @item -mcond-move
15566 @opindex mcond-move
15568 Enable the use of conditional-move instructions (default).
15570 This switch is mainly for debugging the compiler and will likely be removed
15571 in a future version.
15573 @item -mno-cond-move
15574 @opindex mno-cond-move
15576 Disable the use of conditional-move instructions.
15578 This switch is mainly for debugging the compiler and will likely be removed
15579 in a future version.
15581 @item -mscc
15582 @opindex mscc
15584 Enable the use of conditional set instructions (default).
15586 This switch is mainly for debugging the compiler and will likely be removed
15587 in a future version.
15589 @item -mno-scc
15590 @opindex mno-scc
15592 Disable the use of conditional set instructions.
15594 This switch is mainly for debugging the compiler and will likely be removed
15595 in a future version.
15597 @item -mcond-exec
15598 @opindex mcond-exec
15600 Enable the use of conditional execution (default).
15602 This switch is mainly for debugging the compiler and will likely be removed
15603 in a future version.
15605 @item -mno-cond-exec
15606 @opindex mno-cond-exec
15608 Disable the use of conditional execution.
15610 This switch is mainly for debugging the compiler and will likely be removed
15611 in a future version.
15613 @item -mvliw-branch
15614 @opindex mvliw-branch
15616 Run a pass to pack branches into VLIW instructions (default).
15618 This switch is mainly for debugging the compiler and will likely be removed
15619 in a future version.
15621 @item -mno-vliw-branch
15622 @opindex mno-vliw-branch
15624 Do not run a pass to pack branches into VLIW instructions.
15626 This switch is mainly for debugging the compiler and will likely be removed
15627 in a future version.
15629 @item -mmulti-cond-exec
15630 @opindex mmulti-cond-exec
15632 Enable optimization of @code{&&} and @code{||} in conditional execution
15633 (default).
15635 This switch is mainly for debugging the compiler and will likely be removed
15636 in a future version.
15638 @item -mno-multi-cond-exec
15639 @opindex mno-multi-cond-exec
15641 Disable optimization of @code{&&} and @code{||} in conditional execution.
15643 This switch is mainly for debugging the compiler and will likely be removed
15644 in a future version.
15646 @item -mnested-cond-exec
15647 @opindex mnested-cond-exec
15649 Enable nested conditional execution optimizations (default).
15651 This switch is mainly for debugging the compiler and will likely be removed
15652 in a future version.
15654 @item -mno-nested-cond-exec
15655 @opindex mno-nested-cond-exec
15657 Disable nested conditional execution optimizations.
15659 This switch is mainly for debugging the compiler and will likely be removed
15660 in a future version.
15662 @item -moptimize-membar
15663 @opindex moptimize-membar
15665 This switch removes redundant @code{membar} instructions from the
15666 compiler-generated code.  It is enabled by default.
15668 @item -mno-optimize-membar
15669 @opindex mno-optimize-membar
15671 This switch disables the automatic removal of redundant @code{membar}
15672 instructions from the generated code.
15674 @item -mtomcat-stats
15675 @opindex mtomcat-stats
15677 Cause gas to print out tomcat statistics.
15679 @item -mcpu=@var{cpu}
15680 @opindex mcpu
15682 Select the processor type for which to generate code.  Possible values are
15683 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15684 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15686 @end table
15688 @node GNU/Linux Options
15689 @subsection GNU/Linux Options
15691 These @samp{-m} options are defined for GNU/Linux targets:
15693 @table @gcctabopt
15694 @item -mglibc
15695 @opindex mglibc
15696 Use the GNU C library.  This is the default except
15697 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15698 @samp{*-*-linux-*android*} targets.
15700 @item -muclibc
15701 @opindex muclibc
15702 Use uClibc C library.  This is the default on
15703 @samp{*-*-linux-*uclibc*} targets.
15705 @item -mmusl
15706 @opindex mmusl
15707 Use the musl C library.  This is the default on
15708 @samp{*-*-linux-*musl*} targets.
15710 @item -mbionic
15711 @opindex mbionic
15712 Use Bionic C library.  This is the default on
15713 @samp{*-*-linux-*android*} targets.
15715 @item -mandroid
15716 @opindex mandroid
15717 Compile code compatible with Android platform.  This is the default on
15718 @samp{*-*-linux-*android*} targets.
15720 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15721 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15722 this option makes the GCC driver pass Android-specific options to the linker.
15723 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15724 to be defined.
15726 @item -tno-android-cc
15727 @opindex tno-android-cc
15728 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15729 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15730 @option{-fno-rtti} by default.
15732 @item -tno-android-ld
15733 @opindex tno-android-ld
15734 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15735 linking options to the linker.
15737 @end table
15739 @node H8/300 Options
15740 @subsection H8/300 Options
15742 These @samp{-m} options are defined for the H8/300 implementations:
15744 @table @gcctabopt
15745 @item -mrelax
15746 @opindex mrelax
15747 Shorten some address references at link time, when possible; uses the
15748 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15749 ld, Using ld}, for a fuller description.
15751 @item -mh
15752 @opindex mh
15753 Generate code for the H8/300H@.
15755 @item -ms
15756 @opindex ms
15757 Generate code for the H8S@.
15759 @item -mn
15760 @opindex mn
15761 Generate code for the H8S and H8/300H in the normal mode.  This switch
15762 must be used either with @option{-mh} or @option{-ms}.
15764 @item -ms2600
15765 @opindex ms2600
15766 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15768 @item -mexr
15769 @opindex mexr
15770 Extended registers are stored on stack before execution of function
15771 with monitor attribute. Default option is @option{-mexr}.
15772 This option is valid only for H8S targets.
15774 @item -mno-exr
15775 @opindex mno-exr
15776 Extended registers are not stored on stack before execution of function 
15777 with monitor attribute. Default option is @option{-mno-exr}. 
15778 This option is valid only for H8S targets.
15780 @item -mint32
15781 @opindex mint32
15782 Make @code{int} data 32 bits by default.
15784 @item -malign-300
15785 @opindex malign-300
15786 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15787 The default for the H8/300H and H8S is to align longs and floats on
15788 4-byte boundaries.
15789 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15790 This option has no effect on the H8/300.
15791 @end table
15793 @node HPPA Options
15794 @subsection HPPA Options
15795 @cindex HPPA Options
15797 These @samp{-m} options are defined for the HPPA family of computers:
15799 @table @gcctabopt
15800 @item -march=@var{architecture-type}
15801 @opindex march
15802 Generate code for the specified architecture.  The choices for
15803 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15804 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15805 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15806 architecture option for your machine.  Code compiled for lower numbered
15807 architectures runs on higher numbered architectures, but not the
15808 other way around.
15810 @item -mpa-risc-1-0
15811 @itemx -mpa-risc-1-1
15812 @itemx -mpa-risc-2-0
15813 @opindex mpa-risc-1-0
15814 @opindex mpa-risc-1-1
15815 @opindex mpa-risc-2-0
15816 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15818 @item -mjump-in-delay
15819 @opindex mjump-in-delay
15820 This option is ignored and provided for compatibility purposes only.
15822 @item -mdisable-fpregs
15823 @opindex mdisable-fpregs
15824 Prevent floating-point registers from being used in any manner.  This is
15825 necessary for compiling kernels that perform lazy context switching of
15826 floating-point registers.  If you use this option and attempt to perform
15827 floating-point operations, the compiler aborts.
15829 @item -mdisable-indexing
15830 @opindex mdisable-indexing
15831 Prevent the compiler from using indexing address modes.  This avoids some
15832 rather obscure problems when compiling MIG generated code under MACH@.
15834 @item -mno-space-regs
15835 @opindex mno-space-regs
15836 Generate code that assumes the target has no space registers.  This allows
15837 GCC to generate faster indirect calls and use unscaled index address modes.
15839 Such code is suitable for level 0 PA systems and kernels.
15841 @item -mfast-indirect-calls
15842 @opindex mfast-indirect-calls
15843 Generate code that assumes calls never cross space boundaries.  This
15844 allows GCC to emit code that performs faster indirect calls.
15846 This option does not work in the presence of shared libraries or nested
15847 functions.
15849 @item -mfixed-range=@var{register-range}
15850 @opindex mfixed-range
15851 Generate code treating the given register range as fixed registers.
15852 A fixed register is one that the register allocator cannot use.  This is
15853 useful when compiling kernel code.  A register range is specified as
15854 two registers separated by a dash.  Multiple register ranges can be
15855 specified separated by a comma.
15857 @item -mlong-load-store
15858 @opindex mlong-load-store
15859 Generate 3-instruction load and store sequences as sometimes required by
15860 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15861 the HP compilers.
15863 @item -mportable-runtime
15864 @opindex mportable-runtime
15865 Use the portable calling conventions proposed by HP for ELF systems.
15867 @item -mgas
15868 @opindex mgas
15869 Enable the use of assembler directives only GAS understands.
15871 @item -mschedule=@var{cpu-type}
15872 @opindex mschedule
15873 Schedule code according to the constraints for the machine type
15874 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15875 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15876 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15877 proper scheduling option for your machine.  The default scheduling is
15878 @samp{8000}.
15880 @item -mlinker-opt
15881 @opindex mlinker-opt
15882 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15883 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15884 linkers in which they give bogus error messages when linking some programs.
15886 @item -msoft-float
15887 @opindex msoft-float
15888 Generate output containing library calls for floating point.
15889 @strong{Warning:} the requisite libraries are not available for all HPPA
15890 targets.  Normally the facilities of the machine's usual C compiler are
15891 used, but this cannot be done directly in cross-compilation.  You must make
15892 your own arrangements to provide suitable library functions for
15893 cross-compilation.
15895 @option{-msoft-float} changes the calling convention in the output file;
15896 therefore, it is only useful if you compile @emph{all} of a program with
15897 this option.  In particular, you need to compile @file{libgcc.a}, the
15898 library that comes with GCC, with @option{-msoft-float} in order for
15899 this to work.
15901 @item -msio
15902 @opindex msio
15903 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15904 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15905 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15906 options are available under HP-UX and HI-UX@.
15908 @item -mgnu-ld
15909 @opindex mgnu-ld
15910 Use options specific to GNU @command{ld}.
15911 This passes @option{-shared} to @command{ld} when
15912 building a shared library.  It is the default when GCC is configured,
15913 explicitly or implicitly, with the GNU linker.  This option does not
15914 affect which @command{ld} is called; it only changes what parameters
15915 are passed to that @command{ld}.
15916 The @command{ld} that is called is determined by the
15917 @option{--with-ld} configure option, GCC's program search path, and
15918 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15919 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15920 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15922 @item -mhp-ld
15923 @opindex mhp-ld
15924 Use options specific to HP @command{ld}.
15925 This passes @option{-b} to @command{ld} when building
15926 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15927 links.  It is the default when GCC is configured, explicitly or
15928 implicitly, with the HP linker.  This option does not affect
15929 which @command{ld} is called; it only changes what parameters are passed to that
15930 @command{ld}.
15931 The @command{ld} that is called is determined by the @option{--with-ld}
15932 configure option, GCC's program search path, and finally by the user's
15933 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15934 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15935 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15937 @item -mlong-calls
15938 @opindex mno-long-calls
15939 Generate code that uses long call sequences.  This ensures that a call
15940 is always able to reach linker generated stubs.  The default is to generate
15941 long calls only when the distance from the call site to the beginning
15942 of the function or translation unit, as the case may be, exceeds a
15943 predefined limit set by the branch type being used.  The limits for
15944 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15945 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15946 240,000 bytes.
15948 Distances are measured from the beginning of functions when using the
15949 @option{-ffunction-sections} option, or when using the @option{-mgas}
15950 and @option{-mno-portable-runtime} options together under HP-UX with
15951 the SOM linker.
15953 It is normally not desirable to use this option as it degrades
15954 performance.  However, it may be useful in large applications,
15955 particularly when partial linking is used to build the application.
15957 The types of long calls used depends on the capabilities of the
15958 assembler and linker, and the type of code being generated.  The
15959 impact on systems that support long absolute calls, and long pic
15960 symbol-difference or pc-relative calls should be relatively small.
15961 However, an indirect call is used on 32-bit ELF systems in pic code
15962 and it is quite long.
15964 @item -munix=@var{unix-std}
15965 @opindex march
15966 Generate compiler predefines and select a startfile for the specified
15967 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15968 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15969 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15970 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15971 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15972 and later.
15974 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15975 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15976 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15977 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15978 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15979 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15981 It is @emph{important} to note that this option changes the interfaces
15982 for various library routines.  It also affects the operational behavior
15983 of the C library.  Thus, @emph{extreme} care is needed in using this
15984 option.
15986 Library code that is intended to operate with more than one UNIX
15987 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15988 as appropriate.  Most GNU software doesn't provide this capability.
15990 @item -nolibdld
15991 @opindex nolibdld
15992 Suppress the generation of link options to search libdld.sl when the
15993 @option{-static} option is specified on HP-UX 10 and later.
15995 @item -static
15996 @opindex static
15997 The HP-UX implementation of setlocale in libc has a dependency on
15998 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15999 when the @option{-static} option is specified, special link options
16000 are needed to resolve this dependency.
16002 On HP-UX 10 and later, the GCC driver adds the necessary options to
16003 link with libdld.sl when the @option{-static} option is specified.
16004 This causes the resulting binary to be dynamic.  On the 64-bit port,
16005 the linkers generate dynamic binaries by default in any case.  The
16006 @option{-nolibdld} option can be used to prevent the GCC driver from
16007 adding these link options.
16009 @item -threads
16010 @opindex threads
16011 Add support for multithreading with the @dfn{dce thread} library
16012 under HP-UX@.  This option sets flags for both the preprocessor and
16013 linker.
16014 @end table
16016 @node IA-64 Options
16017 @subsection IA-64 Options
16018 @cindex IA-64 Options
16020 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16022 @table @gcctabopt
16023 @item -mbig-endian
16024 @opindex mbig-endian
16025 Generate code for a big-endian target.  This is the default for HP-UX@.
16027 @item -mlittle-endian
16028 @opindex mlittle-endian
16029 Generate code for a little-endian target.  This is the default for AIX5
16030 and GNU/Linux.
16032 @item -mgnu-as
16033 @itemx -mno-gnu-as
16034 @opindex mgnu-as
16035 @opindex mno-gnu-as
16036 Generate (or don't) code for the GNU assembler.  This is the default.
16037 @c Also, this is the default if the configure option @option{--with-gnu-as}
16038 @c is used.
16040 @item -mgnu-ld
16041 @itemx -mno-gnu-ld
16042 @opindex mgnu-ld
16043 @opindex mno-gnu-ld
16044 Generate (or don't) code for the GNU linker.  This is the default.
16045 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16046 @c is used.
16048 @item -mno-pic
16049 @opindex mno-pic
16050 Generate code that does not use a global pointer register.  The result
16051 is not position independent code, and violates the IA-64 ABI@.
16053 @item -mvolatile-asm-stop
16054 @itemx -mno-volatile-asm-stop
16055 @opindex mvolatile-asm-stop
16056 @opindex mno-volatile-asm-stop
16057 Generate (or don't) a stop bit immediately before and after volatile asm
16058 statements.
16060 @item -mregister-names
16061 @itemx -mno-register-names
16062 @opindex mregister-names
16063 @opindex mno-register-names
16064 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16065 the stacked registers.  This may make assembler output more readable.
16067 @item -mno-sdata
16068 @itemx -msdata
16069 @opindex mno-sdata
16070 @opindex msdata
16071 Disable (or enable) optimizations that use the small data section.  This may
16072 be useful for working around optimizer bugs.
16074 @item -mconstant-gp
16075 @opindex mconstant-gp
16076 Generate code that uses a single constant global pointer value.  This is
16077 useful when compiling kernel code.
16079 @item -mauto-pic
16080 @opindex mauto-pic
16081 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16082 This is useful when compiling firmware code.
16084 @item -minline-float-divide-min-latency
16085 @opindex minline-float-divide-min-latency
16086 Generate code for inline divides of floating-point values
16087 using the minimum latency algorithm.
16089 @item -minline-float-divide-max-throughput
16090 @opindex minline-float-divide-max-throughput
16091 Generate code for inline divides of floating-point values
16092 using the maximum throughput algorithm.
16094 @item -mno-inline-float-divide
16095 @opindex mno-inline-float-divide
16096 Do not generate inline code for divides of floating-point values.
16098 @item -minline-int-divide-min-latency
16099 @opindex minline-int-divide-min-latency
16100 Generate code for inline divides of integer values
16101 using the minimum latency algorithm.
16103 @item -minline-int-divide-max-throughput
16104 @opindex minline-int-divide-max-throughput
16105 Generate code for inline divides of integer values
16106 using the maximum throughput algorithm.
16108 @item -mno-inline-int-divide
16109 @opindex mno-inline-int-divide
16110 Do not generate inline code for divides of integer values.
16112 @item -minline-sqrt-min-latency
16113 @opindex minline-sqrt-min-latency
16114 Generate code for inline square roots
16115 using the minimum latency algorithm.
16117 @item -minline-sqrt-max-throughput
16118 @opindex minline-sqrt-max-throughput
16119 Generate code for inline square roots
16120 using the maximum throughput algorithm.
16122 @item -mno-inline-sqrt
16123 @opindex mno-inline-sqrt
16124 Do not generate inline code for @code{sqrt}.
16126 @item -mfused-madd
16127 @itemx -mno-fused-madd
16128 @opindex mfused-madd
16129 @opindex mno-fused-madd
16130 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16131 instructions.  The default is to use these instructions.
16133 @item -mno-dwarf2-asm
16134 @itemx -mdwarf2-asm
16135 @opindex mno-dwarf2-asm
16136 @opindex mdwarf2-asm
16137 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16138 info.  This may be useful when not using the GNU assembler.
16140 @item -mearly-stop-bits
16141 @itemx -mno-early-stop-bits
16142 @opindex mearly-stop-bits
16143 @opindex mno-early-stop-bits
16144 Allow stop bits to be placed earlier than immediately preceding the
16145 instruction that triggered the stop bit.  This can improve instruction
16146 scheduling, but does not always do so.
16148 @item -mfixed-range=@var{register-range}
16149 @opindex mfixed-range
16150 Generate code treating the given register range as fixed registers.
16151 A fixed register is one that the register allocator cannot use.  This is
16152 useful when compiling kernel code.  A register range is specified as
16153 two registers separated by a dash.  Multiple register ranges can be
16154 specified separated by a comma.
16156 @item -mtls-size=@var{tls-size}
16157 @opindex mtls-size
16158 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16161 @item -mtune=@var{cpu-type}
16162 @opindex mtune
16163 Tune the instruction scheduling for a particular CPU, Valid values are
16164 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16165 and @samp{mckinley}.
16167 @item -milp32
16168 @itemx -mlp64
16169 @opindex milp32
16170 @opindex mlp64
16171 Generate code for a 32-bit or 64-bit environment.
16172 The 32-bit environment sets int, long and pointer to 32 bits.
16173 The 64-bit environment sets int to 32 bits and long and pointer
16174 to 64 bits.  These are HP-UX specific flags.
16176 @item -mno-sched-br-data-spec
16177 @itemx -msched-br-data-spec
16178 @opindex mno-sched-br-data-spec
16179 @opindex msched-br-data-spec
16180 (Dis/En)able data speculative scheduling before reload.
16181 This results in generation of @code{ld.a} instructions and
16182 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16183 The default is 'disable'.
16185 @item -msched-ar-data-spec
16186 @itemx -mno-sched-ar-data-spec
16187 @opindex msched-ar-data-spec
16188 @opindex mno-sched-ar-data-spec
16189 (En/Dis)able data speculative scheduling after reload.
16190 This results in generation of @code{ld.a} instructions and
16191 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16192 The default is 'enable'.
16194 @item -mno-sched-control-spec
16195 @itemx -msched-control-spec
16196 @opindex mno-sched-control-spec
16197 @opindex msched-control-spec
16198 (Dis/En)able control speculative scheduling.  This feature is
16199 available only during region scheduling (i.e.@: before reload).
16200 This results in generation of the @code{ld.s} instructions and
16201 the corresponding check instructions @code{chk.s}.
16202 The default is 'disable'.
16204 @item -msched-br-in-data-spec
16205 @itemx -mno-sched-br-in-data-spec
16206 @opindex msched-br-in-data-spec
16207 @opindex mno-sched-br-in-data-spec
16208 (En/Dis)able speculative scheduling of the instructions that
16209 are dependent on the data speculative loads before reload.
16210 This is effective only with @option{-msched-br-data-spec} enabled.
16211 The default is 'enable'.
16213 @item -msched-ar-in-data-spec
16214 @itemx -mno-sched-ar-in-data-spec
16215 @opindex msched-ar-in-data-spec
16216 @opindex mno-sched-ar-in-data-spec
16217 (En/Dis)able speculative scheduling of the instructions that
16218 are dependent on the data speculative loads after reload.
16219 This is effective only with @option{-msched-ar-data-spec} enabled.
16220 The default is 'enable'.
16222 @item -msched-in-control-spec
16223 @itemx -mno-sched-in-control-spec
16224 @opindex msched-in-control-spec
16225 @opindex mno-sched-in-control-spec
16226 (En/Dis)able speculative scheduling of the instructions that
16227 are dependent on the control speculative loads.
16228 This is effective only with @option{-msched-control-spec} enabled.
16229 The default is 'enable'.
16231 @item -mno-sched-prefer-non-data-spec-insns
16232 @itemx -msched-prefer-non-data-spec-insns
16233 @opindex mno-sched-prefer-non-data-spec-insns
16234 @opindex msched-prefer-non-data-spec-insns
16235 If enabled, data-speculative instructions are chosen for schedule
16236 only if there are no other choices at the moment.  This makes
16237 the use of the data speculation much more conservative.
16238 The default is 'disable'.
16240 @item -mno-sched-prefer-non-control-spec-insns
16241 @itemx -msched-prefer-non-control-spec-insns
16242 @opindex mno-sched-prefer-non-control-spec-insns
16243 @opindex msched-prefer-non-control-spec-insns
16244 If enabled, control-speculative instructions are chosen for schedule
16245 only if there are no other choices at the moment.  This makes
16246 the use of the control speculation much more conservative.
16247 The default is 'disable'.
16249 @item -mno-sched-count-spec-in-critical-path
16250 @itemx -msched-count-spec-in-critical-path
16251 @opindex mno-sched-count-spec-in-critical-path
16252 @opindex msched-count-spec-in-critical-path
16253 If enabled, speculative dependencies are considered during
16254 computation of the instructions priorities.  This makes the use of the
16255 speculation a bit more conservative.
16256 The default is 'disable'.
16258 @item -msched-spec-ldc
16259 @opindex msched-spec-ldc
16260 Use a simple data speculation check.  This option is on by default.
16262 @item -msched-control-spec-ldc
16263 @opindex msched-spec-ldc
16264 Use a simple check for control speculation.  This option is on by default.
16266 @item -msched-stop-bits-after-every-cycle
16267 @opindex msched-stop-bits-after-every-cycle
16268 Place a stop bit after every cycle when scheduling.  This option is on
16269 by default.
16271 @item -msched-fp-mem-deps-zero-cost
16272 @opindex msched-fp-mem-deps-zero-cost
16273 Assume that floating-point stores and loads are not likely to cause a conflict
16274 when placed into the same instruction group.  This option is disabled by
16275 default.
16277 @item -msel-sched-dont-check-control-spec
16278 @opindex msel-sched-dont-check-control-spec
16279 Generate checks for control speculation in selective scheduling.
16280 This flag is disabled by default.
16282 @item -msched-max-memory-insns=@var{max-insns}
16283 @opindex msched-max-memory-insns
16284 Limit on the number of memory insns per instruction group, giving lower
16285 priority to subsequent memory insns attempting to schedule in the same
16286 instruction group. Frequently useful to prevent cache bank conflicts.
16287 The default value is 1.
16289 @item -msched-max-memory-insns-hard-limit
16290 @opindex msched-max-memory-insns-hard-limit
16291 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16292 disallowing more than that number in an instruction group.
16293 Otherwise, the limit is ``soft'', meaning that non-memory operations
16294 are preferred when the limit is reached, but memory operations may still
16295 be scheduled.
16297 @end table
16299 @node LM32 Options
16300 @subsection LM32 Options
16301 @cindex LM32 options
16303 These @option{-m} options are defined for the LatticeMico32 architecture:
16305 @table @gcctabopt
16306 @item -mbarrel-shift-enabled
16307 @opindex mbarrel-shift-enabled
16308 Enable barrel-shift instructions.
16310 @item -mdivide-enabled
16311 @opindex mdivide-enabled
16312 Enable divide and modulus instructions.
16314 @item -mmultiply-enabled
16315 @opindex multiply-enabled
16316 Enable multiply instructions.
16318 @item -msign-extend-enabled
16319 @opindex msign-extend-enabled
16320 Enable sign extend instructions.
16322 @item -muser-enabled
16323 @opindex muser-enabled
16324 Enable user-defined instructions.
16326 @end table
16328 @node M32C Options
16329 @subsection M32C Options
16330 @cindex M32C options
16332 @table @gcctabopt
16333 @item -mcpu=@var{name}
16334 @opindex mcpu=
16335 Select the CPU for which code is generated.  @var{name} may be one of
16336 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16337 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16338 the M32C/80 series.
16340 @item -msim
16341 @opindex msim
16342 Specifies that the program will be run on the simulator.  This causes
16343 an alternate runtime library to be linked in which supports, for
16344 example, file I/O@.  You must not use this option when generating
16345 programs that will run on real hardware; you must provide your own
16346 runtime library for whatever I/O functions are needed.
16348 @item -memregs=@var{number}
16349 @opindex memregs=
16350 Specifies the number of memory-based pseudo-registers GCC uses
16351 during code generation.  These pseudo-registers are used like real
16352 registers, so there is a tradeoff between GCC's ability to fit the
16353 code into available registers, and the performance penalty of using
16354 memory instead of registers.  Note that all modules in a program must
16355 be compiled with the same value for this option.  Because of that, you
16356 must not use this option with GCC's default runtime libraries.
16358 @end table
16360 @node M32R/D Options
16361 @subsection M32R/D Options
16362 @cindex M32R/D options
16364 These @option{-m} options are defined for Renesas M32R/D architectures:
16366 @table @gcctabopt
16367 @item -m32r2
16368 @opindex m32r2
16369 Generate code for the M32R/2@.
16371 @item -m32rx
16372 @opindex m32rx
16373 Generate code for the M32R/X@.
16375 @item -m32r
16376 @opindex m32r
16377 Generate code for the M32R@.  This is the default.
16379 @item -mmodel=small
16380 @opindex mmodel=small
16381 Assume all objects live in the lower 16MB of memory (so that their addresses
16382 can be loaded with the @code{ld24} instruction), and assume all subroutines
16383 are reachable with the @code{bl} instruction.
16384 This is the default.
16386 The addressability of a particular object can be set with the
16387 @code{model} attribute.
16389 @item -mmodel=medium
16390 @opindex mmodel=medium
16391 Assume objects may be anywhere in the 32-bit address space (the compiler
16392 generates @code{seth/add3} instructions to load their addresses), and
16393 assume all subroutines are reachable with the @code{bl} instruction.
16395 @item -mmodel=large
16396 @opindex mmodel=large
16397 Assume objects may be anywhere in the 32-bit address space (the compiler
16398 generates @code{seth/add3} instructions to load their addresses), and
16399 assume subroutines may not be reachable with the @code{bl} instruction
16400 (the compiler generates the much slower @code{seth/add3/jl}
16401 instruction sequence).
16403 @item -msdata=none
16404 @opindex msdata=none
16405 Disable use of the small data area.  Variables are put into
16406 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16407 @code{section} attribute has been specified).
16408 This is the default.
16410 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16411 Objects may be explicitly put in the small data area with the
16412 @code{section} attribute using one of these sections.
16414 @item -msdata=sdata
16415 @opindex msdata=sdata
16416 Put small global and static data in the small data area, but do not
16417 generate special code to reference them.
16419 @item -msdata=use
16420 @opindex msdata=use
16421 Put small global and static data in the small data area, and generate
16422 special instructions to reference them.
16424 @item -G @var{num}
16425 @opindex G
16426 @cindex smaller data references
16427 Put global and static objects less than or equal to @var{num} bytes
16428 into the small data or BSS sections instead of the normal data or BSS
16429 sections.  The default value of @var{num} is 8.
16430 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16431 for this option to have any effect.
16433 All modules should be compiled with the same @option{-G @var{num}} value.
16434 Compiling with different values of @var{num} may or may not work; if it
16435 doesn't the linker gives an error message---incorrect code is not
16436 generated.
16438 @item -mdebug
16439 @opindex mdebug
16440 Makes the M32R-specific code in the compiler display some statistics
16441 that might help in debugging programs.
16443 @item -malign-loops
16444 @opindex malign-loops
16445 Align all loops to a 32-byte boundary.
16447 @item -mno-align-loops
16448 @opindex mno-align-loops
16449 Do not enforce a 32-byte alignment for loops.  This is the default.
16451 @item -missue-rate=@var{number}
16452 @opindex missue-rate=@var{number}
16453 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16454 or 2.
16456 @item -mbranch-cost=@var{number}
16457 @opindex mbranch-cost=@var{number}
16458 @var{number} can only be 1 or 2.  If it is 1 then branches are
16459 preferred over conditional code, if it is 2, then the opposite applies.
16461 @item -mflush-trap=@var{number}
16462 @opindex mflush-trap=@var{number}
16463 Specifies the trap number to use to flush the cache.  The default is
16464 12.  Valid numbers are between 0 and 15 inclusive.
16466 @item -mno-flush-trap
16467 @opindex mno-flush-trap
16468 Specifies that the cache cannot be flushed by using a trap.
16470 @item -mflush-func=@var{name}
16471 @opindex mflush-func=@var{name}
16472 Specifies the name of the operating system function to call to flush
16473 the cache.  The default is @samp{_flush_cache}, but a function call
16474 is only used if a trap is not available.
16476 @item -mno-flush-func
16477 @opindex mno-flush-func
16478 Indicates that there is no OS function for flushing the cache.
16480 @end table
16482 @node M680x0 Options
16483 @subsection M680x0 Options
16484 @cindex M680x0 options
16486 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16487 The default settings depend on which architecture was selected when
16488 the compiler was configured; the defaults for the most common choices
16489 are given below.
16491 @table @gcctabopt
16492 @item -march=@var{arch}
16493 @opindex march
16494 Generate code for a specific M680x0 or ColdFire instruction set
16495 architecture.  Permissible values of @var{arch} for M680x0
16496 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16497 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16498 architectures are selected according to Freescale's ISA classification
16499 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16500 @samp{isab} and @samp{isac}.
16502 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16503 code for a ColdFire target.  The @var{arch} in this macro is one of the
16504 @option{-march} arguments given above.
16506 When used together, @option{-march} and @option{-mtune} select code
16507 that runs on a family of similar processors but that is optimized
16508 for a particular microarchitecture.
16510 @item -mcpu=@var{cpu}
16511 @opindex mcpu
16512 Generate code for a specific M680x0 or ColdFire processor.
16513 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16514 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16515 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16516 below, which also classifies the CPUs into families:
16518 @multitable @columnfractions 0.20 0.80
16519 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16520 @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}
16521 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16522 @item @samp{5206e} @tab @samp{5206e}
16523 @item @samp{5208} @tab @samp{5207} @samp{5208}
16524 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16525 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16526 @item @samp{5216} @tab @samp{5214} @samp{5216}
16527 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16528 @item @samp{5225} @tab @samp{5224} @samp{5225}
16529 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16530 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16531 @item @samp{5249} @tab @samp{5249}
16532 @item @samp{5250} @tab @samp{5250}
16533 @item @samp{5271} @tab @samp{5270} @samp{5271}
16534 @item @samp{5272} @tab @samp{5272}
16535 @item @samp{5275} @tab @samp{5274} @samp{5275}
16536 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16537 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16538 @item @samp{5307} @tab @samp{5307}
16539 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16540 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16541 @item @samp{5407} @tab @samp{5407}
16542 @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}
16543 @end multitable
16545 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16546 @var{arch} is compatible with @var{cpu}.  Other combinations of
16547 @option{-mcpu} and @option{-march} are rejected.
16549 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16550 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16551 where the value of @var{family} is given by the table above.
16553 @item -mtune=@var{tune}
16554 @opindex mtune
16555 Tune the code for a particular microarchitecture within the
16556 constraints set by @option{-march} and @option{-mcpu}.
16557 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16558 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16559 and @samp{cpu32}.  The ColdFire microarchitectures
16560 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16562 You can also use @option{-mtune=68020-40} for code that needs
16563 to run relatively well on 68020, 68030 and 68040 targets.
16564 @option{-mtune=68020-60} is similar but includes 68060 targets
16565 as well.  These two options select the same tuning decisions as
16566 @option{-m68020-40} and @option{-m68020-60} respectively.
16568 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16569 when tuning for 680x0 architecture @var{arch}.  It also defines
16570 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16571 option is used.  If GCC is tuning for a range of architectures,
16572 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16573 it defines the macros for every architecture in the range.
16575 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16576 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16577 of the arguments given above.
16579 @item -m68000
16580 @itemx -mc68000
16581 @opindex m68000
16582 @opindex mc68000
16583 Generate output for a 68000.  This is the default
16584 when the compiler is configured for 68000-based systems.
16585 It is equivalent to @option{-march=68000}.
16587 Use this option for microcontrollers with a 68000 or EC000 core,
16588 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16590 @item -m68010
16591 @opindex m68010
16592 Generate output for a 68010.  This is the default
16593 when the compiler is configured for 68010-based systems.
16594 It is equivalent to @option{-march=68010}.
16596 @item -m68020
16597 @itemx -mc68020
16598 @opindex m68020
16599 @opindex mc68020
16600 Generate output for a 68020.  This is the default
16601 when the compiler is configured for 68020-based systems.
16602 It is equivalent to @option{-march=68020}.
16604 @item -m68030
16605 @opindex m68030
16606 Generate output for a 68030.  This is the default when the compiler is
16607 configured for 68030-based systems.  It is equivalent to
16608 @option{-march=68030}.
16610 @item -m68040
16611 @opindex m68040
16612 Generate output for a 68040.  This is the default when the compiler is
16613 configured for 68040-based systems.  It is equivalent to
16614 @option{-march=68040}.
16616 This option inhibits the use of 68881/68882 instructions that have to be
16617 emulated by software on the 68040.  Use this option if your 68040 does not
16618 have code to emulate those instructions.
16620 @item -m68060
16621 @opindex m68060
16622 Generate output for a 68060.  This is the default when the compiler is
16623 configured for 68060-based systems.  It is equivalent to
16624 @option{-march=68060}.
16626 This option inhibits the use of 68020 and 68881/68882 instructions that
16627 have to be emulated by software on the 68060.  Use this option if your 68060
16628 does not have code to emulate those instructions.
16630 @item -mcpu32
16631 @opindex mcpu32
16632 Generate output for a CPU32.  This is the default
16633 when the compiler is configured for CPU32-based systems.
16634 It is equivalent to @option{-march=cpu32}.
16636 Use this option for microcontrollers with a
16637 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16638 68336, 68340, 68341, 68349 and 68360.
16640 @item -m5200
16641 @opindex m5200
16642 Generate output for a 520X ColdFire CPU@.  This is the default
16643 when the compiler is configured for 520X-based systems.
16644 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16645 in favor of that option.
16647 Use this option for microcontroller with a 5200 core, including
16648 the MCF5202, MCF5203, MCF5204 and MCF5206.
16650 @item -m5206e
16651 @opindex m5206e
16652 Generate output for a 5206e ColdFire CPU@.  The option is now
16653 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16655 @item -m528x
16656 @opindex m528x
16657 Generate output for a member of the ColdFire 528X family.
16658 The option is now deprecated in favor of the equivalent
16659 @option{-mcpu=528x}.
16661 @item -m5307
16662 @opindex m5307
16663 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16664 in favor of the equivalent @option{-mcpu=5307}.
16666 @item -m5407
16667 @opindex m5407
16668 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16669 in favor of the equivalent @option{-mcpu=5407}.
16671 @item -mcfv4e
16672 @opindex mcfv4e
16673 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16674 This includes use of hardware floating-point instructions.
16675 The option is equivalent to @option{-mcpu=547x}, and is now
16676 deprecated in favor of that option.
16678 @item -m68020-40
16679 @opindex m68020-40
16680 Generate output for a 68040, without using any of the new instructions.
16681 This results in code that can run relatively efficiently on either a
16682 68020/68881 or a 68030 or a 68040.  The generated code does use the
16683 68881 instructions that are emulated on the 68040.
16685 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16687 @item -m68020-60
16688 @opindex m68020-60
16689 Generate output for a 68060, without using any of the new instructions.
16690 This results in code that can run relatively efficiently on either a
16691 68020/68881 or a 68030 or a 68040.  The generated code does use the
16692 68881 instructions that are emulated on the 68060.
16694 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16696 @item -mhard-float
16697 @itemx -m68881
16698 @opindex mhard-float
16699 @opindex m68881
16700 Generate floating-point instructions.  This is the default for 68020
16701 and above, and for ColdFire devices that have an FPU@.  It defines the
16702 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16703 on ColdFire targets.
16705 @item -msoft-float
16706 @opindex msoft-float
16707 Do not generate floating-point instructions; use library calls instead.
16708 This is the default for 68000, 68010, and 68832 targets.  It is also
16709 the default for ColdFire devices that have no FPU.
16711 @item -mdiv
16712 @itemx -mno-div
16713 @opindex mdiv
16714 @opindex mno-div
16715 Generate (do not generate) ColdFire hardware divide and remainder
16716 instructions.  If @option{-march} is used without @option{-mcpu},
16717 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16718 architectures.  Otherwise, the default is taken from the target CPU
16719 (either the default CPU, or the one specified by @option{-mcpu}).  For
16720 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16721 @option{-mcpu=5206e}.
16723 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16725 @item -mshort
16726 @opindex mshort
16727 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16728 Additionally, parameters passed on the stack are also aligned to a
16729 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16731 @item -mno-short
16732 @opindex mno-short
16733 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16735 @item -mnobitfield
16736 @itemx -mno-bitfield
16737 @opindex mnobitfield
16738 @opindex mno-bitfield
16739 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16740 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16742 @item -mbitfield
16743 @opindex mbitfield
16744 Do use the bit-field instructions.  The @option{-m68020} option implies
16745 @option{-mbitfield}.  This is the default if you use a configuration
16746 designed for a 68020.
16748 @item -mrtd
16749 @opindex mrtd
16750 Use a different function-calling convention, in which functions
16751 that take a fixed number of arguments return with the @code{rtd}
16752 instruction, which pops their arguments while returning.  This
16753 saves one instruction in the caller since there is no need to pop
16754 the arguments there.
16756 This calling convention is incompatible with the one normally
16757 used on Unix, so you cannot use it if you need to call libraries
16758 compiled with the Unix compiler.
16760 Also, you must provide function prototypes for all functions that
16761 take variable numbers of arguments (including @code{printf});
16762 otherwise incorrect code is generated for calls to those
16763 functions.
16765 In addition, seriously incorrect code results if you call a
16766 function with too many arguments.  (Normally, extra arguments are
16767 harmlessly ignored.)
16769 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16770 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16772 @item -mno-rtd
16773 @opindex mno-rtd
16774 Do not use the calling conventions selected by @option{-mrtd}.
16775 This is the default.
16777 @item -malign-int
16778 @itemx -mno-align-int
16779 @opindex malign-int
16780 @opindex mno-align-int
16781 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16782 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16783 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16784 Aligning variables on 32-bit boundaries produces code that runs somewhat
16785 faster on processors with 32-bit busses at the expense of more memory.
16787 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16788 aligns structures containing the above types differently than
16789 most published application binary interface specifications for the m68k.
16791 @item -mpcrel
16792 @opindex mpcrel
16793 Use the pc-relative addressing mode of the 68000 directly, instead of
16794 using a global offset table.  At present, this option implies @option{-fpic},
16795 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16796 not presently supported with @option{-mpcrel}, though this could be supported for
16797 68020 and higher processors.
16799 @item -mno-strict-align
16800 @itemx -mstrict-align
16801 @opindex mno-strict-align
16802 @opindex mstrict-align
16803 Do not (do) assume that unaligned memory references are handled by
16804 the system.
16806 @item -msep-data
16807 Generate code that allows the data segment to be located in a different
16808 area of memory from the text segment.  This allows for execute-in-place in
16809 an environment without virtual memory management.  This option implies
16810 @option{-fPIC}.
16812 @item -mno-sep-data
16813 Generate code that assumes that the data segment follows the text segment.
16814 This is the default.
16816 @item -mid-shared-library
16817 Generate code that supports shared libraries via the library ID method.
16818 This allows for execute-in-place and shared libraries in an environment
16819 without virtual memory management.  This option implies @option{-fPIC}.
16821 @item -mno-id-shared-library
16822 Generate code that doesn't assume ID-based shared libraries are being used.
16823 This is the default.
16825 @item -mshared-library-id=n
16826 Specifies the identification number of the ID-based shared library being
16827 compiled.  Specifying a value of 0 generates more compact code; specifying
16828 other values forces the allocation of that number to the current
16829 library, but is no more space- or time-efficient than omitting this option.
16831 @item -mxgot
16832 @itemx -mno-xgot
16833 @opindex mxgot
16834 @opindex mno-xgot
16835 When generating position-independent code for ColdFire, generate code
16836 that works if the GOT has more than 8192 entries.  This code is
16837 larger and slower than code generated without this option.  On M680x0
16838 processors, this option is not needed; @option{-fPIC} suffices.
16840 GCC normally uses a single instruction to load values from the GOT@.
16841 While this is relatively efficient, it only works if the GOT
16842 is smaller than about 64k.  Anything larger causes the linker
16843 to report an error such as:
16845 @cindex relocation truncated to fit (ColdFire)
16846 @smallexample
16847 relocation truncated to fit: R_68K_GOT16O foobar
16848 @end smallexample
16850 If this happens, you should recompile your code with @option{-mxgot}.
16851 It should then work with very large GOTs.  However, code generated with
16852 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16853 the value of a global symbol.
16855 Note that some linkers, including newer versions of the GNU linker,
16856 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16857 you should only need to use @option{-mxgot} when compiling a single
16858 object file that accesses more than 8192 GOT entries.  Very few do.
16860 These options have no effect unless GCC is generating
16861 position-independent code.
16863 @end table
16865 @node MCore Options
16866 @subsection MCore Options
16867 @cindex MCore options
16869 These are the @samp{-m} options defined for the Motorola M*Core
16870 processors.
16872 @table @gcctabopt
16874 @item -mhardlit
16875 @itemx -mno-hardlit
16876 @opindex mhardlit
16877 @opindex mno-hardlit
16878 Inline constants into the code stream if it can be done in two
16879 instructions or less.
16881 @item -mdiv
16882 @itemx -mno-div
16883 @opindex mdiv
16884 @opindex mno-div
16885 Use the divide instruction.  (Enabled by default).
16887 @item -mrelax-immediate
16888 @itemx -mno-relax-immediate
16889 @opindex mrelax-immediate
16890 @opindex mno-relax-immediate
16891 Allow arbitrary-sized immediates in bit operations.
16893 @item -mwide-bitfields
16894 @itemx -mno-wide-bitfields
16895 @opindex mwide-bitfields
16896 @opindex mno-wide-bitfields
16897 Always treat bit-fields as @code{int}-sized.
16899 @item -m4byte-functions
16900 @itemx -mno-4byte-functions
16901 @opindex m4byte-functions
16902 @opindex mno-4byte-functions
16903 Force all functions to be aligned to a 4-byte boundary.
16905 @item -mcallgraph-data
16906 @itemx -mno-callgraph-data
16907 @opindex mcallgraph-data
16908 @opindex mno-callgraph-data
16909 Emit callgraph information.
16911 @item -mslow-bytes
16912 @itemx -mno-slow-bytes
16913 @opindex mslow-bytes
16914 @opindex mno-slow-bytes
16915 Prefer word access when reading byte quantities.
16917 @item -mlittle-endian
16918 @itemx -mbig-endian
16919 @opindex mlittle-endian
16920 @opindex mbig-endian
16921 Generate code for a little-endian target.
16923 @item -m210
16924 @itemx -m340
16925 @opindex m210
16926 @opindex m340
16927 Generate code for the 210 processor.
16929 @item -mno-lsim
16930 @opindex mno-lsim
16931 Assume that runtime support has been provided and so omit the
16932 simulator library (@file{libsim.a)} from the linker command line.
16934 @item -mstack-increment=@var{size}
16935 @opindex mstack-increment
16936 Set the maximum amount for a single stack increment operation.  Large
16937 values can increase the speed of programs that contain functions
16938 that need a large amount of stack space, but they can also trigger a
16939 segmentation fault if the stack is extended too much.  The default
16940 value is 0x1000.
16942 @end table
16944 @node MeP Options
16945 @subsection MeP Options
16946 @cindex MeP options
16948 @table @gcctabopt
16950 @item -mabsdiff
16951 @opindex mabsdiff
16952 Enables the @code{abs} instruction, which is the absolute difference
16953 between two registers.
16955 @item -mall-opts
16956 @opindex mall-opts
16957 Enables all the optional instructions---average, multiply, divide, bit
16958 operations, leading zero, absolute difference, min/max, clip, and
16959 saturation.
16962 @item -maverage
16963 @opindex maverage
16964 Enables the @code{ave} instruction, which computes the average of two
16965 registers.
16967 @item -mbased=@var{n}
16968 @opindex mbased=
16969 Variables of size @var{n} bytes or smaller are placed in the
16970 @code{.based} section by default.  Based variables use the @code{$tp}
16971 register as a base register, and there is a 128-byte limit to the
16972 @code{.based} section.
16974 @item -mbitops
16975 @opindex mbitops
16976 Enables the bit operation instructions---bit test (@code{btstm}), set
16977 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16978 test-and-set (@code{tas}).
16980 @item -mc=@var{name}
16981 @opindex mc=
16982 Selects which section constant data is placed in.  @var{name} may
16983 be @samp{tiny}, @samp{near}, or @samp{far}.
16985 @item -mclip
16986 @opindex mclip
16987 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16988 useful unless you also provide @option{-mminmax}.
16990 @item -mconfig=@var{name}
16991 @opindex mconfig=
16992 Selects one of the built-in core configurations.  Each MeP chip has
16993 one or more modules in it; each module has a core CPU and a variety of
16994 coprocessors, optional instructions, and peripherals.  The
16995 @code{MeP-Integrator} tool, not part of GCC, provides these
16996 configurations through this option; using this option is the same as
16997 using all the corresponding command-line options.  The default
16998 configuration is @samp{default}.
17000 @item -mcop
17001 @opindex mcop
17002 Enables the coprocessor instructions.  By default, this is a 32-bit
17003 coprocessor.  Note that the coprocessor is normally enabled via the
17004 @option{-mconfig=} option.
17006 @item -mcop32
17007 @opindex mcop32
17008 Enables the 32-bit coprocessor's instructions.
17010 @item -mcop64
17011 @opindex mcop64
17012 Enables the 64-bit coprocessor's instructions.
17014 @item -mivc2
17015 @opindex mivc2
17016 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17018 @item -mdc
17019 @opindex mdc
17020 Causes constant variables to be placed in the @code{.near} section.
17022 @item -mdiv
17023 @opindex mdiv
17024 Enables the @code{div} and @code{divu} instructions.
17026 @item -meb
17027 @opindex meb
17028 Generate big-endian code.
17030 @item -mel
17031 @opindex mel
17032 Generate little-endian code.
17034 @item -mio-volatile
17035 @opindex mio-volatile
17036 Tells the compiler that any variable marked with the @code{io}
17037 attribute is to be considered volatile.
17039 @item -ml
17040 @opindex ml
17041 Causes variables to be assigned to the @code{.far} section by default.
17043 @item -mleadz
17044 @opindex mleadz
17045 Enables the @code{leadz} (leading zero) instruction.
17047 @item -mm
17048 @opindex mm
17049 Causes variables to be assigned to the @code{.near} section by default.
17051 @item -mminmax
17052 @opindex mminmax
17053 Enables the @code{min} and @code{max} instructions.
17055 @item -mmult
17056 @opindex mmult
17057 Enables the multiplication and multiply-accumulate instructions.
17059 @item -mno-opts
17060 @opindex mno-opts
17061 Disables all the optional instructions enabled by @option{-mall-opts}.
17063 @item -mrepeat
17064 @opindex mrepeat
17065 Enables the @code{repeat} and @code{erepeat} instructions, used for
17066 low-overhead looping.
17068 @item -ms
17069 @opindex ms
17070 Causes all variables to default to the @code{.tiny} section.  Note
17071 that there is a 65536-byte limit to this section.  Accesses to these
17072 variables use the @code{%gp} base register.
17074 @item -msatur
17075 @opindex msatur
17076 Enables the saturation instructions.  Note that the compiler does not
17077 currently generate these itself, but this option is included for
17078 compatibility with other tools, like @code{as}.
17080 @item -msdram
17081 @opindex msdram
17082 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17084 @item -msim
17085 @opindex msim
17086 Link the simulator run-time libraries.
17088 @item -msimnovec
17089 @opindex msimnovec
17090 Link the simulator runtime libraries, excluding built-in support
17091 for reset and exception vectors and tables.
17093 @item -mtf
17094 @opindex mtf
17095 Causes all functions to default to the @code{.far} section.  Without
17096 this option, functions default to the @code{.near} section.
17098 @item -mtiny=@var{n}
17099 @opindex mtiny=
17100 Variables that are @var{n} bytes or smaller are allocated to the
17101 @code{.tiny} section.  These variables use the @code{$gp} base
17102 register.  The default for this option is 4, but note that there's a
17103 65536-byte limit to the @code{.tiny} section.
17105 @end table
17107 @node MicroBlaze Options
17108 @subsection MicroBlaze Options
17109 @cindex MicroBlaze Options
17111 @table @gcctabopt
17113 @item -msoft-float
17114 @opindex msoft-float
17115 Use software emulation for floating point (default).
17117 @item -mhard-float
17118 @opindex mhard-float
17119 Use hardware floating-point instructions.
17121 @item -mmemcpy
17122 @opindex mmemcpy
17123 Do not optimize block moves, use @code{memcpy}.
17125 @item -mno-clearbss
17126 @opindex mno-clearbss
17127 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17129 @item -mcpu=@var{cpu-type}
17130 @opindex mcpu=
17131 Use features of, and schedule code for, the given CPU.
17132 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17133 where @var{X} is a major version, @var{YY} is the minor version, and
17134 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17135 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17137 @item -mxl-soft-mul
17138 @opindex mxl-soft-mul
17139 Use software multiply emulation (default).
17141 @item -mxl-soft-div
17142 @opindex mxl-soft-div
17143 Use software emulation for divides (default).
17145 @item -mxl-barrel-shift
17146 @opindex mxl-barrel-shift
17147 Use the hardware barrel shifter.
17149 @item -mxl-pattern-compare
17150 @opindex mxl-pattern-compare
17151 Use pattern compare instructions.
17153 @item -msmall-divides
17154 @opindex msmall-divides
17155 Use table lookup optimization for small signed integer divisions.
17157 @item -mxl-stack-check
17158 @opindex mxl-stack-check
17159 This option is deprecated.  Use @option{-fstack-check} instead.
17161 @item -mxl-gp-opt
17162 @opindex mxl-gp-opt
17163 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17165 @item -mxl-multiply-high
17166 @opindex mxl-multiply-high
17167 Use multiply high instructions for high part of 32x32 multiply.
17169 @item -mxl-float-convert
17170 @opindex mxl-float-convert
17171 Use hardware floating-point conversion instructions.
17173 @item -mxl-float-sqrt
17174 @opindex mxl-float-sqrt
17175 Use hardware floating-point square root instruction.
17177 @item -mbig-endian
17178 @opindex mbig-endian
17179 Generate code for a big-endian target.
17181 @item -mlittle-endian
17182 @opindex mlittle-endian
17183 Generate code for a little-endian target.
17185 @item -mxl-reorder
17186 @opindex mxl-reorder
17187 Use reorder instructions (swap and byte reversed load/store).
17189 @item -mxl-mode-@var{app-model}
17190 Select application model @var{app-model}.  Valid models are
17191 @table @samp
17192 @item executable
17193 normal executable (default), uses startup code @file{crt0.o}.
17195 @item xmdstub
17196 for use with Xilinx Microprocessor Debugger (XMD) based
17197 software intrusive debug agent called xmdstub. This uses startup file
17198 @file{crt1.o} and sets the start address of the program to 0x800.
17200 @item bootstrap
17201 for applications that are loaded using a bootloader.
17202 This model uses startup file @file{crt2.o} which does not contain a processor
17203 reset vector handler. This is suitable for transferring control on a
17204 processor reset to the bootloader rather than the application.
17206 @item novectors
17207 for applications that do not require any of the
17208 MicroBlaze vectors. This option may be useful for applications running
17209 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17210 @end table
17212 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17213 @option{-mxl-mode-@var{app-model}}.
17215 @end table
17217 @node MIPS Options
17218 @subsection MIPS Options
17219 @cindex MIPS options
17221 @table @gcctabopt
17223 @item -EB
17224 @opindex EB
17225 Generate big-endian code.
17227 @item -EL
17228 @opindex EL
17229 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17230 configurations.
17232 @item -march=@var{arch}
17233 @opindex march
17234 Generate code that runs on @var{arch}, which can be the name of a
17235 generic MIPS ISA, or the name of a particular processor.
17236 The ISA names are:
17237 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17238 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17239 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17240 @samp{mips64r5} and @samp{mips64r6}.
17241 The processor names are:
17242 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17243 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17244 @samp{5kc}, @samp{5kf},
17245 @samp{20kc},
17246 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17247 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17248 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17249 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17250 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17251 @samp{i6400},
17252 @samp{interaptiv},
17253 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17254 @samp{m4k},
17255 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17256 @samp{m5100}, @samp{m5101},
17257 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17258 @samp{orion},
17259 @samp{p5600},
17260 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17261 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17262 @samp{rm7000}, @samp{rm9000},
17263 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17264 @samp{sb1},
17265 @samp{sr71000},
17266 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17267 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17268 @samp{xlr} and @samp{xlp}.
17269 The special value @samp{from-abi} selects the
17270 most compatible architecture for the selected ABI (that is,
17271 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17273 The native Linux/GNU toolchain also supports the value @samp{native},
17274 which selects the best architecture option for the host processor.
17275 @option{-march=native} has no effect if GCC does not recognize
17276 the processor.
17278 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17279 (for example, @option{-march=r2k}).  Prefixes are optional, and
17280 @samp{vr} may be written @samp{r}.
17282 Names of the form @samp{@var{n}f2_1} refer to processors with
17283 FPUs clocked at half the rate of the core, names of the form
17284 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17285 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17286 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17287 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17288 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17289 accepted as synonyms for @samp{@var{n}f1_1}.
17291 GCC defines two macros based on the value of this option.  The first
17292 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17293 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17294 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17295 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17296 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17298 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17299 above.  In other words, it has the full prefix and does not
17300 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17301 the macro names the resolved architecture (either @code{"mips1"} or
17302 @code{"mips3"}).  It names the default architecture when no
17303 @option{-march} option is given.
17305 @item -mtune=@var{arch}
17306 @opindex mtune
17307 Optimize for @var{arch}.  Among other things, this option controls
17308 the way instructions are scheduled, and the perceived cost of arithmetic
17309 operations.  The list of @var{arch} values is the same as for
17310 @option{-march}.
17312 When this option is not used, GCC optimizes for the processor
17313 specified by @option{-march}.  By using @option{-march} and
17314 @option{-mtune} together, it is possible to generate code that
17315 runs on a family of processors, but optimize the code for one
17316 particular member of that family.
17318 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17319 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17320 @option{-march} ones described above.
17322 @item -mips1
17323 @opindex mips1
17324 Equivalent to @option{-march=mips1}.
17326 @item -mips2
17327 @opindex mips2
17328 Equivalent to @option{-march=mips2}.
17330 @item -mips3
17331 @opindex mips3
17332 Equivalent to @option{-march=mips3}.
17334 @item -mips4
17335 @opindex mips4
17336 Equivalent to @option{-march=mips4}.
17338 @item -mips32
17339 @opindex mips32
17340 Equivalent to @option{-march=mips32}.
17342 @item -mips32r3
17343 @opindex mips32r3
17344 Equivalent to @option{-march=mips32r3}.
17346 @item -mips32r5
17347 @opindex mips32r5
17348 Equivalent to @option{-march=mips32r5}.
17350 @item -mips32r6
17351 @opindex mips32r6
17352 Equivalent to @option{-march=mips32r6}.
17354 @item -mips64
17355 @opindex mips64
17356 Equivalent to @option{-march=mips64}.
17358 @item -mips64r2
17359 @opindex mips64r2
17360 Equivalent to @option{-march=mips64r2}.
17362 @item -mips64r3
17363 @opindex mips64r3
17364 Equivalent to @option{-march=mips64r3}.
17366 @item -mips64r5
17367 @opindex mips64r5
17368 Equivalent to @option{-march=mips64r5}.
17370 @item -mips64r6
17371 @opindex mips64r6
17372 Equivalent to @option{-march=mips64r6}.
17374 @item -mips16
17375 @itemx -mno-mips16
17376 @opindex mips16
17377 @opindex mno-mips16
17378 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17379 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17381 MIPS16 code generation can also be controlled on a per-function basis
17382 by means of @code{mips16} and @code{nomips16} attributes.
17383 @xref{Function Attributes}, for more information.
17385 @item -mflip-mips16
17386 @opindex mflip-mips16
17387 Generate MIPS16 code on alternating functions.  This option is provided
17388 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17389 not intended for ordinary use in compiling user code.
17391 @item -minterlink-compressed
17392 @item -mno-interlink-compressed
17393 @opindex minterlink-compressed
17394 @opindex mno-interlink-compressed
17395 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17396 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17398 For example, code using the standard ISA encoding cannot jump directly
17399 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17400 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17401 knows that the target of the jump is not compressed.
17403 @item -minterlink-mips16
17404 @itemx -mno-interlink-mips16
17405 @opindex minterlink-mips16
17406 @opindex mno-interlink-mips16
17407 Aliases of @option{-minterlink-compressed} and
17408 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17409 and are retained for backwards compatibility.
17411 @item -mabi=32
17412 @itemx -mabi=o64
17413 @itemx -mabi=n32
17414 @itemx -mabi=64
17415 @itemx -mabi=eabi
17416 @opindex mabi=32
17417 @opindex mabi=o64
17418 @opindex mabi=n32
17419 @opindex mabi=64
17420 @opindex mabi=eabi
17421 Generate code for the given ABI@.
17423 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17424 generates 64-bit code when you select a 64-bit architecture, but you
17425 can use @option{-mgp32} to get 32-bit code instead.
17427 For information about the O64 ABI, see
17428 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17430 GCC supports a variant of the o32 ABI in which floating-point registers
17431 are 64 rather than 32 bits wide.  You can select this combination with
17432 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17433 and @code{mfhc1} instructions and is therefore only supported for
17434 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17436 The register assignments for arguments and return values remain the
17437 same, but each scalar value is passed in a single 64-bit register
17438 rather than a pair of 32-bit registers.  For example, scalar
17439 floating-point values are returned in @samp{$f0} only, not a
17440 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17441 remains the same in that the even-numbered double-precision registers
17442 are saved.
17444 Two additional variants of the o32 ABI are supported to enable
17445 a transition from 32-bit to 64-bit registers.  These are FPXX
17446 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17447 The FPXX extension mandates that all code must execute correctly
17448 when run using 32-bit or 64-bit registers.  The code can be interlinked
17449 with either FP32 or FP64, but not both.
17450 The FP64A extension is similar to the FP64 extension but forbids the
17451 use of odd-numbered single-precision registers.  This can be used
17452 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17453 processors and allows both FP32 and FP64A code to interlink and
17454 run in the same process without changing FPU modes.
17456 @item -mabicalls
17457 @itemx -mno-abicalls
17458 @opindex mabicalls
17459 @opindex mno-abicalls
17460 Generate (do not generate) code that is suitable for SVR4-style
17461 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17462 systems.
17464 @item -mshared
17465 @itemx -mno-shared
17466 Generate (do not generate) code that is fully position-independent,
17467 and that can therefore be linked into shared libraries.  This option
17468 only affects @option{-mabicalls}.
17470 All @option{-mabicalls} code has traditionally been position-independent,
17471 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17472 as an extension, the GNU toolchain allows executables to use absolute
17473 accesses for locally-binding symbols.  It can also use shorter GP
17474 initialization sequences and generate direct calls to locally-defined
17475 functions.  This mode is selected by @option{-mno-shared}.
17477 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17478 objects that can only be linked by the GNU linker.  However, the option
17479 does not affect the ABI of the final executable; it only affects the ABI
17480 of relocatable objects.  Using @option{-mno-shared} generally makes
17481 executables both smaller and quicker.
17483 @option{-mshared} is the default.
17485 @item -mplt
17486 @itemx -mno-plt
17487 @opindex mplt
17488 @opindex mno-plt
17489 Assume (do not assume) that the static and dynamic linkers
17490 support PLTs and copy relocations.  This option only affects
17491 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17492 has no effect without @option{-msym32}.
17494 You can make @option{-mplt} the default by configuring
17495 GCC with @option{--with-mips-plt}.  The default is
17496 @option{-mno-plt} otherwise.
17498 @item -mxgot
17499 @itemx -mno-xgot
17500 @opindex mxgot
17501 @opindex mno-xgot
17502 Lift (do not lift) the usual restrictions on the size of the global
17503 offset table.
17505 GCC normally uses a single instruction to load values from the GOT@.
17506 While this is relatively efficient, it only works if the GOT
17507 is smaller than about 64k.  Anything larger causes the linker
17508 to report an error such as:
17510 @cindex relocation truncated to fit (MIPS)
17511 @smallexample
17512 relocation truncated to fit: R_MIPS_GOT16 foobar
17513 @end smallexample
17515 If this happens, you should recompile your code with @option{-mxgot}.
17516 This works with very large GOTs, although the code is also
17517 less efficient, since it takes three instructions to fetch the
17518 value of a global symbol.
17520 Note that some linkers can create multiple GOTs.  If you have such a
17521 linker, you should only need to use @option{-mxgot} when a single object
17522 file accesses more than 64k's worth of GOT entries.  Very few do.
17524 These options have no effect unless GCC is generating position
17525 independent code.
17527 @item -mgp32
17528 @opindex mgp32
17529 Assume that general-purpose registers are 32 bits wide.
17531 @item -mgp64
17532 @opindex mgp64
17533 Assume that general-purpose registers are 64 bits wide.
17535 @item -mfp32
17536 @opindex mfp32
17537 Assume that floating-point registers are 32 bits wide.
17539 @item -mfp64
17540 @opindex mfp64
17541 Assume that floating-point registers are 64 bits wide.
17543 @item -mfpxx
17544 @opindex mfpxx
17545 Do not assume the width of floating-point registers.
17547 @item -mhard-float
17548 @opindex mhard-float
17549 Use floating-point coprocessor instructions.
17551 @item -msoft-float
17552 @opindex msoft-float
17553 Do not use floating-point coprocessor instructions.  Implement
17554 floating-point calculations using library calls instead.
17556 @item -mno-float
17557 @opindex mno-float
17558 Equivalent to @option{-msoft-float}, but additionally asserts that the
17559 program being compiled does not perform any floating-point operations.
17560 This option is presently supported only by some bare-metal MIPS
17561 configurations, where it may select a special set of libraries
17562 that lack all floating-point support (including, for example, the
17563 floating-point @code{printf} formats).  
17564 If code compiled with @option{-mno-float} accidentally contains
17565 floating-point operations, it is likely to suffer a link-time
17566 or run-time failure.
17568 @item -msingle-float
17569 @opindex msingle-float
17570 Assume that the floating-point coprocessor only supports single-precision
17571 operations.
17573 @item -mdouble-float
17574 @opindex mdouble-float
17575 Assume that the floating-point coprocessor supports double-precision
17576 operations.  This is the default.
17578 @item -modd-spreg
17579 @itemx -mno-odd-spreg
17580 @opindex modd-spreg
17581 @opindex mno-odd-spreg
17582 Enable the use of odd-numbered single-precision floating-point registers
17583 for the o32 ABI.  This is the default for processors that are known to
17584 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17585 is set by default.
17587 @item -mcompact-branches=never
17588 @itemx -mcompact-branches=optimal
17589 @itemx -mcompact-branches=always
17590 @opindex mcompact-branches=never
17591 @opindex mcompact-branches=optimal
17592 @opindex mcompact-branches=always
17593 These options control which form of branches will be generated.  The
17594 default is @option{-mcompact-branches=optimal}.
17596 The @option{-mcompact-branches=never} option ensures that compact branch
17597 instructions will never be generated.
17599 The @option{-mcompact-branches=always} option ensures that a compact
17600 branch instruction will be generated if available.  If a compact branch
17601 instruction is not available, a delay slot form of the branch will be
17602 used instead.
17604 This option is supported from MIPS Release 6 onwards.
17606 The @option{-mcompact-branches=optimal} option will cause a delay slot
17607 branch to be used if one is available in the current ISA and the delay
17608 slot is successfully filled.  If the delay slot is not filled, a compact
17609 branch will be chosen if one is available.
17611 @item -mabs=2008
17612 @itemx -mabs=legacy
17613 @opindex mabs=2008
17614 @opindex mabs=legacy
17615 These options control the treatment of the special not-a-number (NaN)
17616 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17617 @code{neg.@i{fmt}} machine instructions.
17619 By default or when @option{-mabs=legacy} is used the legacy
17620 treatment is selected.  In this case these instructions are considered
17621 arithmetic and avoided where correct operation is required and the
17622 input operand might be a NaN.  A longer sequence of instructions that
17623 manipulate the sign bit of floating-point datum manually is used
17624 instead unless the @option{-ffinite-math-only} option has also been
17625 specified.
17627 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17628 this case these instructions are considered non-arithmetic and therefore
17629 operating correctly in all cases, including in particular where the
17630 input operand is a NaN.  These instructions are therefore always used
17631 for the respective operations.
17633 @item -mnan=2008
17634 @itemx -mnan=legacy
17635 @opindex mnan=2008
17636 @opindex mnan=legacy
17637 These options control the encoding of the special not-a-number (NaN)
17638 IEEE 754 floating-point data.
17640 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17641 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17642 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17643 by the first bit of their trailing significand field being 1.
17645 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17646 this case qNaNs are denoted by the first bit of their trailing
17647 significand field being 1, whereas sNaNs are denoted by the first bit of
17648 their trailing significand field being 0.
17650 The default is @option{-mnan=legacy} unless GCC has been configured with
17651 @option{--with-nan=2008}.
17653 @item -mllsc
17654 @itemx -mno-llsc
17655 @opindex mllsc
17656 @opindex mno-llsc
17657 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17658 implement atomic memory built-in functions.  When neither option is
17659 specified, GCC uses the instructions if the target architecture
17660 supports them.
17662 @option{-mllsc} is useful if the runtime environment can emulate the
17663 instructions and @option{-mno-llsc} can be useful when compiling for
17664 nonstandard ISAs.  You can make either option the default by
17665 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17666 respectively.  @option{--with-llsc} is the default for some
17667 configurations; see the installation documentation for details.
17669 @item -mdsp
17670 @itemx -mno-dsp
17671 @opindex mdsp
17672 @opindex mno-dsp
17673 Use (do not use) revision 1 of the MIPS DSP ASE@.
17674 @xref{MIPS DSP Built-in Functions}.  This option defines the
17675 preprocessor macro @code{__mips_dsp}.  It also defines
17676 @code{__mips_dsp_rev} to 1.
17678 @item -mdspr2
17679 @itemx -mno-dspr2
17680 @opindex mdspr2
17681 @opindex mno-dspr2
17682 Use (do not use) revision 2 of the MIPS DSP ASE@.
17683 @xref{MIPS DSP Built-in Functions}.  This option defines the
17684 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17685 It also defines @code{__mips_dsp_rev} to 2.
17687 @item -msmartmips
17688 @itemx -mno-smartmips
17689 @opindex msmartmips
17690 @opindex mno-smartmips
17691 Use (do not use) the MIPS SmartMIPS ASE.
17693 @item -mpaired-single
17694 @itemx -mno-paired-single
17695 @opindex mpaired-single
17696 @opindex mno-paired-single
17697 Use (do not use) paired-single floating-point instructions.
17698 @xref{MIPS Paired-Single Support}.  This option requires
17699 hardware floating-point support to be enabled.
17701 @item -mdmx
17702 @itemx -mno-mdmx
17703 @opindex mdmx
17704 @opindex mno-mdmx
17705 Use (do not use) MIPS Digital Media Extension instructions.
17706 This option can only be used when generating 64-bit code and requires
17707 hardware floating-point support to be enabled.
17709 @item -mips3d
17710 @itemx -mno-mips3d
17711 @opindex mips3d
17712 @opindex mno-mips3d
17713 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17714 The option @option{-mips3d} implies @option{-mpaired-single}.
17716 @item -mmicromips
17717 @itemx -mno-micromips
17718 @opindex mmicromips
17719 @opindex mno-mmicromips
17720 Generate (do not generate) microMIPS code.
17722 MicroMIPS code generation can also be controlled on a per-function basis
17723 by means of @code{micromips} and @code{nomicromips} attributes.
17724 @xref{Function Attributes}, for more information.
17726 @item -mmt
17727 @itemx -mno-mt
17728 @opindex mmt
17729 @opindex mno-mt
17730 Use (do not use) MT Multithreading instructions.
17732 @item -mmcu
17733 @itemx -mno-mcu
17734 @opindex mmcu
17735 @opindex mno-mcu
17736 Use (do not use) the MIPS MCU ASE instructions.
17738 @item -meva
17739 @itemx -mno-eva
17740 @opindex meva
17741 @opindex mno-eva
17742 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17744 @item -mvirt
17745 @itemx -mno-virt
17746 @opindex mvirt
17747 @opindex mno-virt
17748 Use (do not use) the MIPS Virtualization Application Specific instructions.
17750 @item -mxpa
17751 @itemx -mno-xpa
17752 @opindex mxpa
17753 @opindex mno-xpa
17754 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17756 @item -mlong64
17757 @opindex mlong64
17758 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17759 an explanation of the default and the way that the pointer size is
17760 determined.
17762 @item -mlong32
17763 @opindex mlong32
17764 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17766 The default size of @code{int}s, @code{long}s and pointers depends on
17767 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17768 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17769 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17770 or the same size as integer registers, whichever is smaller.
17772 @item -msym32
17773 @itemx -mno-sym32
17774 @opindex msym32
17775 @opindex mno-sym32
17776 Assume (do not assume) that all symbols have 32-bit values, regardless
17777 of the selected ABI@.  This option is useful in combination with
17778 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17779 to generate shorter and faster references to symbolic addresses.
17781 @item -G @var{num}
17782 @opindex G
17783 Put definitions of externally-visible data in a small data section
17784 if that data is no bigger than @var{num} bytes.  GCC can then generate
17785 more efficient accesses to the data; see @option{-mgpopt} for details.
17787 The default @option{-G} option depends on the configuration.
17789 @item -mlocal-sdata
17790 @itemx -mno-local-sdata
17791 @opindex mlocal-sdata
17792 @opindex mno-local-sdata
17793 Extend (do not extend) the @option{-G} behavior to local data too,
17794 such as to static variables in C@.  @option{-mlocal-sdata} is the
17795 default for all configurations.
17797 If the linker complains that an application is using too much small data,
17798 you might want to try rebuilding the less performance-critical parts with
17799 @option{-mno-local-sdata}.  You might also want to build large
17800 libraries with @option{-mno-local-sdata}, so that the libraries leave
17801 more room for the main program.
17803 @item -mextern-sdata
17804 @itemx -mno-extern-sdata
17805 @opindex mextern-sdata
17806 @opindex mno-extern-sdata
17807 Assume (do not assume) that externally-defined data is in
17808 a small data section if the size of that data is within the @option{-G} limit.
17809 @option{-mextern-sdata} is the default for all configurations.
17811 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17812 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17813 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17814 is placed in a small data section.  If @var{Var} is defined by another
17815 module, you must either compile that module with a high-enough
17816 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17817 definition.  If @var{Var} is common, you must link the application
17818 with a high-enough @option{-G} setting.
17820 The easiest way of satisfying these restrictions is to compile
17821 and link every module with the same @option{-G} option.  However,
17822 you may wish to build a library that supports several different
17823 small data limits.  You can do this by compiling the library with
17824 the highest supported @option{-G} setting and additionally using
17825 @option{-mno-extern-sdata} to stop the library from making assumptions
17826 about externally-defined data.
17828 @item -mgpopt
17829 @itemx -mno-gpopt
17830 @opindex mgpopt
17831 @opindex mno-gpopt
17832 Use (do not use) GP-relative accesses for symbols that are known to be
17833 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17834 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17835 configurations.
17837 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17838 might not hold the value of @code{_gp}.  For example, if the code is
17839 part of a library that might be used in a boot monitor, programs that
17840 call boot monitor routines pass an unknown value in @code{$gp}.
17841 (In such situations, the boot monitor itself is usually compiled
17842 with @option{-G0}.)
17844 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17845 @option{-mno-extern-sdata}.
17847 @item -membedded-data
17848 @itemx -mno-embedded-data
17849 @opindex membedded-data
17850 @opindex mno-embedded-data
17851 Allocate variables to the read-only data section first if possible, then
17852 next in the small data section if possible, otherwise in data.  This gives
17853 slightly slower code than the default, but reduces the amount of RAM required
17854 when executing, and thus may be preferred for some embedded systems.
17856 @item -muninit-const-in-rodata
17857 @itemx -mno-uninit-const-in-rodata
17858 @opindex muninit-const-in-rodata
17859 @opindex mno-uninit-const-in-rodata
17860 Put uninitialized @code{const} variables in the read-only data section.
17861 This option is only meaningful in conjunction with @option{-membedded-data}.
17863 @item -mcode-readable=@var{setting}
17864 @opindex mcode-readable
17865 Specify whether GCC may generate code that reads from executable sections.
17866 There are three possible settings:
17868 @table @gcctabopt
17869 @item -mcode-readable=yes
17870 Instructions may freely access executable sections.  This is the
17871 default setting.
17873 @item -mcode-readable=pcrel
17874 MIPS16 PC-relative load instructions can access executable sections,
17875 but other instructions must not do so.  This option is useful on 4KSc
17876 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17877 It is also useful on processors that can be configured to have a dual
17878 instruction/data SRAM interface and that, like the M4K, automatically
17879 redirect PC-relative loads to the instruction RAM.
17881 @item -mcode-readable=no
17882 Instructions must not access executable sections.  This option can be
17883 useful on targets that are configured to have a dual instruction/data
17884 SRAM interface but that (unlike the M4K) do not automatically redirect
17885 PC-relative loads to the instruction RAM.
17886 @end table
17888 @item -msplit-addresses
17889 @itemx -mno-split-addresses
17890 @opindex msplit-addresses
17891 @opindex mno-split-addresses
17892 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17893 relocation operators.  This option has been superseded by
17894 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17896 @item -mexplicit-relocs
17897 @itemx -mno-explicit-relocs
17898 @opindex mexplicit-relocs
17899 @opindex mno-explicit-relocs
17900 Use (do not use) assembler relocation operators when dealing with symbolic
17901 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17902 is to use assembler macros instead.
17904 @option{-mexplicit-relocs} is the default if GCC was configured
17905 to use an assembler that supports relocation operators.
17907 @item -mcheck-zero-division
17908 @itemx -mno-check-zero-division
17909 @opindex mcheck-zero-division
17910 @opindex mno-check-zero-division
17911 Trap (do not trap) on integer division by zero.
17913 The default is @option{-mcheck-zero-division}.
17915 @item -mdivide-traps
17916 @itemx -mdivide-breaks
17917 @opindex mdivide-traps
17918 @opindex mdivide-breaks
17919 MIPS systems check for division by zero by generating either a
17920 conditional trap or a break instruction.  Using traps results in
17921 smaller code, but is only supported on MIPS II and later.  Also, some
17922 versions of the Linux kernel have a bug that prevents trap from
17923 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17924 allow conditional traps on architectures that support them and
17925 @option{-mdivide-breaks} to force the use of breaks.
17927 The default is usually @option{-mdivide-traps}, but this can be
17928 overridden at configure time using @option{--with-divide=breaks}.
17929 Divide-by-zero checks can be completely disabled using
17930 @option{-mno-check-zero-division}.
17932 @item -mmemcpy
17933 @itemx -mno-memcpy
17934 @opindex mmemcpy
17935 @opindex mno-memcpy
17936 Force (do not force) the use of @code{memcpy} for non-trivial block
17937 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17938 most constant-sized copies.
17940 @item -mlong-calls
17941 @itemx -mno-long-calls
17942 @opindex mlong-calls
17943 @opindex mno-long-calls
17944 Disable (do not disable) use of the @code{jal} instruction.  Calling
17945 functions using @code{jal} is more efficient but requires the caller
17946 and callee to be in the same 256 megabyte segment.
17948 This option has no effect on abicalls code.  The default is
17949 @option{-mno-long-calls}.
17951 @item -mmad
17952 @itemx -mno-mad
17953 @opindex mmad
17954 @opindex mno-mad
17955 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17956 instructions, as provided by the R4650 ISA@.
17958 @item -mimadd
17959 @itemx -mno-imadd
17960 @opindex mimadd
17961 @opindex mno-imadd
17962 Enable (disable) use of the @code{madd} and @code{msub} integer
17963 instructions.  The default is @option{-mimadd} on architectures
17964 that support @code{madd} and @code{msub} except for the 74k 
17965 architecture where it was found to generate slower code.
17967 @item -mfused-madd
17968 @itemx -mno-fused-madd
17969 @opindex mfused-madd
17970 @opindex mno-fused-madd
17971 Enable (disable) use of the floating-point multiply-accumulate
17972 instructions, when they are available.  The default is
17973 @option{-mfused-madd}.
17975 On the R8000 CPU when multiply-accumulate instructions are used,
17976 the intermediate product is calculated to infinite precision
17977 and is not subject to the FCSR Flush to Zero bit.  This may be
17978 undesirable in some circumstances.  On other processors the result
17979 is numerically identical to the equivalent computation using
17980 separate multiply, add, subtract and negate instructions.
17982 @item -nocpp
17983 @opindex nocpp
17984 Tell the MIPS assembler to not run its preprocessor over user
17985 assembler files (with a @samp{.s} suffix) when assembling them.
17987 @item -mfix-24k
17988 @item -mno-fix-24k
17989 @opindex mfix-24k
17990 @opindex mno-fix-24k
17991 Work around the 24K E48 (lost data on stores during refill) errata.
17992 The workarounds are implemented by the assembler rather than by GCC@.
17994 @item -mfix-r4000
17995 @itemx -mno-fix-r4000
17996 @opindex mfix-r4000
17997 @opindex mno-fix-r4000
17998 Work around certain R4000 CPU errata:
17999 @itemize @minus
18000 @item
18001 A double-word or a variable shift may give an incorrect result if executed
18002 immediately after starting an integer division.
18003 @item
18004 A double-word or a variable shift may give an incorrect result if executed
18005 while an integer multiplication is in progress.
18006 @item
18007 An integer division may give an incorrect result if started in a delay slot
18008 of a taken branch or a jump.
18009 @end itemize
18011 @item -mfix-r4400
18012 @itemx -mno-fix-r4400
18013 @opindex mfix-r4400
18014 @opindex mno-fix-r4400
18015 Work around certain R4400 CPU errata:
18016 @itemize @minus
18017 @item
18018 A double-word or a variable shift may give an incorrect result if executed
18019 immediately after starting an integer division.
18020 @end itemize
18022 @item -mfix-r10000
18023 @itemx -mno-fix-r10000
18024 @opindex mfix-r10000
18025 @opindex mno-fix-r10000
18026 Work around certain R10000 errata:
18027 @itemize @minus
18028 @item
18029 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18030 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18031 @end itemize
18033 This option can only be used if the target architecture supports
18034 branch-likely instructions.  @option{-mfix-r10000} is the default when
18035 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18036 otherwise.
18038 @item -mfix-rm7000
18039 @itemx -mno-fix-rm7000
18040 @opindex mfix-rm7000
18041 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18042 workarounds are implemented by the assembler rather than by GCC@.
18044 @item -mfix-vr4120
18045 @itemx -mno-fix-vr4120
18046 @opindex mfix-vr4120
18047 Work around certain VR4120 errata:
18048 @itemize @minus
18049 @item
18050 @code{dmultu} does not always produce the correct result.
18051 @item
18052 @code{div} and @code{ddiv} do not always produce the correct result if one
18053 of the operands is negative.
18054 @end itemize
18055 The workarounds for the division errata rely on special functions in
18056 @file{libgcc.a}.  At present, these functions are only provided by
18057 the @code{mips64vr*-elf} configurations.
18059 Other VR4120 errata require a NOP to be inserted between certain pairs of
18060 instructions.  These errata are handled by the assembler, not by GCC itself.
18062 @item -mfix-vr4130
18063 @opindex mfix-vr4130
18064 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18065 workarounds are implemented by the assembler rather than by GCC,
18066 although GCC avoids using @code{mflo} and @code{mfhi} if the
18067 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18068 instructions are available instead.
18070 @item -mfix-sb1
18071 @itemx -mno-fix-sb1
18072 @opindex mfix-sb1
18073 Work around certain SB-1 CPU core errata.
18074 (This flag currently works around the SB-1 revision 2
18075 ``F1'' and ``F2'' floating-point errata.)
18077 @item -mr10k-cache-barrier=@var{setting}
18078 @opindex mr10k-cache-barrier
18079 Specify whether GCC should insert cache barriers to avoid the
18080 side-effects of speculation on R10K processors.
18082 In common with many processors, the R10K tries to predict the outcome
18083 of a conditional branch and speculatively executes instructions from
18084 the ``taken'' branch.  It later aborts these instructions if the
18085 predicted outcome is wrong.  However, on the R10K, even aborted
18086 instructions can have side effects.
18088 This problem only affects kernel stores and, depending on the system,
18089 kernel loads.  As an example, a speculatively-executed store may load
18090 the target memory into cache and mark the cache line as dirty, even if
18091 the store itself is later aborted.  If a DMA operation writes to the
18092 same area of memory before the ``dirty'' line is flushed, the cached
18093 data overwrites the DMA-ed data.  See the R10K processor manual
18094 for a full description, including other potential problems.
18096 One workaround is to insert cache barrier instructions before every memory
18097 access that might be speculatively executed and that might have side
18098 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18099 controls GCC's implementation of this workaround.  It assumes that
18100 aborted accesses to any byte in the following regions does not have
18101 side effects:
18103 @enumerate
18104 @item
18105 the memory occupied by the current function's stack frame;
18107 @item
18108 the memory occupied by an incoming stack argument;
18110 @item
18111 the memory occupied by an object with a link-time-constant address.
18112 @end enumerate
18114 It is the kernel's responsibility to ensure that speculative
18115 accesses to these regions are indeed safe.
18117 If the input program contains a function declaration such as:
18119 @smallexample
18120 void foo (void);
18121 @end smallexample
18123 then the implementation of @code{foo} must allow @code{j foo} and
18124 @code{jal foo} to be executed speculatively.  GCC honors this
18125 restriction for functions it compiles itself.  It expects non-GCC
18126 functions (such as hand-written assembly code) to do the same.
18128 The option has three forms:
18130 @table @gcctabopt
18131 @item -mr10k-cache-barrier=load-store
18132 Insert a cache barrier before a load or store that might be
18133 speculatively executed and that might have side effects even
18134 if aborted.
18136 @item -mr10k-cache-barrier=store
18137 Insert a cache barrier before a store that might be speculatively
18138 executed and that might have side effects even if aborted.
18140 @item -mr10k-cache-barrier=none
18141 Disable the insertion of cache barriers.  This is the default setting.
18142 @end table
18144 @item -mflush-func=@var{func}
18145 @itemx -mno-flush-func
18146 @opindex mflush-func
18147 Specifies the function to call to flush the I and D caches, or to not
18148 call any such function.  If called, the function must take the same
18149 arguments as the common @code{_flush_func}, that is, the address of the
18150 memory range for which the cache is being flushed, the size of the
18151 memory range, and the number 3 (to flush both caches).  The default
18152 depends on the target GCC was configured for, but commonly is either
18153 @code{_flush_func} or @code{__cpu_flush}.
18155 @item mbranch-cost=@var{num}
18156 @opindex mbranch-cost
18157 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18158 This cost is only a heuristic and is not guaranteed to produce
18159 consistent results across releases.  A zero cost redundantly selects
18160 the default, which is based on the @option{-mtune} setting.
18162 @item -mbranch-likely
18163 @itemx -mno-branch-likely
18164 @opindex mbranch-likely
18165 @opindex mno-branch-likely
18166 Enable or disable use of Branch Likely instructions, regardless of the
18167 default for the selected architecture.  By default, Branch Likely
18168 instructions may be generated if they are supported by the selected
18169 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18170 and processors that implement those architectures; for those, Branch
18171 Likely instructions are not be generated by default because the MIPS32
18172 and MIPS64 architectures specifically deprecate their use.
18174 @item -mfp-exceptions
18175 @itemx -mno-fp-exceptions
18176 @opindex mfp-exceptions
18177 Specifies whether FP exceptions are enabled.  This affects how
18178 FP instructions are scheduled for some processors.
18179 The default is that FP exceptions are
18180 enabled.
18182 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18183 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18184 FP pipe.
18186 @item -mvr4130-align
18187 @itemx -mno-vr4130-align
18188 @opindex mvr4130-align
18189 The VR4130 pipeline is two-way superscalar, but can only issue two
18190 instructions together if the first one is 8-byte aligned.  When this
18191 option is enabled, GCC aligns pairs of instructions that it
18192 thinks should execute in parallel.
18194 This option only has an effect when optimizing for the VR4130.
18195 It normally makes code faster, but at the expense of making it bigger.
18196 It is enabled by default at optimization level @option{-O3}.
18198 @item -msynci
18199 @itemx -mno-synci
18200 @opindex msynci
18201 Enable (disable) generation of @code{synci} instructions on
18202 architectures that support it.  The @code{synci} instructions (if
18203 enabled) are generated when @code{__builtin___clear_cache} is
18204 compiled.
18206 This option defaults to @option{-mno-synci}, but the default can be
18207 overridden by configuring GCC with @option{--with-synci}.
18209 When compiling code for single processor systems, it is generally safe
18210 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18211 does not invalidate the instruction caches on all cores and may lead
18212 to undefined behavior.
18214 @item -mrelax-pic-calls
18215 @itemx -mno-relax-pic-calls
18216 @opindex mrelax-pic-calls
18217 Try to turn PIC calls that are normally dispatched via register
18218 @code{$25} into direct calls.  This is only possible if the linker can
18219 resolve the destination at link-time and if the destination is within
18220 range for a direct call.
18222 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18223 an assembler and a linker that support the @code{.reloc} assembly
18224 directive and @option{-mexplicit-relocs} is in effect.  With
18225 @option{-mno-explicit-relocs}, this optimization can be performed by the
18226 assembler and the linker alone without help from the compiler.
18228 @item -mmcount-ra-address
18229 @itemx -mno-mcount-ra-address
18230 @opindex mmcount-ra-address
18231 @opindex mno-mcount-ra-address
18232 Emit (do not emit) code that allows @code{_mcount} to modify the
18233 calling function's return address.  When enabled, this option extends
18234 the usual @code{_mcount} interface with a new @var{ra-address}
18235 parameter, which has type @code{intptr_t *} and is passed in register
18236 @code{$12}.  @code{_mcount} can then modify the return address by
18237 doing both of the following:
18238 @itemize
18239 @item
18240 Returning the new address in register @code{$31}.
18241 @item
18242 Storing the new address in @code{*@var{ra-address}},
18243 if @var{ra-address} is nonnull.
18244 @end itemize
18246 The default is @option{-mno-mcount-ra-address}.
18248 @item -mframe-header-opt
18249 @itemx -mno-frame-header-opt
18250 @opindex mframe-header-opt
18251 Enable (disable) frame header optimization in the o32 ABI.  When using the
18252 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
18253 function to write out register arguments.  When enabled, this optimization
18254 will suppress the allocation of the frame header if it can be determined that
18255 it is unused.
18257 This optimization is off by default at all optimization levels.
18259 @end table
18261 @node MMIX Options
18262 @subsection MMIX Options
18263 @cindex MMIX Options
18265 These options are defined for the MMIX:
18267 @table @gcctabopt
18268 @item -mlibfuncs
18269 @itemx -mno-libfuncs
18270 @opindex mlibfuncs
18271 @opindex mno-libfuncs
18272 Specify that intrinsic library functions are being compiled, passing all
18273 values in registers, no matter the size.
18275 @item -mepsilon
18276 @itemx -mno-epsilon
18277 @opindex mepsilon
18278 @opindex mno-epsilon
18279 Generate floating-point comparison instructions that compare with respect
18280 to the @code{rE} epsilon register.
18282 @item -mabi=mmixware
18283 @itemx -mabi=gnu
18284 @opindex mabi=mmixware
18285 @opindex mabi=gnu
18286 Generate code that passes function parameters and return values that (in
18287 the called function) are seen as registers @code{$0} and up, as opposed to
18288 the GNU ABI which uses global registers @code{$231} and up.
18290 @item -mzero-extend
18291 @itemx -mno-zero-extend
18292 @opindex mzero-extend
18293 @opindex mno-zero-extend
18294 When reading data from memory in sizes shorter than 64 bits, use (do not
18295 use) zero-extending load instructions by default, rather than
18296 sign-extending ones.
18298 @item -mknuthdiv
18299 @itemx -mno-knuthdiv
18300 @opindex mknuthdiv
18301 @opindex mno-knuthdiv
18302 Make the result of a division yielding a remainder have the same sign as
18303 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18304 remainder follows the sign of the dividend.  Both methods are
18305 arithmetically valid, the latter being almost exclusively used.
18307 @item -mtoplevel-symbols
18308 @itemx -mno-toplevel-symbols
18309 @opindex mtoplevel-symbols
18310 @opindex mno-toplevel-symbols
18311 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18312 code can be used with the @code{PREFIX} assembly directive.
18314 @item -melf
18315 @opindex melf
18316 Generate an executable in the ELF format, rather than the default
18317 @samp{mmo} format used by the @command{mmix} simulator.
18319 @item -mbranch-predict
18320 @itemx -mno-branch-predict
18321 @opindex mbranch-predict
18322 @opindex mno-branch-predict
18323 Use (do not use) the probable-branch instructions, when static branch
18324 prediction indicates a probable branch.
18326 @item -mbase-addresses
18327 @itemx -mno-base-addresses
18328 @opindex mbase-addresses
18329 @opindex mno-base-addresses
18330 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18331 base address automatically generates a request (handled by the assembler
18332 and the linker) for a constant to be set up in a global register.  The
18333 register is used for one or more base address requests within the range 0
18334 to 255 from the value held in the register.  The generally leads to short
18335 and fast code, but the number of different data items that can be
18336 addressed is limited.  This means that a program that uses lots of static
18337 data may require @option{-mno-base-addresses}.
18339 @item -msingle-exit
18340 @itemx -mno-single-exit
18341 @opindex msingle-exit
18342 @opindex mno-single-exit
18343 Force (do not force) generated code to have a single exit point in each
18344 function.
18345 @end table
18347 @node MN10300 Options
18348 @subsection MN10300 Options
18349 @cindex MN10300 options
18351 These @option{-m} options are defined for Matsushita MN10300 architectures:
18353 @table @gcctabopt
18354 @item -mmult-bug
18355 @opindex mmult-bug
18356 Generate code to avoid bugs in the multiply instructions for the MN10300
18357 processors.  This is the default.
18359 @item -mno-mult-bug
18360 @opindex mno-mult-bug
18361 Do not generate code to avoid bugs in the multiply instructions for the
18362 MN10300 processors.
18364 @item -mam33
18365 @opindex mam33
18366 Generate code using features specific to the AM33 processor.
18368 @item -mno-am33
18369 @opindex mno-am33
18370 Do not generate code using features specific to the AM33 processor.  This
18371 is the default.
18373 @item -mam33-2
18374 @opindex mam33-2
18375 Generate code using features specific to the AM33/2.0 processor.
18377 @item -mam34
18378 @opindex mam34
18379 Generate code using features specific to the AM34 processor.
18381 @item -mtune=@var{cpu-type}
18382 @opindex mtune
18383 Use the timing characteristics of the indicated CPU type when
18384 scheduling instructions.  This does not change the targeted processor
18385 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18386 @samp{am33-2} or @samp{am34}.
18388 @item -mreturn-pointer-on-d0
18389 @opindex mreturn-pointer-on-d0
18390 When generating a function that returns a pointer, return the pointer
18391 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18392 only in @code{a0}, and attempts to call such functions without a prototype
18393 result in errors.  Note that this option is on by default; use
18394 @option{-mno-return-pointer-on-d0} to disable it.
18396 @item -mno-crt0
18397 @opindex mno-crt0
18398 Do not link in the C run-time initialization object file.
18400 @item -mrelax
18401 @opindex mrelax
18402 Indicate to the linker that it should perform a relaxation optimization pass
18403 to shorten branches, calls and absolute memory addresses.  This option only
18404 has an effect when used on the command line for the final link step.
18406 This option makes symbolic debugging impossible.
18408 @item -mliw
18409 @opindex mliw
18410 Allow the compiler to generate @emph{Long Instruction Word}
18411 instructions if the target is the @samp{AM33} or later.  This is the
18412 default.  This option defines the preprocessor macro @code{__LIW__}.
18414 @item -mnoliw
18415 @opindex mnoliw
18416 Do not allow the compiler to generate @emph{Long Instruction Word}
18417 instructions.  This option defines the preprocessor macro
18418 @code{__NO_LIW__}.
18420 @item -msetlb
18421 @opindex msetlb
18422 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18423 instructions if the target is the @samp{AM33} or later.  This is the
18424 default.  This option defines the preprocessor macro @code{__SETLB__}.
18426 @item -mnosetlb
18427 @opindex mnosetlb
18428 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18429 instructions.  This option defines the preprocessor macro
18430 @code{__NO_SETLB__}.
18432 @end table
18434 @node Moxie Options
18435 @subsection Moxie Options
18436 @cindex Moxie Options
18438 @table @gcctabopt
18440 @item -meb
18441 @opindex meb
18442 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18443 configurations.
18445 @item -mel
18446 @opindex mel
18447 Generate little-endian code.
18449 @item -mmul.x
18450 @opindex mmul.x
18451 Generate mul.x and umul.x instructions.  This is the default for
18452 @samp{moxiebox-*-*} configurations.
18454 @item -mno-crt0
18455 @opindex mno-crt0
18456 Do not link in the C run-time initialization object file.
18458 @end table
18460 @node MSP430 Options
18461 @subsection MSP430 Options
18462 @cindex MSP430 Options
18464 These options are defined for the MSP430:
18466 @table @gcctabopt
18468 @item -masm-hex
18469 @opindex masm-hex
18470 Force assembly output to always use hex constants.  Normally such
18471 constants are signed decimals, but this option is available for
18472 testsuite and/or aesthetic purposes.
18474 @item -mmcu=
18475 @opindex mmcu=
18476 Select the MCU to target.  This is used to create a C preprocessor
18477 symbol based upon the MCU name, converted to upper case and pre- and
18478 post-fixed with @samp{__}.  This in turn is used by the
18479 @file{msp430.h} header file to select an MCU-specific supplementary
18480 header file.
18482 The option also sets the ISA to use.  If the MCU name is one that is
18483 known to only support the 430 ISA then that is selected, otherwise the
18484 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18485 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18486 name selects the 430X ISA.
18488 In addition an MCU-specific linker script is added to the linker
18489 command line.  The script's name is the name of the MCU with
18490 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18491 command line defines the C preprocessor symbol @code{__XXX__} and
18492 cause the linker to search for a script called @file{xxx.ld}.
18494 This option is also passed on to the assembler.
18496 @item -mcpu=
18497 @opindex mcpu=
18498 Specifies the ISA to use.  Accepted values are @samp{msp430},
18499 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18500 @option{-mmcu=} option should be used to select the ISA.
18502 @item -msim
18503 @opindex msim
18504 Link to the simulator runtime libraries and linker script.  Overrides
18505 any scripts that would be selected by the @option{-mmcu=} option.
18507 @item -mlarge
18508 @opindex mlarge
18509 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18511 @item -msmall
18512 @opindex msmall
18513 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18515 @item -mrelax
18516 @opindex mrelax
18517 This option is passed to the assembler and linker, and allows the
18518 linker to perform certain optimizations that cannot be done until
18519 the final link.
18521 @item mhwmult=
18522 @opindex mhwmult=
18523 Describes the type of hardware multiply supported by the target.
18524 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18525 for the original 16-bit-only multiply supported by early MCUs.
18526 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18527 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18528 A value of @samp{auto} can also be given.  This tells GCC to deduce
18529 the hardware multiply support based upon the MCU name provided by the
18530 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18531 @samp{32bit} hardware multiply support is assumed.  If the MCU name is
18532 not recognised then no hardware multiply support is assumed.
18533 @code{auto} is the default setting.
18535 Hardware multiplies are normally performed by calling a library
18536 routine.  This saves space in the generated code.  When compiling at
18537 @option{-O3} or higher however the hardware multiplier is invoked
18538 inline.  This makes for bigger, but faster code.
18540 The hardware multiply routines disable interrupts whilst running and
18541 restore the previous interrupt state when they finish.  This makes
18542 them safe to use inside interrupt handlers as well as in normal code.
18544 @item -minrt
18545 @opindex minrt
18546 Enable the use of a minimum runtime environment - no static
18547 initializers or constructors.  This is intended for memory-constrained
18548 devices.  The compiler includes special symbols in some objects
18549 that tell the linker and runtime which code fragments are required.
18551 @item -mcode-region=
18552 @itemx -mdata-region=
18553 @opindex mcode-region
18554 @opindex mdata-region
18555 These options tell the compiler where to place functions and data that
18556 do not have one of the @code{lower}, @code{upper}, @code{either} or
18557 @code{section} attributes.  Possible values are @code{lower},
18558 @code{upper}, @code{either} or @code{any}.  The first three behave
18559 like the corresponding attribute.  The fourth possible value -
18560 @code{any} - is the default.  It leaves placement entirely up to the
18561 linker script and how it assigns the standard sections (.text, .data
18562 etc) to the memory regions.
18564 @item -msilicon-errata=
18565 @opindex msilicon-errata
18566 This option passes on a request to assembler to enable the fixes for
18567 the named silicon errata.
18569 @item -msilicon-errata-warn=
18570 @opindex msilicon-errata-warn
18571 This option passes on a request to the assembler to enable warning
18572 messages when a silicon errata might need to be applied.
18574 @end table
18576 @node NDS32 Options
18577 @subsection NDS32 Options
18578 @cindex NDS32 Options
18580 These options are defined for NDS32 implementations:
18582 @table @gcctabopt
18584 @item -mbig-endian
18585 @opindex mbig-endian
18586 Generate code in big-endian mode.
18588 @item -mlittle-endian
18589 @opindex mlittle-endian
18590 Generate code in little-endian mode.
18592 @item -mreduced-regs
18593 @opindex mreduced-regs
18594 Use reduced-set registers for register allocation.
18596 @item -mfull-regs
18597 @opindex mfull-regs
18598 Use full-set registers for register allocation.
18600 @item -mcmov
18601 @opindex mcmov
18602 Generate conditional move instructions.
18604 @item -mno-cmov
18605 @opindex mno-cmov
18606 Do not generate conditional move instructions.
18608 @item -mperf-ext
18609 @opindex mperf-ext
18610 Generate performance extension instructions.
18612 @item -mno-perf-ext
18613 @opindex mno-perf-ext
18614 Do not generate performance extension instructions.
18616 @item -mv3push
18617 @opindex mv3push
18618 Generate v3 push25/pop25 instructions.
18620 @item -mno-v3push
18621 @opindex mno-v3push
18622 Do not generate v3 push25/pop25 instructions.
18624 @item -m16-bit
18625 @opindex m16-bit
18626 Generate 16-bit instructions.
18628 @item -mno-16-bit
18629 @opindex mno-16-bit
18630 Do not generate 16-bit instructions.
18632 @item -misr-vector-size=@var{num}
18633 @opindex misr-vector-size
18634 Specify the size of each interrupt vector, which must be 4 or 16.
18636 @item -mcache-block-size=@var{num}
18637 @opindex mcache-block-size
18638 Specify the size of each cache block,
18639 which must be a power of 2 between 4 and 512.
18641 @item -march=@var{arch}
18642 @opindex march
18643 Specify the name of the target architecture.
18645 @item -mcmodel=@var{code-model}
18646 @opindex mcmodel
18647 Set the code model to one of
18648 @table @asis
18649 @item @samp{small}
18650 All the data and read-only data segments must be within 512KB addressing space.
18651 The text segment must be within 16MB addressing space.
18652 @item @samp{medium}
18653 The data segment must be within 512KB while the read-only data segment can be
18654 within 4GB addressing space.  The text segment should be still within 16MB
18655 addressing space.
18656 @item @samp{large}
18657 All the text and data segments can be within 4GB addressing space.
18658 @end table
18660 @item -mctor-dtor
18661 @opindex mctor-dtor
18662 Enable constructor/destructor feature.
18664 @item -mrelax
18665 @opindex mrelax
18666 Guide linker to relax instructions.
18668 @end table
18670 @node Nios II Options
18671 @subsection Nios II Options
18672 @cindex Nios II options
18673 @cindex Altera Nios II options
18675 These are the options defined for the Altera Nios II processor.
18677 @table @gcctabopt
18679 @item -G @var{num}
18680 @opindex G
18681 @cindex smaller data references
18682 Put global and static objects less than or equal to @var{num} bytes
18683 into the small data or BSS sections instead of the normal data or BSS
18684 sections.  The default value of @var{num} is 8.
18686 @item -mgpopt=@var{option}
18687 @item -mgpopt
18688 @itemx -mno-gpopt
18689 @opindex mgpopt
18690 @opindex mno-gpopt
18691 Generate (do not generate) GP-relative accesses.  The following 
18692 @var{option} names are recognized:
18694 @table @samp
18696 @item none
18697 Do not generate GP-relative accesses.
18699 @item local
18700 Generate GP-relative accesses for small data objects that are not 
18701 external, weak, or uninitialized common symbols.  
18702 Also use GP-relative addressing for objects that
18703 have been explicitly placed in a small data section via a @code{section}
18704 attribute.
18706 @item global
18707 As for @samp{local}, but also generate GP-relative accesses for
18708 small data objects that are external, weak, or common.  If you use this option,
18709 you must ensure that all parts of your program (including libraries) are
18710 compiled with the same @option{-G} setting.
18712 @item data
18713 Generate GP-relative accesses for all data objects in the program.  If you
18714 use this option, the entire data and BSS segments
18715 of your program must fit in 64K of memory and you must use an appropriate
18716 linker script to allocate them within the addressible range of the
18717 global pointer.
18719 @item all
18720 Generate GP-relative addresses for function pointers as well as data
18721 pointers.  If you use this option, the entire text, data, and BSS segments
18722 of your program must fit in 64K of memory and you must use an appropriate
18723 linker script to allocate them within the addressible range of the
18724 global pointer.
18726 @end table
18728 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18729 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18731 The default is @option{-mgpopt} except when @option{-fpic} or
18732 @option{-fPIC} is specified to generate position-independent code.
18733 Note that the Nios II ABI does not permit GP-relative accesses from
18734 shared libraries.
18736 You may need to specify @option{-mno-gpopt} explicitly when building
18737 programs that include large amounts of small data, including large
18738 GOT data sections.  In this case, the 16-bit offset for GP-relative
18739 addressing may not be large enough to allow access to the entire 
18740 small data section.
18742 @item -mel
18743 @itemx -meb
18744 @opindex mel
18745 @opindex meb
18746 Generate little-endian (default) or big-endian (experimental) code,
18747 respectively.
18749 @item -march=@var{arch}
18750 @opindex march
18751 This specifies the name of the target Nios II architecture.  GCC uses this
18752 name to determine what kind of instructions it can emit when generating
18753 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
18755 The preprocessor macro @code{__nios2_arch__} is available to programs,
18756 with value 1 or 2, indicating the targeted ISA level.
18758 @item -mbypass-cache
18759 @itemx -mno-bypass-cache
18760 @opindex mno-bypass-cache
18761 @opindex mbypass-cache
18762 Force all load and store instructions to always bypass cache by 
18763 using I/O variants of the instructions. The default is not to
18764 bypass the cache.
18766 @item -mno-cache-volatile 
18767 @itemx -mcache-volatile       
18768 @opindex mcache-volatile 
18769 @opindex mno-cache-volatile
18770 Volatile memory access bypass the cache using the I/O variants of 
18771 the load and store instructions. The default is not to bypass the cache.
18773 @item -mno-fast-sw-div
18774 @itemx -mfast-sw-div
18775 @opindex mno-fast-sw-div
18776 @opindex mfast-sw-div
18777 Do not use table-based fast divide for small numbers. The default 
18778 is to use the fast divide at @option{-O3} and above.
18780 @item -mno-hw-mul
18781 @itemx -mhw-mul
18782 @itemx -mno-hw-mulx
18783 @itemx -mhw-mulx
18784 @itemx -mno-hw-div
18785 @itemx -mhw-div
18786 @opindex mno-hw-mul
18787 @opindex mhw-mul
18788 @opindex mno-hw-mulx
18789 @opindex mhw-mulx
18790 @opindex mno-hw-div
18791 @opindex mhw-div
18792 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18793 instructions by the compiler. The default is to emit @code{mul}
18794 and not emit @code{div} and @code{mulx}.
18796 @item -mbmx
18797 @itemx -mno-bmx
18798 @itemx -mcdx
18799 @itemx -mno-cdx
18800 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
18801 CDX (code density) instructions.  Enabling these instructions also
18802 requires @option{-march=r2}.  Since these instructions are optional
18803 extensions to the R2 architecture, the default is not to emit them.
18805 @item -mcustom-@var{insn}=@var{N}
18806 @itemx -mno-custom-@var{insn}
18807 @opindex mcustom-@var{insn}
18808 @opindex mno-custom-@var{insn}
18809 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18810 custom instruction with encoding @var{N} when generating code that uses 
18811 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18812 instruction 253 for single-precision floating-point add operations instead
18813 of the default behavior of using a library call.
18815 The following values of @var{insn} are supported.  Except as otherwise
18816 noted, floating-point operations are expected to be implemented with
18817 normal IEEE 754 semantics and correspond directly to the C operators or the
18818 equivalent GCC built-in functions (@pxref{Other Builtins}).
18820 Single-precision floating point:
18821 @table @asis
18823 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18824 Binary arithmetic operations.
18826 @item @samp{fnegs}
18827 Unary negation.
18829 @item @samp{fabss}
18830 Unary absolute value.
18832 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18833 Comparison operations.
18835 @item @samp{fmins}, @samp{fmaxs}
18836 Floating-point minimum and maximum.  These instructions are only
18837 generated if @option{-ffinite-math-only} is specified.
18839 @item @samp{fsqrts}
18840 Unary square root operation.
18842 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18843 Floating-point trigonometric and exponential functions.  These instructions
18844 are only generated if @option{-funsafe-math-optimizations} is also specified.
18846 @end table
18848 Double-precision floating point:
18849 @table @asis
18851 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18852 Binary arithmetic operations.
18854 @item @samp{fnegd}
18855 Unary negation.
18857 @item @samp{fabsd}
18858 Unary absolute value.
18860 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18861 Comparison operations.
18863 @item @samp{fmind}, @samp{fmaxd}
18864 Double-precision minimum and maximum.  These instructions are only
18865 generated if @option{-ffinite-math-only} is specified.
18867 @item @samp{fsqrtd}
18868 Unary square root operation.
18870 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18871 Double-precision trigonometric and exponential functions.  These instructions
18872 are only generated if @option{-funsafe-math-optimizations} is also specified.
18874 @end table
18876 Conversions:
18877 @table @asis
18878 @item @samp{fextsd}
18879 Conversion from single precision to double precision.
18881 @item @samp{ftruncds}
18882 Conversion from double precision to single precision.
18884 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18885 Conversion from floating point to signed or unsigned integer types, with
18886 truncation towards zero.
18888 @item @samp{round}
18889 Conversion from single-precision floating point to signed integer,
18890 rounding to the nearest integer and ties away from zero.
18891 This corresponds to the @code{__builtin_lroundf} function when
18892 @option{-fno-math-errno} is used.
18894 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18895 Conversion from signed or unsigned integer types to floating-point types.
18897 @end table
18899 In addition, all of the following transfer instructions for internal
18900 registers X and Y must be provided to use any of the double-precision
18901 floating-point instructions.  Custom instructions taking two
18902 double-precision source operands expect the first operand in the
18903 64-bit register X.  The other operand (or only operand of a unary
18904 operation) is given to the custom arithmetic instruction with the
18905 least significant half in source register @var{src1} and the most
18906 significant half in @var{src2}.  A custom instruction that returns a
18907 double-precision result returns the most significant 32 bits in the
18908 destination register and the other half in 32-bit register Y.  
18909 GCC automatically generates the necessary code sequences to write
18910 register X and/or read register Y when double-precision floating-point
18911 instructions are used.
18913 @table @asis
18915 @item @samp{fwrx}
18916 Write @var{src1} into the least significant half of X and @var{src2} into
18917 the most significant half of X.
18919 @item @samp{fwry}
18920 Write @var{src1} into Y.
18922 @item @samp{frdxhi}, @samp{frdxlo}
18923 Read the most or least (respectively) significant half of X and store it in
18924 @var{dest}.
18926 @item @samp{frdy}
18927 Read the value of Y and store it into @var{dest}.
18928 @end table
18930 Note that you can gain more local control over generation of Nios II custom
18931 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18932 and @code{target("no-custom-@var{insn}")} function attributes
18933 (@pxref{Function Attributes})
18934 or pragmas (@pxref{Function Specific Option Pragmas}).
18936 @item -mcustom-fpu-cfg=@var{name}
18937 @opindex mcustom-fpu-cfg
18939 This option enables a predefined, named set of custom instruction encodings
18940 (see @option{-mcustom-@var{insn}} above).  
18941 Currently, the following sets are defined:
18943 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18944 @gccoptlist{-mcustom-fmuls=252 @gol
18945 -mcustom-fadds=253 @gol
18946 -mcustom-fsubs=254 @gol
18947 -fsingle-precision-constant}
18949 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18950 @gccoptlist{-mcustom-fmuls=252 @gol
18951 -mcustom-fadds=253 @gol
18952 -mcustom-fsubs=254 @gol
18953 -mcustom-fdivs=255 @gol
18954 -fsingle-precision-constant}
18956 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18957 @gccoptlist{-mcustom-floatus=243 @gol
18958 -mcustom-fixsi=244 @gol
18959 -mcustom-floatis=245 @gol
18960 -mcustom-fcmpgts=246 @gol
18961 -mcustom-fcmples=249 @gol
18962 -mcustom-fcmpeqs=250 @gol
18963 -mcustom-fcmpnes=251 @gol
18964 -mcustom-fmuls=252 @gol
18965 -mcustom-fadds=253 @gol
18966 -mcustom-fsubs=254 @gol
18967 -mcustom-fdivs=255 @gol
18968 -fsingle-precision-constant}
18970 Custom instruction assignments given by individual
18971 @option{-mcustom-@var{insn}=} options override those given by
18972 @option{-mcustom-fpu-cfg=}, regardless of the
18973 order of the options on the command line.
18975 Note that you can gain more local control over selection of a FPU
18976 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18977 function attribute (@pxref{Function Attributes})
18978 or pragma (@pxref{Function Specific Option Pragmas}).
18980 @end table
18982 These additional @samp{-m} options are available for the Altera Nios II
18983 ELF (bare-metal) target:
18985 @table @gcctabopt
18987 @item -mhal
18988 @opindex mhal
18989 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18990 startup and termination code, and is typically used in conjunction with
18991 @option{-msys-crt0=} to specify the location of the alternate startup code
18992 provided by the HAL BSP.
18994 @item -msmallc
18995 @opindex msmallc
18996 Link with a limited version of the C library, @option{-lsmallc}, rather than
18997 Newlib.
18999 @item -msys-crt0=@var{startfile}
19000 @opindex msys-crt0
19001 @var{startfile} is the file name of the startfile (crt0) to use 
19002 when linking.  This option is only useful in conjunction with @option{-mhal}.
19004 @item -msys-lib=@var{systemlib}
19005 @opindex msys-lib
19006 @var{systemlib} is the library name of the library that provides
19007 low-level system calls required by the C library,
19008 e.g. @code{read} and @code{write}.
19009 This option is typically used to link with a library provided by a HAL BSP.
19011 @end table
19013 @node Nvidia PTX Options
19014 @subsection Nvidia PTX Options
19015 @cindex Nvidia PTX options
19016 @cindex nvptx options
19018 These options are defined for Nvidia PTX:
19020 @table @gcctabopt
19022 @item -m32
19023 @itemx -m64
19024 @opindex m32
19025 @opindex m64
19026 Generate code for 32-bit or 64-bit ABI.
19028 @item -mmainkernel
19029 @opindex mmainkernel
19030 Link in code for a __main kernel.  This is for stand-alone instead of
19031 offloading execution.
19033 @item -moptimize
19034 @opindex moptimize
19035 Apply partitioned execution optimizations.  This is the default when any
19036 level of optimization is selected.
19038 @end table
19040 @node PDP-11 Options
19041 @subsection PDP-11 Options
19042 @cindex PDP-11 Options
19044 These options are defined for the PDP-11:
19046 @table @gcctabopt
19047 @item -mfpu
19048 @opindex mfpu
19049 Use hardware FPP floating point.  This is the default.  (FIS floating
19050 point on the PDP-11/40 is not supported.)
19052 @item -msoft-float
19053 @opindex msoft-float
19054 Do not use hardware floating point.
19056 @item -mac0
19057 @opindex mac0
19058 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19060 @item -mno-ac0
19061 @opindex mno-ac0
19062 Return floating-point results in memory.  This is the default.
19064 @item -m40
19065 @opindex m40
19066 Generate code for a PDP-11/40.
19068 @item -m45
19069 @opindex m45
19070 Generate code for a PDP-11/45.  This is the default.
19072 @item -m10
19073 @opindex m10
19074 Generate code for a PDP-11/10.
19076 @item -mbcopy-builtin
19077 @opindex mbcopy-builtin
19078 Use inline @code{movmemhi} patterns for copying memory.  This is the
19079 default.
19081 @item -mbcopy
19082 @opindex mbcopy
19083 Do not use inline @code{movmemhi} patterns for copying memory.
19085 @item -mint16
19086 @itemx -mno-int32
19087 @opindex mint16
19088 @opindex mno-int32
19089 Use 16-bit @code{int}.  This is the default.
19091 @item -mint32
19092 @itemx -mno-int16
19093 @opindex mint32
19094 @opindex mno-int16
19095 Use 32-bit @code{int}.
19097 @item -mfloat64
19098 @itemx -mno-float32
19099 @opindex mfloat64
19100 @opindex mno-float32
19101 Use 64-bit @code{float}.  This is the default.
19103 @item -mfloat32
19104 @itemx -mno-float64
19105 @opindex mfloat32
19106 @opindex mno-float64
19107 Use 32-bit @code{float}.
19109 @item -mabshi
19110 @opindex mabshi
19111 Use @code{abshi2} pattern.  This is the default.
19113 @item -mno-abshi
19114 @opindex mno-abshi
19115 Do not use @code{abshi2} pattern.
19117 @item -mbranch-expensive
19118 @opindex mbranch-expensive
19119 Pretend that branches are expensive.  This is for experimenting with
19120 code generation only.
19122 @item -mbranch-cheap
19123 @opindex mbranch-cheap
19124 Do not pretend that branches are expensive.  This is the default.
19126 @item -munix-asm
19127 @opindex munix-asm
19128 Use Unix assembler syntax.  This is the default when configured for
19129 @samp{pdp11-*-bsd}.
19131 @item -mdec-asm
19132 @opindex mdec-asm
19133 Use DEC assembler syntax.  This is the default when configured for any
19134 PDP-11 target other than @samp{pdp11-*-bsd}.
19135 @end table
19137 @node picoChip Options
19138 @subsection picoChip Options
19139 @cindex picoChip options
19141 These @samp{-m} options are defined for picoChip implementations:
19143 @table @gcctabopt
19145 @item -mae=@var{ae_type}
19146 @opindex mcpu
19147 Set the instruction set, register set, and instruction scheduling
19148 parameters for array element type @var{ae_type}.  Supported values
19149 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19151 @option{-mae=ANY} selects a completely generic AE type.  Code
19152 generated with this option runs on any of the other AE types.  The
19153 code is not as efficient as it would be if compiled for a specific
19154 AE type, and some types of operation (e.g., multiplication) do not
19155 work properly on all types of AE.
19157 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19158 for compiled code, and is the default.
19160 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19161 option may suffer from poor performance of byte (char) manipulation,
19162 since the DSP AE does not provide hardware support for byte load/stores.
19164 @item -msymbol-as-address
19165 Enable the compiler to directly use a symbol name as an address in a
19166 load/store instruction, without first loading it into a
19167 register.  Typically, the use of this option generates larger
19168 programs, which run faster than when the option isn't used.  However, the
19169 results vary from program to program, so it is left as a user option,
19170 rather than being permanently enabled.
19172 @item -mno-inefficient-warnings
19173 Disables warnings about the generation of inefficient code.  These
19174 warnings can be generated, for example, when compiling code that
19175 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19176 no hardware support for byte-level memory operations, so all byte
19177 load/stores must be synthesized from word load/store operations.  This is
19178 inefficient and a warning is generated to indicate
19179 that you should rewrite the code to avoid byte operations, or to target
19180 an AE type that has the necessary hardware support.  This option disables
19181 these warnings.
19183 @end table
19185 @node PowerPC Options
19186 @subsection PowerPC Options
19187 @cindex PowerPC options
19189 These are listed under @xref{RS/6000 and PowerPC Options}.
19191 @node RL78 Options
19192 @subsection RL78 Options
19193 @cindex RL78 Options
19195 @table @gcctabopt
19197 @item -msim
19198 @opindex msim
19199 Links in additional target libraries to support operation within a
19200 simulator.
19202 @item -mmul=none
19203 @itemx -mmul=g10
19204 @itemx -mmul=g13
19205 @itemx -mmul=g14
19206 @itemx -mmul=rl78
19207 @opindex mmul
19208 Specifies the type of hardware multiplication and division support to
19209 be used.  The simplest is @code{none}, which uses software for both
19210 multiplication and division.  This is the default.  The @code{g13}
19211 value is for the hardware multiply/divide peripheral found on the
19212 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
19213 the multiplication and division instructions supported by the RL78/G14
19214 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
19215 the value @code{mg10} is an alias for @code{none}.
19217 In addition a C preprocessor macro is defined, based upon the setting
19218 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
19219 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
19221 @item -mcpu=g10
19222 @itemx -mcpu=g13
19223 @itemx -mcpu=g14
19224 @itemx -mcpu=rl78
19225 @opindex mcpu
19226 Specifies the RL78 core to target.  The default is the G14 core, also
19227 known as an S3 core or just RL78.  The G13 or S2 core does not have
19228 multiply or divide instructions, instead it uses a hardware peripheral
19229 for these operations.  The G10 or S1 core does not have register
19230 banks, so it uses a different calling convention.
19232 If this option is set it also selects the type of hardware multiply
19233 support to use, unless this is overridden by an explicit
19234 @option{-mmul=none} option on the command line.  Thus specifying
19235 @option{-mcpu=g13} enables the use of the G13 hardware multiply
19236 peripheral and specifying @option{-mcpu=g10} disables the use of
19237 hardware multipications altogether.
19239 Note, although the RL78/G14 core is the default target, specifying
19240 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
19241 change the behaviour of the toolchain since it also enables G14
19242 hardware multiply support.  If these options are not specified on the
19243 command line then software multiplication routines will be used even
19244 though the code targets the RL78 core.  This is for backwards
19245 compatibility with older toolchains which did not have hardware
19246 multiply and divide support.
19248 In addition a C preprocessor macro is defined, based upon the setting
19249 of this option.  Possible values are: @code{__RL78_G10__},
19250 @code{__RL78_G13__} or @code{__RL78_G14__}.
19252 @item -mg10
19253 @itemx -mg13
19254 @itemx -mg14
19255 @itemx -mrl78
19256 @opindex mg10
19257 @opindex mg13
19258 @opindex mg14
19259 @opindex mrl78
19260 These are aliases for the corresponding @option{-mcpu=} option.  They
19261 are provided for backwards compatibility.
19263 @item -mallregs
19264 @opindex mallregs
19265 Allow the compiler to use all of the available registers.  By default
19266 registers @code{r24..r31} are reserved for use in interrupt handlers.
19267 With this option enabled these registers can be used in ordinary
19268 functions as well.
19270 @item -m64bit-doubles
19271 @itemx -m32bit-doubles
19272 @opindex m64bit-doubles
19273 @opindex m32bit-doubles
19274 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19275 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19276 @option{-m32bit-doubles}.
19278 @end table
19280 @node RS/6000 and PowerPC Options
19281 @subsection IBM RS/6000 and PowerPC Options
19282 @cindex RS/6000 and PowerPC Options
19283 @cindex IBM RS/6000 and PowerPC Options
19285 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19286 @table @gcctabopt
19287 @item -mpowerpc-gpopt
19288 @itemx -mno-powerpc-gpopt
19289 @itemx -mpowerpc-gfxopt
19290 @itemx -mno-powerpc-gfxopt
19291 @need 800
19292 @itemx -mpowerpc64
19293 @itemx -mno-powerpc64
19294 @itemx -mmfcrf
19295 @itemx -mno-mfcrf
19296 @itemx -mpopcntb
19297 @itemx -mno-popcntb
19298 @itemx -mpopcntd
19299 @itemx -mno-popcntd
19300 @itemx -mfprnd
19301 @itemx -mno-fprnd
19302 @need 800
19303 @itemx -mcmpb
19304 @itemx -mno-cmpb
19305 @itemx -mmfpgpr
19306 @itemx -mno-mfpgpr
19307 @itemx -mhard-dfp
19308 @itemx -mno-hard-dfp
19309 @opindex mpowerpc-gpopt
19310 @opindex mno-powerpc-gpopt
19311 @opindex mpowerpc-gfxopt
19312 @opindex mno-powerpc-gfxopt
19313 @opindex mpowerpc64
19314 @opindex mno-powerpc64
19315 @opindex mmfcrf
19316 @opindex mno-mfcrf
19317 @opindex mpopcntb
19318 @opindex mno-popcntb
19319 @opindex mpopcntd
19320 @opindex mno-popcntd
19321 @opindex mfprnd
19322 @opindex mno-fprnd
19323 @opindex mcmpb
19324 @opindex mno-cmpb
19325 @opindex mmfpgpr
19326 @opindex mno-mfpgpr
19327 @opindex mhard-dfp
19328 @opindex mno-hard-dfp
19329 You use these options to specify which instructions are available on the
19330 processor you are using.  The default value of these options is
19331 determined when configuring GCC@.  Specifying the
19332 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19333 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19334 rather than the options listed above.
19336 Specifying @option{-mpowerpc-gpopt} allows
19337 GCC to use the optional PowerPC architecture instructions in the
19338 General Purpose group, including floating-point square root.  Specifying
19339 @option{-mpowerpc-gfxopt} allows GCC to
19340 use the optional PowerPC architecture instructions in the Graphics
19341 group, including floating-point select.
19343 The @option{-mmfcrf} option allows GCC to generate the move from
19344 condition register field instruction implemented on the POWER4
19345 processor and other processors that support the PowerPC V2.01
19346 architecture.
19347 The @option{-mpopcntb} option allows GCC to generate the popcount and
19348 double-precision FP reciprocal estimate instruction implemented on the
19349 POWER5 processor and other processors that support the PowerPC V2.02
19350 architecture.
19351 The @option{-mpopcntd} option allows GCC to generate the popcount
19352 instruction implemented on the POWER7 processor and other processors
19353 that support the PowerPC V2.06 architecture.
19354 The @option{-mfprnd} option allows GCC to generate the FP round to
19355 integer instructions implemented on the POWER5+ processor and other
19356 processors that support the PowerPC V2.03 architecture.
19357 The @option{-mcmpb} option allows GCC to generate the compare bytes
19358 instruction implemented on the POWER6 processor and other processors
19359 that support the PowerPC V2.05 architecture.
19360 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19361 general-purpose register instructions implemented on the POWER6X
19362 processor and other processors that support the extended PowerPC V2.05
19363 architecture.
19364 The @option{-mhard-dfp} option allows GCC to generate the decimal
19365 floating-point instructions implemented on some POWER processors.
19367 The @option{-mpowerpc64} option allows GCC to generate the additional
19368 64-bit instructions that are found in the full PowerPC64 architecture
19369 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19370 @option{-mno-powerpc64}.
19372 @item -mcpu=@var{cpu_type}
19373 @opindex mcpu
19374 Set architecture type, register usage, and
19375 instruction scheduling parameters for machine type @var{cpu_type}.
19376 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19377 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19378 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19379 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19380 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19381 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19382 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19383 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19384 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19385 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8},
19386 @samp{power9}, @samp{powerpc}, @samp{powerpc64}, @samp{powerpc64le},
19387 and @samp{rs64}.
19389 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19390 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19391 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19392 architecture machine types, with an appropriate, generic processor
19393 model assumed for scheduling purposes.
19395 The other options specify a specific processor.  Code generated under
19396 those options runs best on that processor, and may not run at all on
19397 others.
19399 The @option{-mcpu} options automatically enable or disable the
19400 following options:
19402 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19403 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19404 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19405 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19406 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19407 -mquad-memory -mquad-memory-atomic -mmodulo -mfloat128 -mfloat128-hardware @gol
19408 -mpower9-fusion -mpower9-vector}
19410 The particular options set for any particular CPU varies between
19411 compiler versions, depending on what setting seems to produce optimal
19412 code for that CPU; it doesn't necessarily reflect the actual hardware's
19413 capabilities.  If you wish to set an individual option to a particular
19414 value, you may specify it after the @option{-mcpu} option, like
19415 @option{-mcpu=970 -mno-altivec}.
19417 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19418 not enabled or disabled by the @option{-mcpu} option at present because
19419 AIX does not have full support for these options.  You may still
19420 enable or disable them individually if you're sure it'll work in your
19421 environment.
19423 @item -mtune=@var{cpu_type}
19424 @opindex mtune
19425 Set the instruction scheduling parameters for machine type
19426 @var{cpu_type}, but do not set the architecture type or register usage,
19427 as @option{-mcpu=@var{cpu_type}} does.  The same
19428 values for @var{cpu_type} are used for @option{-mtune} as for
19429 @option{-mcpu}.  If both are specified, the code generated uses the
19430 architecture and registers set by @option{-mcpu}, but the
19431 scheduling parameters set by @option{-mtune}.
19433 @item -mcmodel=small
19434 @opindex mcmodel=small
19435 Generate PowerPC64 code for the small model: The TOC is limited to
19436 64k.
19438 @item -mcmodel=medium
19439 @opindex mcmodel=medium
19440 Generate PowerPC64 code for the medium model: The TOC and other static
19441 data may be up to a total of 4G in size.
19443 @item -mcmodel=large
19444 @opindex mcmodel=large
19445 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19446 in size.  Other data and code is only limited by the 64-bit address
19447 space.
19449 @item -maltivec
19450 @itemx -mno-altivec
19451 @opindex maltivec
19452 @opindex mno-altivec
19453 Generate code that uses (does not use) AltiVec instructions, and also
19454 enable the use of built-in functions that allow more direct access to
19455 the AltiVec instruction set.  You may also need to set
19456 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19457 enhancements.
19459 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19460 @option{-maltivec=be}, the element order for Altivec intrinsics such
19461 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19462 match array element order corresponding to the endianness of the
19463 target.  That is, element zero identifies the leftmost element in a
19464 vector register when targeting a big-endian platform, and identifies
19465 the rightmost element in a vector register when targeting a
19466 little-endian platform.
19468 @item -maltivec=be
19469 @opindex maltivec=be
19470 Generate Altivec instructions using big-endian element order,
19471 regardless of whether the target is big- or little-endian.  This is
19472 the default when targeting a big-endian platform.
19474 The element order is used to interpret element numbers in Altivec
19475 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19476 @code{vec_insert}.  By default, these match array element order
19477 corresponding to the endianness for the target.
19479 @item -maltivec=le
19480 @opindex maltivec=le
19481 Generate Altivec instructions using little-endian element order,
19482 regardless of whether the target is big- or little-endian.  This is
19483 the default when targeting a little-endian platform.  This option is
19484 currently ignored when targeting a big-endian platform.
19486 The element order is used to interpret element numbers in Altivec
19487 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19488 @code{vec_insert}.  By default, these match array element order
19489 corresponding to the endianness for the target.
19491 @item -mvrsave
19492 @itemx -mno-vrsave
19493 @opindex mvrsave
19494 @opindex mno-vrsave
19495 Generate VRSAVE instructions when generating AltiVec code.
19497 @item -mgen-cell-microcode
19498 @opindex mgen-cell-microcode
19499 Generate Cell microcode instructions.
19501 @item -mwarn-cell-microcode
19502 @opindex mwarn-cell-microcode
19503 Warn when a Cell microcode instruction is emitted.  An example
19504 of a Cell microcode instruction is a variable shift.
19506 @item -msecure-plt
19507 @opindex msecure-plt
19508 Generate code that allows @command{ld} and @command{ld.so}
19509 to build executables and shared
19510 libraries with non-executable @code{.plt} and @code{.got} sections.
19511 This is a PowerPC
19512 32-bit SYSV ABI option.
19514 @item -mbss-plt
19515 @opindex mbss-plt
19516 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19517 fills in, and
19518 requires @code{.plt} and @code{.got}
19519 sections that are both writable and executable.
19520 This is a PowerPC 32-bit SYSV ABI option.
19522 @item -misel
19523 @itemx -mno-isel
19524 @opindex misel
19525 @opindex mno-isel
19526 This switch enables or disables the generation of ISEL instructions.
19528 @item -misel=@var{yes/no}
19529 This switch has been deprecated.  Use @option{-misel} and
19530 @option{-mno-isel} instead.
19532 @item -mspe
19533 @itemx -mno-spe
19534 @opindex mspe
19535 @opindex mno-spe
19536 This switch enables or disables the generation of SPE simd
19537 instructions.
19539 @item -mpaired
19540 @itemx -mno-paired
19541 @opindex mpaired
19542 @opindex mno-paired
19543 This switch enables or disables the generation of PAIRED simd
19544 instructions.
19546 @item -mspe=@var{yes/no}
19547 This option has been deprecated.  Use @option{-mspe} and
19548 @option{-mno-spe} instead.
19550 @item -mvsx
19551 @itemx -mno-vsx
19552 @opindex mvsx
19553 @opindex mno-vsx
19554 Generate code that uses (does not use) vector/scalar (VSX)
19555 instructions, and also enable the use of built-in functions that allow
19556 more direct access to the VSX instruction set.
19558 @item -mcrypto
19559 @itemx -mno-crypto
19560 @opindex mcrypto
19561 @opindex mno-crypto
19562 Enable the use (disable) of the built-in functions that allow direct
19563 access to the cryptographic instructions that were added in version
19564 2.07 of the PowerPC ISA.
19566 @item -mdirect-move
19567 @itemx -mno-direct-move
19568 @opindex mdirect-move
19569 @opindex mno-direct-move
19570 Generate code that uses (does not use) the instructions to move data
19571 between the general purpose registers and the vector/scalar (VSX)
19572 registers that were added in version 2.07 of the PowerPC ISA.
19574 @item -mpower8-fusion
19575 @itemx -mno-power8-fusion
19576 @opindex mpower8-fusion
19577 @opindex mno-power8-fusion
19578 Generate code that keeps (does not keeps) some integer operations
19579 adjacent so that the instructions can be fused together on power8 and
19580 later processors.
19582 @item -mpower8-vector
19583 @itemx -mno-power8-vector
19584 @opindex mpower8-vector
19585 @opindex mno-power8-vector
19586 Generate code that uses (does not use) the vector and scalar
19587 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19588 enable the use of built-in functions that allow more direct access to
19589 the vector instructions.
19591 @item -mquad-memory
19592 @itemx -mno-quad-memory
19593 @opindex mquad-memory
19594 @opindex mno-quad-memory
19595 Generate code that uses (does not use) the non-atomic quad word memory
19596 instructions.  The @option{-mquad-memory} option requires use of
19597 64-bit mode.
19599 @item -mquad-memory-atomic
19600 @itemx -mno-quad-memory-atomic
19601 @opindex mquad-memory-atomic
19602 @opindex mno-quad-memory-atomic
19603 Generate code that uses (does not use) the atomic quad word memory
19604 instructions.  The @option{-mquad-memory-atomic} option requires use of
19605 64-bit mode.
19607 @item -mupper-regs-df
19608 @itemx -mno-upper-regs-df
19609 @opindex mupper-regs-df
19610 @opindex mno-upper-regs-df
19611 Generate code that uses (does not use) the scalar double precision
19612 instructions that target all 64 registers in the vector/scalar
19613 floating point register set that were added in version 2.06 of the
19614 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19615 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19616 @option{-mvsx} options.
19618 @item -mupper-regs-sf
19619 @itemx -mno-upper-regs-sf
19620 @opindex mupper-regs-sf
19621 @opindex mno-upper-regs-sf
19622 Generate code that uses (does not use) the scalar single precision
19623 instructions that target all 64 registers in the vector/scalar
19624 floating point register set that were added in version 2.07 of the
19625 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19626 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19627 options.
19629 @item -mupper-regs
19630 @itemx -mno-upper-regs
19631 @opindex mupper-regs
19632 @opindex mno-upper-regs
19633 Generate code that uses (does not use) the scalar
19634 instructions that target all 64 registers in the vector/scalar
19635 floating point register set, depending on the model of the machine.
19637 If the @option{-mno-upper-regs} option is used, it turns off both
19638 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19640 @item -mfloat128
19641 @itemx -mno-float128
19642 @opindex mfloat128
19643 @opindex mno-float128
19644 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
19645 and use either software emulation for IEEE 128-bit floating point or
19646 hardware instructions.
19648 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
19649 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
19650 option.
19652 @item -mfloat128-hardware
19653 @itemx -mno-float128-hardware
19654 @opindex mfloat128-hardware
19655 @opindex mno-float128-hardware
19656 Enable/disable using ISA 3.0 hardware instructions to support the
19657 @var{__float128} data type.
19659 @item -mmodulo
19660 @itemx -mno-modulo
19661 @opindex mmodulo
19662 @opindex mno-module
19663 Generate code that uses (does not use) the ISA 3.0 integer modulo
19664 instructions.  The @option{-mmodulo} option is enabled by default
19665 with the @option{-mcpu=power9} option.
19667 @item -mpower9-fusion
19668 @itemx -mno-power9-fusion
19669 @opindex mpower9-fusion
19670 @opindex mno-power9-fusion
19671 Generate code that keeps (does not keeps) some operations adjacent so
19672 that the instructions can be fused together on power9 and later
19673 processors.
19675 @item -mpower9-vector
19676 @itemx -mno-power9-vector
19677 @opindex mpower9-vector
19678 @opindex mno-power9-vector
19679 Generate code that uses (does not use) the vector and scalar
19680 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19681 enable the use of built-in functions that allow more direct access to
19682 the vector instructions.
19684 @item -mfloat-gprs=@var{yes/single/double/no}
19685 @itemx -mfloat-gprs
19686 @opindex mfloat-gprs
19687 This switch enables or disables the generation of floating-point
19688 operations on the general-purpose registers for architectures that
19689 support it.
19691 The argument @samp{yes} or @samp{single} enables the use of
19692 single-precision floating-point operations.
19694 The argument @samp{double} enables the use of single and
19695 double-precision floating-point operations.
19697 The argument @samp{no} disables floating-point operations on the
19698 general-purpose registers.
19700 This option is currently only available on the MPC854x.
19702 @item -m32
19703 @itemx -m64
19704 @opindex m32
19705 @opindex m64
19706 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19707 targets (including GNU/Linux).  The 32-bit environment sets int, long
19708 and pointer to 32 bits and generates code that runs on any PowerPC
19709 variant.  The 64-bit environment sets int to 32 bits and long and
19710 pointer to 64 bits, and generates code for PowerPC64, as for
19711 @option{-mpowerpc64}.
19713 @item -mfull-toc
19714 @itemx -mno-fp-in-toc
19715 @itemx -mno-sum-in-toc
19716 @itemx -mminimal-toc
19717 @opindex mfull-toc
19718 @opindex mno-fp-in-toc
19719 @opindex mno-sum-in-toc
19720 @opindex mminimal-toc
19721 Modify generation of the TOC (Table Of Contents), which is created for
19722 every executable file.  The @option{-mfull-toc} option is selected by
19723 default.  In that case, GCC allocates at least one TOC entry for
19724 each unique non-automatic variable reference in your program.  GCC
19725 also places floating-point constants in the TOC@.  However, only
19726 16,384 entries are available in the TOC@.
19728 If you receive a linker error message that saying you have overflowed
19729 the available TOC space, you can reduce the amount of TOC space used
19730 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19731 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19732 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19733 generate code to calculate the sum of an address and a constant at
19734 run time instead of putting that sum into the TOC@.  You may specify one
19735 or both of these options.  Each causes GCC to produce very slightly
19736 slower and larger code at the expense of conserving TOC space.
19738 If you still run out of space in the TOC even when you specify both of
19739 these options, specify @option{-mminimal-toc} instead.  This option causes
19740 GCC to make only one TOC entry for every file.  When you specify this
19741 option, GCC produces code that is slower and larger but which
19742 uses extremely little TOC space.  You may wish to use this option
19743 only on files that contain less frequently-executed code.
19745 @item -maix64
19746 @itemx -maix32
19747 @opindex maix64
19748 @opindex maix32
19749 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19750 @code{long} type, and the infrastructure needed to support them.
19751 Specifying @option{-maix64} implies @option{-mpowerpc64},
19752 while @option{-maix32} disables the 64-bit ABI and
19753 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19755 @item -mxl-compat
19756 @itemx -mno-xl-compat
19757 @opindex mxl-compat
19758 @opindex mno-xl-compat
19759 Produce code that conforms more closely to IBM XL compiler semantics
19760 when using AIX-compatible ABI@.  Pass floating-point arguments to
19761 prototyped functions beyond the register save area (RSA) on the stack
19762 in addition to argument FPRs.  Do not assume that most significant
19763 double in 128-bit long double value is properly rounded when comparing
19764 values and converting to double.  Use XL symbol names for long double
19765 support routines.
19767 The AIX calling convention was extended but not initially documented to
19768 handle an obscure K&R C case of calling a function that takes the
19769 address of its arguments with fewer arguments than declared.  IBM XL
19770 compilers access floating-point arguments that do not fit in the
19771 RSA from the stack when a subroutine is compiled without
19772 optimization.  Because always storing floating-point arguments on the
19773 stack is inefficient and rarely needed, this option is not enabled by
19774 default and only is necessary when calling subroutines compiled by IBM
19775 XL compilers without optimization.
19777 @item -mpe
19778 @opindex mpe
19779 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19780 application written to use message passing with special startup code to
19781 enable the application to run.  The system must have PE installed in the
19782 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19783 must be overridden with the @option{-specs=} option to specify the
19784 appropriate directory location.  The Parallel Environment does not
19785 support threads, so the @option{-mpe} option and the @option{-pthread}
19786 option are incompatible.
19788 @item -malign-natural
19789 @itemx -malign-power
19790 @opindex malign-natural
19791 @opindex malign-power
19792 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19793 @option{-malign-natural} overrides the ABI-defined alignment of larger
19794 types, such as floating-point doubles, on their natural size-based boundary.
19795 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19796 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19798 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19799 is not supported.
19801 @item -msoft-float
19802 @itemx -mhard-float
19803 @opindex msoft-float
19804 @opindex mhard-float
19805 Generate code that does not use (uses) the floating-point register set.
19806 Software floating-point emulation is provided if you use the
19807 @option{-msoft-float} option, and pass the option to GCC when linking.
19809 @item -msingle-float
19810 @itemx -mdouble-float
19811 @opindex msingle-float
19812 @opindex mdouble-float
19813 Generate code for single- or double-precision floating-point operations.
19814 @option{-mdouble-float} implies @option{-msingle-float}.
19816 @item -msimple-fpu
19817 @opindex msimple-fpu
19818 Do not generate @code{sqrt} and @code{div} instructions for hardware
19819 floating-point unit.
19821 @item -mfpu=@var{name}
19822 @opindex mfpu
19823 Specify type of floating-point unit.  Valid values for @var{name} are
19824 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19825 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19826 @samp{sp_full} (equivalent to @option{-msingle-float}),
19827 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19829 @item -mxilinx-fpu
19830 @opindex mxilinx-fpu
19831 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19833 @item -mmultiple
19834 @itemx -mno-multiple
19835 @opindex mmultiple
19836 @opindex mno-multiple
19837 Generate code that uses (does not use) the load multiple word
19838 instructions and the store multiple word instructions.  These
19839 instructions are generated by default on POWER systems, and not
19840 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19841 PowerPC systems, since those instructions do not work when the
19842 processor is in little-endian mode.  The exceptions are PPC740 and
19843 PPC750 which permit these instructions in little-endian mode.
19845 @item -mstring
19846 @itemx -mno-string
19847 @opindex mstring
19848 @opindex mno-string
19849 Generate code that uses (does not use) the load string instructions
19850 and the store string word instructions to save multiple registers and
19851 do small block moves.  These instructions are generated by default on
19852 POWER systems, and not generated on PowerPC systems.  Do not use
19853 @option{-mstring} on little-endian PowerPC systems, since those
19854 instructions do not work when the processor is in little-endian mode.
19855 The exceptions are PPC740 and PPC750 which permit these instructions
19856 in little-endian mode.
19858 @item -mupdate
19859 @itemx -mno-update
19860 @opindex mupdate
19861 @opindex mno-update
19862 Generate code that uses (does not use) the load or store instructions
19863 that update the base register to the address of the calculated memory
19864 location.  These instructions are generated by default.  If you use
19865 @option{-mno-update}, there is a small window between the time that the
19866 stack pointer is updated and the address of the previous frame is
19867 stored, which means code that walks the stack frame across interrupts or
19868 signals may get corrupted data.
19870 @item -mavoid-indexed-addresses
19871 @itemx -mno-avoid-indexed-addresses
19872 @opindex mavoid-indexed-addresses
19873 @opindex mno-avoid-indexed-addresses
19874 Generate code that tries to avoid (not avoid) the use of indexed load
19875 or store instructions. These instructions can incur a performance
19876 penalty on Power6 processors in certain situations, such as when
19877 stepping through large arrays that cross a 16M boundary.  This option
19878 is enabled by default when targeting Power6 and disabled otherwise.
19880 @item -mfused-madd
19881 @itemx -mno-fused-madd
19882 @opindex mfused-madd
19883 @opindex mno-fused-madd
19884 Generate code that uses (does not use) the floating-point multiply and
19885 accumulate instructions.  These instructions are generated by default
19886 if hardware floating point is used.  The machine-dependent
19887 @option{-mfused-madd} option is now mapped to the machine-independent
19888 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19889 mapped to @option{-ffp-contract=off}.
19891 @item -mmulhw
19892 @itemx -mno-mulhw
19893 @opindex mmulhw
19894 @opindex mno-mulhw
19895 Generate code that uses (does not use) the half-word multiply and
19896 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19897 These instructions are generated by default when targeting those
19898 processors.
19900 @item -mdlmzb
19901 @itemx -mno-dlmzb
19902 @opindex mdlmzb
19903 @opindex mno-dlmzb
19904 Generate code that uses (does not use) the string-search @samp{dlmzb}
19905 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19906 generated by default when targeting those processors.
19908 @item -mno-bit-align
19909 @itemx -mbit-align
19910 @opindex mno-bit-align
19911 @opindex mbit-align
19912 On System V.4 and embedded PowerPC systems do not (do) force structures
19913 and unions that contain bit-fields to be aligned to the base type of the
19914 bit-field.
19916 For example, by default a structure containing nothing but 8
19917 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19918 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19919 the structure is aligned to a 1-byte boundary and is 1 byte in
19920 size.
19922 @item -mno-strict-align
19923 @itemx -mstrict-align
19924 @opindex mno-strict-align
19925 @opindex mstrict-align
19926 On System V.4 and embedded PowerPC systems do not (do) assume that
19927 unaligned memory references are handled by the system.
19929 @item -mrelocatable
19930 @itemx -mno-relocatable
19931 @opindex mrelocatable
19932 @opindex mno-relocatable
19933 Generate code that allows (does not allow) a static executable to be
19934 relocated to a different address at run time.  A simple embedded
19935 PowerPC system loader should relocate the entire contents of
19936 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19937 a table of 32-bit addresses generated by this option.  For this to
19938 work, all objects linked together must be compiled with
19939 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19940 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19942 @item -mrelocatable-lib
19943 @itemx -mno-relocatable-lib
19944 @opindex mrelocatable-lib
19945 @opindex mno-relocatable-lib
19946 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19947 @code{.fixup} section to allow static executables to be relocated at
19948 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19949 alignment of @option{-mrelocatable}.  Objects compiled with
19950 @option{-mrelocatable-lib} may be linked with objects compiled with
19951 any combination of the @option{-mrelocatable} options.
19953 @item -mno-toc
19954 @itemx -mtoc
19955 @opindex mno-toc
19956 @opindex mtoc
19957 On System V.4 and embedded PowerPC systems do not (do) assume that
19958 register 2 contains a pointer to a global area pointing to the addresses
19959 used in the program.
19961 @item -mlittle
19962 @itemx -mlittle-endian
19963 @opindex mlittle
19964 @opindex mlittle-endian
19965 On System V.4 and embedded PowerPC systems compile code for the
19966 processor in little-endian mode.  The @option{-mlittle-endian} option is
19967 the same as @option{-mlittle}.
19969 @item -mbig
19970 @itemx -mbig-endian
19971 @opindex mbig
19972 @opindex mbig-endian
19973 On System V.4 and embedded PowerPC systems compile code for the
19974 processor in big-endian mode.  The @option{-mbig-endian} option is
19975 the same as @option{-mbig}.
19977 @item -mdynamic-no-pic
19978 @opindex mdynamic-no-pic
19979 On Darwin and Mac OS X systems, compile code so that it is not
19980 relocatable, but that its external references are relocatable.  The
19981 resulting code is suitable for applications, but not shared
19982 libraries.
19984 @item -msingle-pic-base
19985 @opindex msingle-pic-base
19986 Treat the register used for PIC addressing as read-only, rather than
19987 loading it in the prologue for each function.  The runtime system is
19988 responsible for initializing this register with an appropriate value
19989 before execution begins.
19991 @item -mprioritize-restricted-insns=@var{priority}
19992 @opindex mprioritize-restricted-insns
19993 This option controls the priority that is assigned to
19994 dispatch-slot restricted instructions during the second scheduling
19995 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19996 or @samp{2} to assign no, highest, or second-highest (respectively) 
19997 priority to dispatch-slot restricted
19998 instructions.
20000 @item -msched-costly-dep=@var{dependence_type}
20001 @opindex msched-costly-dep
20002 This option controls which dependences are considered costly
20003 by the target during instruction scheduling.  The argument
20004 @var{dependence_type} takes one of the following values:
20006 @table @asis
20007 @item @samp{no}
20008 No dependence is costly.
20010 @item @samp{all}
20011 All dependences are costly.
20013 @item @samp{true_store_to_load}
20014 A true dependence from store to load is costly.
20016 @item @samp{store_to_load}
20017 Any dependence from store to load is costly.
20019 @item @var{number}
20020 Any dependence for which the latency is greater than or equal to 
20021 @var{number} is costly.
20022 @end table
20024 @item -minsert-sched-nops=@var{scheme}
20025 @opindex minsert-sched-nops
20026 This option controls which NOP insertion scheme is used during
20027 the second scheduling pass.  The argument @var{scheme} takes one of the
20028 following values:
20030 @table @asis
20031 @item @samp{no}
20032 Don't insert NOPs.
20034 @item @samp{pad}
20035 Pad with NOPs any dispatch group that has vacant issue slots,
20036 according to the scheduler's grouping.
20038 @item @samp{regroup_exact}
20039 Insert NOPs to force costly dependent insns into
20040 separate groups.  Insert exactly as many NOPs as needed to force an insn
20041 to a new group, according to the estimated processor grouping.
20043 @item @var{number}
20044 Insert NOPs to force costly dependent insns into
20045 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20046 @end table
20048 @item -mcall-sysv
20049 @opindex mcall-sysv
20050 On System V.4 and embedded PowerPC systems compile code using calling
20051 conventions that adhere to the March 1995 draft of the System V
20052 Application Binary Interface, PowerPC processor supplement.  This is the
20053 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20055 @item -mcall-sysv-eabi
20056 @itemx -mcall-eabi
20057 @opindex mcall-sysv-eabi
20058 @opindex mcall-eabi
20059 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20061 @item -mcall-sysv-noeabi
20062 @opindex mcall-sysv-noeabi
20063 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20065 @item -mcall-aixdesc
20066 @opindex m
20067 On System V.4 and embedded PowerPC systems compile code for the AIX
20068 operating system.
20070 @item -mcall-linux
20071 @opindex mcall-linux
20072 On System V.4 and embedded PowerPC systems compile code for the
20073 Linux-based GNU system.
20075 @item -mcall-freebsd
20076 @opindex mcall-freebsd
20077 On System V.4 and embedded PowerPC systems compile code for the
20078 FreeBSD operating system.
20080 @item -mcall-netbsd
20081 @opindex mcall-netbsd
20082 On System V.4 and embedded PowerPC systems compile code for the
20083 NetBSD operating system.
20085 @item -mcall-openbsd
20086 @opindex mcall-netbsd
20087 On System V.4 and embedded PowerPC systems compile code for the
20088 OpenBSD operating system.
20090 @item -maix-struct-return
20091 @opindex maix-struct-return
20092 Return all structures in memory (as specified by the AIX ABI)@.
20094 @item -msvr4-struct-return
20095 @opindex msvr4-struct-return
20096 Return structures smaller than 8 bytes in registers (as specified by the
20097 SVR4 ABI)@.
20099 @item -mabi=@var{abi-type}
20100 @opindex mabi
20101 Extend the current ABI with a particular extension, or remove such extension.
20102 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
20103 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
20104 @samp{elfv1}, @samp{elfv2}@.
20106 @item -mabi=spe
20107 @opindex mabi=spe
20108 Extend the current ABI with SPE ABI extensions.  This does not change
20109 the default ABI, instead it adds the SPE ABI extensions to the current
20110 ABI@.
20112 @item -mabi=no-spe
20113 @opindex mabi=no-spe
20114 Disable Book-E SPE ABI extensions for the current ABI@.
20116 @item -mabi=ibmlongdouble
20117 @opindex mabi=ibmlongdouble
20118 Change the current ABI to use IBM extended-precision long double.
20119 This is a PowerPC 32-bit SYSV ABI option.
20121 @item -mabi=ieeelongdouble
20122 @opindex mabi=ieeelongdouble
20123 Change the current ABI to use IEEE extended-precision long double.
20124 This is a PowerPC 32-bit Linux ABI option.
20126 @item -mabi=elfv1
20127 @opindex mabi=elfv1
20128 Change the current ABI to use the ELFv1 ABI.
20129 This is the default ABI for big-endian PowerPC 64-bit Linux.
20130 Overriding the default ABI requires special system support and is
20131 likely to fail in spectacular ways.
20133 @item -mabi=elfv2
20134 @opindex mabi=elfv2
20135 Change the current ABI to use the ELFv2 ABI.
20136 This is the default ABI for little-endian PowerPC 64-bit Linux.
20137 Overriding the default ABI requires special system support and is
20138 likely to fail in spectacular ways.
20140 @item -mprototype
20141 @itemx -mno-prototype
20142 @opindex mprototype
20143 @opindex mno-prototype
20144 On System V.4 and embedded PowerPC systems assume that all calls to
20145 variable argument functions are properly prototyped.  Otherwise, the
20146 compiler must insert an instruction before every non-prototyped call to
20147 set or clear bit 6 of the condition code register (@code{CR}) to
20148 indicate whether floating-point values are passed in the floating-point
20149 registers in case the function takes variable arguments.  With
20150 @option{-mprototype}, only calls to prototyped variable argument functions
20151 set or clear the bit.
20153 @item -msim
20154 @opindex msim
20155 On embedded PowerPC systems, assume that the startup module is called
20156 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20157 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20158 configurations.
20160 @item -mmvme
20161 @opindex mmvme
20162 On embedded PowerPC systems, assume that the startup module is called
20163 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20164 @file{libc.a}.
20166 @item -mads
20167 @opindex mads
20168 On embedded PowerPC systems, assume that the startup module is called
20169 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20170 @file{libc.a}.
20172 @item -myellowknife
20173 @opindex myellowknife
20174 On embedded PowerPC systems, assume that the startup module is called
20175 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20176 @file{libc.a}.
20178 @item -mvxworks
20179 @opindex mvxworks
20180 On System V.4 and embedded PowerPC systems, specify that you are
20181 compiling for a VxWorks system.
20183 @item -memb
20184 @opindex memb
20185 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
20186 header to indicate that @samp{eabi} extended relocations are used.
20188 @item -meabi
20189 @itemx -mno-eabi
20190 @opindex meabi
20191 @opindex mno-eabi
20192 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20193 Embedded Applications Binary Interface (EABI), which is a set of
20194 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20195 means that the stack is aligned to an 8-byte boundary, a function
20196 @code{__eabi} is called from @code{main} to set up the EABI
20197 environment, and the @option{-msdata} option can use both @code{r2} and
20198 @code{r13} to point to two separate small data areas.  Selecting
20199 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20200 no EABI initialization function is called from @code{main}, and the
20201 @option{-msdata} option only uses @code{r13} to point to a single
20202 small data area.  The @option{-meabi} option is on by default if you
20203 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20205 @item -msdata=eabi
20206 @opindex msdata=eabi
20207 On System V.4 and embedded PowerPC systems, put small initialized
20208 @code{const} global and static data in the @code{.sdata2} section, which
20209 is pointed to by register @code{r2}.  Put small initialized
20210 non-@code{const} global and static data in the @code{.sdata} section,
20211 which is pointed to by register @code{r13}.  Put small uninitialized
20212 global and static data in the @code{.sbss} section, which is adjacent to
20213 the @code{.sdata} section.  The @option{-msdata=eabi} option is
20214 incompatible with the @option{-mrelocatable} option.  The
20215 @option{-msdata=eabi} option also sets the @option{-memb} option.
20217 @item -msdata=sysv
20218 @opindex msdata=sysv
20219 On System V.4 and embedded PowerPC systems, put small global and static
20220 data in the @code{.sdata} section, which is pointed to by register
20221 @code{r13}.  Put small uninitialized global and static data in the
20222 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
20223 The @option{-msdata=sysv} option is incompatible with the
20224 @option{-mrelocatable} option.
20226 @item -msdata=default
20227 @itemx -msdata
20228 @opindex msdata=default
20229 @opindex msdata
20230 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20231 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20232 same as @option{-msdata=sysv}.
20234 @item -msdata=data
20235 @opindex msdata=data
20236 On System V.4 and embedded PowerPC systems, put small global
20237 data in the @code{.sdata} section.  Put small uninitialized global
20238 data in the @code{.sbss} section.  Do not use register @code{r13}
20239 to address small data however.  This is the default behavior unless
20240 other @option{-msdata} options are used.
20242 @item -msdata=none
20243 @itemx -mno-sdata
20244 @opindex msdata=none
20245 @opindex mno-sdata
20246 On embedded PowerPC systems, put all initialized global and static data
20247 in the @code{.data} section, and all uninitialized data in the
20248 @code{.bss} section.
20250 @item -mblock-move-inline-limit=@var{num}
20251 @opindex mblock-move-inline-limit
20252 Inline all block moves (such as calls to @code{memcpy} or structure
20253 copies) less than or equal to @var{num} bytes.  The minimum value for
20254 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20255 targets.  The default value is target-specific.
20257 @item -G @var{num}
20258 @opindex G
20259 @cindex smaller data references (PowerPC)
20260 @cindex .sdata/.sdata2 references (PowerPC)
20261 On embedded PowerPC systems, put global and static items less than or
20262 equal to @var{num} bytes into the small data or BSS sections instead of
20263 the normal data or BSS section.  By default, @var{num} is 8.  The
20264 @option{-G @var{num}} switch is also passed to the linker.
20265 All modules should be compiled with the same @option{-G @var{num}} value.
20267 @item -mregnames
20268 @itemx -mno-regnames
20269 @opindex mregnames
20270 @opindex mno-regnames
20271 On System V.4 and embedded PowerPC systems do (do not) emit register
20272 names in the assembly language output using symbolic forms.
20274 @item -mlongcall
20275 @itemx -mno-longcall
20276 @opindex mlongcall
20277 @opindex mno-longcall
20278 By default assume that all calls are far away so that a longer and more
20279 expensive calling sequence is required.  This is required for calls
20280 farther than 32 megabytes (33,554,432 bytes) from the current location.
20281 A short call is generated if the compiler knows
20282 the call cannot be that far away.  This setting can be overridden by
20283 the @code{shortcall} function attribute, or by @code{#pragma
20284 longcall(0)}.
20286 Some linkers are capable of detecting out-of-range calls and generating
20287 glue code on the fly.  On these systems, long calls are unnecessary and
20288 generate slower code.  As of this writing, the AIX linker can do this,
20289 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20290 to the GNU linker for 32-bit PowerPC systems as well.
20292 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20293 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20294 addresses represent the callee and the branch island.  The
20295 Darwin/PPC linker prefers the first address and generates a @code{bl
20296 callee} if the PPC @code{bl} instruction reaches the callee directly;
20297 otherwise, the linker generates @code{bl L42} to call the branch
20298 island.  The branch island is appended to the body of the
20299 calling function; it computes the full 32-bit address of the callee
20300 and jumps to it.
20302 On Mach-O (Darwin) systems, this option directs the compiler emit to
20303 the glue for every direct call, and the Darwin linker decides whether
20304 to use or discard it.
20306 In the future, GCC may ignore all longcall specifications
20307 when the linker is known to generate glue.
20309 @item -mtls-markers
20310 @itemx -mno-tls-markers
20311 @opindex mtls-markers
20312 @opindex mno-tls-markers
20313 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20314 specifying the function argument.  The relocation allows the linker to
20315 reliably associate function call with argument setup instructions for
20316 TLS optimization, which in turn allows GCC to better schedule the
20317 sequence.
20319 @item -pthread
20320 @opindex pthread
20321 Adds support for multithreading with the @dfn{pthreads} library.
20322 This option sets flags for both the preprocessor and linker.
20324 @item -mrecip
20325 @itemx -mno-recip
20326 @opindex mrecip
20327 This option enables use of the reciprocal estimate and
20328 reciprocal square root estimate instructions with additional
20329 Newton-Raphson steps to increase precision instead of doing a divide or
20330 square root and divide for floating-point arguments.  You should use
20331 the @option{-ffast-math} option when using @option{-mrecip} (or at
20332 least @option{-funsafe-math-optimizations},
20333 @option{-finite-math-only}, @option{-freciprocal-math} and
20334 @option{-fno-trapping-math}).  Note that while the throughput of the
20335 sequence is generally higher than the throughput of the non-reciprocal
20336 instruction, the precision of the sequence can be decreased by up to 2
20337 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20338 roots.
20340 @item -mrecip=@var{opt}
20341 @opindex mrecip=opt
20342 This option controls which reciprocal estimate instructions
20343 may be used.  @var{opt} is a comma-separated list of options, which may
20344 be preceded by a @code{!} to invert the option:
20346 @table @samp
20348 @item all
20349 Enable all estimate instructions.
20351 @item default 
20352 Enable the default instructions, equivalent to @option{-mrecip}.
20354 @item none 
20355 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20357 @item div 
20358 Enable the reciprocal approximation instructions for both 
20359 single and double precision.
20361 @item divf 
20362 Enable the single-precision reciprocal approximation instructions.
20364 @item divd 
20365 Enable the double-precision reciprocal approximation instructions.
20367 @item rsqrt 
20368 Enable the reciprocal square root approximation instructions for both
20369 single and double precision.
20371 @item rsqrtf 
20372 Enable the single-precision reciprocal square root approximation instructions.
20374 @item rsqrtd 
20375 Enable the double-precision reciprocal square root approximation instructions.
20377 @end table
20379 So, for example, @option{-mrecip=all,!rsqrtd} enables
20380 all of the reciprocal estimate instructions, except for the
20381 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20382 which handle the double-precision reciprocal square root calculations.
20384 @item -mrecip-precision
20385 @itemx -mno-recip-precision
20386 @opindex mrecip-precision
20387 Assume (do not assume) that the reciprocal estimate instructions
20388 provide higher-precision estimates than is mandated by the PowerPC
20389 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20390 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20391 The double-precision square root estimate instructions are not generated by
20392 default on low-precision machines, since they do not provide an
20393 estimate that converges after three steps.
20395 @item -mveclibabi=@var{type}
20396 @opindex mveclibabi
20397 Specifies the ABI type to use for vectorizing intrinsics using an
20398 external library.  The only type supported at present is @samp{mass},
20399 which specifies to use IBM's Mathematical Acceleration Subsystem
20400 (MASS) libraries for vectorizing intrinsics using external libraries.
20401 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20402 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20403 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20404 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20405 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20406 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20407 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20408 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20409 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20410 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20411 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20412 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20413 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20414 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20415 for power7.  Both @option{-ftree-vectorize} and
20416 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20417 libraries must be specified at link time.
20419 @item -mfriz
20420 @itemx -mno-friz
20421 @opindex mfriz
20422 Generate (do not generate) the @code{friz} instruction when the
20423 @option{-funsafe-math-optimizations} option is used to optimize
20424 rounding of floating-point values to 64-bit integer and back to floating
20425 point.  The @code{friz} instruction does not return the same value if
20426 the floating-point number is too large to fit in an integer.
20428 @item -mpointers-to-nested-functions
20429 @itemx -mno-pointers-to-nested-functions
20430 @opindex mpointers-to-nested-functions
20431 Generate (do not generate) code to load up the static chain register
20432 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20433 systems where a function pointer points to a 3-word descriptor giving
20434 the function address, TOC value to be loaded in register @code{r2}, and
20435 static chain value to be loaded in register @code{r11}.  The
20436 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20437 call through pointers to nested functions or pointers
20438 to functions compiled in other languages that use the static chain if
20439 you use @option{-mno-pointers-to-nested-functions}.
20441 @item -msave-toc-indirect
20442 @itemx -mno-save-toc-indirect
20443 @opindex msave-toc-indirect
20444 Generate (do not generate) code to save the TOC value in the reserved
20445 stack location in the function prologue if the function calls through
20446 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20447 saved in the prologue, it is saved just before the call through the
20448 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20450 @item -mcompat-align-parm
20451 @itemx -mno-compat-align-parm
20452 @opindex mcompat-align-parm
20453 Generate (do not generate) code to pass structure parameters with a
20454 maximum alignment of 64 bits, for compatibility with older versions
20455 of GCC.
20457 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20458 structure parameter on a 128-bit boundary when that structure contained
20459 a member requiring 128-bit alignment.  This is corrected in more
20460 recent versions of GCC.  This option may be used to generate code
20461 that is compatible with functions compiled with older versions of
20462 GCC.
20464 The @option{-mno-compat-align-parm} option is the default.
20465 @end table
20467 @node RX Options
20468 @subsection RX Options
20469 @cindex RX Options
20471 These command-line options are defined for RX targets:
20473 @table @gcctabopt
20474 @item -m64bit-doubles
20475 @itemx -m32bit-doubles
20476 @opindex m64bit-doubles
20477 @opindex m32bit-doubles
20478 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20479 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20480 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20481 works on 32-bit values, which is why the default is
20482 @option{-m32bit-doubles}.
20484 @item -fpu
20485 @itemx -nofpu
20486 @opindex fpu
20487 @opindex nofpu
20488 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20489 floating-point hardware.  The default is enabled for the RX600
20490 series and disabled for the RX200 series.
20492 Floating-point instructions are only generated for 32-bit floating-point 
20493 values, however, so the FPU hardware is not used for doubles if the
20494 @option{-m64bit-doubles} option is used.
20496 @emph{Note} If the @option{-fpu} option is enabled then
20497 @option{-funsafe-math-optimizations} is also enabled automatically.
20498 This is because the RX FPU instructions are themselves unsafe.
20500 @item -mcpu=@var{name}
20501 @opindex mcpu
20502 Selects the type of RX CPU to be targeted.  Currently three types are
20503 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20504 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20506 The only difference between @samp{RX600} and @samp{RX610} is that the
20507 @samp{RX610} does not support the @code{MVTIPL} instruction.
20509 The @samp{RX200} series does not have a hardware floating-point unit
20510 and so @option{-nofpu} is enabled by default when this type is
20511 selected.
20513 @item -mbig-endian-data
20514 @itemx -mlittle-endian-data
20515 @opindex mbig-endian-data
20516 @opindex mlittle-endian-data
20517 Store data (but not code) in the big-endian format.  The default is
20518 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20519 format.
20521 @item -msmall-data-limit=@var{N}
20522 @opindex msmall-data-limit
20523 Specifies the maximum size in bytes of global and static variables
20524 which can be placed into the small data area.  Using the small data
20525 area can lead to smaller and faster code, but the size of area is
20526 limited and it is up to the programmer to ensure that the area does
20527 not overflow.  Also when the small data area is used one of the RX's
20528 registers (usually @code{r13}) is reserved for use pointing to this
20529 area, so it is no longer available for use by the compiler.  This
20530 could result in slower and/or larger code if variables are pushed onto
20531 the stack instead of being held in this register.
20533 Note, common variables (variables that have not been initialized) and
20534 constants are not placed into the small data area as they are assigned
20535 to other sections in the output executable.
20537 The default value is zero, which disables this feature.  Note, this
20538 feature is not enabled by default with higher optimization levels
20539 (@option{-O2} etc) because of the potentially detrimental effects of
20540 reserving a register.  It is up to the programmer to experiment and
20541 discover whether this feature is of benefit to their program.  See the
20542 description of the @option{-mpid} option for a description of how the
20543 actual register to hold the small data area pointer is chosen.
20545 @item -msim
20546 @itemx -mno-sim
20547 @opindex msim
20548 @opindex mno-sim
20549 Use the simulator runtime.  The default is to use the libgloss
20550 board-specific runtime.
20552 @item -mas100-syntax
20553 @itemx -mno-as100-syntax
20554 @opindex mas100-syntax
20555 @opindex mno-as100-syntax
20556 When generating assembler output use a syntax that is compatible with
20557 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20558 assembler, but it has some restrictions so it is not generated by default.
20560 @item -mmax-constant-size=@var{N}
20561 @opindex mmax-constant-size
20562 Specifies the maximum size, in bytes, of a constant that can be used as
20563 an operand in a RX instruction.  Although the RX instruction set does
20564 allow constants of up to 4 bytes in length to be used in instructions,
20565 a longer value equates to a longer instruction.  Thus in some
20566 circumstances it can be beneficial to restrict the size of constants
20567 that are used in instructions.  Constants that are too big are instead
20568 placed into a constant pool and referenced via register indirection.
20570 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20571 or 4 means that constants of any size are allowed.
20573 @item -mrelax
20574 @opindex mrelax
20575 Enable linker relaxation.  Linker relaxation is a process whereby the
20576 linker attempts to reduce the size of a program by finding shorter
20577 versions of various instructions.  Disabled by default.
20579 @item -mint-register=@var{N}
20580 @opindex mint-register
20581 Specify the number of registers to reserve for fast interrupt handler
20582 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20583 means that register @code{r13} is reserved for the exclusive use
20584 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20585 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20586 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20587 A value of 0, the default, does not reserve any registers.
20589 @item -msave-acc-in-interrupts
20590 @opindex msave-acc-in-interrupts
20591 Specifies that interrupt handler functions should preserve the
20592 accumulator register.  This is only necessary if normal code might use
20593 the accumulator register, for example because it performs 64-bit
20594 multiplications.  The default is to ignore the accumulator as this
20595 makes the interrupt handlers faster.
20597 @item -mpid
20598 @itemx -mno-pid
20599 @opindex mpid
20600 @opindex mno-pid
20601 Enables the generation of position independent data.  When enabled any
20602 access to constant data is done via an offset from a base address
20603 held in a register.  This allows the location of constant data to be
20604 determined at run time without requiring the executable to be
20605 relocated, which is a benefit to embedded applications with tight
20606 memory constraints.  Data that can be modified is not affected by this
20607 option.
20609 Note, using this feature reserves a register, usually @code{r13}, for
20610 the constant data base address.  This can result in slower and/or
20611 larger code, especially in complicated functions.
20613 The actual register chosen to hold the constant data base address
20614 depends upon whether the @option{-msmall-data-limit} and/or the
20615 @option{-mint-register} command-line options are enabled.  Starting
20616 with register @code{r13} and proceeding downwards, registers are
20617 allocated first to satisfy the requirements of @option{-mint-register},
20618 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20619 is possible for the small data area register to be @code{r8} if both
20620 @option{-mint-register=4} and @option{-mpid} are specified on the
20621 command line.
20623 By default this feature is not enabled.  The default can be restored
20624 via the @option{-mno-pid} command-line option.
20626 @item -mno-warn-multiple-fast-interrupts
20627 @itemx -mwarn-multiple-fast-interrupts
20628 @opindex mno-warn-multiple-fast-interrupts
20629 @opindex mwarn-multiple-fast-interrupts
20630 Prevents GCC from issuing a warning message if it finds more than one
20631 fast interrupt handler when it is compiling a file.  The default is to
20632 issue a warning for each extra fast interrupt handler found, as the RX
20633 only supports one such interrupt.
20635 @item -mallow-string-insns
20636 @itemx -mno-allow-string-insns
20637 @opindex mallow-string-insns
20638 @opindex mno-allow-string-insns
20639 Enables or disables the use of the string manipulation instructions
20640 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20641 @code{SWHILE} and also the @code{RMPA} instruction.  These
20642 instructions may prefetch data, which is not safe to do if accessing
20643 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20644 for more information).
20646 The default is to allow these instructions, but it is not possible for
20647 GCC to reliably detect all circumstances where a string instruction
20648 might be used to access an I/O register, so their use cannot be
20649 disabled automatically.  Instead it is reliant upon the programmer to
20650 use the @option{-mno-allow-string-insns} option if their program
20651 accesses I/O space.
20653 When the instructions are enabled GCC defines the C preprocessor
20654 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20655 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20656 @end table
20658 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20659 has special significance to the RX port when used with the
20660 @code{interrupt} function attribute.  This attribute indicates a
20661 function intended to process fast interrupts.  GCC ensures
20662 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20663 and/or @code{r13} and only provided that the normal use of the
20664 corresponding registers have been restricted via the
20665 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20666 options.
20668 @node S/390 and zSeries Options
20669 @subsection S/390 and zSeries Options
20670 @cindex S/390 and zSeries Options
20672 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20674 @table @gcctabopt
20675 @item -mhard-float
20676 @itemx -msoft-float
20677 @opindex mhard-float
20678 @opindex msoft-float
20679 Use (do not use) the hardware floating-point instructions and registers
20680 for floating-point operations.  When @option{-msoft-float} is specified,
20681 functions in @file{libgcc.a} are used to perform floating-point
20682 operations.  When @option{-mhard-float} is specified, the compiler
20683 generates IEEE floating-point instructions.  This is the default.
20685 @item -mhard-dfp
20686 @itemx -mno-hard-dfp
20687 @opindex mhard-dfp
20688 @opindex mno-hard-dfp
20689 Use (do not use) the hardware decimal-floating-point instructions for
20690 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20691 specified, functions in @file{libgcc.a} are used to perform
20692 decimal-floating-point operations.  When @option{-mhard-dfp} is
20693 specified, the compiler generates decimal-floating-point hardware
20694 instructions.  This is the default for @option{-march=z9-ec} or higher.
20696 @item -mlong-double-64
20697 @itemx -mlong-double-128
20698 @opindex mlong-double-64
20699 @opindex mlong-double-128
20700 These switches control the size of @code{long double} type. A size
20701 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20702 type. This is the default.
20704 @item -mbackchain
20705 @itemx -mno-backchain
20706 @opindex mbackchain
20707 @opindex mno-backchain
20708 Store (do not store) the address of the caller's frame as backchain pointer
20709 into the callee's stack frame.
20710 A backchain may be needed to allow debugging using tools that do not understand
20711 DWARF 2 call frame information.
20712 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20713 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20714 the backchain is placed into the topmost word of the 96/160 byte register
20715 save area.
20717 In general, code compiled with @option{-mbackchain} is call-compatible with
20718 code compiled with @option{-mmo-backchain}; however, use of the backchain
20719 for debugging purposes usually requires that the whole binary is built with
20720 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20721 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20722 to build a linux kernel use @option{-msoft-float}.
20724 The default is to not maintain the backchain.
20726 @item -mpacked-stack
20727 @itemx -mno-packed-stack
20728 @opindex mpacked-stack
20729 @opindex mno-packed-stack
20730 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20731 specified, the compiler uses the all fields of the 96/160 byte register save
20732 area only for their default purpose; unused fields still take up stack space.
20733 When @option{-mpacked-stack} is specified, register save slots are densely
20734 packed at the top of the register save area; unused space is reused for other
20735 purposes, allowing for more efficient use of the available stack space.
20736 However, when @option{-mbackchain} is also in effect, the topmost word of
20737 the save area is always used to store the backchain, and the return address
20738 register is always saved two words below the backchain.
20740 As long as the stack frame backchain is not used, code generated with
20741 @option{-mpacked-stack} is call-compatible with code generated with
20742 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20743 S/390 or zSeries generated code that uses the stack frame backchain at run
20744 time, not just for debugging purposes.  Such code is not call-compatible
20745 with code compiled with @option{-mpacked-stack}.  Also, note that the
20746 combination of @option{-mbackchain},
20747 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20748 to build a linux kernel use @option{-msoft-float}.
20750 The default is to not use the packed stack layout.
20752 @item -msmall-exec
20753 @itemx -mno-small-exec
20754 @opindex msmall-exec
20755 @opindex mno-small-exec
20756 Generate (or do not generate) code using the @code{bras} instruction
20757 to do subroutine calls.
20758 This only works reliably if the total executable size does not
20759 exceed 64k.  The default is to use the @code{basr} instruction instead,
20760 which does not have this limitation.
20762 @item -m64
20763 @itemx -m31
20764 @opindex m64
20765 @opindex m31
20766 When @option{-m31} is specified, generate code compliant to the
20767 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20768 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20769 particular to generate 64-bit instructions.  For the @samp{s390}
20770 targets, the default is @option{-m31}, while the @samp{s390x}
20771 targets default to @option{-m64}.
20773 @item -mzarch
20774 @itemx -mesa
20775 @opindex mzarch
20776 @opindex mesa
20777 When @option{-mzarch} is specified, generate code using the
20778 instructions available on z/Architecture.
20779 When @option{-mesa} is specified, generate code using the
20780 instructions available on ESA/390.  Note that @option{-mesa} is
20781 not possible with @option{-m64}.
20782 When generating code compliant to the GNU/Linux for S/390 ABI,
20783 the default is @option{-mesa}.  When generating code compliant
20784 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20786 @item -mhtm
20787 @itemx -mno-htm
20788 @opindex mhtm
20789 @opindex mno-htm
20790 The @option{-mhtm} option enables a set of builtins making use of
20791 instructions available with the transactional execution facility
20792 introduced with the IBM zEnterprise EC12 machine generation
20793 @ref{S/390 System z Built-in Functions}.
20794 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
20796 @item -mvx
20797 @itemx -mno-vx
20798 @opindex mvx
20799 @opindex mno-vx
20800 When @option{-mvx} is specified, generate code using the instructions
20801 available with the vector extension facility introduced with the IBM
20802 z13 machine generation.
20803 This option changes the ABI for some vector type values with regard to
20804 alignment and calling conventions.  In case vector type values are
20805 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
20806 command will be added to mark the resulting binary with the ABI used.
20807 @option{-mvx} is enabled by default when using @option{-march=z13}.
20809 @item -mzvector
20810 @itemx -mno-zvector
20811 @opindex mzvector
20812 @opindex mno-zvector
20813 The @option{-mzvector} option enables vector language extensions and
20814 builtins using instructions available with the vector extension
20815 facility introduced with the IBM z13 machine generation.
20816 This option adds support for @samp{vector} to be used as a keyword to
20817 define vector type variables and arguments.  @samp{vector} is only
20818 available when GNU extensions are enabled.  It will not be expanded
20819 when requesting strict standard compliance e.g. with @option{-std=c99}.
20820 In addition to the GCC low-level builtins @option{-mzvector} enables
20821 a set of builtins added for compatibility with Altivec-style
20822 implementations like Power and Cell.  In order to make use of these
20823 builtins the header file @file{vecintrin.h} needs to be included.
20824 @option{-mzvector} is disabled by default.
20826 @item -mmvcle
20827 @itemx -mno-mvcle
20828 @opindex mmvcle
20829 @opindex mno-mvcle
20830 Generate (or do not generate) code using the @code{mvcle} instruction
20831 to perform block moves.  When @option{-mno-mvcle} is specified,
20832 use a @code{mvc} loop instead.  This is the default unless optimizing for
20833 size.
20835 @item -mdebug
20836 @itemx -mno-debug
20837 @opindex mdebug
20838 @opindex mno-debug
20839 Print (or do not print) additional debug information when compiling.
20840 The default is to not print debug information.
20842 @item -march=@var{cpu-type}
20843 @opindex march
20844 Generate code that runs on @var{cpu-type}, which is the name of a system
20845 representing a certain processor type.  Possible values for
20846 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20847 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20848 and @samp{z13}.
20849 When generating code using the instructions available on z/Architecture,
20850 the default is @option{-march=z900}.  Otherwise, the default is
20851 @option{-march=g5}.
20853 @item -mtune=@var{cpu-type}
20854 @opindex mtune
20855 Tune to @var{cpu-type} everything applicable about the generated code,
20856 except for the ABI and the set of available instructions.
20857 The list of @var{cpu-type} values is the same as for @option{-march}.
20858 The default is the value used for @option{-march}.
20860 @item -mtpf-trace
20861 @itemx -mno-tpf-trace
20862 @opindex mtpf-trace
20863 @opindex mno-tpf-trace
20864 Generate code that adds (does not add) in TPF OS specific branches to trace
20865 routines in the operating system.  This option is off by default, even
20866 when compiling for the TPF OS@.
20868 @item -mfused-madd
20869 @itemx -mno-fused-madd
20870 @opindex mfused-madd
20871 @opindex mno-fused-madd
20872 Generate code that uses (does not use) the floating-point multiply and
20873 accumulate instructions.  These instructions are generated by default if
20874 hardware floating point is used.
20876 @item -mwarn-framesize=@var{framesize}
20877 @opindex mwarn-framesize
20878 Emit a warning if the current function exceeds the given frame size.  Because
20879 this is a compile-time check it doesn't need to be a real problem when the program
20880 runs.  It is intended to identify functions that most probably cause
20881 a stack overflow.  It is useful to be used in an environment with limited stack
20882 size e.g.@: the linux kernel.
20884 @item -mwarn-dynamicstack
20885 @opindex mwarn-dynamicstack
20886 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20887 arrays.  This is generally a bad idea with a limited stack size.
20889 @item -mstack-guard=@var{stack-guard}
20890 @itemx -mstack-size=@var{stack-size}
20891 @opindex mstack-guard
20892 @opindex mstack-size
20893 If these options are provided the S/390 back end emits additional instructions in
20894 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20895 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20896 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20897 the frame size of the compiled function is chosen.
20898 These options are intended to be used to help debugging stack overflow problems.
20899 The additionally emitted code causes only little overhead and hence can also be
20900 used in production-like systems without greater performance degradation.  The given
20901 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20902 @var{stack-guard} without exceeding 64k.
20903 In order to be efficient the extra code makes the assumption that the stack starts
20904 at an address aligned to the value given by @var{stack-size}.
20905 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20907 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20908 @opindex mhotpatch
20909 If the hotpatch option is enabled, a ``hot-patching'' function
20910 prologue is generated for all functions in the compilation unit.
20911 The funtion label is prepended with the given number of two-byte
20912 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20913 the label, 2 * @var{post-halfwords} bytes are appended, using the
20914 largest NOP like instructions the architecture allows (maximum
20915 1000000).
20917 If both arguments are zero, hotpatching is disabled.
20919 This option can be overridden for individual functions with the
20920 @code{hotpatch} attribute.
20921 @end table
20923 @node Score Options
20924 @subsection Score Options
20925 @cindex Score Options
20927 These options are defined for Score implementations:
20929 @table @gcctabopt
20930 @item -meb
20931 @opindex meb
20932 Compile code for big-endian mode.  This is the default.
20934 @item -mel
20935 @opindex mel
20936 Compile code for little-endian mode.
20938 @item -mnhwloop
20939 @opindex mnhwloop
20940 Disable generation of @code{bcnz} instructions.
20942 @item -muls
20943 @opindex muls
20944 Enable generation of unaligned load and store instructions.
20946 @item -mmac
20947 @opindex mmac
20948 Enable the use of multiply-accumulate instructions. Disabled by default.
20950 @item -mscore5
20951 @opindex mscore5
20952 Specify the SCORE5 as the target architecture.
20954 @item -mscore5u
20955 @opindex mscore5u
20956 Specify the SCORE5U of the target architecture.
20958 @item -mscore7
20959 @opindex mscore7
20960 Specify the SCORE7 as the target architecture. This is the default.
20962 @item -mscore7d
20963 @opindex mscore7d
20964 Specify the SCORE7D as the target architecture.
20965 @end table
20967 @node SH Options
20968 @subsection SH Options
20970 These @samp{-m} options are defined for the SH implementations:
20972 @table @gcctabopt
20973 @item -m1
20974 @opindex m1
20975 Generate code for the SH1.
20977 @item -m2
20978 @opindex m2
20979 Generate code for the SH2.
20981 @item -m2e
20982 Generate code for the SH2e.
20984 @item -m2a-nofpu
20985 @opindex m2a-nofpu
20986 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20987 that the floating-point unit is not used.
20989 @item -m2a-single-only
20990 @opindex m2a-single-only
20991 Generate code for the SH2a-FPU, in such a way that no double-precision
20992 floating-point operations are used.
20994 @item -m2a-single
20995 @opindex m2a-single
20996 Generate code for the SH2a-FPU assuming the floating-point unit is in
20997 single-precision mode by default.
20999 @item -m2a
21000 @opindex m2a
21001 Generate code for the SH2a-FPU assuming the floating-point unit is in
21002 double-precision mode by default.
21004 @item -m3
21005 @opindex m3
21006 Generate code for the SH3.
21008 @item -m3e
21009 @opindex m3e
21010 Generate code for the SH3e.
21012 @item -m4-nofpu
21013 @opindex m4-nofpu
21014 Generate code for the SH4 without a floating-point unit.
21016 @item -m4-single-only
21017 @opindex m4-single-only
21018 Generate code for the SH4 with a floating-point unit that only
21019 supports single-precision arithmetic.
21021 @item -m4-single
21022 @opindex m4-single
21023 Generate code for the SH4 assuming the floating-point unit is in
21024 single-precision mode by default.
21026 @item -m4
21027 @opindex m4
21028 Generate code for the SH4.
21030 @item -m4-100
21031 @opindex m4-100
21032 Generate code for SH4-100.
21034 @item -m4-100-nofpu
21035 @opindex m4-100-nofpu
21036 Generate code for SH4-100 in such a way that the
21037 floating-point unit is not used.
21039 @item -m4-100-single
21040 @opindex m4-100-single
21041 Generate code for SH4-100 assuming the floating-point unit is in
21042 single-precision mode by default.
21044 @item -m4-100-single-only
21045 @opindex m4-100-single-only
21046 Generate code for SH4-100 in such a way that no double-precision
21047 floating-point operations are used.
21049 @item -m4-200
21050 @opindex m4-200
21051 Generate code for SH4-200.
21053 @item -m4-200-nofpu
21054 @opindex m4-200-nofpu
21055 Generate code for SH4-200 without in such a way that the
21056 floating-point unit is not used.
21058 @item -m4-200-single
21059 @opindex m4-200-single
21060 Generate code for SH4-200 assuming the floating-point unit is in
21061 single-precision mode by default.
21063 @item -m4-200-single-only
21064 @opindex m4-200-single-only
21065 Generate code for SH4-200 in such a way that no double-precision
21066 floating-point operations are used.
21068 @item -m4-300
21069 @opindex m4-300
21070 Generate code for SH4-300.
21072 @item -m4-300-nofpu
21073 @opindex m4-300-nofpu
21074 Generate code for SH4-300 without in such a way that the
21075 floating-point unit is not used.
21077 @item -m4-300-single
21078 @opindex m4-300-single
21079 Generate code for SH4-300 in such a way that no double-precision
21080 floating-point operations are used.
21082 @item -m4-300-single-only
21083 @opindex m4-300-single-only
21084 Generate code for SH4-300 in such a way that no double-precision
21085 floating-point operations are used.
21087 @item -m4-340
21088 @opindex m4-340
21089 Generate code for SH4-340 (no MMU, no FPU).
21091 @item -m4-500
21092 @opindex m4-500
21093 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21094 assembler.
21096 @item -m4a-nofpu
21097 @opindex m4a-nofpu
21098 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21099 floating-point unit is not used.
21101 @item -m4a-single-only
21102 @opindex m4a-single-only
21103 Generate code for the SH4a, in such a way that no double-precision
21104 floating-point operations are used.
21106 @item -m4a-single
21107 @opindex m4a-single
21108 Generate code for the SH4a assuming the floating-point unit is in
21109 single-precision mode by default.
21111 @item -m4a
21112 @opindex m4a
21113 Generate code for the SH4a.
21115 @item -m4al
21116 @opindex m4al
21117 Same as @option{-m4a-nofpu}, except that it implicitly passes
21118 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21119 instructions at the moment.
21121 @item -mb
21122 @opindex mb
21123 Compile code for the processor in big-endian mode.
21125 @item -ml
21126 @opindex ml
21127 Compile code for the processor in little-endian mode.
21129 @item -mdalign
21130 @opindex mdalign
21131 Align doubles at 64-bit boundaries.  Note that this changes the calling
21132 conventions, and thus some functions from the standard C library do
21133 not work unless you recompile it first with @option{-mdalign}.
21135 @item -mrelax
21136 @opindex mrelax
21137 Shorten some address references at link time, when possible; uses the
21138 linker option @option{-relax}.
21140 @item -mbigtable
21141 @opindex mbigtable
21142 Use 32-bit offsets in @code{switch} tables.  The default is to use
21143 16-bit offsets.
21145 @item -mbitops
21146 @opindex mbitops
21147 Enable the use of bit manipulation instructions on SH2A.
21149 @item -mfmovd
21150 @opindex mfmovd
21151 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21152 alignment constraints.
21154 @item -mrenesas
21155 @opindex mrenesas
21156 Comply with the calling conventions defined by Renesas.
21158 @item -mno-renesas
21159 @opindex mno-renesas
21160 Comply with the calling conventions defined for GCC before the Renesas
21161 conventions were available.  This option is the default for all
21162 targets of the SH toolchain.
21164 @item -mnomacsave
21165 @opindex mnomacsave
21166 Mark the @code{MAC} register as call-clobbered, even if
21167 @option{-mrenesas} is given.
21169 @item -mieee
21170 @itemx -mno-ieee
21171 @opindex mieee
21172 @opindex mno-ieee
21173 Control the IEEE compliance of floating-point comparisons, which affects the
21174 handling of cases where the result of a comparison is unordered.  By default
21175 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21176 enabled @option{-mno-ieee} is implicitly set, which results in faster
21177 floating-point greater-equal and less-equal comparisons.  The implcit settings
21178 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21180 @item -minline-ic_invalidate
21181 @opindex minline-ic_invalidate
21182 Inline code to invalidate instruction cache entries after setting up
21183 nested function trampolines.
21184 This option has no effect if @option{-musermode} is in effect and the selected
21185 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21186 instruction.
21187 If the selected code generation option does not allow the use of the @code{icbi}
21188 instruction, and @option{-musermode} is not in effect, the inlined code
21189 manipulates the instruction cache address array directly with an associative
21190 write.  This not only requires privileged mode at run time, but it also
21191 fails if the cache line had been mapped via the TLB and has become unmapped.
21193 @item -misize
21194 @opindex misize
21195 Dump instruction size and location in the assembly code.
21197 @item -mpadstruct
21198 @opindex mpadstruct
21199 This option is deprecated.  It pads structures to multiple of 4 bytes,
21200 which is incompatible with the SH ABI@.
21202 @item -matomic-model=@var{model}
21203 @opindex matomic-model=@var{model}
21204 Sets the model of atomic operations and additional parameters as a comma
21205 separated list.  For details on the atomic built-in functions see
21206 @ref{__atomic Builtins}.  The following models and parameters are supported:
21208 @table @samp
21210 @item none
21211 Disable compiler generated atomic sequences and emit library calls for atomic
21212 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21214 @item soft-gusa
21215 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21216 built-in functions.  The generated atomic sequences require additional support
21217 from the interrupt/exception handling code of the system and are only suitable
21218 for SH3* and SH4* single-core systems.  This option is enabled by default when
21219 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21220 this option also partially utilizes the hardware atomic instructions
21221 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21222 @samp{strict} is specified.  
21224 @item soft-tcb
21225 Generate software atomic sequences that use a variable in the thread control
21226 block.  This is a variation of the gUSA sequences which can also be used on
21227 SH1* and SH2* targets.  The generated atomic sequences require additional
21228 support from the interrupt/exception handling code of the system and are only
21229 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21230 parameter has to be specified as well.
21232 @item soft-imask
21233 Generate software atomic sequences that temporarily disable interrupts by
21234 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21235 in privileged mode and is only suitable for single-core systems.  Additional
21236 support from the interrupt/exception handling code of the system is not
21237 required.  This model is enabled by default when the target is
21238 @code{sh*-*-linux*} and SH1* or SH2*.
21240 @item hard-llcs
21241 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21242 instructions only.  This is only available on SH4A and is suitable for
21243 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21244 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21245 Code compiled with this option is also compatible with other software
21246 atomic model interrupt/exception handling systems if executed on an SH4A
21247 system.  Additional support from the interrupt/exception handling code of the
21248 system is not required for this model.
21250 @item gbr-offset=
21251 This parameter specifies the offset in bytes of the variable in the thread
21252 control block structure that should be used by the generated atomic sequences
21253 when the @samp{soft-tcb} model has been selected.  For other models this
21254 parameter is ignored.  The specified value must be an integer multiple of four
21255 and in the range 0-1020.
21257 @item strict
21258 This parameter prevents mixed usage of multiple atomic models, even if they
21259 are compatible, and makes the compiler generate atomic sequences of the
21260 specified model only.
21262 @end table
21264 @item -mtas
21265 @opindex mtas
21266 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21267 Notice that depending on the particular hardware and software configuration
21268 this can degrade overall performance due to the operand cache line flushes
21269 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21270 processors the @code{tas.b} instruction must be used with caution since it
21271 can result in data corruption for certain cache configurations.
21273 @item -mprefergot
21274 @opindex mprefergot
21275 When generating position-independent code, emit function calls using
21276 the Global Offset Table instead of the Procedure Linkage Table.
21278 @item -musermode
21279 @itemx -mno-usermode
21280 @opindex musermode
21281 @opindex mno-usermode
21282 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21283 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21284 inlined code would not work in user mode.  @option{-musermode} is the default
21285 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21286 @option{-musermode} has no effect, since there is no user mode.
21288 @item -multcost=@var{number}
21289 @opindex multcost=@var{number}
21290 Set the cost to assume for a multiply insn.
21292 @item -mdiv=@var{strategy}
21293 @opindex mdiv=@var{strategy}
21294 Set the division strategy to be used for integer division operations.
21295 @var{strategy} can be one of: 
21297 @table @samp
21299 @item call-div1
21300 Calls a library function that uses the single-step division instruction
21301 @code{div1} to perform the operation.  Division by zero calculates an
21302 unspecified result and does not trap.  This is the default except for SH4,
21303 SH2A and SHcompact.
21305 @item call-fp
21306 Calls a library function that performs the operation in double precision
21307 floating point.  Division by zero causes a floating-point exception.  This is
21308 the default for SHcompact with FPU.  Specifying this for targets that do not
21309 have a double precision FPU defaults to @code{call-div1}.
21311 @item call-table
21312 Calls a library function that uses a lookup table for small divisors and
21313 the @code{div1} instruction with case distinction for larger divisors.  Division
21314 by zero calculates an unspecified result and does not trap.  This is the default
21315 for SH4.  Specifying this for targets that do not have dynamic shift
21316 instructions defaults to @code{call-div1}.
21318 @end table
21320 When a division strategy has not been specified the default strategy is
21321 selected based on the current target.  For SH2A the default strategy is to
21322 use the @code{divs} and @code{divu} instructions instead of library function
21323 calls.
21325 @item -maccumulate-outgoing-args
21326 @opindex maccumulate-outgoing-args
21327 Reserve space once for outgoing arguments in the function prologue rather
21328 than around each call.  Generally beneficial for performance and size.  Also
21329 needed for unwinding to avoid changing the stack frame around conditional code.
21331 @item -mdivsi3_libfunc=@var{name}
21332 @opindex mdivsi3_libfunc=@var{name}
21333 Set the name of the library function used for 32-bit signed division to
21334 @var{name}.
21335 This only affects the name used in the @samp{call} division strategies, and
21336 the compiler still expects the same sets of input/output/clobbered registers as
21337 if this option were not present.
21339 @item -mfixed-range=@var{register-range}
21340 @opindex mfixed-range
21341 Generate code treating the given register range as fixed registers.
21342 A fixed register is one that the register allocator can not use.  This is
21343 useful when compiling kernel code.  A register range is specified as
21344 two registers separated by a dash.  Multiple register ranges can be
21345 specified separated by a comma.
21347 @item -mbranch-cost=@var{num}
21348 @opindex mbranch-cost=@var{num}
21349 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21350 make the compiler try to generate more branch-free code if possible.  
21351 If not specified the value is selected depending on the processor type that
21352 is being compiled for.
21354 @item -mzdcbranch
21355 @itemx -mno-zdcbranch
21356 @opindex mzdcbranch
21357 @opindex mno-zdcbranch
21358 Assume (do not assume) that zero displacement conditional branch instructions
21359 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21360 compiler prefers zero displacement branch code sequences.  This is
21361 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21362 disabled by specifying @option{-mno-zdcbranch}.
21364 @item -mcbranch-force-delay-slot
21365 @opindex mcbranch-force-delay-slot
21366 Force the usage of delay slots for conditional branches, which stuffs the delay
21367 slot with a @code{nop} if a suitable instruction can't be found.  By default
21368 this option is disabled.  It can be enabled to work around hardware bugs as
21369 found in the original SH7055.
21371 @item -mfused-madd
21372 @itemx -mno-fused-madd
21373 @opindex mfused-madd
21374 @opindex mno-fused-madd
21375 Generate code that uses (does not use) the floating-point multiply and
21376 accumulate instructions.  These instructions are generated by default
21377 if hardware floating point is used.  The machine-dependent
21378 @option{-mfused-madd} option is now mapped to the machine-independent
21379 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21380 mapped to @option{-ffp-contract=off}.
21382 @item -mfsca
21383 @itemx -mno-fsca
21384 @opindex mfsca
21385 @opindex mno-fsca
21386 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21387 and cosine approximations.  The option @option{-mfsca} must be used in
21388 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21389 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21390 approximations even if @option{-funsafe-math-optimizations} is in effect.
21392 @item -mfsrra
21393 @itemx -mno-fsrra
21394 @opindex mfsrra
21395 @opindex mno-fsrra
21396 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21397 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21398 in combination with @option{-funsafe-math-optimizations} and
21399 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21400 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21401 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21402 in effect.
21404 @item -mpretend-cmove
21405 @opindex mpretend-cmove
21406 Prefer zero-displacement conditional branches for conditional move instruction
21407 patterns.  This can result in faster code on the SH4 processor.
21409 @item -mfdpic
21410 @opindex fdpic
21411 Generate code using the FDPIC ABI.
21413 @end table
21415 @node Solaris 2 Options
21416 @subsection Solaris 2 Options
21417 @cindex Solaris 2 options
21419 These @samp{-m} options are supported on Solaris 2:
21421 @table @gcctabopt
21422 @item -mclear-hwcap
21423 @opindex mclear-hwcap
21424 @option{-mclear-hwcap} tells the compiler to remove the hardware
21425 capabilities generated by the Solaris assembler.  This is only necessary
21426 when object files use ISA extensions not supported by the current
21427 machine, but check at runtime whether or not to use them.
21429 @item -mimpure-text
21430 @opindex mimpure-text
21431 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21432 the compiler to not pass @option{-z text} to the linker when linking a
21433 shared object.  Using this option, you can link position-dependent
21434 code into a shared object.
21436 @option{-mimpure-text} suppresses the ``relocations remain against
21437 allocatable but non-writable sections'' linker error message.
21438 However, the necessary relocations trigger copy-on-write, and the
21439 shared object is not actually shared across processes.  Instead of
21440 using @option{-mimpure-text}, you should compile all source code with
21441 @option{-fpic} or @option{-fPIC}.
21443 @end table
21445 These switches are supported in addition to the above on Solaris 2:
21447 @table @gcctabopt
21448 @item -pthreads
21449 @opindex pthreads
21450 Add support for multithreading using the POSIX threads library.  This
21451 option sets flags for both the preprocessor and linker.  This option does
21452 not affect the thread safety of object code produced  by the compiler or
21453 that of libraries supplied with it.
21455 @item -pthread
21456 @opindex pthread
21457 This is a synonym for @option{-pthreads}.
21458 @end table
21460 @node SPARC Options
21461 @subsection SPARC Options
21462 @cindex SPARC options
21464 These @samp{-m} options are supported on the SPARC:
21466 @table @gcctabopt
21467 @item -mno-app-regs
21468 @itemx -mapp-regs
21469 @opindex mno-app-regs
21470 @opindex mapp-regs
21471 Specify @option{-mapp-regs} to generate output using the global registers
21472 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21473 global register 1, each global register 2 through 4 is then treated as an
21474 allocable register that is clobbered by function calls.  This is the default.
21476 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21477 specify @option{-mno-app-regs}.  You should compile libraries and system
21478 software with this option.
21480 @item -mflat
21481 @itemx -mno-flat
21482 @opindex mflat
21483 @opindex mno-flat
21484 With @option{-mflat}, the compiler does not generate save/restore instructions
21485 and uses a ``flat'' or single register window model.  This model is compatible
21486 with the regular register window model.  The local registers and the input
21487 registers (0--5) are still treated as ``call-saved'' registers and are
21488 saved on the stack as needed.
21490 With @option{-mno-flat} (the default), the compiler generates save/restore
21491 instructions (except for leaf functions).  This is the normal operating mode.
21493 @item -mfpu
21494 @itemx -mhard-float
21495 @opindex mfpu
21496 @opindex mhard-float
21497 Generate output containing floating-point instructions.  This is the
21498 default.
21500 @item -mno-fpu
21501 @itemx -msoft-float
21502 @opindex mno-fpu
21503 @opindex msoft-float
21504 Generate output containing library calls for floating point.
21505 @strong{Warning:} the requisite libraries are not available for all SPARC
21506 targets.  Normally the facilities of the machine's usual C compiler are
21507 used, but this cannot be done directly in cross-compilation.  You must make
21508 your own arrangements to provide suitable library functions for
21509 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21510 @samp{sparclite-*-*} do provide software floating-point support.
21512 @option{-msoft-float} changes the calling convention in the output file;
21513 therefore, it is only useful if you compile @emph{all} of a program with
21514 this option.  In particular, you need to compile @file{libgcc.a}, the
21515 library that comes with GCC, with @option{-msoft-float} in order for
21516 this to work.
21518 @item -mhard-quad-float
21519 @opindex mhard-quad-float
21520 Generate output containing quad-word (long double) floating-point
21521 instructions.
21523 @item -msoft-quad-float
21524 @opindex msoft-quad-float
21525 Generate output containing library calls for quad-word (long double)
21526 floating-point instructions.  The functions called are those specified
21527 in the SPARC ABI@.  This is the default.
21529 As of this writing, there are no SPARC implementations that have hardware
21530 support for the quad-word floating-point instructions.  They all invoke
21531 a trap handler for one of these instructions, and then the trap handler
21532 emulates the effect of the instruction.  Because of the trap handler overhead,
21533 this is much slower than calling the ABI library routines.  Thus the
21534 @option{-msoft-quad-float} option is the default.
21536 @item -mno-unaligned-doubles
21537 @itemx -munaligned-doubles
21538 @opindex mno-unaligned-doubles
21539 @opindex munaligned-doubles
21540 Assume that doubles have 8-byte alignment.  This is the default.
21542 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21543 alignment only if they are contained in another type, or if they have an
21544 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21545 Specifying this option avoids some rare compatibility problems with code
21546 generated by other compilers.  It is not the default because it results
21547 in a performance loss, especially for floating-point code.
21549 @item -muser-mode
21550 @itemx -mno-user-mode
21551 @opindex muser-mode
21552 @opindex mno-user-mode
21553 Do not generate code that can only run in supervisor mode.  This is relevant
21554 only for the @code{casa} instruction emitted for the LEON3 processor.  This
21555 is the default.
21557 @item -mno-faster-structs
21558 @itemx -mfaster-structs
21559 @opindex mno-faster-structs
21560 @opindex mfaster-structs
21561 With @option{-mfaster-structs}, the compiler assumes that structures
21562 should have 8-byte alignment.  This enables the use of pairs of
21563 @code{ldd} and @code{std} instructions for copies in structure
21564 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21565 However, the use of this changed alignment directly violates the SPARC
21566 ABI@.  Thus, it's intended only for use on targets where the developer
21567 acknowledges that their resulting code is not directly in line with
21568 the rules of the ABI@.
21570 @item -mcpu=@var{cpu_type}
21571 @opindex mcpu
21572 Set the instruction set, register set, and instruction scheduling parameters
21573 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21574 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21575 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21576 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21577 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21578 @samp{niagara3} and @samp{niagara4}.
21580 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21581 which selects the best architecture option for the host processor.
21582 @option{-mcpu=native} has no effect if GCC does not recognize
21583 the processor.
21585 Default instruction scheduling parameters are used for values that select
21586 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21587 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21589 Here is a list of each supported architecture and their supported
21590 implementations.
21592 @table @asis
21593 @item v7
21594 cypress, leon3v7
21596 @item v8
21597 supersparc, hypersparc, leon, leon3
21599 @item sparclite
21600 f930, f934, sparclite86x
21602 @item sparclet
21603 tsc701
21605 @item v9
21606 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21607 @end table
21609 By default (unless configured otherwise), GCC generates code for the V7
21610 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21611 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21612 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21613 SPARCStation 1, 2, IPX etc.
21615 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21616 architecture.  The only difference from V7 code is that the compiler emits
21617 the integer multiply and integer divide instructions which exist in SPARC-V8
21618 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21619 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21620 2000 series.
21622 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21623 the SPARC architecture.  This adds the integer multiply, integer divide step
21624 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21625 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21626 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21627 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21628 MB86934 chip, which is the more recent SPARClite with FPU@.
21630 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21631 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21632 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21633 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21634 optimizes it for the TEMIC SPARClet chip.
21636 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21637 architecture.  This adds 64-bit integer and floating-point move instructions,
21638 3 additional floating-point condition code registers and conditional move
21639 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21640 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21641 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21642 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21643 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21644 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21645 additionally optimizes it for Sun UltraSPARC T2 chips. With
21646 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21647 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21648 additionally optimizes it for Sun UltraSPARC T4 chips.
21650 @item -mtune=@var{cpu_type}
21651 @opindex mtune
21652 Set the instruction scheduling parameters for machine type
21653 @var{cpu_type}, but do not set the instruction set or register set that the
21654 option @option{-mcpu=@var{cpu_type}} does.
21656 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21657 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21658 that select a particular CPU implementation.  Those are @samp{cypress},
21659 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21660 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21661 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21662 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21663 toolchains, @samp{native} can also be used.
21665 @item -mv8plus
21666 @itemx -mno-v8plus
21667 @opindex mv8plus
21668 @opindex mno-v8plus
21669 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21670 difference from the V8 ABI is that the global and out registers are
21671 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21672 mode for all SPARC-V9 processors.
21674 @item -mvis
21675 @itemx -mno-vis
21676 @opindex mvis
21677 @opindex mno-vis
21678 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21679 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21681 @item -mvis2
21682 @itemx -mno-vis2
21683 @opindex mvis2
21684 @opindex mno-vis2
21685 With @option{-mvis2}, GCC generates code that takes advantage of
21686 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21687 default is @option{-mvis2} when targeting a cpu that supports such
21688 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21689 also sets @option{-mvis}.
21691 @item -mvis3
21692 @itemx -mno-vis3
21693 @opindex mvis3
21694 @opindex mno-vis3
21695 With @option{-mvis3}, GCC generates code that takes advantage of
21696 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21697 default is @option{-mvis3} when targeting a cpu that supports such
21698 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21699 also sets @option{-mvis2} and @option{-mvis}.
21701 @item -mcbcond
21702 @itemx -mno-cbcond
21703 @opindex mcbcond
21704 @opindex mno-cbcond
21705 With @option{-mcbcond}, GCC generates code that takes advantage of
21706 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21707 The default is @option{-mcbcond} when targeting a cpu that supports such
21708 instructions, such as niagara-4 and later.
21710 @item -mpopc
21711 @itemx -mno-popc
21712 @opindex mpopc
21713 @opindex mno-popc
21714 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21715 population count instruction.  The default is @option{-mpopc}
21716 when targeting a cpu that supports such instructions, such as Niagara-2 and
21717 later.
21719 @item -mfmaf
21720 @itemx -mno-fmaf
21721 @opindex mfmaf
21722 @opindex mno-fmaf
21723 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21724 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21725 when targeting a cpu that supports such instructions, such as Niagara-3 and
21726 later.
21728 @item -mfix-at697f
21729 @opindex mfix-at697f
21730 Enable the documented workaround for the single erratum of the Atmel AT697F
21731 processor (which corresponds to erratum #13 of the AT697E processor).
21733 @item -mfix-ut699
21734 @opindex mfix-ut699
21735 Enable the documented workarounds for the floating-point errata and the data
21736 cache nullify errata of the UT699 processor.
21737 @end table
21739 These @samp{-m} options are supported in addition to the above
21740 on SPARC-V9 processors in 64-bit environments:
21742 @table @gcctabopt
21743 @item -m32
21744 @itemx -m64
21745 @opindex m32
21746 @opindex m64
21747 Generate code for a 32-bit or 64-bit environment.
21748 The 32-bit environment sets int, long and pointer to 32 bits.
21749 The 64-bit environment sets int to 32 bits and long and pointer
21750 to 64 bits.
21752 @item -mcmodel=@var{which}
21753 @opindex mcmodel
21754 Set the code model to one of
21756 @table @samp
21757 @item medlow
21758 The Medium/Low code model: 64-bit addresses, programs
21759 must be linked in the low 32 bits of memory.  Programs can be statically
21760 or dynamically linked.
21762 @item medmid
21763 The Medium/Middle code model: 64-bit addresses, programs
21764 must be linked in the low 44 bits of memory, the text and data segments must
21765 be less than 2GB in size and the data segment must be located within 2GB of
21766 the text segment.
21768 @item medany
21769 The Medium/Anywhere code model: 64-bit addresses, programs
21770 may be linked anywhere in memory, the text and data segments must be less
21771 than 2GB in size and the data segment must be located within 2GB of the
21772 text segment.
21774 @item embmedany
21775 The Medium/Anywhere code model for embedded systems:
21776 64-bit addresses, the text and data segments must be less than 2GB in
21777 size, both starting anywhere in memory (determined at link time).  The
21778 global register %g4 points to the base of the data segment.  Programs
21779 are statically linked and PIC is not supported.
21780 @end table
21782 @item -mmemory-model=@var{mem-model}
21783 @opindex mmemory-model
21784 Set the memory model in force on the processor to one of
21786 @table @samp
21787 @item default
21788 The default memory model for the processor and operating system.
21790 @item rmo
21791 Relaxed Memory Order
21793 @item pso
21794 Partial Store Order
21796 @item tso
21797 Total Store Order
21799 @item sc
21800 Sequential Consistency
21801 @end table
21803 These memory models are formally defined in Appendix D of the Sparc V9
21804 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21806 @item -mstack-bias
21807 @itemx -mno-stack-bias
21808 @opindex mstack-bias
21809 @opindex mno-stack-bias
21810 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21811 frame pointer if present, are offset by @minus{}2047 which must be added back
21812 when making stack frame references.  This is the default in 64-bit mode.
21813 Otherwise, assume no such offset is present.
21814 @end table
21816 @node SPU Options
21817 @subsection SPU Options
21818 @cindex SPU options
21820 These @samp{-m} options are supported on the SPU:
21822 @table @gcctabopt
21823 @item -mwarn-reloc
21824 @itemx -merror-reloc
21825 @opindex mwarn-reloc
21826 @opindex merror-reloc
21828 The loader for SPU does not handle dynamic relocations.  By default, GCC
21829 gives an error when it generates code that requires a dynamic
21830 relocation.  @option{-mno-error-reloc} disables the error,
21831 @option{-mwarn-reloc} generates a warning instead.
21833 @item -msafe-dma
21834 @itemx -munsafe-dma
21835 @opindex msafe-dma
21836 @opindex munsafe-dma
21838 Instructions that initiate or test completion of DMA must not be
21839 reordered with respect to loads and stores of the memory that is being
21840 accessed.
21841 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21842 memory accesses, but that can lead to inefficient code in places where the
21843 memory is known to not change.  Rather than mark the memory as volatile,
21844 you can use @option{-msafe-dma} to tell the compiler to treat
21845 the DMA instructions as potentially affecting all memory.  
21847 @item -mbranch-hints
21848 @opindex mbranch-hints
21850 By default, GCC generates a branch hint instruction to avoid
21851 pipeline stalls for always-taken or probably-taken branches.  A hint
21852 is not generated closer than 8 instructions away from its branch.
21853 There is little reason to disable them, except for debugging purposes,
21854 or to make an object a little bit smaller.
21856 @item -msmall-mem
21857 @itemx -mlarge-mem
21858 @opindex msmall-mem
21859 @opindex mlarge-mem
21861 By default, GCC generates code assuming that addresses are never larger
21862 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21863 a full 32-bit address.
21865 @item -mstdmain
21866 @opindex mstdmain
21868 By default, GCC links against startup code that assumes the SPU-style
21869 main function interface (which has an unconventional parameter list).
21870 With @option{-mstdmain}, GCC links your program against startup
21871 code that assumes a C99-style interface to @code{main}, including a
21872 local copy of @code{argv} strings.
21874 @item -mfixed-range=@var{register-range}
21875 @opindex mfixed-range
21876 Generate code treating the given register range as fixed registers.
21877 A fixed register is one that the register allocator cannot use.  This is
21878 useful when compiling kernel code.  A register range is specified as
21879 two registers separated by a dash.  Multiple register ranges can be
21880 specified separated by a comma.
21882 @item -mea32
21883 @itemx -mea64
21884 @opindex mea32
21885 @opindex mea64
21886 Compile code assuming that pointers to the PPU address space accessed
21887 via the @code{__ea} named address space qualifier are either 32 or 64
21888 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21889 all object code in an executable must be compiled with the same setting.
21891 @item -maddress-space-conversion
21892 @itemx -mno-address-space-conversion
21893 @opindex maddress-space-conversion
21894 @opindex mno-address-space-conversion
21895 Allow/disallow treating the @code{__ea} address space as superset
21896 of the generic address space.  This enables explicit type casts
21897 between @code{__ea} and generic pointer as well as implicit
21898 conversions of generic pointers to @code{__ea} pointers.  The
21899 default is to allow address space pointer conversions.
21901 @item -mcache-size=@var{cache-size}
21902 @opindex mcache-size
21903 This option controls the version of libgcc that the compiler links to an
21904 executable and selects a software-managed cache for accessing variables
21905 in the @code{__ea} address space with a particular cache size.  Possible
21906 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21907 and @samp{128}.  The default cache size is 64KB.
21909 @item -matomic-updates
21910 @itemx -mno-atomic-updates
21911 @opindex matomic-updates
21912 @opindex mno-atomic-updates
21913 This option controls the version of libgcc that the compiler links to an
21914 executable and selects whether atomic updates to the software-managed
21915 cache of PPU-side variables are used.  If you use atomic updates, changes
21916 to a PPU variable from SPU code using the @code{__ea} named address space
21917 qualifier do not interfere with changes to other PPU variables residing
21918 in the same cache line from PPU code.  If you do not use atomic updates,
21919 such interference may occur; however, writing back cache lines is
21920 more efficient.  The default behavior is to use atomic updates.
21922 @item -mdual-nops
21923 @itemx -mdual-nops=@var{n}
21924 @opindex mdual-nops
21925 By default, GCC inserts nops to increase dual issue when it expects
21926 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21927 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21928 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21930 @item -mhint-max-nops=@var{n}
21931 @opindex mhint-max-nops
21932 Maximum number of nops to insert for a branch hint.  A branch hint must
21933 be at least 8 instructions away from the branch it is affecting.  GCC
21934 inserts up to @var{n} nops to enforce this, otherwise it does not
21935 generate the branch hint.
21937 @item -mhint-max-distance=@var{n}
21938 @opindex mhint-max-distance
21939 The encoding of the branch hint instruction limits the hint to be within
21940 256 instructions of the branch it is affecting.  By default, GCC makes
21941 sure it is within 125.
21943 @item -msafe-hints
21944 @opindex msafe-hints
21945 Work around a hardware bug that causes the SPU to stall indefinitely.
21946 By default, GCC inserts the @code{hbrp} instruction to make sure
21947 this stall won't happen.
21949 @end table
21951 @node System V Options
21952 @subsection Options for System V
21954 These additional options are available on System V Release 4 for
21955 compatibility with other compilers on those systems:
21957 @table @gcctabopt
21958 @item -G
21959 @opindex G
21960 Create a shared object.
21961 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21963 @item -Qy
21964 @opindex Qy
21965 Identify the versions of each tool used by the compiler, in a
21966 @code{.ident} assembler directive in the output.
21968 @item -Qn
21969 @opindex Qn
21970 Refrain from adding @code{.ident} directives to the output file (this is
21971 the default).
21973 @item -YP,@var{dirs}
21974 @opindex YP
21975 Search the directories @var{dirs}, and no others, for libraries
21976 specified with @option{-l}.
21978 @item -Ym,@var{dir}
21979 @opindex Ym
21980 Look in the directory @var{dir} to find the M4 preprocessor.
21981 The assembler uses this option.
21982 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21983 @c the generic assembler that comes with Solaris takes just -Ym.
21984 @end table
21986 @node TILE-Gx Options
21987 @subsection TILE-Gx Options
21988 @cindex TILE-Gx options
21990 These @samp{-m} options are supported on the TILE-Gx:
21992 @table @gcctabopt
21993 @item -mcmodel=small
21994 @opindex mcmodel=small
21995 Generate code for the small model.  The distance for direct calls is
21996 limited to 500M in either direction.  PC-relative addresses are 32
21997 bits.  Absolute addresses support the full address range.
21999 @item -mcmodel=large
22000 @opindex mcmodel=large
22001 Generate code for the large model.  There is no limitation on call
22002 distance, pc-relative addresses, or absolute addresses.
22004 @item -mcpu=@var{name}
22005 @opindex mcpu
22006 Selects the type of CPU to be targeted.  Currently the only supported
22007 type is @samp{tilegx}.
22009 @item -m32
22010 @itemx -m64
22011 @opindex m32
22012 @opindex m64
22013 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22014 environment sets int, long, and pointer to 32 bits.  The 64-bit
22015 environment sets int to 32 bits and long and pointer to 64 bits.
22017 @item -mbig-endian
22018 @itemx -mlittle-endian
22019 @opindex mbig-endian
22020 @opindex mlittle-endian
22021 Generate code in big/little endian mode, respectively.
22022 @end table
22024 @node TILEPro Options
22025 @subsection TILEPro Options
22026 @cindex TILEPro options
22028 These @samp{-m} options are supported on the TILEPro:
22030 @table @gcctabopt
22031 @item -mcpu=@var{name}
22032 @opindex mcpu
22033 Selects the type of CPU to be targeted.  Currently the only supported
22034 type is @samp{tilepro}.
22036 @item -m32
22037 @opindex m32
22038 Generate code for a 32-bit environment, which sets int, long, and
22039 pointer to 32 bits.  This is the only supported behavior so the flag
22040 is essentially ignored.
22041 @end table
22043 @node V850 Options
22044 @subsection V850 Options
22045 @cindex V850 Options
22047 These @samp{-m} options are defined for V850 implementations:
22049 @table @gcctabopt
22050 @item -mlong-calls
22051 @itemx -mno-long-calls
22052 @opindex mlong-calls
22053 @opindex mno-long-calls
22054 Treat all calls as being far away (near).  If calls are assumed to be
22055 far away, the compiler always loads the function's address into a
22056 register, and calls indirect through the pointer.
22058 @item -mno-ep
22059 @itemx -mep
22060 @opindex mno-ep
22061 @opindex mep
22062 Do not optimize (do optimize) basic blocks that use the same index
22063 pointer 4 or more times to copy pointer into the @code{ep} register, and
22064 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22065 option is on by default if you optimize.
22067 @item -mno-prolog-function
22068 @itemx -mprolog-function
22069 @opindex mno-prolog-function
22070 @opindex mprolog-function
22071 Do not use (do use) external functions to save and restore registers
22072 at the prologue and epilogue of a function.  The external functions
22073 are slower, but use less code space if more than one function saves
22074 the same number of registers.  The @option{-mprolog-function} option
22075 is on by default if you optimize.
22077 @item -mspace
22078 @opindex mspace
22079 Try to make the code as small as possible.  At present, this just turns
22080 on the @option{-mep} and @option{-mprolog-function} options.
22082 @item -mtda=@var{n}
22083 @opindex mtda
22084 Put static or global variables whose size is @var{n} bytes or less into
22085 the tiny data area that register @code{ep} points to.  The tiny data
22086 area can hold up to 256 bytes in total (128 bytes for byte references).
22088 @item -msda=@var{n}
22089 @opindex msda
22090 Put static or global variables whose size is @var{n} bytes or less into
22091 the small data area that register @code{gp} points to.  The small data
22092 area can hold up to 64 kilobytes.
22094 @item -mzda=@var{n}
22095 @opindex mzda
22096 Put static or global variables whose size is @var{n} bytes or less into
22097 the first 32 kilobytes of memory.
22099 @item -mv850
22100 @opindex mv850
22101 Specify that the target processor is the V850.
22103 @item -mv850e3v5
22104 @opindex mv850e3v5
22105 Specify that the target processor is the V850E3V5.  The preprocessor
22106 constant @code{__v850e3v5__} is defined if this option is used.
22108 @item -mv850e2v4
22109 @opindex mv850e2v4
22110 Specify that the target processor is the V850E3V5.  This is an alias for
22111 the @option{-mv850e3v5} option.
22113 @item -mv850e2v3
22114 @opindex mv850e2v3
22115 Specify that the target processor is the V850E2V3.  The preprocessor
22116 constant @code{__v850e2v3__} is defined if this option is used.
22118 @item -mv850e2
22119 @opindex mv850e2
22120 Specify that the target processor is the V850E2.  The preprocessor
22121 constant @code{__v850e2__} is defined if this option is used.
22123 @item -mv850e1
22124 @opindex mv850e1
22125 Specify that the target processor is the V850E1.  The preprocessor
22126 constants @code{__v850e1__} and @code{__v850e__} are defined if
22127 this option is used.
22129 @item -mv850es
22130 @opindex mv850es
22131 Specify that the target processor is the V850ES.  This is an alias for
22132 the @option{-mv850e1} option.
22134 @item -mv850e
22135 @opindex mv850e
22136 Specify that the target processor is the V850E@.  The preprocessor
22137 constant @code{__v850e__} is defined if this option is used.
22139 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22140 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22141 are defined then a default target processor is chosen and the
22142 relevant @samp{__v850*__} preprocessor constant is defined.
22144 The preprocessor constants @code{__v850} and @code{__v851__} are always
22145 defined, regardless of which processor variant is the target.
22147 @item -mdisable-callt
22148 @itemx -mno-disable-callt
22149 @opindex mdisable-callt
22150 @opindex mno-disable-callt
22151 This option suppresses generation of the @code{CALLT} instruction for the
22152 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22153 architecture.
22155 This option is enabled by default when the RH850 ABI is
22156 in use (see @option{-mrh850-abi}), and disabled by default when the
22157 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22158 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
22160 @item -mrelax
22161 @itemx -mno-relax
22162 @opindex mrelax
22163 @opindex mno-relax
22164 Pass on (or do not pass on) the @option{-mrelax} command-line option
22165 to the assembler.
22167 @item -mlong-jumps
22168 @itemx -mno-long-jumps
22169 @opindex mlong-jumps
22170 @opindex mno-long-jumps
22171 Disable (or re-enable) the generation of PC-relative jump instructions.
22173 @item -msoft-float
22174 @itemx -mhard-float
22175 @opindex msoft-float
22176 @opindex mhard-float
22177 Disable (or re-enable) the generation of hardware floating point
22178 instructions.  This option is only significant when the target
22179 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22180 instructions are being generated then the C preprocessor symbol
22181 @code{__FPU_OK__} is defined, otherwise the symbol
22182 @code{__NO_FPU__} is defined.
22184 @item -mloop
22185 @opindex mloop
22186 Enables the use of the e3v5 LOOP instruction.  The use of this
22187 instruction is not enabled by default when the e3v5 architecture is
22188 selected because its use is still experimental.
22190 @item -mrh850-abi
22191 @itemx -mghs
22192 @opindex mrh850-abi
22193 @opindex mghs
22194 Enables support for the RH850 version of the V850 ABI.  This is the
22195 default.  With this version of the ABI the following rules apply:
22197 @itemize
22198 @item
22199 Integer sized structures and unions are returned via a memory pointer
22200 rather than a register.
22202 @item
22203 Large structures and unions (more than 8 bytes in size) are passed by
22204 value.
22206 @item
22207 Functions are aligned to 16-bit boundaries.
22209 @item
22210 The @option{-m8byte-align} command-line option is supported.
22212 @item
22213 The @option{-mdisable-callt} command-line option is enabled by
22214 default.  The @option{-mno-disable-callt} command-line option is not
22215 supported.
22216 @end itemize
22218 When this version of the ABI is enabled the C preprocessor symbol
22219 @code{__V850_RH850_ABI__} is defined.
22221 @item -mgcc-abi
22222 @opindex mgcc-abi
22223 Enables support for the old GCC version of the V850 ABI.  With this
22224 version of the ABI the following rules apply:
22226 @itemize
22227 @item
22228 Integer sized structures and unions are returned in register @code{r10}.
22230 @item
22231 Large structures and unions (more than 8 bytes in size) are passed by
22232 reference.
22234 @item
22235 Functions are aligned to 32-bit boundaries, unless optimizing for
22236 size.
22238 @item
22239 The @option{-m8byte-align} command-line option is not supported.
22241 @item
22242 The @option{-mdisable-callt} command-line option is supported but not
22243 enabled by default.
22244 @end itemize
22246 When this version of the ABI is enabled the C preprocessor symbol
22247 @code{__V850_GCC_ABI__} is defined.
22249 @item -m8byte-align
22250 @itemx -mno-8byte-align
22251 @opindex m8byte-align
22252 @opindex mno-8byte-align
22253 Enables support for @code{double} and @code{long long} types to be
22254 aligned on 8-byte boundaries.  The default is to restrict the
22255 alignment of all objects to at most 4-bytes.  When
22256 @option{-m8byte-align} is in effect the C preprocessor symbol
22257 @code{__V850_8BYTE_ALIGN__} is defined.
22259 @item -mbig-switch
22260 @opindex mbig-switch
22261 Generate code suitable for big switch tables.  Use this option only if
22262 the assembler/linker complain about out of range branches within a switch
22263 table.
22265 @item -mapp-regs
22266 @opindex mapp-regs
22267 This option causes r2 and r5 to be used in the code generated by
22268 the compiler.  This setting is the default.
22270 @item -mno-app-regs
22271 @opindex mno-app-regs
22272 This option causes r2 and r5 to be treated as fixed registers.
22274 @end table
22276 @node VAX Options
22277 @subsection VAX Options
22278 @cindex VAX options
22280 These @samp{-m} options are defined for the VAX:
22282 @table @gcctabopt
22283 @item -munix
22284 @opindex munix
22285 Do not output certain jump instructions (@code{aobleq} and so on)
22286 that the Unix assembler for the VAX cannot handle across long
22287 ranges.
22289 @item -mgnu
22290 @opindex mgnu
22291 Do output those jump instructions, on the assumption that the
22292 GNU assembler is being used.
22294 @item -mg
22295 @opindex mg
22296 Output code for G-format floating-point numbers instead of D-format.
22297 @end table
22299 @node Visium Options
22300 @subsection Visium Options
22301 @cindex Visium options
22303 @table @gcctabopt
22305 @item -mdebug
22306 @opindex mdebug
22307 A program which performs file I/O and is destined to run on an MCM target
22308 should be linked with this option.  It causes the libraries libc.a and
22309 libdebug.a to be linked.  The program should be run on the target under
22310 the control of the GDB remote debugging stub.
22312 @item -msim
22313 @opindex msim
22314 A program which performs file I/O and is destined to run on the simulator
22315 should be linked with option.  This causes libraries libc.a and libsim.a to
22316 be linked.
22318 @item -mfpu
22319 @itemx -mhard-float
22320 @opindex mfpu
22321 @opindex mhard-float
22322 Generate code containing floating-point instructions.  This is the
22323 default.
22325 @item -mno-fpu
22326 @itemx -msoft-float
22327 @opindex mno-fpu
22328 @opindex msoft-float
22329 Generate code containing library calls for floating-point.
22331 @option{-msoft-float} changes the calling convention in the output file;
22332 therefore, it is only useful if you compile @emph{all} of a program with
22333 this option.  In particular, you need to compile @file{libgcc.a}, the
22334 library that comes with GCC, with @option{-msoft-float} in order for
22335 this to work.
22337 @item -mcpu=@var{cpu_type}
22338 @opindex mcpu
22339 Set the instruction set, register set, and instruction scheduling parameters
22340 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22341 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22343 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22345 By default (unless configured otherwise), GCC generates code for the GR5
22346 variant of the Visium architecture.  
22348 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22349 architecture.  The only difference from GR5 code is that the compiler will
22350 generate block move instructions.
22352 @item -mtune=@var{cpu_type}
22353 @opindex mtune
22354 Set the instruction scheduling parameters for machine type @var{cpu_type},
22355 but do not set the instruction set or register set that the option
22356 @option{-mcpu=@var{cpu_type}} would.
22358 @item -msv-mode
22359 @opindex msv-mode
22360 Generate code for the supervisor mode, where there are no restrictions on
22361 the access to general registers.  This is the default.
22363 @item -muser-mode
22364 @opindex muser-mode
22365 Generate code for the user mode, where the access to some general registers
22366 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22367 mode; on the GR6, only registers r29 to r31 are affected.
22368 @end table
22370 @node VMS Options
22371 @subsection VMS Options
22373 These @samp{-m} options are defined for the VMS implementations:
22375 @table @gcctabopt
22376 @item -mvms-return-codes
22377 @opindex mvms-return-codes
22378 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22379 condition (e.g.@ error) codes.
22381 @item -mdebug-main=@var{prefix}
22382 @opindex mdebug-main=@var{prefix}
22383 Flag the first routine whose name starts with @var{prefix} as the main
22384 routine for the debugger.
22386 @item -mmalloc64
22387 @opindex mmalloc64
22388 Default to 64-bit memory allocation routines.
22390 @item -mpointer-size=@var{size}
22391 @opindex mpointer-size=@var{size}
22392 Set the default size of pointers. Possible options for @var{size} are
22393 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22394 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22395 The later option disables @code{pragma pointer_size}.
22396 @end table
22398 @node VxWorks Options
22399 @subsection VxWorks Options
22400 @cindex VxWorks Options
22402 The options in this section are defined for all VxWorks targets.
22403 Options specific to the target hardware are listed with the other
22404 options for that target.
22406 @table @gcctabopt
22407 @item -mrtp
22408 @opindex mrtp
22409 GCC can generate code for both VxWorks kernels and real time processes
22410 (RTPs).  This option switches from the former to the latter.  It also
22411 defines the preprocessor macro @code{__RTP__}.
22413 @item -non-static
22414 @opindex non-static
22415 Link an RTP executable against shared libraries rather than static
22416 libraries.  The options @option{-static} and @option{-shared} can
22417 also be used for RTPs (@pxref{Link Options}); @option{-static}
22418 is the default.
22420 @item -Bstatic
22421 @itemx -Bdynamic
22422 @opindex Bstatic
22423 @opindex Bdynamic
22424 These options are passed down to the linker.  They are defined for
22425 compatibility with Diab.
22427 @item -Xbind-lazy
22428 @opindex Xbind-lazy
22429 Enable lazy binding of function calls.  This option is equivalent to
22430 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22432 @item -Xbind-now
22433 @opindex Xbind-now
22434 Disable lazy binding of function calls.  This option is the default and
22435 is defined for compatibility with Diab.
22436 @end table
22438 @node x86 Options
22439 @subsection x86 Options
22440 @cindex x86 Options
22442 These @samp{-m} options are defined for the x86 family of computers.
22444 @table @gcctabopt
22446 @item -march=@var{cpu-type}
22447 @opindex march
22448 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22449 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22450 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22451 to generate code that may not run at all on processors other than the one
22452 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22453 @option{-mtune=@var{cpu-type}}.
22455 The choices for @var{cpu-type} are:
22457 @table @samp
22458 @item native
22459 This selects the CPU to generate code for at compilation time by determining
22460 the processor type of the compiling machine.  Using @option{-march=native}
22461 enables all instruction subsets supported by the local machine (hence
22462 the result might not run on different machines).  Using @option{-mtune=native}
22463 produces code optimized for the local machine under the constraints
22464 of the selected instruction set.  
22466 @item i386
22467 Original Intel i386 CPU@.
22469 @item i486
22470 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22472 @item i586
22473 @itemx pentium
22474 Intel Pentium CPU with no MMX support.
22476 @item lakemont
22477 Intel Lakemont MCU, based on Intel Pentium CPU.
22479 @item pentium-mmx
22480 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22482 @item pentiumpro
22483 Intel Pentium Pro CPU@.
22485 @item i686
22486 When used with @option{-march}, the Pentium Pro
22487 instruction set is used, so the code runs on all i686 family chips.
22488 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22490 @item pentium2
22491 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22492 support.
22494 @item pentium3
22495 @itemx pentium3m
22496 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22497 set support.
22499 @item pentium-m
22500 Intel Pentium M; low-power version of Intel Pentium III CPU
22501 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22503 @item pentium4
22504 @itemx pentium4m
22505 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22507 @item prescott
22508 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22509 set support.
22511 @item nocona
22512 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22513 SSE2 and SSE3 instruction set support.
22515 @item core2
22516 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22517 instruction set support.
22519 @item nehalem
22520 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22521 SSE4.1, SSE4.2 and POPCNT instruction set support.
22523 @item westmere
22524 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22525 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22527 @item sandybridge
22528 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22529 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22531 @item ivybridge
22532 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22533 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22534 instruction set support.
22536 @item haswell
22537 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22538 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22539 BMI, BMI2 and F16C instruction set support.
22541 @item broadwell
22542 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22543 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22544 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22546 @item skylake
22547 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22548 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22549 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
22550 XSAVES instruction set support.
22552 @item bonnell
22553 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22554 instruction set support.
22556 @item silvermont
22557 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22558 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22560 @item knl
22561 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22562 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22563 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22564 AVX512CD instruction set support.
22566 @item skylake-avx512
22567 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22568 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22569 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
22570 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
22572 @item k6
22573 AMD K6 CPU with MMX instruction set support.
22575 @item k6-2
22576 @itemx k6-3
22577 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22579 @item athlon
22580 @itemx athlon-tbird
22581 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22582 support.
22584 @item athlon-4
22585 @itemx athlon-xp
22586 @itemx athlon-mp
22587 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22588 instruction set support.
22590 @item k8
22591 @itemx opteron
22592 @itemx athlon64
22593 @itemx athlon-fx
22594 Processors based on the AMD K8 core with x86-64 instruction set support,
22595 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22596 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22597 instruction set extensions.)
22599 @item k8-sse3
22600 @itemx opteron-sse3
22601 @itemx athlon64-sse3
22602 Improved versions of AMD K8 cores with SSE3 instruction set support.
22604 @item amdfam10
22605 @itemx barcelona
22606 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22607 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22608 instruction set extensions.)
22610 @item bdver1
22611 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22612 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22613 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22614 @item bdver2
22615 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22616 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22617 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22618 extensions.)
22619 @item bdver3
22620 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22621 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22622 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22623 64-bit instruction set extensions.
22624 @item bdver4
22625 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22626 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22627 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22628 SSE4.2, ABM and 64-bit instruction set extensions.
22630 @item znver1
22631 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
22632 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
22633 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
22634 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
22635 instruction set extensions.
22637 @item btver1
22638 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22639 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22640 instruction set extensions.)
22642 @item btver2
22643 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22644 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22645 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22647 @item winchip-c6
22648 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22649 set support.
22651 @item winchip2
22652 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22653 instruction set support.
22655 @item c3
22656 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22657 implemented for this chip.)
22659 @item c3-2
22660 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22661 (No scheduling is
22662 implemented for this chip.)
22664 @item geode
22665 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22666 @end table
22668 @item -mtune=@var{cpu-type}
22669 @opindex mtune
22670 Tune to @var{cpu-type} everything applicable about the generated code, except
22671 for the ABI and the set of available instructions.  
22672 While picking a specific @var{cpu-type} schedules things appropriately
22673 for that particular chip, the compiler does not generate any code that
22674 cannot run on the default machine type unless you use a
22675 @option{-march=@var{cpu-type}} option.
22676 For example, if GCC is configured for i686-pc-linux-gnu
22677 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22678 but still runs on i686 machines.
22680 The choices for @var{cpu-type} are the same as for @option{-march}.
22681 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22683 @table @samp
22684 @item generic
22685 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22686 If you know the CPU on which your code will run, then you should use
22687 the corresponding @option{-mtune} or @option{-march} option instead of
22688 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22689 of your application will have, then you should use this option.
22691 As new processors are deployed in the marketplace, the behavior of this
22692 option will change.  Therefore, if you upgrade to a newer version of
22693 GCC, code generation controlled by this option will change to reflect
22694 the processors
22695 that are most common at the time that version of GCC is released.
22697 There is no @option{-march=generic} option because @option{-march}
22698 indicates the instruction set the compiler can use, and there is no
22699 generic instruction set applicable to all processors.  In contrast,
22700 @option{-mtune} indicates the processor (or, in this case, collection of
22701 processors) for which the code is optimized.
22703 @item intel
22704 Produce code optimized for the most current Intel processors, which are
22705 Haswell and Silvermont for this version of GCC.  If you know the CPU
22706 on which your code will run, then you should use the corresponding
22707 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22708 But, if you want your application performs better on both Haswell and
22709 Silvermont, then you should use this option.
22711 As new Intel processors are deployed in the marketplace, the behavior of
22712 this option will change.  Therefore, if you upgrade to a newer version of
22713 GCC, code generation controlled by this option will change to reflect
22714 the most current Intel processors at the time that version of GCC is
22715 released.
22717 There is no @option{-march=intel} option because @option{-march} indicates
22718 the instruction set the compiler can use, and there is no common
22719 instruction set applicable to all processors.  In contrast,
22720 @option{-mtune} indicates the processor (or, in this case, collection of
22721 processors) for which the code is optimized.
22722 @end table
22724 @item -mcpu=@var{cpu-type}
22725 @opindex mcpu
22726 A deprecated synonym for @option{-mtune}.
22728 @item -mfpmath=@var{unit}
22729 @opindex mfpmath
22730 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22731 for @var{unit} are:
22733 @table @samp
22734 @item 387
22735 Use the standard 387 floating-point coprocessor present on the majority of chips and
22736 emulated otherwise.  Code compiled with this option runs almost everywhere.
22737 The temporary results are computed in 80-bit precision instead of the precision
22738 specified by the type, resulting in slightly different results compared to most
22739 of other chips.  See @option{-ffloat-store} for more detailed description.
22741 This is the default choice for x86-32 targets.
22743 @item sse
22744 Use scalar floating-point instructions present in the SSE instruction set.
22745 This instruction set is supported by Pentium III and newer chips,
22746 and in the AMD line
22747 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22748 instruction set supports only single-precision arithmetic, thus the double and
22749 extended-precision arithmetic are still done using 387.  A later version, present
22750 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22751 arithmetic too.
22753 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22754 or @option{-msse2} switches to enable SSE extensions and make this option
22755 effective.  For the x86-64 compiler, these extensions are enabled by default.
22757 The resulting code should be considerably faster in the majority of cases and avoid
22758 the numerical instability problems of 387 code, but may break some existing
22759 code that expects temporaries to be 80 bits.
22761 This is the default choice for the x86-64 compiler.
22763 @item sse,387
22764 @itemx sse+387
22765 @itemx both
22766 Attempt to utilize both instruction sets at once.  This effectively doubles the
22767 amount of available registers, and on chips with separate execution units for
22768 387 and SSE the execution resources too.  Use this option with care, as it is
22769 still experimental, because the GCC register allocator does not model separate
22770 functional units well, resulting in unstable performance.
22771 @end table
22773 @item -masm=@var{dialect}
22774 @opindex masm=@var{dialect}
22775 Output assembly instructions using selected @var{dialect}.  Also affects
22776 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22777 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22778 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22779 not support @samp{intel}.
22781 @item -mieee-fp
22782 @itemx -mno-ieee-fp
22783 @opindex mieee-fp
22784 @opindex mno-ieee-fp
22785 Control whether or not the compiler uses IEEE floating-point
22786 comparisons.  These correctly handle the case where the result of a
22787 comparison is unordered.
22789 @item -msoft-float
22790 @opindex msoft-float
22791 Generate output containing library calls for floating point.
22793 @strong{Warning:} the requisite libraries are not part of GCC@.
22794 Normally the facilities of the machine's usual C compiler are used, but
22795 this can't be done directly in cross-compilation.  You must make your
22796 own arrangements to provide suitable library functions for
22797 cross-compilation.
22799 On machines where a function returns floating-point results in the 80387
22800 register stack, some floating-point opcodes may be emitted even if
22801 @option{-msoft-float} is used.
22803 @item -mno-fp-ret-in-387
22804 @opindex mno-fp-ret-in-387
22805 Do not use the FPU registers for return values of functions.
22807 The usual calling convention has functions return values of types
22808 @code{float} and @code{double} in an FPU register, even if there
22809 is no FPU@.  The idea is that the operating system should emulate
22810 an FPU@.
22812 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22813 in ordinary CPU registers instead.
22815 @item -mno-fancy-math-387
22816 @opindex mno-fancy-math-387
22817 Some 387 emulators do not support the @code{sin}, @code{cos} and
22818 @code{sqrt} instructions for the 387.  Specify this option to avoid
22819 generating those instructions.  This option is the default on
22820 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22821 indicates that the target CPU always has an FPU and so the
22822 instruction does not need emulation.  These
22823 instructions are not generated unless you also use the
22824 @option{-funsafe-math-optimizations} switch.
22826 @item -malign-double
22827 @itemx -mno-align-double
22828 @opindex malign-double
22829 @opindex mno-align-double
22830 Control whether GCC aligns @code{double}, @code{long double}, and
22831 @code{long long} variables on a two-word boundary or a one-word
22832 boundary.  Aligning @code{double} variables on a two-word boundary
22833 produces code that runs somewhat faster on a Pentium at the
22834 expense of more memory.
22836 On x86-64, @option{-malign-double} is enabled by default.
22838 @strong{Warning:} if you use the @option{-malign-double} switch,
22839 structures containing the above types are aligned differently than
22840 the published application binary interface specifications for the x86-32
22841 and are not binary compatible with structures in code compiled
22842 without that switch.
22844 @item -m96bit-long-double
22845 @itemx -m128bit-long-double
22846 @opindex m96bit-long-double
22847 @opindex m128bit-long-double
22848 These switches control the size of @code{long double} type.  The x86-32
22849 application binary interface specifies the size to be 96 bits,
22850 so @option{-m96bit-long-double} is the default in 32-bit mode.
22852 Modern architectures (Pentium and newer) prefer @code{long double}
22853 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22854 conforming to the ABI, this is not possible.  So specifying
22855 @option{-m128bit-long-double} aligns @code{long double}
22856 to a 16-byte boundary by padding the @code{long double} with an additional
22857 32-bit zero.
22859 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22860 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22862 Notice that neither of these options enable any extra precision over the x87
22863 standard of 80 bits for a @code{long double}.
22865 @strong{Warning:} if you override the default value for your target ABI, this
22866 changes the size of 
22867 structures and arrays containing @code{long double} variables,
22868 as well as modifying the function calling convention for functions taking
22869 @code{long double}.  Hence they are not binary-compatible
22870 with code compiled without that switch.
22872 @item -mlong-double-64
22873 @itemx -mlong-double-80
22874 @itemx -mlong-double-128
22875 @opindex mlong-double-64
22876 @opindex mlong-double-80
22877 @opindex mlong-double-128
22878 These switches control the size of @code{long double} type. A size
22879 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22880 type. This is the default for 32-bit Bionic C library.  A size
22881 of 128 bits makes the @code{long double} type equivalent to the
22882 @code{__float128} type. This is the default for 64-bit Bionic C library.
22884 @strong{Warning:} if you override the default value for your target ABI, this
22885 changes the size of
22886 structures and arrays containing @code{long double} variables,
22887 as well as modifying the function calling convention for functions taking
22888 @code{long double}.  Hence they are not binary-compatible
22889 with code compiled without that switch.
22891 @item -malign-data=@var{type}
22892 @opindex malign-data
22893 Control how GCC aligns variables.  Supported values for @var{type} are
22894 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22895 and earlier, @samp{abi} uses alignment value as specified by the
22896 psABI, and @samp{cacheline} uses increased alignment value to match
22897 the cache line size.  @samp{compat} is the default.
22899 @item -mlarge-data-threshold=@var{threshold}
22900 @opindex mlarge-data-threshold
22901 When @option{-mcmodel=medium} is specified, data objects larger than
22902 @var{threshold} are placed in the large data section.  This value must be the
22903 same across all objects linked into the binary, and defaults to 65535.
22905 @item -mrtd
22906 @opindex mrtd
22907 Use a different function-calling convention, in which functions that
22908 take a fixed number of arguments return with the @code{ret @var{num}}
22909 instruction, which pops their arguments while returning.  This saves one
22910 instruction in the caller since there is no need to pop the arguments
22911 there.
22913 You can specify that an individual function is called with this calling
22914 sequence with the function attribute @code{stdcall}.  You can also
22915 override the @option{-mrtd} option by using the function attribute
22916 @code{cdecl}.  @xref{Function Attributes}.
22918 @strong{Warning:} this calling convention is incompatible with the one
22919 normally used on Unix, so you cannot use it if you need to call
22920 libraries compiled with the Unix compiler.
22922 Also, you must provide function prototypes for all functions that
22923 take variable numbers of arguments (including @code{printf});
22924 otherwise incorrect code is generated for calls to those
22925 functions.
22927 In addition, seriously incorrect code results if you call a
22928 function with too many arguments.  (Normally, extra arguments are
22929 harmlessly ignored.)
22931 @item -mregparm=@var{num}
22932 @opindex mregparm
22933 Control how many registers are used to pass integer arguments.  By
22934 default, no registers are used to pass arguments, and at most 3
22935 registers can be used.  You can control this behavior for a specific
22936 function by using the function attribute @code{regparm}.
22937 @xref{Function Attributes}.
22939 @strong{Warning:} if you use this switch, and
22940 @var{num} is nonzero, then you must build all modules with the same
22941 value, including any libraries.  This includes the system libraries and
22942 startup modules.
22944 @item -msseregparm
22945 @opindex msseregparm
22946 Use SSE register passing conventions for float and double arguments
22947 and return values.  You can control this behavior for a specific
22948 function by using the function attribute @code{sseregparm}.
22949 @xref{Function Attributes}.
22951 @strong{Warning:} if you use this switch then you must build all
22952 modules with the same value, including any libraries.  This includes
22953 the system libraries and startup modules.
22955 @item -mvect8-ret-in-mem
22956 @opindex mvect8-ret-in-mem
22957 Return 8-byte vectors in memory instead of MMX registers.  This is the
22958 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22959 Studio compilers until version 12.  Later compiler versions (starting
22960 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22961 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22962 you need to remain compatible with existing code produced by those
22963 previous compiler versions or older versions of GCC@.
22965 @item -mpc32
22966 @itemx -mpc64
22967 @itemx -mpc80
22968 @opindex mpc32
22969 @opindex mpc64
22970 @opindex mpc80
22972 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22973 is specified, the significands of results of floating-point operations are
22974 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22975 significands of results of floating-point operations to 53 bits (double
22976 precision) and @option{-mpc80} rounds the significands of results of
22977 floating-point operations to 64 bits (extended double precision), which is
22978 the default.  When this option is used, floating-point operations in higher
22979 precisions are not available to the programmer without setting the FPU
22980 control word explicitly.
22982 Setting the rounding of floating-point operations to less than the default
22983 80 bits can speed some programs by 2% or more.  Note that some mathematical
22984 libraries assume that extended-precision (80-bit) floating-point operations
22985 are enabled by default; routines in such libraries could suffer significant
22986 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22987 when this option is used to set the precision to less than extended precision.
22989 @item -mstackrealign
22990 @opindex mstackrealign
22991 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22992 option generates an alternate prologue and epilogue that realigns the
22993 run-time stack if necessary.  This supports mixing legacy codes that keep
22994 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22995 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22996 applicable to individual functions.
22998 @item -mpreferred-stack-boundary=@var{num}
22999 @opindex mpreferred-stack-boundary
23000 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
23001 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
23002 the default is 4 (16 bytes or 128 bits).
23004 @strong{Warning:} When generating code for the x86-64 architecture with
23005 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
23006 used to keep the stack boundary aligned to 8 byte boundary.  Since
23007 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
23008 intended to be used in controlled environment where stack space is
23009 important limitation.  This option leads to wrong code when functions
23010 compiled with 16 byte stack alignment (such as functions from a standard
23011 library) are called with misaligned stack.  In this case, SSE
23012 instructions may lead to misaligned memory access traps.  In addition,
23013 variable arguments are handled incorrectly for 16 byte aligned
23014 objects (including x87 long double and __int128), leading to wrong
23015 results.  You must build all modules with
23016 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
23017 includes the system libraries and startup modules.
23019 @item -mincoming-stack-boundary=@var{num}
23020 @opindex mincoming-stack-boundary
23021 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
23022 boundary.  If @option{-mincoming-stack-boundary} is not specified,
23023 the one specified by @option{-mpreferred-stack-boundary} is used.
23025 On Pentium and Pentium Pro, @code{double} and @code{long double} values
23026 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
23027 suffer significant run time performance penalties.  On Pentium III, the
23028 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
23029 properly if it is not 16-byte aligned.
23031 To ensure proper alignment of this values on the stack, the stack boundary
23032 must be as aligned as that required by any value stored on the stack.
23033 Further, every function must be generated such that it keeps the stack
23034 aligned.  Thus calling a function compiled with a higher preferred
23035 stack boundary from a function compiled with a lower preferred stack
23036 boundary most likely misaligns the stack.  It is recommended that
23037 libraries that use callbacks always use the default setting.
23039 This extra alignment does consume extra stack space, and generally
23040 increases code size.  Code that is sensitive to stack space usage, such
23041 as embedded systems and operating system kernels, may want to reduce the
23042 preferred alignment to @option{-mpreferred-stack-boundary=2}.
23044 @need 200
23045 @item -mmmx
23046 @opindex mmmx
23047 @need 200
23048 @itemx -msse
23049 @opindex msse
23050 @need 200
23051 @itemx -msse2
23052 @opindex msse2
23053 @need 200
23054 @itemx -msse3
23055 @opindex msse3
23056 @need 200
23057 @itemx -mssse3
23058 @opindex mssse3
23059 @need 200
23060 @itemx -msse4
23061 @opindex msse4
23062 @need 200
23063 @itemx -msse4a
23064 @opindex msse4a
23065 @need 200
23066 @itemx -msse4.1
23067 @opindex msse4.1
23068 @need 200
23069 @itemx -msse4.2
23070 @opindex msse4.2
23071 @need 200
23072 @itemx -mavx
23073 @opindex mavx
23074 @need 200
23075 @itemx -mavx2
23076 @opindex mavx2
23077 @need 200
23078 @itemx -mavx512f
23079 @opindex mavx512f
23080 @need 200
23081 @itemx -mavx512pf
23082 @opindex mavx512pf
23083 @need 200
23084 @itemx -mavx512er
23085 @opindex mavx512er
23086 @need 200
23087 @itemx -mavx512cd
23088 @opindex mavx512cd
23089 @need 200
23090 @itemx -mavx512vl
23091 @opindex mavx512vl
23092 @need 200
23093 @itemx -mavx512bw
23094 @opindex mavx512bw
23095 @need 200
23096 @itemx -mavx512dq
23097 @opindex mavx512dq
23098 @need 200
23099 @itemx -mavx512ifma
23100 @opindex mavx512ifma
23101 @need 200
23102 @itemx -mavx512vbmi
23103 @opindex mavx512vbmi
23104 @need 200
23105 @itemx -msha
23106 @opindex msha
23107 @need 200
23108 @itemx -maes
23109 @opindex maes
23110 @need 200
23111 @itemx -mpclmul
23112 @opindex mpclmul
23113 @need 200
23114 @itemx -mclfushopt
23115 @opindex mclfushopt
23116 @need 200
23117 @itemx -mfsgsbase
23118 @opindex mfsgsbase
23119 @need 200
23120 @itemx -mrdrnd
23121 @opindex mrdrnd
23122 @need 200
23123 @itemx -mf16c
23124 @opindex mf16c
23125 @need 200
23126 @itemx -mfma
23127 @opindex mfma
23128 @need 200
23129 @itemx -mfma4
23130 @opindex mfma4
23131 @need 200
23132 @itemx -mno-fma4
23133 @opindex mno-fma4
23134 @need 200
23135 @itemx -mprefetchwt1
23136 @opindex mprefetchwt1
23137 @need 200
23138 @itemx -mxop
23139 @opindex mxop
23140 @need 200
23141 @itemx -mlwp
23142 @opindex mlwp
23143 @need 200
23144 @itemx -m3dnow
23145 @opindex m3dnow
23146 @need 200
23147 @itemx -mpopcnt
23148 @opindex mpopcnt
23149 @need 200
23150 @itemx -mabm
23151 @opindex mabm
23152 @need 200
23153 @itemx -mbmi
23154 @opindex mbmi
23155 @need 200
23156 @itemx -mbmi2
23157 @need 200
23158 @itemx -mlzcnt
23159 @opindex mlzcnt
23160 @need 200
23161 @itemx -mfxsr
23162 @opindex mfxsr
23163 @need 200
23164 @itemx -mxsave
23165 @opindex mxsave
23166 @need 200
23167 @itemx -mxsaveopt
23168 @opindex mxsaveopt
23169 @need 200
23170 @itemx -mxsavec
23171 @opindex mxsavec
23172 @need 200
23173 @itemx -mxsaves
23174 @opindex mxsaves
23175 @need 200
23176 @itemx -mrtm
23177 @opindex mrtm
23178 @need 200
23179 @itemx -mtbm
23180 @opindex mtbm
23181 @need 200
23182 @itemx -mmpx
23183 @opindex mmpx
23184 @need 200
23185 @itemx -mmwaitx
23186 @opindex mmwaitx
23187 These switches enable the use of instructions in the MMX, SSE,
23188 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
23189 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
23190 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
23191 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX or 3DNow!@:
23192 extended instruction sets.  Each has a corresponding @option{-mno-} option
23193 to disable use of these instructions.
23195 These extensions are also available as built-in functions: see
23196 @ref{x86 Built-in Functions}, for details of the functions enabled and
23197 disabled by these switches.
23199 To generate SSE/SSE2 instructions automatically from floating-point
23200 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
23202 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
23203 generates new AVX instructions or AVX equivalence for all SSEx instructions
23204 when needed.
23206 These options enable GCC to use these extended instructions in
23207 generated code, even without @option{-mfpmath=sse}.  Applications that
23208 perform run-time CPU detection must compile separate files for each
23209 supported architecture, using the appropriate flags.  In particular,
23210 the file containing the CPU detection code should be compiled without
23211 these options.
23213 @item -mdump-tune-features
23214 @opindex mdump-tune-features
23215 This option instructs GCC to dump the names of the x86 performance 
23216 tuning features and default settings. The names can be used in 
23217 @option{-mtune-ctrl=@var{feature-list}}.
23219 @item -mtune-ctrl=@var{feature-list}
23220 @opindex mtune-ctrl=@var{feature-list}
23221 This option is used to do fine grain control of x86 code generation features.
23222 @var{feature-list} is a comma separated list of @var{feature} names. See also
23223 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
23224 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
23225 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
23226 developers. Using it may lead to code paths not covered by testing and can
23227 potentially result in compiler ICEs or runtime errors.
23229 @item -mno-default
23230 @opindex mno-default
23231 This option instructs GCC to turn off all tunable features. See also 
23232 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
23234 @item -mcld
23235 @opindex mcld
23236 This option instructs GCC to emit a @code{cld} instruction in the prologue
23237 of functions that use string instructions.  String instructions depend on
23238 the DF flag to select between autoincrement or autodecrement mode.  While the
23239 ABI specifies the DF flag to be cleared on function entry, some operating
23240 systems violate this specification by not clearing the DF flag in their
23241 exception dispatchers.  The exception handler can be invoked with the DF flag
23242 set, which leads to wrong direction mode when string instructions are used.
23243 This option can be enabled by default on 32-bit x86 targets by configuring
23244 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
23245 instructions can be suppressed with the @option{-mno-cld} compiler option
23246 in this case.
23248 @item -mvzeroupper
23249 @opindex mvzeroupper
23250 This option instructs GCC to emit a @code{vzeroupper} instruction
23251 before a transfer of control flow out of the function to minimize
23252 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
23253 intrinsics.
23255 @item -mprefer-avx128
23256 @opindex mprefer-avx128
23257 This option instructs GCC to use 128-bit AVX instructions instead of
23258 256-bit AVX instructions in the auto-vectorizer.
23260 @item -mcx16
23261 @opindex mcx16
23262 This option enables GCC to generate @code{CMPXCHG16B} instructions.
23263 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
23264 (or oword) data types.  
23265 This is useful for high-resolution counters that can be updated
23266 by multiple processors (or cores).  This instruction is generated as part of
23267 atomic built-in functions: see @ref{__sync Builtins} or
23268 @ref{__atomic Builtins} for details.
23270 @item -msahf
23271 @opindex msahf
23272 This option enables generation of @code{SAHF} instructions in 64-bit code.
23273 Early Intel Pentium 4 CPUs with Intel 64 support,
23274 prior to the introduction of Pentium 4 G1 step in December 2005,
23275 lacked the @code{LAHF} and @code{SAHF} instructions
23276 which are supported by AMD64.
23277 These are load and store instructions, respectively, for certain status flags.
23278 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
23279 @code{drem}, and @code{remainder} built-in functions;
23280 see @ref{Other Builtins} for details.
23282 @item -mmovbe
23283 @opindex mmovbe
23284 This option enables use of the @code{movbe} instruction to implement
23285 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
23287 @item -mcrc32
23288 @opindex mcrc32
23289 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23290 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23291 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23293 @item -mrecip
23294 @opindex mrecip
23295 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23296 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23297 with an additional Newton-Raphson step
23298 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23299 (and their vectorized
23300 variants) for single-precision floating-point arguments.  These instructions
23301 are generated only when @option{-funsafe-math-optimizations} is enabled
23302 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
23303 Note that while the throughput of the sequence is higher than the throughput
23304 of the non-reciprocal instruction, the precision of the sequence can be
23305 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23307 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23308 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23309 combination), and doesn't need @option{-mrecip}.
23311 Also note that GCC emits the above sequence with additional Newton-Raphson step
23312 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23313 already with @option{-ffast-math} (or the above option combination), and
23314 doesn't need @option{-mrecip}.
23316 @item -mrecip=@var{opt}
23317 @opindex mrecip=opt
23318 This option controls which reciprocal estimate instructions
23319 may be used.  @var{opt} is a comma-separated list of options, which may
23320 be preceded by a @samp{!} to invert the option:
23322 @table @samp
23323 @item all
23324 Enable all estimate instructions.
23326 @item default
23327 Enable the default instructions, equivalent to @option{-mrecip}.
23329 @item none
23330 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23332 @item div
23333 Enable the approximation for scalar division.
23335 @item vec-div
23336 Enable the approximation for vectorized division.
23338 @item sqrt
23339 Enable the approximation for scalar square root.
23341 @item vec-sqrt
23342 Enable the approximation for vectorized square root.
23343 @end table
23345 So, for example, @option{-mrecip=all,!sqrt} enables
23346 all of the reciprocal approximations, except for square root.
23348 @item -mveclibabi=@var{type}
23349 @opindex mveclibabi
23350 Specifies the ABI type to use for vectorizing intrinsics using an
23351 external library.  Supported values for @var{type} are @samp{svml} 
23352 for the Intel short
23353 vector math library and @samp{acml} for the AMD math core library.
23354 To use this option, both @option{-ftree-vectorize} and
23355 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23356 ABI-compatible library must be specified at link time.
23358 GCC currently emits calls to @code{vmldExp2},
23359 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23360 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23361 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23362 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23363 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23364 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23365 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23366 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23367 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23368 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23369 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23370 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23371 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23372 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23373 when @option{-mveclibabi=acml} is used.  
23375 @item -mabi=@var{name}
23376 @opindex mabi
23377 Generate code for the specified calling convention.  Permissible values
23378 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23379 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23380 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23381 You can control this behavior for specific functions by
23382 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23383 @xref{Function Attributes}.
23385 @item -mtls-dialect=@var{type}
23386 @opindex mtls-dialect
23387 Generate code to access thread-local storage using the @samp{gnu} or
23388 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23389 @samp{gnu2} is more efficient, but it may add compile- and run-time
23390 requirements that cannot be satisfied on all systems.
23392 @item -mpush-args
23393 @itemx -mno-push-args
23394 @opindex mpush-args
23395 @opindex mno-push-args
23396 Use PUSH operations to store outgoing parameters.  This method is shorter
23397 and usually equally fast as method using SUB/MOV operations and is enabled
23398 by default.  In some cases disabling it may improve performance because of
23399 improved scheduling and reduced dependencies.
23401 @item -maccumulate-outgoing-args
23402 @opindex maccumulate-outgoing-args
23403 If enabled, the maximum amount of space required for outgoing arguments is
23404 computed in the function prologue.  This is faster on most modern CPUs
23405 because of reduced dependencies, improved scheduling and reduced stack usage
23406 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23407 increase in code size.  This switch implies @option{-mno-push-args}.
23409 @item -mthreads
23410 @opindex mthreads
23411 Support thread-safe exception handling on MinGW.  Programs that rely
23412 on thread-safe exception handling must compile and link all code with the
23413 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23414 @option{-D_MT}; when linking, it links in a special thread helper library
23415 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23417 @item -mno-align-stringops
23418 @opindex mno-align-stringops
23419 Do not align the destination of inlined string operations.  This switch reduces
23420 code size and improves performance in case the destination is already aligned,
23421 but GCC doesn't know about it.
23423 @item -minline-all-stringops
23424 @opindex minline-all-stringops
23425 By default GCC inlines string operations only when the destination is 
23426 known to be aligned to least a 4-byte boundary.  
23427 This enables more inlining and increases code
23428 size, but may improve performance of code that depends on fast
23429 @code{memcpy}, @code{strlen},
23430 and @code{memset} for short lengths.
23432 @item -minline-stringops-dynamically
23433 @opindex minline-stringops-dynamically
23434 For string operations of unknown size, use run-time checks with
23435 inline code for small blocks and a library call for large blocks.
23437 @item -mstringop-strategy=@var{alg}
23438 @opindex mstringop-strategy=@var{alg}
23439 Override the internal decision heuristic for the particular algorithm to use
23440 for inlining string operations.  The allowed values for @var{alg} are:
23442 @table @samp
23443 @item rep_byte
23444 @itemx rep_4byte
23445 @itemx rep_8byte
23446 Expand using i386 @code{rep} prefix of the specified size.
23448 @item byte_loop
23449 @itemx loop
23450 @itemx unrolled_loop
23451 Expand into an inline loop.
23453 @item libcall
23454 Always use a library call.
23455 @end table
23457 @item -mmemcpy-strategy=@var{strategy}
23458 @opindex mmemcpy-strategy=@var{strategy}
23459 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23460 should be inlined and what inline algorithm to use when the expected size
23461 of the copy operation is known. @var{strategy} 
23462 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23463 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23464 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23465 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23466 in the list must be specified in increasing order.  The minimal byte size for 
23467 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23468 preceding range.
23470 @item -mmemset-strategy=@var{strategy}
23471 @opindex mmemset-strategy=@var{strategy}
23472 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23473 @code{__builtin_memset} expansion.
23475 @item -momit-leaf-frame-pointer
23476 @opindex momit-leaf-frame-pointer
23477 Don't keep the frame pointer in a register for leaf functions.  This
23478 avoids the instructions to save, set up, and restore frame pointers and
23479 makes an extra register available in leaf functions.  The option
23480 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23481 which might make debugging harder.
23483 @item -mtls-direct-seg-refs
23484 @itemx -mno-tls-direct-seg-refs
23485 @opindex mtls-direct-seg-refs
23486 Controls whether TLS variables may be accessed with offsets from the
23487 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23488 or whether the thread base pointer must be added.  Whether or not this
23489 is valid depends on the operating system, and whether it maps the
23490 segment to cover the entire TLS area.
23492 For systems that use the GNU C Library, the default is on.
23494 @item -msse2avx
23495 @itemx -mno-sse2avx
23496 @opindex msse2avx
23497 Specify that the assembler should encode SSE instructions with VEX
23498 prefix.  The option @option{-mavx} turns this on by default.
23500 @item -mfentry
23501 @itemx -mno-fentry
23502 @opindex mfentry
23503 If profiling is active (@option{-pg}), put the profiling
23504 counter call before the prologue.
23505 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23506 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23508 @item -mrecord-mcount
23509 @itemx -mno-record-mcount
23510 @opindex mrecord-mcount
23511 If profiling is active (@option{-pg}), generate a __mcount_loc section
23512 that contains pointers to each profiling call. This is useful for
23513 automatically patching and out calls.
23515 @item -mnop-mcount
23516 @itemx -mno-nop-mcount
23517 @opindex mnop-mcount
23518 If profiling is active (@option{-pg}), generate the calls to
23519 the profiling functions as nops. This is useful when they
23520 should be patched in later dynamically. This is likely only
23521 useful together with @option{-mrecord-mcount}.
23523 @item -mskip-rax-setup
23524 @itemx -mno-skip-rax-setup
23525 @opindex mskip-rax-setup
23526 When generating code for the x86-64 architecture with SSE extensions
23527 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23528 register when there are no variable arguments passed in vector registers.
23530 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23531 saving vector registers on stack when passing variable arguments, the
23532 impacts of this option are callees may waste some stack space,
23533 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23534 those issues, regardless the RAX register value.
23536 @item -m8bit-idiv
23537 @itemx -mno-8bit-idiv
23538 @opindex m8bit-idiv
23539 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23540 much faster than 32-bit/64-bit integer divide.  This option generates a
23541 run-time check.  If both dividend and divisor are within range of 0
23542 to 255, 8-bit unsigned integer divide is used instead of
23543 32-bit/64-bit integer divide.
23545 @item -mavx256-split-unaligned-load
23546 @itemx -mavx256-split-unaligned-store
23547 @opindex mavx256-split-unaligned-load
23548 @opindex mavx256-split-unaligned-store
23549 Split 32-byte AVX unaligned load and store.
23551 @item -mstack-protector-guard=@var{guard}
23552 @opindex mstack-protector-guard=@var{guard}
23553 Generate stack protection code using canary at @var{guard}.  Supported
23554 locations are @samp{global} for global canary or @samp{tls} for per-thread
23555 canary in the TLS block (the default).  This option has effect only when
23556 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23558 @end table
23560 These @samp{-m} switches are supported in addition to the above
23561 on x86-64 processors in 64-bit environments.
23563 @table @gcctabopt
23564 @item -m32
23565 @itemx -m64
23566 @itemx -mx32
23567 @itemx -m16
23568 @itemx -miamcu
23569 @opindex m32
23570 @opindex m64
23571 @opindex mx32
23572 @opindex m16
23573 @opindex miamcu
23574 Generate code for a 16-bit, 32-bit or 64-bit environment.
23575 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23576 to 32 bits, and
23577 generates code that runs on any i386 system.
23579 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23580 types to 64 bits, and generates code for the x86-64 architecture.
23581 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23582 and @option{-mdynamic-no-pic} options.
23584 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23585 to 32 bits, and
23586 generates code for the x86-64 architecture.
23588 The @option{-m16} option is the same as @option{-m32}, except for that
23589 it outputs the @code{.code16gcc} assembly directive at the beginning of
23590 the assembly output so that the binary can run in 16-bit mode.
23592 The @option{-miamcu} option generates code which conforms to Intel MCU
23593 psABI.  It requires the @option{-m32} option to be turned on.
23595 @item -mno-red-zone
23596 @opindex mno-red-zone
23597 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23598 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23599 stack pointer that is not modified by signal or interrupt handlers
23600 and therefore can be used for temporary data without adjusting the stack
23601 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23603 @item -mcmodel=small
23604 @opindex mcmodel=small
23605 Generate code for the small code model: the program and its symbols must
23606 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23607 Programs can be statically or dynamically linked.  This is the default
23608 code model.
23610 @item -mcmodel=kernel
23611 @opindex mcmodel=kernel
23612 Generate code for the kernel code model.  The kernel runs in the
23613 negative 2 GB of the address space.
23614 This model has to be used for Linux kernel code.
23616 @item -mcmodel=medium
23617 @opindex mcmodel=medium
23618 Generate code for the medium model: the program is linked in the lower 2
23619 GB of the address space.  Small symbols are also placed there.  Symbols
23620 with sizes larger than @option{-mlarge-data-threshold} are put into
23621 large data or BSS sections and can be located above 2GB.  Programs can
23622 be statically or dynamically linked.
23624 @item -mcmodel=large
23625 @opindex mcmodel=large
23626 Generate code for the large model.  This model makes no assumptions
23627 about addresses and sizes of sections.
23629 @item -maddress-mode=long
23630 @opindex maddress-mode=long
23631 Generate code for long address mode.  This is only supported for 64-bit
23632 and x32 environments.  It is the default address mode for 64-bit
23633 environments.
23635 @item -maddress-mode=short
23636 @opindex maddress-mode=short
23637 Generate code for short address mode.  This is only supported for 32-bit
23638 and x32 environments.  It is the default address mode for 32-bit and
23639 x32 environments.
23640 @end table
23642 @node x86 Windows Options
23643 @subsection x86 Windows Options
23644 @cindex x86 Windows Options
23645 @cindex Windows Options for x86
23647 These additional options are available for Microsoft Windows targets:
23649 @table @gcctabopt
23650 @item -mconsole
23651 @opindex mconsole
23652 This option
23653 specifies that a console application is to be generated, by
23654 instructing the linker to set the PE header subsystem type
23655 required for console applications.
23656 This option is available for Cygwin and MinGW targets and is
23657 enabled by default on those targets.
23659 @item -mdll
23660 @opindex mdll
23661 This option is available for Cygwin and MinGW targets.  It
23662 specifies that a DLL---a dynamic link library---is to be
23663 generated, enabling the selection of the required runtime
23664 startup object and entry point.
23666 @item -mnop-fun-dllimport
23667 @opindex mnop-fun-dllimport
23668 This option is available for Cygwin and MinGW targets.  It
23669 specifies that the @code{dllimport} attribute should be ignored.
23671 @item -mthread
23672 @opindex mthread
23673 This option is available for MinGW targets. It specifies
23674 that MinGW-specific thread support is to be used.
23676 @item -municode
23677 @opindex municode
23678 This option is available for MinGW-w64 targets.  It causes
23679 the @code{UNICODE} preprocessor macro to be predefined, and
23680 chooses Unicode-capable runtime startup code.
23682 @item -mwin32
23683 @opindex mwin32
23684 This option is available for Cygwin and MinGW targets.  It
23685 specifies that the typical Microsoft Windows predefined macros are to
23686 be set in the pre-processor, but does not influence the choice
23687 of runtime library/startup code.
23689 @item -mwindows
23690 @opindex mwindows
23691 This option is available for Cygwin and MinGW targets.  It
23692 specifies that a GUI application is to be generated by
23693 instructing the linker to set the PE header subsystem type
23694 appropriately.
23696 @item -fno-set-stack-executable
23697 @opindex fno-set-stack-executable
23698 This option is available for MinGW targets. It specifies that
23699 the executable flag for the stack used by nested functions isn't
23700 set. This is necessary for binaries running in kernel mode of
23701 Microsoft Windows, as there the User32 API, which is used to set executable
23702 privileges, isn't available.
23704 @item -fwritable-relocated-rdata
23705 @opindex fno-writable-relocated-rdata
23706 This option is available for MinGW and Cygwin targets.  It specifies
23707 that relocated-data in read-only section is put into .data
23708 section.  This is a necessary for older runtimes not supporting
23709 modification of .rdata sections for pseudo-relocation.
23711 @item -mpe-aligned-commons
23712 @opindex mpe-aligned-commons
23713 This option is available for Cygwin and MinGW targets.  It
23714 specifies that the GNU extension to the PE file format that
23715 permits the correct alignment of COMMON variables should be
23716 used when generating code.  It is enabled by default if
23717 GCC detects that the target assembler found during configuration
23718 supports the feature.
23719 @end table
23721 See also under @ref{x86 Options} for standard options.
23723 @node Xstormy16 Options
23724 @subsection Xstormy16 Options
23725 @cindex Xstormy16 Options
23727 These options are defined for Xstormy16:
23729 @table @gcctabopt
23730 @item -msim
23731 @opindex msim
23732 Choose startup files and linker script suitable for the simulator.
23733 @end table
23735 @node Xtensa Options
23736 @subsection Xtensa Options
23737 @cindex Xtensa Options
23739 These options are supported for Xtensa targets:
23741 @table @gcctabopt
23742 @item -mconst16
23743 @itemx -mno-const16
23744 @opindex mconst16
23745 @opindex mno-const16
23746 Enable or disable use of @code{CONST16} instructions for loading
23747 constant values.  The @code{CONST16} instruction is currently not a
23748 standard option from Tensilica.  When enabled, @code{CONST16}
23749 instructions are always used in place of the standard @code{L32R}
23750 instructions.  The use of @code{CONST16} is enabled by default only if
23751 the @code{L32R} instruction is not available.
23753 @item -mfused-madd
23754 @itemx -mno-fused-madd
23755 @opindex mfused-madd
23756 @opindex mno-fused-madd
23757 Enable or disable use of fused multiply/add and multiply/subtract
23758 instructions in the floating-point option.  This has no effect if the
23759 floating-point option is not also enabled.  Disabling fused multiply/add
23760 and multiply/subtract instructions forces the compiler to use separate
23761 instructions for the multiply and add/subtract operations.  This may be
23762 desirable in some cases where strict IEEE 754-compliant results are
23763 required: the fused multiply add/subtract instructions do not round the
23764 intermediate result, thereby producing results with @emph{more} bits of
23765 precision than specified by the IEEE standard.  Disabling fused multiply
23766 add/subtract instructions also ensures that the program output is not
23767 sensitive to the compiler's ability to combine multiply and add/subtract
23768 operations.
23770 @item -mserialize-volatile
23771 @itemx -mno-serialize-volatile
23772 @opindex mserialize-volatile
23773 @opindex mno-serialize-volatile
23774 When this option is enabled, GCC inserts @code{MEMW} instructions before
23775 @code{volatile} memory references to guarantee sequential consistency.
23776 The default is @option{-mserialize-volatile}.  Use
23777 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23779 @item -mforce-no-pic
23780 @opindex mforce-no-pic
23781 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23782 position-independent code (PIC), this option disables PIC for compiling
23783 kernel code.
23785 @item -mtext-section-literals
23786 @itemx -mno-text-section-literals
23787 @opindex mtext-section-literals
23788 @opindex mno-text-section-literals
23789 These options control the treatment of literal pools.  The default is
23790 @option{-mno-text-section-literals}, which places literals in a separate
23791 section in the output file.  This allows the literal pool to be placed
23792 in a data RAM/ROM, and it also allows the linker to combine literal
23793 pools from separate object files to remove redundant literals and
23794 improve code size.  With @option{-mtext-section-literals}, the literals
23795 are interspersed in the text section in order to keep them as close as
23796 possible to their references.  This may be necessary for large assembly
23797 files.  Literals for each function are placed right before that function.
23799 @item -mauto-litpools
23800 @itemx -mno-auto-litpools
23801 @opindex mauto-litpools
23802 @opindex mno-auto-litpools
23803 These options control the treatment of literal pools.  The default is
23804 @option{-mno-auto-litpools}, which places literals in a separate
23805 section in the output file unless @option{-mtext-section-literals} is
23806 used.  With @option{-mauto-litpools} the literals are interspersed in
23807 the text section by the assembler.  Compiler does not produce explicit
23808 @code{.literal} directives and loads literals into registers with
23809 @code{MOVI} instructions instead of @code{L32R} to let the assembler
23810 do relaxation and place literals as necessary.  This option allows
23811 assembler to create several literal pools per function and assemble
23812 very big functions, which may not be possible with
23813 @option{-mtext-section-literals}.
23815 @item -mtarget-align
23816 @itemx -mno-target-align
23817 @opindex mtarget-align
23818 @opindex mno-target-align
23819 When this option is enabled, GCC instructs the assembler to
23820 automatically align instructions to reduce branch penalties at the
23821 expense of some code density.  The assembler attempts to widen density
23822 instructions to align branch targets and the instructions following call
23823 instructions.  If there are not enough preceding safe density
23824 instructions to align a target, no widening is performed.  The
23825 default is @option{-mtarget-align}.  These options do not affect the
23826 treatment of auto-aligned instructions like @code{LOOP}, which the
23827 assembler always aligns, either by widening density instructions or
23828 by inserting NOP instructions.
23830 @item -mlongcalls
23831 @itemx -mno-longcalls
23832 @opindex mlongcalls
23833 @opindex mno-longcalls
23834 When this option is enabled, GCC instructs the assembler to translate
23835 direct calls to indirect calls unless it can determine that the target
23836 of a direct call is in the range allowed by the call instruction.  This
23837 translation typically occurs for calls to functions in other source
23838 files.  Specifically, the assembler translates a direct @code{CALL}
23839 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23840 The default is @option{-mno-longcalls}.  This option should be used in
23841 programs where the call target can potentially be out of range.  This
23842 option is implemented in the assembler, not the compiler, so the
23843 assembly code generated by GCC still shows direct call
23844 instructions---look at the disassembled object code to see the actual
23845 instructions.  Note that the assembler uses an indirect call for
23846 every cross-file call, not just those that really are out of range.
23847 @end table
23849 @node zSeries Options
23850 @subsection zSeries Options
23851 @cindex zSeries options
23853 These are listed under @xref{S/390 and zSeries Options}.
23855 @node Code Gen Options
23856 @section Options for Code Generation Conventions
23857 @cindex code generation conventions
23858 @cindex options, code generation
23859 @cindex run-time options
23861 These machine-independent options control the interface conventions
23862 used in code generation.
23864 Most of them have both positive and negative forms; the negative form
23865 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23866 one of the forms is listed---the one that is not the default.  You
23867 can figure out the other form by either removing @samp{no-} or adding
23870 @table @gcctabopt
23871 @item -fbounds-check
23872 @opindex fbounds-check
23873 For front ends that support it, generate additional code to check that
23874 indices used to access arrays are within the declared range.  This is
23875 currently only supported by the Java and Fortran front ends, where
23876 this option defaults to true and false respectively.
23878 @item -fstack-reuse=@var{reuse-level}
23879 @opindex fstack_reuse
23880 This option controls stack space reuse for user declared local/auto variables
23881 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23882 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23883 local variables and temporaries, @samp{named_vars} enables the reuse only for
23884 user defined local variables with names, and @samp{none} disables stack reuse
23885 completely. The default value is @samp{all}. The option is needed when the
23886 program extends the lifetime of a scoped local variable or a compiler generated
23887 temporary beyond the end point defined by the language.  When a lifetime of
23888 a variable ends, and if the variable lives in memory, the optimizing compiler
23889 has the freedom to reuse its stack space with other temporaries or scoped
23890 local variables whose live range does not overlap with it. Legacy code extending
23891 local lifetime is likely to break with the stack reuse optimization.
23893 For example,
23895 @smallexample
23896    int *p;
23897    @{
23898      int local1;
23900      p = &local1;
23901      local1 = 10;
23902      ....
23903    @}
23904    @{
23905       int local2;
23906       local2 = 20;
23907       ...
23908    @}
23910    if (*p == 10)  // out of scope use of local1
23911      @{
23913      @}
23914 @end smallexample
23916 Another example:
23917 @smallexample
23919    struct A
23920    @{
23921        A(int k) : i(k), j(k) @{ @}
23922        int i;
23923        int j;
23924    @};
23926    A *ap;
23928    void foo(const A& ar)
23929    @{
23930       ap = &ar;
23931    @}
23933    void bar()
23934    @{
23935       foo(A(10)); // temp object's lifetime ends when foo returns
23937       @{
23938         A a(20);
23939         ....
23940       @}
23941       ap->i+= 10;  // ap references out of scope temp whose space
23942                    // is reused with a. What is the value of ap->i?
23943    @}
23945 @end smallexample
23947 The lifetime of a compiler generated temporary is well defined by the C++
23948 standard. When a lifetime of a temporary ends, and if the temporary lives
23949 in memory, the optimizing compiler has the freedom to reuse its stack
23950 space with other temporaries or scoped local variables whose live range
23951 does not overlap with it. However some of the legacy code relies on
23952 the behavior of older compilers in which temporaries' stack space is
23953 not reused, the aggressive stack reuse can lead to runtime errors. This
23954 option is used to control the temporary stack reuse optimization.
23956 @item -ftrapv
23957 @opindex ftrapv
23958 This option generates traps for signed overflow on addition, subtraction,
23959 multiplication operations.
23960 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23961 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23962 @option{-fwrapv} being effective.  Note that only active options override, so
23963 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23964 results in @option{-ftrapv} being effective.
23966 @item -fwrapv
23967 @opindex fwrapv
23968 This option instructs the compiler to assume that signed arithmetic
23969 overflow of addition, subtraction and multiplication wraps around
23970 using twos-complement representation.  This flag enables some optimizations
23971 and disables others.  This option is enabled by default for the Java
23972 front end, as required by the Java language specification.
23973 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23974 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23975 @option{-fwrapv} being effective.  Note that only active options override, so
23976 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23977 results in @option{-ftrapv} being effective.
23979 @item -fexceptions
23980 @opindex fexceptions
23981 Enable exception handling.  Generates extra code needed to propagate
23982 exceptions.  For some targets, this implies GCC generates frame
23983 unwind information for all functions, which can produce significant data
23984 size overhead, although it does not affect execution.  If you do not
23985 specify this option, GCC enables it by default for languages like
23986 C++ that normally require exception handling, and disables it for
23987 languages like C that do not normally require it.  However, you may need
23988 to enable this option when compiling C code that needs to interoperate
23989 properly with exception handlers written in C++.  You may also wish to
23990 disable this option if you are compiling older C++ programs that don't
23991 use exception handling.
23993 @item -fnon-call-exceptions
23994 @opindex fnon-call-exceptions
23995 Generate code that allows trapping instructions to throw exceptions.
23996 Note that this requires platform-specific runtime support that does
23997 not exist everywhere.  Moreover, it only allows @emph{trapping}
23998 instructions to throw exceptions, i.e.@: memory references or floating-point
23999 instructions.  It does not allow exceptions to be thrown from
24000 arbitrary signal handlers such as @code{SIGALRM}.
24002 @item -fdelete-dead-exceptions
24003 @opindex fdelete-dead-exceptions
24004 Consider that instructions that may throw exceptions but don't otherwise
24005 contribute to the execution of the program can be optimized away.
24006 This option is enabled by default for the Ada front end, as permitted by
24007 the Ada language specification.
24008 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
24010 @item -funwind-tables
24011 @opindex funwind-tables
24012 Similar to @option{-fexceptions}, except that it just generates any needed
24013 static data, but does not affect the generated code in any other way.
24014 You normally do not need to enable this option; instead, a language processor
24015 that needs this handling enables it on your behalf.
24017 @item -fasynchronous-unwind-tables
24018 @opindex fasynchronous-unwind-tables
24019 Generate unwind table in DWARF 2 format, if supported by target machine.  The
24020 table is exact at each instruction boundary, so it can be used for stack
24021 unwinding from asynchronous events (such as debugger or garbage collector).
24023 @item -fno-gnu-unique
24024 @opindex fno-gnu-unique
24025 On systems with recent GNU assembler and C library, the C++ compiler
24026 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
24027 of template static data members and static local variables in inline
24028 functions are unique even in the presence of @code{RTLD_LOCAL}; this
24029 is necessary to avoid problems with a library used by two different
24030 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
24031 therefore disagreeing with the other one about the binding of the
24032 symbol.  But this causes @code{dlclose} to be ignored for affected
24033 DSOs; if your program relies on reinitialization of a DSO via
24034 @code{dlclose} and @code{dlopen}, you can use
24035 @option{-fno-gnu-unique}.
24037 @item -fpcc-struct-return
24038 @opindex fpcc-struct-return
24039 Return ``short'' @code{struct} and @code{union} values in memory like
24040 longer ones, rather than in registers.  This convention is less
24041 efficient, but it has the advantage of allowing intercallability between
24042 GCC-compiled files and files compiled with other compilers, particularly
24043 the Portable C Compiler (pcc).
24045 The precise convention for returning structures in memory depends
24046 on the target configuration macros.
24048 Short structures and unions are those whose size and alignment match
24049 that of some integer type.
24051 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
24052 switch is not binary compatible with code compiled with the
24053 @option{-freg-struct-return} switch.
24054 Use it to conform to a non-default application binary interface.
24056 @item -freg-struct-return
24057 @opindex freg-struct-return
24058 Return @code{struct} and @code{union} values in registers when possible.
24059 This is more efficient for small structures than
24060 @option{-fpcc-struct-return}.
24062 If you specify neither @option{-fpcc-struct-return} nor
24063 @option{-freg-struct-return}, GCC defaults to whichever convention is
24064 standard for the target.  If there is no standard convention, GCC
24065 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
24066 the principal compiler.  In those cases, we can choose the standard, and
24067 we chose the more efficient register return alternative.
24069 @strong{Warning:} code compiled with the @option{-freg-struct-return}
24070 switch is not binary compatible with code compiled with the
24071 @option{-fpcc-struct-return} switch.
24072 Use it to conform to a non-default application binary interface.
24074 @item -fshort-enums
24075 @opindex fshort-enums
24076 Allocate to an @code{enum} type only as many bytes as it needs for the
24077 declared range of possible values.  Specifically, the @code{enum} type
24078 is equivalent to the smallest integer type that has enough room.
24080 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
24081 code that is not binary compatible with code generated without that switch.
24082 Use it to conform to a non-default application binary interface.
24084 @item -fshort-double
24085 @opindex fshort-double
24086 Use the same size for @code{double} as for @code{float}.
24088 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
24089 code that is not binary compatible with code generated without that switch.
24090 Use it to conform to a non-default application binary interface.
24092 @item -fshort-wchar
24093 @opindex fshort-wchar
24094 Override the underlying type for @code{wchar_t} to be @code{short
24095 unsigned int} instead of the default for the target.  This option is
24096 useful for building programs to run under WINE@.
24098 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
24099 code that is not binary compatible with code generated without that switch.
24100 Use it to conform to a non-default application binary interface.
24102 @item -fno-common
24103 @opindex fno-common
24104 In C code, controls the placement of uninitialized global variables.
24105 Unix C compilers have traditionally permitted multiple definitions of
24106 such variables in different compilation units by placing the variables
24107 in a common block.
24108 This is the behavior specified by @option{-fcommon}, and is the default
24109 for GCC on most targets.
24110 On the other hand, this behavior is not required by ISO C, and on some
24111 targets may carry a speed or code size penalty on variable references.
24112 The @option{-fno-common} option specifies that the compiler should place
24113 uninitialized global variables in the data section of the object file,
24114 rather than generating them as common blocks.
24115 This has the effect that if the same variable is declared
24116 (without @code{extern}) in two different compilations,
24117 you get a multiple-definition error when you link them.
24118 In this case, you must compile with @option{-fcommon} instead.
24119 Compiling with @option{-fno-common} is useful on targets for which
24120 it provides better performance, or if you wish to verify that the
24121 program will work on other systems that always treat uninitialized
24122 variable declarations this way.
24124 @item -fno-ident
24125 @opindex fno-ident
24126 Ignore the @code{#ident} directive.
24128 @item -finhibit-size-directive
24129 @opindex finhibit-size-directive
24130 Don't output a @code{.size} assembler directive, or anything else that
24131 would cause trouble if the function is split in the middle, and the
24132 two halves are placed at locations far apart in memory.  This option is
24133 used when compiling @file{crtstuff.c}; you should not need to use it
24134 for anything else.
24136 @item -fverbose-asm
24137 @opindex fverbose-asm
24138 Put extra commentary information in the generated assembly code to
24139 make it more readable.  This option is generally only of use to those
24140 who actually need to read the generated assembly code (perhaps while
24141 debugging the compiler itself).
24143 @option{-fno-verbose-asm}, the default, causes the
24144 extra information to be omitted and is useful when comparing two assembler
24145 files.
24147 @item -frecord-gcc-switches
24148 @opindex frecord-gcc-switches
24149 This switch causes the command line used to invoke the
24150 compiler to be recorded into the object file that is being created.
24151 This switch is only implemented on some targets and the exact format
24152 of the recording is target and binary file format dependent, but it
24153 usually takes the form of a section containing ASCII text.  This
24154 switch is related to the @option{-fverbose-asm} switch, but that
24155 switch only records information in the assembler output file as
24156 comments, so it never reaches the object file.
24157 See also @option{-grecord-gcc-switches} for another
24158 way of storing compiler options into the object file.
24160 @item -fpic
24161 @opindex fpic
24162 @cindex global offset table
24163 @cindex PIC
24164 Generate position-independent code (PIC) suitable for use in a shared
24165 library, if supported for the target machine.  Such code accesses all
24166 constant addresses through a global offset table (GOT)@.  The dynamic
24167 loader resolves the GOT entries when the program starts (the dynamic
24168 loader is not part of GCC; it is part of the operating system).  If
24169 the GOT size for the linked executable exceeds a machine-specific
24170 maximum size, you get an error message from the linker indicating that
24171 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
24172 instead.  (These maximums are 8k on the SPARC and 32k
24173 on the m68k and RS/6000.  The x86 has no such limit.)
24175 Position-independent code requires special support, and therefore works
24176 only on certain machines.  For the x86, GCC supports PIC for System V
24177 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
24178 position-independent.
24180 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
24181 are defined to 1.
24183 @item -fPIC
24184 @opindex fPIC
24185 If supported for the target machine, emit position-independent code,
24186 suitable for dynamic linking and avoiding any limit on the size of the
24187 global offset table.  This option makes a difference on the m68k,
24188 PowerPC and SPARC@.
24190 Position-independent code requires special support, and therefore works
24191 only on certain machines.
24193 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
24194 are defined to 2.
24196 @item -fpie
24197 @itemx -fPIE
24198 @opindex fpie
24199 @opindex fPIE
24200 These options are similar to @option{-fpic} and @option{-fPIC}, but
24201 generated position independent code can be only linked into executables.
24202 Usually these options are used when @option{-pie} GCC option is
24203 used during linking.
24205 @option{-fpie} and @option{-fPIE} both define the macros
24206 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
24207 for @option{-fpie} and 2 for @option{-fPIE}.
24209 @item -fno-plt
24210 @opindex fno-plt
24211 Do not use PLT for external function calls in position-independent code.
24212 Instead, load callee address at call site from GOT and branch to it.
24213 This leads to more efficient code by eliminating PLT stubs and exposing
24214 GOT load to optimizations.  On architectures such as 32-bit x86 where
24215 PLT stubs expect GOT pointer in a specific register, this gives more
24216 register allocation freedom to the compiler.  Lazy binding requires PLT:
24217 with @option{-fno-plt} all external symbols are resolved at load time.
24219 Alternatively, function attribute @code{noplt} can be used to avoid PLT
24220 for calls to specific external functions by marking those functions with
24221 this attribute.
24223 Additionally, a few targets also convert calls to those functions that are
24224 marked to not use the PLT to use the GOT instead for non-position independent
24225 code.
24227 @item -fno-jump-tables
24228 @opindex fno-jump-tables
24229 Do not use jump tables for switch statements even where it would be
24230 more efficient than other code generation strategies.  This option is
24231 of use in conjunction with @option{-fpic} or @option{-fPIC} for
24232 building code that forms part of a dynamic linker and cannot
24233 reference the address of a jump table.  On some targets, jump tables
24234 do not require a GOT and this option is not needed.
24236 @item -ffixed-@var{reg}
24237 @opindex ffixed
24238 Treat the register named @var{reg} as a fixed register; generated code
24239 should never refer to it (except perhaps as a stack pointer, frame
24240 pointer or in some other fixed role).
24242 @var{reg} must be the name of a register.  The register names accepted
24243 are machine-specific and are defined in the @code{REGISTER_NAMES}
24244 macro in the machine description macro file.
24246 This flag does not have a negative form, because it specifies a
24247 three-way choice.
24249 @item -fcall-used-@var{reg}
24250 @opindex fcall-used
24251 Treat the register named @var{reg} as an allocable register that is
24252 clobbered by function calls.  It may be allocated for temporaries or
24253 variables that do not live across a call.  Functions compiled this way
24254 do not save and restore the register @var{reg}.
24256 It is an error to use this flag with the frame pointer or stack pointer.
24257 Use of this flag for other registers that have fixed pervasive roles in
24258 the machine's execution model produces disastrous results.
24260 This flag does not have a negative form, because it specifies a
24261 three-way choice.
24263 @item -fcall-saved-@var{reg}
24264 @opindex fcall-saved
24265 Treat the register named @var{reg} as an allocable register saved by
24266 functions.  It may be allocated even for temporaries or variables that
24267 live across a call.  Functions compiled this way save and restore
24268 the register @var{reg} if they use it.
24270 It is an error to use this flag with the frame pointer or stack pointer.
24271 Use of this flag for other registers that have fixed pervasive roles in
24272 the machine's execution model produces disastrous results.
24274 A different sort of disaster results from the use of this flag for
24275 a register in which function values may be returned.
24277 This flag does not have a negative form, because it specifies a
24278 three-way choice.
24280 @item -fpack-struct[=@var{n}]
24281 @opindex fpack-struct
24282 Without a value specified, pack all structure members together without
24283 holes.  When a value is specified (which must be a small power of two), pack
24284 structure members according to this value, representing the maximum
24285 alignment (that is, objects with default alignment requirements larger than
24286 this are output potentially unaligned at the next fitting location.
24288 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
24289 code that is not binary compatible with code generated without that switch.
24290 Additionally, it makes the code suboptimal.
24291 Use it to conform to a non-default application binary interface.
24293 @item -finstrument-functions
24294 @opindex finstrument-functions
24295 Generate instrumentation calls for entry and exit to functions.  Just
24296 after function entry and just before function exit, the following
24297 profiling functions are called with the address of the current
24298 function and its call site.  (On some platforms,
24299 @code{__builtin_return_address} does not work beyond the current
24300 function, so the call site information may not be available to the
24301 profiling functions otherwise.)
24303 @smallexample
24304 void __cyg_profile_func_enter (void *this_fn,
24305                                void *call_site);
24306 void __cyg_profile_func_exit  (void *this_fn,
24307                                void *call_site);
24308 @end smallexample
24310 The first argument is the address of the start of the current function,
24311 which may be looked up exactly in the symbol table.
24313 This instrumentation is also done for functions expanded inline in other
24314 functions.  The profiling calls indicate where, conceptually, the
24315 inline function is entered and exited.  This means that addressable
24316 versions of such functions must be available.  If all your uses of a
24317 function are expanded inline, this may mean an additional expansion of
24318 code size.  If you use @code{extern inline} in your C code, an
24319 addressable version of such functions must be provided.  (This is
24320 normally the case anyway, but if you get lucky and the optimizer always
24321 expands the functions inline, you might have gotten away without
24322 providing static copies.)
24324 A function may be given the attribute @code{no_instrument_function}, in
24325 which case this instrumentation is not done.  This can be used, for
24326 example, for the profiling functions listed above, high-priority
24327 interrupt routines, and any functions from which the profiling functions
24328 cannot safely be called (perhaps signal handlers, if the profiling
24329 routines generate output or allocate memory).
24331 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
24332 @opindex finstrument-functions-exclude-file-list
24334 Set the list of functions that are excluded from instrumentation (see
24335 the description of @option{-finstrument-functions}).  If the file that
24336 contains a function definition matches with one of @var{file}, then
24337 that function is not instrumented.  The match is done on substrings:
24338 if the @var{file} parameter is a substring of the file name, it is
24339 considered to be a match.
24341 For example:
24343 @smallexample
24344 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
24345 @end smallexample
24347 @noindent
24348 excludes any inline function defined in files whose pathnames
24349 contain @file{/bits/stl} or @file{include/sys}.
24351 If, for some reason, you want to include letter @samp{,} in one of
24352 @var{sym}, write @samp{\,}. For example,
24353 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
24354 (note the single quote surrounding the option).
24356 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24357 @opindex finstrument-functions-exclude-function-list
24359 This is similar to @option{-finstrument-functions-exclude-file-list},
24360 but this option sets the list of function names to be excluded from
24361 instrumentation.  The function name to be matched is its user-visible
24362 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24363 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24364 match is done on substrings: if the @var{sym} parameter is a substring
24365 of the function name, it is considered to be a match.  For C99 and C++
24366 extended identifiers, the function name must be given in UTF-8, not
24367 using universal character names.
24369 @item -fstack-check
24370 @opindex fstack-check
24371 Generate code to verify that you do not go beyond the boundary of the
24372 stack.  You should specify this flag if you are running in an
24373 environment with multiple threads, but you only rarely need to specify it in
24374 a single-threaded environment since stack overflow is automatically
24375 detected on nearly all systems if there is only one stack.
24377 Note that this switch does not actually cause checking to be done; the
24378 operating system or the language runtime must do that.  The switch causes
24379 generation of code to ensure that they see the stack being extended.
24381 You can additionally specify a string parameter: @samp{no} means no
24382 checking, @samp{generic} means force the use of old-style checking,
24383 @samp{specific} means use the best checking method and is equivalent
24384 to bare @option{-fstack-check}.
24386 Old-style checking is a generic mechanism that requires no specific
24387 target support in the compiler but comes with the following drawbacks:
24389 @enumerate
24390 @item
24391 Modified allocation strategy for large objects: they are always
24392 allocated dynamically if their size exceeds a fixed threshold.
24394 @item
24395 Fixed limit on the size of the static frame of functions: when it is
24396 topped by a particular function, stack checking is not reliable and
24397 a warning is issued by the compiler.
24399 @item
24400 Inefficiency: because of both the modified allocation strategy and the
24401 generic implementation, code performance is hampered.
24402 @end enumerate
24404 Note that old-style stack checking is also the fallback method for
24405 @samp{specific} if no target support has been added in the compiler.
24407 @item -fstack-limit-register=@var{reg}
24408 @itemx -fstack-limit-symbol=@var{sym}
24409 @itemx -fno-stack-limit
24410 @opindex fstack-limit-register
24411 @opindex fstack-limit-symbol
24412 @opindex fno-stack-limit
24413 Generate code to ensure that the stack does not grow beyond a certain value,
24414 either the value of a register or the address of a symbol.  If a larger
24415 stack is required, a signal is raised at run time.  For most targets,
24416 the signal is raised before the stack overruns the boundary, so
24417 it is possible to catch the signal without taking special precautions.
24419 For instance, if the stack starts at absolute address @samp{0x80000000}
24420 and grows downwards, you can use the flags
24421 @option{-fstack-limit-symbol=__stack_limit} and
24422 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24423 of 128KB@.  Note that this may only work with the GNU linker.
24425 @item -fsplit-stack
24426 @opindex fsplit-stack
24427 Generate code to automatically split the stack before it overflows.
24428 The resulting program has a discontiguous stack which can only
24429 overflow if the program is unable to allocate any more memory.  This
24430 is most useful when running threaded programs, as it is no longer
24431 necessary to calculate a good stack size to use for each thread.  This
24432 is currently only implemented for the x86 targets running
24433 GNU/Linux.
24435 When code compiled with @option{-fsplit-stack} calls code compiled
24436 without @option{-fsplit-stack}, there may not be much stack space
24437 available for the latter code to run.  If compiling all code,
24438 including library code, with @option{-fsplit-stack} is not an option,
24439 then the linker can fix up these calls so that the code compiled
24440 without @option{-fsplit-stack} always has a large stack.  Support for
24441 this is implemented in the gold linker in GNU binutils release 2.21
24442 and later.
24444 @item -fleading-underscore
24445 @opindex fleading-underscore
24446 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24447 change the way C symbols are represented in the object file.  One use
24448 is to help link with legacy assembly code.
24450 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24451 generate code that is not binary compatible with code generated without that
24452 switch.  Use it to conform to a non-default application binary interface.
24453 Not all targets provide complete support for this switch.
24455 @item -ftls-model=@var{model}
24456 @opindex ftls-model
24457 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24458 The @var{model} argument should be one of @samp{global-dynamic},
24459 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24460 Note that the choice is subject to optimization: the compiler may use
24461 a more efficient model for symbols not visible outside of the translation
24462 unit, or if @option{-fpic} is not given on the command line.
24464 The default without @option{-fpic} is @samp{initial-exec}; with
24465 @option{-fpic} the default is @samp{global-dynamic}.
24467 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24468 @opindex fvisibility
24469 Set the default ELF image symbol visibility to the specified option---all
24470 symbols are marked with this unless overridden within the code.
24471 Using this feature can very substantially improve linking and
24472 load times of shared object libraries, produce more optimized
24473 code, provide near-perfect API export and prevent symbol clashes.
24474 It is @strong{strongly} recommended that you use this in any shared objects
24475 you distribute.
24477 Despite the nomenclature, @samp{default} always means public; i.e.,
24478 available to be linked against from outside the shared object.
24479 @samp{protected} and @samp{internal} are pretty useless in real-world
24480 usage so the only other commonly used option is @samp{hidden}.
24481 The default if @option{-fvisibility} isn't specified is
24482 @samp{default}, i.e., make every symbol public.
24484 A good explanation of the benefits offered by ensuring ELF
24485 symbols have the correct visibility is given by ``How To Write
24486 Shared Libraries'' by Ulrich Drepper (which can be found at
24487 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24488 solution made possible by this option to marking things hidden when
24489 the default is public is to make the default hidden and mark things
24490 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24491 and @code{__attribute__ ((visibility("default")))} instead of
24492 @code{__declspec(dllexport)} you get almost identical semantics with
24493 identical syntax.  This is a great boon to those working with
24494 cross-platform projects.
24496 For those adding visibility support to existing code, you may find
24497 @code{#pragma GCC visibility} of use.  This works by you enclosing
24498 the declarations you wish to set visibility for with (for example)
24499 @code{#pragma GCC visibility push(hidden)} and
24500 @code{#pragma GCC visibility pop}.
24501 Bear in mind that symbol visibility should be viewed @strong{as
24502 part of the API interface contract} and thus all new code should
24503 always specify visibility when it is not the default; i.e., declarations
24504 only for use within the local DSO should @strong{always} be marked explicitly
24505 as hidden as so to avoid PLT indirection overheads---making this
24506 abundantly clear also aids readability and self-documentation of the code.
24507 Note that due to ISO C++ specification requirements, @code{operator new} and
24508 @code{operator delete} must always be of default visibility.
24510 Be aware that headers from outside your project, in particular system
24511 headers and headers from any other library you use, may not be
24512 expecting to be compiled with visibility other than the default.  You
24513 may need to explicitly say @code{#pragma GCC visibility push(default)}
24514 before including any such headers.
24516 @code{extern} declarations are not affected by @option{-fvisibility}, so
24517 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24518 no modifications.  However, this means that calls to @code{extern}
24519 functions with no explicit visibility use the PLT, so it is more
24520 effective to use @code{__attribute ((visibility))} and/or
24521 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24522 declarations should be treated as hidden.
24524 Note that @option{-fvisibility} does affect C++ vague linkage
24525 entities. This means that, for instance, an exception class that is
24526 be thrown between DSOs must be explicitly marked with default
24527 visibility so that the @samp{type_info} nodes are unified between
24528 the DSOs.
24530 An overview of these techniques, their benefits and how to use them
24531 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24533 @item -fstrict-volatile-bitfields
24534 @opindex fstrict-volatile-bitfields
24535 This option should be used if accesses to volatile bit-fields (or other
24536 structure fields, although the compiler usually honors those types
24537 anyway) should use a single access of the width of the
24538 field's type, aligned to a natural alignment if possible.  For
24539 example, targets with memory-mapped peripheral registers might require
24540 all such accesses to be 16 bits wide; with this flag you can
24541 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24542 is 16 bits on these targets) to force GCC to use 16-bit accesses
24543 instead of, perhaps, a more efficient 32-bit access.
24545 If this option is disabled, the compiler uses the most efficient
24546 instruction.  In the previous example, that might be a 32-bit load
24547 instruction, even though that accesses bytes that do not contain
24548 any portion of the bit-field, or memory-mapped registers unrelated to
24549 the one being updated.
24551 In some cases, such as when the @code{packed} attribute is applied to a 
24552 structure field, it may not be possible to access the field with a single
24553 read or write that is correctly aligned for the target machine.  In this
24554 case GCC falls back to generating multiple accesses rather than code that 
24555 will fault or truncate the result at run time.
24557 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24558 not allowed to touch non bit-field members.  It is therefore recommended
24559 to define all bits of the field's type as bit-field members.
24561 The default value of this option is determined by the application binary
24562 interface for the target processor.
24564 @item -fsync-libcalls
24565 @opindex fsync-libcalls
24566 This option controls whether any out-of-line instance of the @code{__sync}
24567 family of functions may be used to implement the C++11 @code{__atomic}
24568 family of functions.
24570 The default value of this option is enabled, thus the only useful form
24571 of the option is @option{-fno-sync-libcalls}.  This option is used in
24572 the implementation of the @file{libatomic} runtime library.
24574 @end table
24576 @c man end
24578 @node Environment Variables
24579 @section Environment Variables Affecting GCC
24580 @cindex environment variables
24582 @c man begin ENVIRONMENT
24583 This section describes several environment variables that affect how GCC
24584 operates.  Some of them work by specifying directories or prefixes to use
24585 when searching for various kinds of files.  Some are used to specify other
24586 aspects of the compilation environment.
24588 Note that you can also specify places to search using options such as
24589 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24590 take precedence over places specified using environment variables, which
24591 in turn take precedence over those specified by the configuration of GCC@.
24592 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24593 GNU Compiler Collection (GCC) Internals}.
24595 @table @env
24596 @item LANG
24597 @itemx LC_CTYPE
24598 @c @itemx LC_COLLATE
24599 @itemx LC_MESSAGES
24600 @c @itemx LC_MONETARY
24601 @c @itemx LC_NUMERIC
24602 @c @itemx LC_TIME
24603 @itemx LC_ALL
24604 @findex LANG
24605 @findex LC_CTYPE
24606 @c @findex LC_COLLATE
24607 @findex LC_MESSAGES
24608 @c @findex LC_MONETARY
24609 @c @findex LC_NUMERIC
24610 @c @findex LC_TIME
24611 @findex LC_ALL
24612 @cindex locale
24613 These environment variables control the way that GCC uses
24614 localization information which allows GCC to work with different
24615 national conventions.  GCC inspects the locale categories
24616 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24617 so.  These locale categories can be set to any value supported by your
24618 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24619 Kingdom encoded in UTF-8.
24621 The @env{LC_CTYPE} environment variable specifies character
24622 classification.  GCC uses it to determine the character boundaries in
24623 a string; this is needed for some multibyte encodings that contain quote
24624 and escape characters that are otherwise interpreted as a string
24625 end or escape.
24627 The @env{LC_MESSAGES} environment variable specifies the language to
24628 use in diagnostic messages.
24630 If the @env{LC_ALL} environment variable is set, it overrides the value
24631 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24632 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24633 environment variable.  If none of these variables are set, GCC
24634 defaults to traditional C English behavior.
24636 @item TMPDIR
24637 @findex TMPDIR
24638 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24639 files.  GCC uses temporary files to hold the output of one stage of
24640 compilation which is to be used as input to the next stage: for example,
24641 the output of the preprocessor, which is the input to the compiler
24642 proper.
24644 @item GCC_COMPARE_DEBUG
24645 @findex GCC_COMPARE_DEBUG
24646 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24647 @option{-fcompare-debug} to the compiler driver.  See the documentation
24648 of this option for more details.
24650 @item GCC_EXEC_PREFIX
24651 @findex GCC_EXEC_PREFIX
24652 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24653 names of the subprograms executed by the compiler.  No slash is added
24654 when this prefix is combined with the name of a subprogram, but you can
24655 specify a prefix that ends with a slash if you wish.
24657 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24658 an appropriate prefix to use based on the pathname it is invoked with.
24660 If GCC cannot find the subprogram using the specified prefix, it
24661 tries looking in the usual places for the subprogram.
24663 The default value of @env{GCC_EXEC_PREFIX} is
24664 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24665 the installed compiler. In many cases @var{prefix} is the value
24666 of @code{prefix} when you ran the @file{configure} script.
24668 Other prefixes specified with @option{-B} take precedence over this prefix.
24670 This prefix is also used for finding files such as @file{crt0.o} that are
24671 used for linking.
24673 In addition, the prefix is used in an unusual way in finding the
24674 directories to search for header files.  For each of the standard
24675 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24676 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24677 replacing that beginning with the specified prefix to produce an
24678 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24679 @file{foo/bar} just before it searches the standard directory 
24680 @file{/usr/local/lib/bar}.
24681 If a standard directory begins with the configured
24682 @var{prefix} then the value of @var{prefix} is replaced by
24683 @env{GCC_EXEC_PREFIX} when looking for header files.
24685 @item COMPILER_PATH
24686 @findex COMPILER_PATH
24687 The value of @env{COMPILER_PATH} is a colon-separated list of
24688 directories, much like @env{PATH}.  GCC tries the directories thus
24689 specified when searching for subprograms, if it can't find the
24690 subprograms using @env{GCC_EXEC_PREFIX}.
24692 @item LIBRARY_PATH
24693 @findex LIBRARY_PATH
24694 The value of @env{LIBRARY_PATH} is a colon-separated list of
24695 directories, much like @env{PATH}.  When configured as a native compiler,
24696 GCC tries the directories thus specified when searching for special
24697 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24698 using GCC also uses these directories when searching for ordinary
24699 libraries for the @option{-l} option (but directories specified with
24700 @option{-L} come first).
24702 @item LANG
24703 @findex LANG
24704 @cindex locale definition
24705 This variable is used to pass locale information to the compiler.  One way in
24706 which this information is used is to determine the character set to be used
24707 when character literals, string literals and comments are parsed in C and C++.
24708 When the compiler is configured to allow multibyte characters,
24709 the following values for @env{LANG} are recognized:
24711 @table @samp
24712 @item C-JIS
24713 Recognize JIS characters.
24714 @item C-SJIS
24715 Recognize SJIS characters.
24716 @item C-EUCJP
24717 Recognize EUCJP characters.
24718 @end table
24720 If @env{LANG} is not defined, or if it has some other value, then the
24721 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24722 recognize and translate multibyte characters.
24723 @end table
24725 @noindent
24726 Some additional environment variables affect the behavior of the
24727 preprocessor.
24729 @include cppenv.texi
24731 @c man end
24733 @node Precompiled Headers
24734 @section Using Precompiled Headers
24735 @cindex precompiled headers
24736 @cindex speed of compilation
24738 Often large projects have many header files that are included in every
24739 source file.  The time the compiler takes to process these header files
24740 over and over again can account for nearly all of the time required to
24741 build the project.  To make builds faster, GCC allows you to
24742 @dfn{precompile} a header file.
24744 To create a precompiled header file, simply compile it as you would any
24745 other file, if necessary using the @option{-x} option to make the driver
24746 treat it as a C or C++ header file.  You may want to use a
24747 tool like @command{make} to keep the precompiled header up-to-date when
24748 the headers it contains change.
24750 A precompiled header file is searched for when @code{#include} is
24751 seen in the compilation.  As it searches for the included file
24752 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24753 compiler looks for a precompiled header in each directory just before it
24754 looks for the include file in that directory.  The name searched for is
24755 the name specified in the @code{#include} with @samp{.gch} appended.  If
24756 the precompiled header file can't be used, it is ignored.
24758 For instance, if you have @code{#include "all.h"}, and you have
24759 @file{all.h.gch} in the same directory as @file{all.h}, then the
24760 precompiled header file is used if possible, and the original
24761 header is used otherwise.
24763 Alternatively, you might decide to put the precompiled header file in a
24764 directory and use @option{-I} to ensure that directory is searched
24765 before (or instead of) the directory containing the original header.
24766 Then, if you want to check that the precompiled header file is always
24767 used, you can put a file of the same name as the original header in this
24768 directory containing an @code{#error} command.
24770 This also works with @option{-include}.  So yet another way to use
24771 precompiled headers, good for projects not designed with precompiled
24772 header files in mind, is to simply take most of the header files used by
24773 a project, include them from another header file, precompile that header
24774 file, and @option{-include} the precompiled header.  If the header files
24775 have guards against multiple inclusion, they are skipped because
24776 they've already been included (in the precompiled header).
24778 If you need to precompile the same header file for different
24779 languages, targets, or compiler options, you can instead make a
24780 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24781 header in the directory, perhaps using @option{-o}.  It doesn't matter
24782 what you call the files in the directory; every precompiled header in
24783 the directory is considered.  The first precompiled header
24784 encountered in the directory that is valid for this compilation is
24785 used; they're searched in no particular order.
24787 There are many other possibilities, limited only by your imagination,
24788 good sense, and the constraints of your build system.
24790 A precompiled header file can be used only when these conditions apply:
24792 @itemize
24793 @item
24794 Only one precompiled header can be used in a particular compilation.
24796 @item
24797 A precompiled header can't be used once the first C token is seen.  You
24798 can have preprocessor directives before a precompiled header; you cannot
24799 include a precompiled header from inside another header.
24801 @item
24802 The precompiled header file must be produced for the same language as
24803 the current compilation.  You can't use a C precompiled header for a C++
24804 compilation.
24806 @item
24807 The precompiled header file must have been produced by the same compiler
24808 binary as the current compilation is using.
24810 @item
24811 Any macros defined before the precompiled header is included must
24812 either be defined in the same way as when the precompiled header was
24813 generated, or must not affect the precompiled header, which usually
24814 means that they don't appear in the precompiled header at all.
24816 The @option{-D} option is one way to define a macro before a
24817 precompiled header is included; using a @code{#define} can also do it.
24818 There are also some options that define macros implicitly, like
24819 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24820 defined this way.
24822 @item If debugging information is output when using the precompiled
24823 header, using @option{-g} or similar, the same kind of debugging information
24824 must have been output when building the precompiled header.  However,
24825 a precompiled header built using @option{-g} can be used in a compilation
24826 when no debugging information is being output.
24828 @item The same @option{-m} options must generally be used when building
24829 and using the precompiled header.  @xref{Submodel Options},
24830 for any cases where this rule is relaxed.
24832 @item Each of the following options must be the same when building and using
24833 the precompiled header:
24835 @gccoptlist{-fexceptions}
24837 @item
24838 Some other command-line options starting with @option{-f},
24839 @option{-p}, or @option{-O} must be defined in the same way as when
24840 the precompiled header was generated.  At present, it's not clear
24841 which options are safe to change and which are not; the safest choice
24842 is to use exactly the same options when generating and using the
24843 precompiled header.  The following are known to be safe:
24845 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24846 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24847 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24848 -pedantic-errors}
24850 @end itemize
24852 For all of these except the last, the compiler automatically
24853 ignores the precompiled header if the conditions aren't met.  If you
24854 find an option combination that doesn't work and doesn't cause the
24855 precompiled header to be ignored, please consider filing a bug report,
24856 see @ref{Bugs}.
24858 If you do use differing options when generating and using the
24859 precompiled header, the actual behavior is a mixture of the
24860 behavior for the options.  For instance, if you use @option{-g} to
24861 generate the precompiled header but not when using it, you may or may
24862 not get debugging information for routines in the precompiled header.