Re: [Docs] Reword the documentation for -fdump-rtl-
[official-gcc.git] / gcc / doc / invoke.texi
blob4fc7d887a72a4666da3c171e7517d334b4ebfc0a
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 -trigraphs -traditional -traditional-cpp @gol
173 -fallow-single-precision  -fcond-mismatch -flax-vector-conversions @gol
174 -fsigned-bitfields  -fsigned-char @gol
175 -funsigned-bitfields  -funsigned-char}
177 @item C++ Language Options
178 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}.
179 @gccoptlist{-fabi-version=@var{n}  -fno-access-control  -fcheck-new @gol
180 -fconstexpr-depth=@var{n}  -ffriend-injection @gol
181 -fno-elide-constructors @gol
182 -fno-enforce-eh-specs @gol
183 -ffor-scope  -fno-for-scope  -fno-gnu-keywords @gol
184 -fno-implicit-templates @gol
185 -fno-implicit-inline-templates @gol
186 -fno-implement-inlines  -fms-extensions @gol
187 -fno-nonansi-builtins  -fnothrow-opt  -fno-operator-names @gol
188 -fno-optional-diags  -fpermissive @gol
189 -fno-pretty-templates @gol
190 -frepo  -fno-rtti -fsized-deallocation @gol
191 -fstats  -ftemplate-backtrace-limit=@var{n} @gol
192 -ftemplate-depth=@var{n} @gol
193 -fno-threadsafe-statics  -fuse-cxa-atexit @gol
194 -fno-weak  -nostdinc++ @gol
195 -fvisibility-inlines-hidden @gol
196 -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]} @gol
197 -fvtv-counts -fvtv-debug @gol
198 -fvisibility-ms-compat @gol
199 -fext-numeric-literals @gol
200 -Wabi=@var{n}  -Wabi-tag  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wmultiple-inheritance @gol
202 -Wnamespaces -Wnarrowing @gol
203 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
204 -Weffc++  -Wstrict-null-sentinel -Wtemplates @gol
205 -Wno-non-template-friend  -Wold-style-cast @gol
206 -Woverloaded-virtual  -Wno-pmf-conversions @gol
207 -Wsign-promo -Wvirtual-inheritance}
209 @item Objective-C and Objective-C++ Language Options
210 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
211 Objective-C and Objective-C++ Dialects}.
212 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
213 -fgnu-runtime  -fnext-runtime @gol
214 -fno-nil-receivers @gol
215 -fobjc-abi-version=@var{n} @gol
216 -fobjc-call-cxx-cdtors @gol
217 -fobjc-direct-dispatch @gol
218 -fobjc-exceptions @gol
219 -fobjc-gc @gol
220 -fobjc-nilcheck @gol
221 -fobjc-std=objc1 @gol
222 -fno-local-ivars @gol
223 -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]} @gol
224 -freplace-objc-classes @gol
225 -fzero-link @gol
226 -gen-decls @gol
227 -Wassign-intercept @gol
228 -Wno-protocol  -Wselector @gol
229 -Wstrict-selector-match @gol
230 -Wundeclared-selector}
232 @item Diagnostic Message Formatting Options
233 @xref{Diagnostic Message Formatting Options,,Options to Control Diagnostic Messages Formatting}.
234 @gccoptlist{-fmessage-length=@var{n}  @gol
235 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
236 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
237 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
239 @item Warning Options
240 @xref{Warning Options,,Options to Request or Suppress Warnings}.
241 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
242 -pedantic-errors @gol
243 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
244 -Waggressive-loop-optimizations -Warray-bounds -Warray-bounds=@var{n} @gol
245 -Wbool-compare -Wduplicated-cond -Wframe-address @gol
246 -Wno-attributes -Wno-builtin-macro-redefined @gol
247 -Wc90-c99-compat -Wc99-c11-compat @gol
248 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
249 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
250 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
251 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
252 -Wdisabled-optimization @gol
253 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
254 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
255 -Wno-endif-labels -Werror  -Werror=* @gol
256 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
257 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
258 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
259 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
260 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
261 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
262 -Winit-self  -Winline  -Wno-int-conversion @gol
263 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
264 -Wnull-dereference @gol
265 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
266 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
267 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args @gol
268 -Wmisleading-indentation -Wmissing-braces @gol
269 -Wmissing-field-initializers -Wmissing-include-dirs @gol
270 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
271 -Wodr  -Wno-overflow  -Wopenmp-simd @gol
272 -Woverride-init-side-effects @gol
273 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
274 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
275 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
276 -Wredundant-decls  -Wno-return-local-addr @gol
277 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
278 -Wshift-overflow -Wshift-overflow=@var{n} @gol
279 -Wshift-count-negative -Wshift-count-overflow -Wshift-negative-value @gol
280 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
281 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
282 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
283 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
284 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
285 -Wsuggest-final-types @gol -Wsuggest-final-methods -Wsuggest-override @gol
286 -Wmissing-format-attribute -Wsubobject-linkage @gol
287 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
288 -Wsystem-headers  -Wtautological-compare  -Wtrampolines  -Wtrigraphs @gol
289 -Wtype-limits  -Wundef @gol
290 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
291 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
292 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
293 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
294 -Wunused-const-variable @gol
295 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
296 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
297 -Wvla -Wvolatile-register-var  -Wwrite-strings @gol
298 -Wzero-as-null-pointer-constant}
300 @item C and Objective-C-only Warning Options
301 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
302 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
303 -Wold-style-declaration  -Wold-style-definition @gol
304 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
305 -Wdeclaration-after-statement -Wpointer-sign}
307 @item Debugging Options
308 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
309 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
310 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
311 -fasan-shadow-offset=@var{number} -fsanitize-sections=@var{s1},@var{s2},... @gol
312 -fsanitize-undefined-trap-on-error @gol
313 -fcheck-pointer-bounds -fchecking -fchkp-check-incomplete-type @gol
314 -fchkp-first-field-has-own-bounds -fchkp-narrow-bounds @gol
315 -fchkp-narrow-to-innermost-array -fchkp-optimize @gol
316 -fchkp-use-fast-string-functions -fchkp-use-nochk-string-functions @gol
317 -fchkp-use-static-bounds -fchkp-use-static-const-bounds @gol
318 -fchkp-treat-zero-dynamic-size-as-infinite -fchkp-check-read @gol
319 -fchkp-check-read -fchkp-check-write -fchkp-store-bounds @gol
320 -fchkp-instrument-calls -fchkp-instrument-marked-only @gol
321 -fchkp-use-wrappers @gol
322 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
323 -fdisable-ipa-@var{pass_name} @gol
324 -fdisable-rtl-@var{pass_name} @gol
325 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
326 -fdisable-tree-@var{pass_name} @gol
327 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
328 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
329 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
330 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
331 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
332 -fdump-passes @gol
333 -fdump-statistics @gol
334 -fdump-tree-all @gol
335 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
336 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
337 -fdump-tree-cfg -fdump-tree-alias @gol
338 -fdump-tree-ch @gol
339 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
340 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
341 -fdump-tree-gimple@r{[}-raw@r{]} @gol
342 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
343 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
344 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
345 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
346 -fdump-tree-backprop@r{[}-@var{n}@r{]} @gol
347 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
348 -fdump-tree-nrv -fdump-tree-vect @gol
349 -fdump-tree-sink @gol
350 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
351 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
352 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
353 -fdump-tree-vtable-verify @gol
354 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
355 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
356 -fdump-final-insns=@var{file} @gol
357 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
358 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
359 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
360 -fenable-@var{kind}-@var{pass} @gol
361 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
362 -fdebug-types-section -fmem-report-wpa @gol
363 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
364 -fopt-info @gol
365 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
366 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
367 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
368 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
369 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
370 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
371 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
372 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
373 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
374 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
375 -fdebug-prefix-map=@var{old}=@var{new} @gol
376 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
377 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
378 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
379 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
380 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
381 -print-sysroot -print-sysroot-headers-suffix @gol
382 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
384 @item Optimization Options
385 @xref{Optimize Options,,Options that Control Optimization}.
386 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
387 -falign-jumps[=@var{n}] @gol
388 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
389 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
390 -fauto-inc-dec -fbranch-probabilities @gol
391 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
392 -fbtr-bb-exclusive -fcaller-saves @gol
393 -fcombine-stack-adjustments -fconserve-stack @gol
394 -fcompare-elim -fcprop-registers -fcrossjumping @gol
395 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
396 -fcx-limited-range @gol
397 -fdata-sections -fdce -fdelayed-branch @gol
398 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
399 -fdevirtualize-at-ltrans -fdse @gol
400 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
401 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
402 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
403 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
404 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
405 -fif-conversion2 -findirect-inlining @gol
406 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
407 -finline-small-functions -fipa-cp -fipa-cp-clone -fipa-cp-alignment @gol
408 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
409 -fira-algorithm=@var{algorithm} @gol
410 -fira-region=@var{region} -fira-hoist-pressure @gol
411 -fira-loop-pressure -fno-ira-share-save-slots @gol
412 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
413 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
414 -fivopts -fkeep-inline-functions -fkeep-static-functions @gol
415 -fkeep-static-consts -flive-range-shrinkage @gol
416 -floop-block -floop-interchange -floop-strip-mine @gol
417 -floop-unroll-and-jam -floop-nest-optimize @gol
418 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
419 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
420 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
421 -fmove-loop-invariants -fno-branch-count-reg @gol
422 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
423 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
424 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
425 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
426 -fomit-frame-pointer -foptimize-sibling-calls @gol
427 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
428 -fprefetch-loop-arrays -fprofile-report @gol
429 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
430 -fprofile-generate=@var{path} @gol
431 -fprofile-use -fprofile-use=@var{path} -fprofile-values @gol
432 -fprofile-reorder-functions @gol
433 -freciprocal-math -free -frename-registers -freorder-blocks @gol
434 -freorder-blocks-algorithm=@var{algorithm} @gol
435 -freorder-blocks-and-partition -freorder-functions @gol
436 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
437 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
438 -fsched-spec-load -fsched-spec-load-dangerous @gol
439 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
440 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
441 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
442 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
443 -fschedule-fusion @gol
444 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
445 -fselective-scheduling -fselective-scheduling2 @gol
446 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
447 -fsemantic-interposition -fshrink-wrap -fsignaling-nans @gol
448 -fsingle-precision-constant -fsplit-ivs-in-unroller @gol
449 -fsplit-wide-types -fssa-backprop -fssa-phiopt @gol
450 -fstack-protector -fstack-protector-all -fstack-protector-strong @gol
451 -fstack-protector-explicit -fstdarg-opt -fstrict-aliasing @gol
452 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
453 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
454 -ftree-coalesce-vars -ftree-copy-prop -ftree-dce -ftree-dominator-opts @gol
455 -ftree-dse -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
456 -ftree-loop-if-convert-stores -ftree-loop-im @gol
457 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
458 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
459 -ftree-loop-vectorize @gol
460 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
461 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
462 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
463 -ftree-vectorize -ftree-vrp @gol
464 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
465 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
466 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
467 -fweb -fwhole-program -fwpa -fuse-linker-plugin @gol
468 --param @var{name}=@var{value}
469 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
471 @item Preprocessor Options
472 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
473 @gccoptlist{-A@var{question}=@var{answer} @gol
474 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
475 -C  -dD  -dI  -dM  -dN @gol
476 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
477 -idirafter @var{dir} @gol
478 -include @var{file}  -imacros @var{file} @gol
479 -iprefix @var{file}  -iwithprefix @var{dir} @gol
480 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
481 -imultilib @var{dir} -isysroot @var{dir} @gol
482 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
483 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
484 -remap -trigraphs  -undef  -U@var{macro}  @gol
485 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
487 @item Assembler Option
488 @xref{Assembler Options,,Passing Options to the Assembler}.
489 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
491 @item Linker Options
492 @xref{Link Options,,Options for Linking}.
493 @gccoptlist{@var{object-file-name}  -fuse-ld=@var{linker} -l@var{library} @gol
494 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
495 -s  -static -static-libgcc -static-libstdc++ @gol
496 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
497 -static-libmpx -static-libmpxwrappers @gol
498 -shared -shared-libgcc  -symbolic @gol
499 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
500 -u @var{symbol} -z @var{keyword}}
502 @item Directory Options
503 @xref{Directory Options,,Options for Directory Search}.
504 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
505 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
506 --sysroot=@var{dir} --no-sysroot-suffix}
508 @item Machine Dependent Options
509 @xref{Submodel Options,,Hardware Models and Configurations}.
510 @c This list is ordered alphanumerically by subsection name.
511 @c Try and put the significant identifier (CPU or system) first,
512 @c so users have a clue at guessing where the ones they want will be.
514 @emph{AArch64 Options}
515 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
516 -mgeneral-regs-only @gol
517 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
518 -mstrict-align @gol
519 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
520 -mtls-dialect=desc  -mtls-dialect=traditional @gol
521 -mtls-size=@var{size} @gol
522 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
523 -mfix-cortex-a53-843419  -mno-fix-cortex-a53-843419 @gol
524 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
526 @emph{Adapteva Epiphany Options}
527 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
528 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
529 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
530 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
531 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
532 -msplit-vecmove-early -m1reg-@var{reg}}
534 @emph{ARC Options}
535 @gccoptlist{-mbarrel-shifter @gol
536 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
537 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
538 -mea -mno-mpy -mmul32x16 -mmul64 @gol
539 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
540 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
541 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
542 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
543 -mucb-mcount -mvolatile-cache @gol
544 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
545 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
546 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
547 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
548 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
549 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
551 @emph{ARM Options}
552 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
553 -mabi=@var{name} @gol
554 -mapcs-stack-check  -mno-apcs-stack-check @gol
555 -mapcs-float  -mno-apcs-float @gol
556 -mapcs-reentrant  -mno-apcs-reentrant @gol
557 -msched-prolog  -mno-sched-prolog @gol
558 -mlittle-endian  -mbig-endian @gol
559 -mfloat-abi=@var{name} @gol
560 -mfp16-format=@var{name}
561 -mthumb-interwork  -mno-thumb-interwork @gol
562 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
563 -mtune=@var{name} -mprint-tune-info @gol
564 -mstructure-size-boundary=@var{n} @gol
565 -mabort-on-noreturn @gol
566 -mlong-calls  -mno-long-calls @gol
567 -msingle-pic-base  -mno-single-pic-base @gol
568 -mpic-register=@var{reg} @gol
569 -mnop-fun-dllimport @gol
570 -mpoke-function-name @gol
571 -mthumb  -marm @gol
572 -mtpcs-frame  -mtpcs-leaf-frame @gol
573 -mcaller-super-interworking  -mcallee-super-interworking @gol
574 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
575 -mword-relocations @gol
576 -mfix-cortex-m3-ldrd @gol
577 -munaligned-access @gol
578 -mneon-for-64bits @gol
579 -mslow-flash-data @gol
580 -masm-syntax-unified @gol
581 -mrestrict-it}
583 @emph{AVR Options}
584 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
585 -mcall-prologues -mint8 -mn_flash=@var{size} -mno-interrupts @gol
586 -mrelax -mrmw -mstrict-X -mtiny-stack -nodevicelib -Waddr-space-convert}
588 @emph{Blackfin Options}
589 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
590 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
591 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
592 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
593 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
594 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
595 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
596 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
597 -micplb}
599 @emph{C6X Options}
600 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
601 -msim -msdata=@var{sdata-type}}
603 @emph{CRIS Options}
604 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
605 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
606 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
607 -mstack-align  -mdata-align  -mconst-align @gol
608 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
609 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
610 -mmul-bug-workaround  -mno-mul-bug-workaround}
612 @emph{CR16 Options}
613 @gccoptlist{-mmac @gol
614 -mcr16cplus -mcr16c @gol
615 -msim -mint32 -mbit-ops
616 -mdata-model=@var{model}}
618 @emph{Darwin Options}
619 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
620 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
621 -client_name  -compatibility_version  -current_version @gol
622 -dead_strip @gol
623 -dependency-file  -dylib_file  -dylinker_install_name @gol
624 -dynamic  -dynamiclib  -exported_symbols_list @gol
625 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
626 -force_flat_namespace  -headerpad_max_install_names @gol
627 -iframework @gol
628 -image_base  -init  -install_name  -keep_private_externs @gol
629 -multi_module  -multiply_defined  -multiply_defined_unused @gol
630 -noall_load   -no_dead_strip_inits_and_terms @gol
631 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
632 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
633 -private_bundle  -read_only_relocs  -sectalign @gol
634 -sectobjectsymbols  -whyload  -seg1addr @gol
635 -sectcreate  -sectobjectsymbols  -sectorder @gol
636 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
637 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
638 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
639 -single_module  -static  -sub_library  -sub_umbrella @gol
640 -twolevel_namespace  -umbrella  -undefined @gol
641 -unexported_symbols_list  -weak_reference_mismatches @gol
642 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
643 -mkernel -mone-byte-bool}
645 @emph{DEC Alpha Options}
646 @gccoptlist{-mno-fp-regs  -msoft-float @gol
647 -mieee  -mieee-with-inexact  -mieee-conformant @gol
648 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
649 -mtrap-precision=@var{mode}  -mbuild-constants @gol
650 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
651 -mbwx  -mmax  -mfix  -mcix @gol
652 -mfloat-vax  -mfloat-ieee @gol
653 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
654 -msmall-text  -mlarge-text @gol
655 -mmemory-latency=@var{time}}
657 @emph{FR30 Options}
658 @gccoptlist{-msmall-model -mno-lsim}
660 @emph{FT32 Options}
661 @gccoptlist{-msim -mlra}
663 @emph{FRV Options}
664 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
665 -mhard-float  -msoft-float @gol
666 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
667 -mdouble  -mno-double @gol
668 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
669 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
670 -mlinked-fp  -mlong-calls  -malign-labels @gol
671 -mlibrary-pic  -macc-4  -macc-8 @gol
672 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
673 -moptimize-membar -mno-optimize-membar @gol
674 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
675 -mvliw-branch  -mno-vliw-branch @gol
676 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
677 -mno-nested-cond-exec  -mtomcat-stats @gol
678 -mTLS -mtls @gol
679 -mcpu=@var{cpu}}
681 @emph{GNU/Linux Options}
682 @gccoptlist{-mglibc -muclibc -mmusl -mbionic -mandroid @gol
683 -tno-android-cc -tno-android-ld}
685 @emph{H8/300 Options}
686 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
688 @emph{HPPA Options}
689 @gccoptlist{-march=@var{architecture-type} @gol
690 -mdisable-fpregs  -mdisable-indexing @gol
691 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
692 -mfixed-range=@var{register-range} @gol
693 -mjump-in-delay -mlinker-opt -mlong-calls @gol
694 -mlong-load-store  -mno-disable-fpregs @gol
695 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
696 -mno-jump-in-delay  -mno-long-load-store @gol
697 -mno-portable-runtime  -mno-soft-float @gol
698 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
699 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
700 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
701 -munix=@var{unix-std}  -nolibdld  -static  -threads}
703 @emph{IA-64 Options}
704 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
705 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
706 -mconstant-gp  -mauto-pic  -mfused-madd @gol
707 -minline-float-divide-min-latency @gol
708 -minline-float-divide-max-throughput @gol
709 -mno-inline-float-divide @gol
710 -minline-int-divide-min-latency @gol
711 -minline-int-divide-max-throughput  @gol
712 -mno-inline-int-divide @gol
713 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
714 -mno-inline-sqrt @gol
715 -mdwarf2-asm -mearly-stop-bits @gol
716 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
717 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
718 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
719 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
720 -msched-spec-ldc -msched-spec-control-ldc @gol
721 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
722 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
723 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
724 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
726 @emph{LM32 Options}
727 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
728 -msign-extend-enabled -muser-enabled}
730 @emph{M32R/D Options}
731 @gccoptlist{-m32r2 -m32rx -m32r @gol
732 -mdebug @gol
733 -malign-loops -mno-align-loops @gol
734 -missue-rate=@var{number} @gol
735 -mbranch-cost=@var{number} @gol
736 -mmodel=@var{code-size-model-type} @gol
737 -msdata=@var{sdata-type} @gol
738 -mno-flush-func -mflush-func=@var{name} @gol
739 -mno-flush-trap -mflush-trap=@var{number} @gol
740 -G @var{num}}
742 @emph{M32C Options}
743 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
745 @emph{M680x0 Options}
746 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune} @gol
747 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
748 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
749 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
750 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
751 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
752 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
753 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
754 -mxgot -mno-xgot}
756 @emph{MCore Options}
757 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
758 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
759 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
760 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
761 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
763 @emph{MeP Options}
764 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
765 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
766 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
767 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
768 -mtiny=@var{n}}
770 @emph{MicroBlaze Options}
771 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
772 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
773 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
774 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
775 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
777 @emph{MIPS Options}
778 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
779 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
780 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
781 -mips16  -mno-mips16  -mflip-mips16 @gol
782 -minterlink-compressed -mno-interlink-compressed @gol
783 -minterlink-mips16  -mno-interlink-mips16 @gol
784 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
785 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
786 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
787 -mno-float  -msingle-float  -mdouble-float @gol
788 -modd-spreg -mno-odd-spreg @gol
789 -mcompact-branches=@var{policy} @gol
790 -mabs=@var{mode}  -mnan=@var{encoding} @gol
791 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
792 -mmcu -mmno-mcu @gol
793 -meva -mno-eva @gol
794 -mvirt -mno-virt @gol
795 -mxpa -mno-xpa @gol
796 -mmicromips -mno-micromips @gol
797 -mfpu=@var{fpu-type} @gol
798 -msmartmips  -mno-smartmips @gol
799 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
800 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
801 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
802 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
803 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
804 -membedded-data  -mno-embedded-data @gol
805 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
806 -mcode-readable=@var{setting} @gol
807 -msplit-addresses  -mno-split-addresses @gol
808 -mexplicit-relocs  -mno-explicit-relocs @gol
809 -mcheck-zero-division  -mno-check-zero-division @gol
810 -mdivide-traps  -mdivide-breaks @gol
811 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
812 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
813 -mfix-24k -mno-fix-24k @gol
814 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
815 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
816 -mfix-vr4120  -mno-fix-vr4120 @gol
817 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
818 -mflush-func=@var{func}  -mno-flush-func @gol
819 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
820 -mfp-exceptions -mno-fp-exceptions @gol
821 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
822 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address @gol
823 -mframe-header-opt -mno-frame-header-opt}
825 @emph{MMIX Options}
826 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
827 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
828 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
829 -mno-base-addresses  -msingle-exit  -mno-single-exit}
831 @emph{MN10300 Options}
832 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
833 -mno-am33 -mam33 -mam33-2 -mam34 @gol
834 -mtune=@var{cpu-type} @gol
835 -mreturn-pointer-on-d0 @gol
836 -mno-crt0  -mrelax -mliw -msetlb}
838 @emph{Moxie Options}
839 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
841 @emph{MSP430 Options}
842 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
843 -mcode-region= -mdata-region= @gol
844 -msilicon-errata= -msilicon-errata-warn= @gol
845 -mhwmult= -minrt}
847 @emph{NDS32 Options}
848 @gccoptlist{-mbig-endian -mlittle-endian @gol
849 -mreduced-regs -mfull-regs @gol
850 -mcmov -mno-cmov @gol
851 -mperf-ext -mno-perf-ext @gol
852 -mv3push -mno-v3push @gol
853 -m16bit -mno-16bit @gol
854 -misr-vector-size=@var{num} @gol
855 -mcache-block-size=@var{num} @gol
856 -march=@var{arch} @gol
857 -mcmodel=@var{code-model} @gol
858 -mctor-dtor -mrelax}
860 @emph{Nios II Options}
861 @gccoptlist{-G @var{num} -mgpopt=@var{option} -mgpopt -mno-gpopt @gol
862 -mel -meb @gol
863 -mno-bypass-cache -mbypass-cache @gol
864 -mno-cache-volatile -mcache-volatile @gol
865 -mno-fast-sw-div -mfast-sw-div @gol
866 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
867 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
868 -mcustom-fpu-cfg=@var{name} @gol
869 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name} @gol
870 -march=@var{arch} -mbmx -mno-bmx -mcdx -mno-cdx}
872 @emph{Nvidia PTX Options}
873 @gccoptlist{-m32 -m64 -mmainkernel}
875 @emph{PDP-11 Options}
876 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
877 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
878 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
879 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
880 -mbranch-expensive  -mbranch-cheap @gol
881 -munix-asm  -mdec-asm}
883 @emph{picoChip Options}
884 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
885 -msymbol-as-address -mno-inefficient-warnings}
887 @emph{PowerPC Options}
888 See RS/6000 and PowerPC Options.
890 @emph{RL78 Options}
891 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=g14 -mallregs @gol
892 -mcpu=g10 -mcpu=g13 -mcpu=g14 -mg10 -mg13 -mg14 @gol
893 -m64bit-doubles -m32bit-doubles}
895 @emph{RS/6000 and PowerPC Options}
896 @gccoptlist{-mcpu=@var{cpu-type} @gol
897 -mtune=@var{cpu-type} @gol
898 -mcmodel=@var{code-model} @gol
899 -mpowerpc64 @gol
900 -maltivec  -mno-altivec @gol
901 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
902 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
903 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
904 -mfprnd  -mno-fprnd @gol
905 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
906 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
907 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
908 -malign-power  -malign-natural @gol
909 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
910 -msingle-float -mdouble-float -msimple-fpu @gol
911 -mstring  -mno-string  -mupdate  -mno-update @gol
912 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
913 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
914 -mstrict-align  -mno-strict-align  -mrelocatable @gol
915 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
916 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
917 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
918 -mprioritize-restricted-insns=@var{priority} @gol
919 -msched-costly-dep=@var{dependence_type} @gol
920 -minsert-sched-nops=@var{scheme} @gol
921 -mcall-sysv  -mcall-netbsd @gol
922 -maix-struct-return  -msvr4-struct-return @gol
923 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
924 -mblock-move-inline-limit=@var{num} @gol
925 -misel -mno-isel @gol
926 -misel=yes  -misel=no @gol
927 -mspe -mno-spe @gol
928 -mspe=yes  -mspe=no @gol
929 -mpaired @gol
930 -mgen-cell-microcode -mwarn-cell-microcode @gol
931 -mvrsave -mno-vrsave @gol
932 -mmulhw -mno-mulhw @gol
933 -mdlmzb -mno-dlmzb @gol
934 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
935 -mprototype  -mno-prototype @gol
936 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
937 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
938 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
939 -mno-recip-precision @gol
940 -mveclibabi=@var{type} -mfriz -mno-friz @gol
941 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
942 -msave-toc-indirect -mno-save-toc-indirect @gol
943 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
944 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
945 -mquad-memory -mno-quad-memory @gol
946 -mquad-memory-atomic -mno-quad-memory-atomic @gol
947 -mcompat-align-parm -mno-compat-align-parm @gol
948 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
949 -mupper-regs -mno-upper-regs @gol
950 -mfloat128 -mno-float128}
952 @emph{RX Options}
953 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
954 -mcpu=@gol
955 -mbig-endian-data -mlittle-endian-data @gol
956 -msmall-data @gol
957 -msim  -mno-sim@gol
958 -mas100-syntax -mno-as100-syntax@gol
959 -mrelax@gol
960 -mmax-constant-size=@gol
961 -mint-register=@gol
962 -mpid@gol
963 -mallow-string-insns -mno-allow-string-insns@gol
964 -mno-warn-multiple-fast-interrupts@gol
965 -msave-acc-in-interrupts}
967 @emph{S/390 and zSeries Options}
968 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
969 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
970 -mlong-double-64 -mlong-double-128 @gol
971 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
972 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
973 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
974 -mhtm -mvx -mzvector @gol
975 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
976 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
977 -mhotpatch=@var{halfwords},@var{halfwords}}
979 @emph{Score Options}
980 @gccoptlist{-meb -mel @gol
981 -mnhwloop @gol
982 -muls @gol
983 -mmac @gol
984 -mscore5 -mscore5u -mscore7 -mscore7d}
986 @emph{SH Options}
987 @gccoptlist{-m1  -m2  -m2e @gol
988 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
989 -m3  -m3e @gol
990 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
991 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
992 -mb  -ml  -mdalign  -mrelax @gol
993 -mbigtable -mfmovd -mrenesas -mno-renesas -mnomacsave @gol
994 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
995 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
996 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
997 -maccumulate-outgoing-args @gol
998 -matomic-model=@var{atomic-model} @gol
999 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1000 -mcbranch-force-delay-slot @gol
1001 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1002 -mpretend-cmove -mtas}
1004 @emph{Solaris 2 Options}
1005 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1006 -pthreads -pthread}
1008 @emph{SPARC Options}
1009 @gccoptlist{-mcpu=@var{cpu-type} @gol
1010 -mtune=@var{cpu-type} @gol
1011 -mcmodel=@var{code-model} @gol
1012 -mmemory-model=@var{mem-model} @gol
1013 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1014 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1015 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1016 -mhard-quad-float  -msoft-quad-float @gol
1017 -mstack-bias  -mno-stack-bias @gol
1018 -munaligned-doubles  -mno-unaligned-doubles @gol
1019 -muser-mode  -mno-user-mode @gol
1020 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1021 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1022 -mcbcond -mno-cbcond @gol
1023 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1024 -mfix-at697f -mfix-ut699}
1026 @emph{SPU Options}
1027 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1028 -msafe-dma -munsafe-dma @gol
1029 -mbranch-hints @gol
1030 -msmall-mem -mlarge-mem -mstdmain @gol
1031 -mfixed-range=@var{register-range} @gol
1032 -mea32 -mea64 @gol
1033 -maddress-space-conversion -mno-address-space-conversion @gol
1034 -mcache-size=@var{cache-size} @gol
1035 -matomic-updates -mno-atomic-updates}
1037 @emph{System V Options}
1038 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1040 @emph{TILE-Gx Options}
1041 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1042 -mcmodel=@var{code-model}}
1044 @emph{TILEPro Options}
1045 @gccoptlist{-mcpu=@var{cpu} -m32}
1047 @emph{V850 Options}
1048 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1049 -mprolog-function  -mno-prolog-function  -mspace @gol
1050 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1051 -mapp-regs  -mno-app-regs @gol
1052 -mdisable-callt  -mno-disable-callt @gol
1053 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1054 -mv850e -mv850 -mv850e3v5 @gol
1055 -mloop @gol
1056 -mrelax @gol
1057 -mlong-jumps @gol
1058 -msoft-float @gol
1059 -mhard-float @gol
1060 -mgcc-abi @gol
1061 -mrh850-abi @gol
1062 -mbig-switch}
1064 @emph{VAX Options}
1065 @gccoptlist{-mg  -mgnu  -munix}
1067 @emph{Visium Options}
1068 @gccoptlist{-mdebug -msim -mfpu -mno-fpu -mhard-float -msoft-float @gol
1069 -mcpu=@var{cpu-type} -mtune=@var{cpu-type} -msv-mode -muser-mode}
1071 @emph{VMS Options}
1072 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1073 -mpointer-size=@var{size}}
1075 @emph{VxWorks Options}
1076 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1077 -Xbind-lazy  -Xbind-now}
1079 @emph{x86 Options}
1080 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
1081 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
1082 -mfpmath=@var{unit} @gol
1083 -masm=@var{dialect}  -mno-fancy-math-387 @gol
1084 -mno-fp-ret-in-387  -msoft-float @gol
1085 -mno-wide-multiply  -mrtd  -malign-double @gol
1086 -mpreferred-stack-boundary=@var{num} @gol
1087 -mincoming-stack-boundary=@var{num} @gol
1088 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
1089 -mrecip -mrecip=@var{opt} @gol
1090 -mvzeroupper -mprefer-avx128 @gol
1091 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
1092 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -mavx512vl @gol
1093 -mavx512bw -mavx512dq -mavx512ifma -mavx512vbmi -msha -maes @gol
1094 -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma @gol
1095 -mprefetchwt1 -mclflushopt -mxsavec -mxsaves @gol
1096 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
1097 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mmwaitx -mthreads @gol
1098 -mno-align-stringops  -minline-all-stringops @gol
1099 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
1100 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy} @gol
1101 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
1102 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
1103 -mregparm=@var{num}  -msseregparm @gol
1104 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
1105 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
1106 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
1107 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
1108 -m32 -m64 -mx32 -m16 -miamcu -mlarge-data-threshold=@var{num} @gol
1109 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
1110 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
1111 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
1113 @emph{x86 Windows Options}
1114 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
1115 -mnop-fun-dllimport -mthread @gol
1116 -municode -mwin32 -mwindows -fno-set-stack-executable}
1118 @emph{Xstormy16 Options}
1119 @gccoptlist{-msim}
1121 @emph{Xtensa Options}
1122 @gccoptlist{-mconst16 -mno-const16 @gol
1123 -mfused-madd  -mno-fused-madd @gol
1124 -mforce-no-pic @gol
1125 -mserialize-volatile  -mno-serialize-volatile @gol
1126 -mtext-section-literals  -mno-text-section-literals @gol
1127 -mauto-litpools  -mno-auto-litpools @gol
1128 -mtarget-align  -mno-target-align @gol
1129 -mlongcalls  -mno-longcalls}
1131 @emph{zSeries Options}
1132 See S/390 and zSeries Options.
1134 @item Code Generation Options
1135 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1136 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1137 -ffixed-@var{reg}  -fexceptions @gol
1138 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1139 -fasynchronous-unwind-tables @gol
1140 -fno-gnu-unique @gol
1141 -finhibit-size-directive  -finstrument-functions @gol
1142 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1143 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1144 -fno-common  -fno-ident @gol
1145 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE -fno-plt @gol
1146 -fno-jump-tables @gol
1147 -frecord-gcc-switches @gol
1148 -freg-struct-return  -fshort-enums @gol
1149 -fshort-double  -fshort-wchar @gol
1150 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1151 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1152 -fno-stack-limit -fsplit-stack @gol
1153 -fleading-underscore  -ftls-model=@var{model} @gol
1154 -fstack-reuse=@var{reuse_level} @gol
1155 -ftrapv  -fwrapv  -fbounds-check @gol
1156 -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]} @gol
1157 -fstrict-volatile-bitfields -fsync-libcalls}
1158 @end table
1161 @node Overall Options
1162 @section Options Controlling the Kind of Output
1164 Compilation can involve up to four stages: preprocessing, compilation
1165 proper, assembly and linking, always in that order.  GCC is capable of
1166 preprocessing and compiling several files either into several
1167 assembler input files, or into one assembler input file; then each
1168 assembler input file produces an object file, and linking combines all
1169 the object files (those newly compiled, and those specified as input)
1170 into an executable file.
1172 @cindex file name suffix
1173 For any given input file, the file name suffix determines what kind of
1174 compilation is done:
1176 @table @gcctabopt
1177 @item @var{file}.c
1178 C source code that must be preprocessed.
1180 @item @var{file}.i
1181 C source code that should not be preprocessed.
1183 @item @var{file}.ii
1184 C++ source code that should not be preprocessed.
1186 @item @var{file}.m
1187 Objective-C source code.  Note that you must link with the @file{libobjc}
1188 library to make an Objective-C program work.
1190 @item @var{file}.mi
1191 Objective-C source code that should not be preprocessed.
1193 @item @var{file}.mm
1194 @itemx @var{file}.M
1195 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1196 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1197 to a literal capital M@.
1199 @item @var{file}.mii
1200 Objective-C++ source code that should not be preprocessed.
1202 @item @var{file}.h
1203 C, C++, Objective-C or Objective-C++ header file to be turned into a
1204 precompiled header (default), or C, C++ header file to be turned into an
1205 Ada spec (via the @option{-fdump-ada-spec} switch).
1207 @item @var{file}.cc
1208 @itemx @var{file}.cp
1209 @itemx @var{file}.cxx
1210 @itemx @var{file}.cpp
1211 @itemx @var{file}.CPP
1212 @itemx @var{file}.c++
1213 @itemx @var{file}.C
1214 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1215 the last two letters must both be literally @samp{x}.  Likewise,
1216 @samp{.C} refers to a literal capital C@.
1218 @item @var{file}.mm
1219 @itemx @var{file}.M
1220 Objective-C++ source code that must be preprocessed.
1222 @item @var{file}.mii
1223 Objective-C++ source code that should not be preprocessed.
1225 @item @var{file}.hh
1226 @itemx @var{file}.H
1227 @itemx @var{file}.hp
1228 @itemx @var{file}.hxx
1229 @itemx @var{file}.hpp
1230 @itemx @var{file}.HPP
1231 @itemx @var{file}.h++
1232 @itemx @var{file}.tcc
1233 C++ header file to be turned into a precompiled header or Ada spec.
1235 @item @var{file}.f
1236 @itemx @var{file}.for
1237 @itemx @var{file}.ftn
1238 Fixed form Fortran source code that should not be preprocessed.
1240 @item @var{file}.F
1241 @itemx @var{file}.FOR
1242 @itemx @var{file}.fpp
1243 @itemx @var{file}.FPP
1244 @itemx @var{file}.FTN
1245 Fixed form Fortran source code that must be preprocessed (with the traditional
1246 preprocessor).
1248 @item @var{file}.f90
1249 @itemx @var{file}.f95
1250 @itemx @var{file}.f03
1251 @itemx @var{file}.f08
1252 Free form Fortran source code that should not be preprocessed.
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 must be preprocessed (with the
1259 traditional preprocessor).
1261 @item @var{file}.go
1262 Go source code.
1264 @c FIXME: Descriptions of Java file types.
1265 @c @var{file}.java
1266 @c @var{file}.class
1267 @c @var{file}.zip
1268 @c @var{file}.jar
1270 @item @var{file}.ads
1271 Ada source code file that contains a library unit declaration (a
1272 declaration of a package, subprogram, or generic, or a generic
1273 instantiation), or a library unit renaming declaration (a package,
1274 generic, or subprogram renaming declaration).  Such files are also
1275 called @dfn{specs}.
1277 @item @var{file}.adb
1278 Ada source code file containing a library unit body (a subprogram or
1279 package body).  Such files are also called @dfn{bodies}.
1281 @c GCC also knows about some suffixes for languages not yet included:
1282 @c Pascal:
1283 @c @var{file}.p
1284 @c @var{file}.pas
1285 @c Ratfor:
1286 @c @var{file}.r
1288 @item @var{file}.s
1289 Assembler code.
1291 @item @var{file}.S
1292 @itemx @var{file}.sx
1293 Assembler code that must be preprocessed.
1295 @item @var{other}
1296 An object file to be fed straight into linking.
1297 Any file name with no recognized suffix is treated this way.
1298 @end table
1300 @opindex x
1301 You can specify the input language explicitly with the @option{-x} option:
1303 @table @gcctabopt
1304 @item -x @var{language}
1305 Specify explicitly the @var{language} for the following input files
1306 (rather than letting the compiler choose a default based on the file
1307 name suffix).  This option applies to all following input files until
1308 the next @option{-x} option.  Possible values for @var{language} are:
1309 @smallexample
1310 c  c-header  cpp-output
1311 c++  c++-header  c++-cpp-output
1312 objective-c  objective-c-header  objective-c-cpp-output
1313 objective-c++ objective-c++-header objective-c++-cpp-output
1314 assembler  assembler-with-cpp
1316 f77  f77-cpp-input f95  f95-cpp-input
1318 java
1319 @end smallexample
1321 @item -x none
1322 Turn off any specification of a language, so that subsequent files are
1323 handled according to their file name suffixes (as they are if @option{-x}
1324 has not been used at all).
1326 @item -pass-exit-codes
1327 @opindex pass-exit-codes
1328 Normally the @command{gcc} program exits with the code of 1 if any
1329 phase of the compiler returns a non-success return code.  If you specify
1330 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1331 the numerically highest error produced by any phase returning an error
1332 indication.  The C, C++, and Fortran front ends return 4 if an internal
1333 compiler error is encountered.
1334 @end table
1336 If you only want some of the stages of compilation, you can use
1337 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1338 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1339 @command{gcc} is to stop.  Note that some combinations (for example,
1340 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1342 @table @gcctabopt
1343 @item -c
1344 @opindex c
1345 Compile or assemble the source files, but do not link.  The linking
1346 stage simply is not done.  The ultimate output is in the form of an
1347 object file for each source file.
1349 By default, the object file name for a source file is made by replacing
1350 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1352 Unrecognized input files, not requiring compilation or assembly, are
1353 ignored.
1355 @item -S
1356 @opindex S
1357 Stop after the stage of compilation proper; do not assemble.  The output
1358 is in the form of an assembler code file for each non-assembler input
1359 file specified.
1361 By default, the assembler file name for a source file is made by
1362 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1364 Input files that don't require compilation are ignored.
1366 @item -E
1367 @opindex E
1368 Stop after the preprocessing stage; do not run the compiler proper.  The
1369 output is in the form of preprocessed source code, which is sent to the
1370 standard output.
1372 Input files that don't require preprocessing are ignored.
1374 @cindex output file option
1375 @item -o @var{file}
1376 @opindex o
1377 Place output in file @var{file}.  This applies to whatever
1378 sort of output is being produced, whether it be an executable file,
1379 an object file, an assembler file or preprocessed C code.
1381 If @option{-o} is not specified, the default is to put an executable
1382 file in @file{a.out}, the object file for
1383 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1384 assembler file in @file{@var{source}.s}, a precompiled header file in
1385 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1386 standard output.
1388 @item -v
1389 @opindex v
1390 Print (on standard error output) the commands executed to run the stages
1391 of compilation.  Also print the version number of the compiler driver
1392 program and of the preprocessor and the compiler proper.
1394 @item -###
1395 @opindex ###
1396 Like @option{-v} except the commands are not executed and arguments
1397 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1398 This is useful for shell scripts to capture the driver-generated command lines.
1400 @item -pipe
1401 @opindex pipe
1402 Use pipes rather than temporary files for communication between the
1403 various stages of compilation.  This fails to work on some systems where
1404 the assembler is unable to read from a pipe; but the GNU assembler has
1405 no trouble.
1407 @item --help
1408 @opindex help
1409 Print (on the standard output) a description of the command-line options
1410 understood by @command{gcc}.  If the @option{-v} option is also specified
1411 then @option{--help} is also passed on to the various processes
1412 invoked by @command{gcc}, so that they can display the command-line options
1413 they accept.  If the @option{-Wextra} option has also been specified
1414 (prior to the @option{--help} option), then command-line options that
1415 have no documentation associated with them are also displayed.
1417 @item --target-help
1418 @opindex target-help
1419 Print (on the standard output) a description of target-specific command-line
1420 options for each tool.  For some targets extra target-specific
1421 information may also be printed.
1423 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1424 Print (on the standard output) a description of the command-line
1425 options understood by the compiler that fit into all specified classes
1426 and qualifiers.  These are the supported classes:
1428 @table @asis
1429 @item @samp{optimizers}
1430 Display all of the optimization options supported by the
1431 compiler.
1433 @item @samp{warnings}
1434 Display all of the options controlling warning messages
1435 produced by the compiler.
1437 @item @samp{target}
1438 Display target-specific options.  Unlike the
1439 @option{--target-help} option however, target-specific options of the
1440 linker and assembler are not displayed.  This is because those
1441 tools do not currently support the extended @option{--help=} syntax.
1443 @item @samp{params}
1444 Display the values recognized by the @option{--param}
1445 option.
1447 @item @var{language}
1448 Display the options supported for @var{language}, where
1449 @var{language} is the name of one of the languages supported in this
1450 version of GCC@.
1452 @item @samp{common}
1453 Display the options that are common to all languages.
1454 @end table
1456 These are the supported qualifiers:
1458 @table @asis
1459 @item @samp{undocumented}
1460 Display only those options that are undocumented.
1462 @item @samp{joined}
1463 Display options taking an argument that appears after an equal
1464 sign in the same continuous piece of text, such as:
1465 @samp{--help=target}.
1467 @item @samp{separate}
1468 Display options taking an argument that appears as a separate word
1469 following the original option, such as: @samp{-o output-file}.
1470 @end table
1472 Thus for example to display all the undocumented target-specific
1473 switches supported by the compiler, use:
1475 @smallexample
1476 --help=target,undocumented
1477 @end smallexample
1479 The sense of a qualifier can be inverted by prefixing it with the
1480 @samp{^} character, so for example to display all binary warning
1481 options (i.e., ones that are either on or off and that do not take an
1482 argument) that have a description, use:
1484 @smallexample
1485 --help=warnings,^joined,^undocumented
1486 @end smallexample
1488 The argument to @option{--help=} should not consist solely of inverted
1489 qualifiers.
1491 Combining several classes is possible, although this usually
1492 restricts the output so much that there is nothing to display.  One
1493 case where it does work, however, is when one of the classes is
1494 @var{target}.  For example, to display all the target-specific
1495 optimization options, use:
1497 @smallexample
1498 --help=target,optimizers
1499 @end smallexample
1501 The @option{--help=} option can be repeated on the command line.  Each
1502 successive use displays its requested class of options, skipping
1503 those that have already been displayed.
1505 If the @option{-Q} option appears on the command line before the
1506 @option{--help=} option, then the descriptive text displayed by
1507 @option{--help=} is changed.  Instead of describing the displayed
1508 options, an indication is given as to whether the option is enabled,
1509 disabled or set to a specific value (assuming that the compiler
1510 knows this at the point where the @option{--help=} option is used).
1512 Here is a truncated example from the ARM port of @command{gcc}:
1514 @smallexample
1515   % gcc -Q -mabi=2 --help=target -c
1516   The following options are target specific:
1517   -mabi=                                2
1518   -mabort-on-noreturn                   [disabled]
1519   -mapcs                                [disabled]
1520 @end smallexample
1522 The output is sensitive to the effects of previous command-line
1523 options, so for example it is possible to find out which optimizations
1524 are enabled at @option{-O2} by using:
1526 @smallexample
1527 -Q -O2 --help=optimizers
1528 @end smallexample
1530 Alternatively you can discover which binary optimizations are enabled
1531 by @option{-O3} by using:
1533 @smallexample
1534 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1535 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1536 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1537 @end smallexample
1539 @item -no-canonical-prefixes
1540 @opindex no-canonical-prefixes
1541 Do not expand any symbolic links, resolve references to @samp{/../}
1542 or @samp{/./}, or make the path absolute when generating a relative
1543 prefix.
1545 @item --version
1546 @opindex version
1547 Display the version number and copyrights of the invoked GCC@.
1549 @item -wrapper
1550 @opindex wrapper
1551 Invoke all subcommands under a wrapper program.  The name of the
1552 wrapper program and its parameters are passed as a comma separated
1553 list.
1555 @smallexample
1556 gcc -c t.c -wrapper gdb,--args
1557 @end smallexample
1559 @noindent
1560 This invokes all subprograms of @command{gcc} under
1561 @samp{gdb --args}, thus the invocation of @command{cc1} is
1562 @samp{gdb --args cc1 @dots{}}.
1564 @item -fplugin=@var{name}.so
1565 @opindex fplugin
1566 Load the plugin code in file @var{name}.so, assumed to be a
1567 shared object to be dlopen'd by the compiler.  The base name of
1568 the shared object file is used to identify the plugin for the
1569 purposes of argument parsing (See
1570 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1571 Each plugin should define the callback functions specified in the
1572 Plugins API.
1574 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1575 @opindex fplugin-arg
1576 Define an argument called @var{key} with a value of @var{value}
1577 for the plugin called @var{name}.
1579 @item -fdump-ada-spec@r{[}-slim@r{]}
1580 @opindex fdump-ada-spec
1581 For C and C++ source and include files, generate corresponding Ada specs.
1582 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1583 GNAT User's Guide}, which provides detailed documentation on this feature.
1585 @item -fada-spec-parent=@var{unit}
1586 @opindex fada-spec-parent
1587 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1588 Ada specs as child units of parent @var{unit}.
1590 @item -fdump-go-spec=@var{file}
1591 @opindex fdump-go-spec
1592 For input files in any language, generate corresponding Go
1593 declarations in @var{file}.  This generates Go @code{const},
1594 @code{type}, @code{var}, and @code{func} declarations which may be a
1595 useful way to start writing a Go interface to code written in some
1596 other language.
1598 @include @value{srcdir}/../libiberty/at-file.texi
1599 @end table
1601 @node Invoking G++
1602 @section Compiling C++ Programs
1604 @cindex suffixes for C++ source
1605 @cindex C++ source file suffixes
1606 C++ source files conventionally use one of the suffixes @samp{.C},
1607 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1608 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1609 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1610 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1611 files with these names and compiles them as C++ programs even if you
1612 call the compiler the same way as for compiling C programs (usually
1613 with the name @command{gcc}).
1615 @findex g++
1616 @findex c++
1617 However, the use of @command{gcc} does not add the C++ library.
1618 @command{g++} is a program that calls GCC and automatically specifies linking
1619 against the C++ library.  It treats @samp{.c},
1620 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1621 files unless @option{-x} is used.  This program is also useful when
1622 precompiling a C header file with a @samp{.h} extension for use in C++
1623 compilations.  On many systems, @command{g++} is also installed with
1624 the name @command{c++}.
1626 @cindex invoking @command{g++}
1627 When you compile C++ programs, you may specify many of the same
1628 command-line options that you use for compiling programs in any
1629 language; or command-line options meaningful for C and related
1630 languages; or options that are meaningful only for C++ programs.
1631 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1632 explanations of options for languages related to C@.
1633 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1634 explanations of options that are meaningful only for C++ programs.
1636 @node C Dialect Options
1637 @section Options Controlling C Dialect
1638 @cindex dialect options
1639 @cindex language dialect options
1640 @cindex options, dialect
1642 The following options control the dialect of C (or languages derived
1643 from C, such as C++, Objective-C and Objective-C++) that the compiler
1644 accepts:
1646 @table @gcctabopt
1647 @cindex ANSI support
1648 @cindex ISO support
1649 @item -ansi
1650 @opindex ansi
1651 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1652 equivalent to @option{-std=c++98}.
1654 This turns off certain features of GCC that are incompatible with ISO
1655 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1656 such as the @code{asm} and @code{typeof} keywords, and
1657 predefined macros such as @code{unix} and @code{vax} that identify the
1658 type of system you are using.  It also enables the undesirable and
1659 rarely used ISO trigraph feature.  For the C compiler,
1660 it disables recognition of C++ style @samp{//} comments as well as
1661 the @code{inline} keyword.
1663 The alternate keywords @code{__asm__}, @code{__extension__},
1664 @code{__inline__} and @code{__typeof__} continue to work despite
1665 @option{-ansi}.  You would not want to use them in an ISO C program, of
1666 course, but it is useful to put them in header files that might be included
1667 in compilations done with @option{-ansi}.  Alternate predefined macros
1668 such as @code{__unix__} and @code{__vax__} are also available, with or
1669 without @option{-ansi}.
1671 The @option{-ansi} option does not cause non-ISO programs to be
1672 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1673 addition to @option{-ansi}.  @xref{Warning Options}.
1675 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1676 option is used.  Some header files may notice this macro and refrain
1677 from declaring certain functions or defining certain macros that the
1678 ISO standard doesn't call for; this is to avoid interfering with any
1679 programs that might use these names for other things.
1681 Functions that are normally built in but do not have semantics
1682 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1683 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1684 built-in functions provided by GCC}, for details of the functions
1685 affected.
1687 @item -std=
1688 @opindex std
1689 Determine the language standard. @xref{Standards,,Language Standards
1690 Supported by GCC}, for details of these standard versions.  This option
1691 is currently only supported when compiling C or C++.
1693 The compiler can accept several base standards, such as @samp{c90} or
1694 @samp{c++98}, and GNU dialects of those standards, such as
1695 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1696 compiler accepts all programs following that standard plus those
1697 using GNU extensions that do not contradict it.  For example,
1698 @option{-std=c90} turns off certain features of GCC that are
1699 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1700 keywords, but not other GNU extensions that do not have a meaning in
1701 ISO C90, such as omitting the middle term of a @code{?:}
1702 expression. On the other hand, when a GNU dialect of a standard is
1703 specified, all features supported by the compiler are enabled, even when
1704 those features change the meaning of the base standard.  As a result, some
1705 strict-conforming programs may be rejected.  The particular standard
1706 is used by @option{-Wpedantic} to identify which features are GNU
1707 extensions given that version of the standard. For example
1708 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1709 comments, while @option{-std=gnu99 -Wpedantic} does not.
1711 A value for this option must be provided; possible values are
1713 @table @samp
1714 @item c90
1715 @itemx c89
1716 @itemx iso9899:1990
1717 Support all ISO C90 programs (certain GNU extensions that conflict
1718 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1720 @item iso9899:199409
1721 ISO C90 as modified in amendment 1.
1723 @item c99
1724 @itemx c9x
1725 @itemx iso9899:1999
1726 @itemx iso9899:199x
1727 ISO C99.  This standard is substantially completely supported, modulo
1728 bugs and floating-point issues
1729 (mainly but not entirely relating to optional C99 features from
1730 Annexes F and G).  See
1731 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1732 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1734 @item c11
1735 @itemx c1x
1736 @itemx iso9899:2011
1737 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1738 substantially completely supported, modulo bugs, floating-point issues
1739 (mainly but not entirely relating to optional C11 features from
1740 Annexes F and G) and the optional Annexes K (Bounds-checking
1741 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1743 @item gnu90
1744 @itemx gnu89
1745 GNU dialect of ISO C90 (including some C99 features).
1747 @item gnu99
1748 @itemx gnu9x
1749 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1751 @item gnu11
1752 @itemx gnu1x
1753 GNU dialect of ISO C11.  This is the default for C code.
1754 The name @samp{gnu1x} is deprecated.
1756 @item c++98
1757 @itemx c++03
1758 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1759 additional defect reports. Same as @option{-ansi} for C++ code.
1761 @item gnu++98
1762 @itemx gnu++03
1763 GNU dialect of @option{-std=c++98}.  This is the default for
1764 C++ code.
1766 @item c++11
1767 @itemx c++0x
1768 The 2011 ISO C++ standard plus amendments.
1769 The name @samp{c++0x} is deprecated.
1771 @item gnu++11
1772 @itemx gnu++0x
1773 GNU dialect of @option{-std=c++11}.
1774 The name @samp{gnu++0x} is deprecated.
1776 @item c++14
1777 @itemx c++1y
1778 The 2014 ISO C++ standard plus amendments.
1779 The name @samp{c++1y} is deprecated.
1781 @item gnu++14
1782 @itemx gnu++1y
1783 GNU dialect of @option{-std=c++14}.
1784 The name @samp{gnu++1y} is deprecated.
1786 @item c++1z
1787 The next revision of the ISO C++ standard, tentatively planned for
1788 2017.  Support is highly experimental, and will almost certainly
1789 change in incompatible ways in future releases.
1791 @item gnu++1z
1792 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1793 and will almost certainly change in incompatible ways in future
1794 releases.
1795 @end table
1797 @item -fgnu89-inline
1798 @opindex fgnu89-inline
1799 The option @option{-fgnu89-inline} tells GCC to use the traditional
1800 GNU semantics for @code{inline} functions when in C99 mode.
1801 @xref{Inline,,An Inline Function is As Fast As a Macro}.
1802 Using this option is roughly equivalent to adding the
1803 @code{gnu_inline} function attribute to all inline functions
1804 (@pxref{Function Attributes}).
1806 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1807 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1808 specifies the default behavior).
1809 This option is not supported in @option{-std=c90} or
1810 @option{-std=gnu90} mode.
1812 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1813 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1814 in effect for @code{inline} functions.  @xref{Common Predefined
1815 Macros,,,cpp,The C Preprocessor}.
1817 @item -aux-info @var{filename}
1818 @opindex aux-info
1819 Output to the given filename prototyped declarations for all functions
1820 declared and/or defined in a translation unit, including those in header
1821 files.  This option is silently ignored in any language other than C@.
1823 Besides declarations, the file indicates, in comments, the origin of
1824 each declaration (source file and line), whether the declaration was
1825 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1826 @samp{O} for old, respectively, in the first character after the line
1827 number and the colon), and whether it came from a declaration or a
1828 definition (@samp{C} or @samp{F}, respectively, in the following
1829 character).  In the case of function definitions, a K&R-style list of
1830 arguments followed by their declarations is also provided, inside
1831 comments, after the declaration.
1833 @item -fallow-parameterless-variadic-functions
1834 @opindex fallow-parameterless-variadic-functions
1835 Accept variadic functions without named parameters.
1837 Although it is possible to define such a function, this is not very
1838 useful as it is not possible to read the arguments.  This is only
1839 supported for C as this construct is allowed by C++.
1841 @item -fno-asm
1842 @opindex fno-asm
1843 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1844 keyword, so that code can use these words as identifiers.  You can use
1845 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1846 instead.  @option{-ansi} implies @option{-fno-asm}.
1848 In C++, this switch only affects the @code{typeof} keyword, since
1849 @code{asm} and @code{inline} are standard keywords.  You may want to
1850 use the @option{-fno-gnu-keywords} flag instead, which has the same
1851 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1852 switch only affects the @code{asm} and @code{typeof} keywords, since
1853 @code{inline} is a standard keyword in ISO C99.
1855 @item -fno-builtin
1856 @itemx -fno-builtin-@var{function}
1857 @opindex fno-builtin
1858 @cindex built-in functions
1859 Don't recognize built-in functions that do not begin with
1860 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1861 functions provided by GCC}, for details of the functions affected,
1862 including those which are not built-in functions when @option{-ansi} or
1863 @option{-std} options for strict ISO C conformance are used because they
1864 do not have an ISO standard meaning.
1866 GCC normally generates special code to handle certain built-in functions
1867 more efficiently; for instance, calls to @code{alloca} may become single
1868 instructions which adjust the stack directly, and calls to @code{memcpy}
1869 may become inline copy loops.  The resulting code is often both smaller
1870 and faster, but since the function calls no longer appear as such, you
1871 cannot set a breakpoint on those calls, nor can you change the behavior
1872 of the functions by linking with a different library.  In addition,
1873 when a function is recognized as a built-in function, GCC may use
1874 information about that function to warn about problems with calls to
1875 that function, or to generate more efficient code, even if the
1876 resulting code still contains calls to that function.  For example,
1877 warnings are given with @option{-Wformat} for bad calls to
1878 @code{printf} when @code{printf} is built in and @code{strlen} is
1879 known not to modify global memory.
1881 With the @option{-fno-builtin-@var{function}} option
1882 only the built-in function @var{function} is
1883 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1884 function is named that is not built-in in this version of GCC, this
1885 option is ignored.  There is no corresponding
1886 @option{-fbuiltin-@var{function}} option; if you wish to enable
1887 built-in functions selectively when using @option{-fno-builtin} or
1888 @option{-ffreestanding}, you may define macros such as:
1890 @smallexample
1891 #define abs(n)          __builtin_abs ((n))
1892 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1893 @end smallexample
1895 @item -fhosted
1896 @opindex fhosted
1897 @cindex hosted environment
1899 Assert that compilation targets a hosted environment.  This implies
1900 @option{-fbuiltin}.  A hosted environment is one in which the
1901 entire standard library is available, and in which @code{main} has a return
1902 type of @code{int}.  Examples are nearly everything except a kernel.
1903 This is equivalent to @option{-fno-freestanding}.
1905 @item -ffreestanding
1906 @opindex ffreestanding
1907 @cindex hosted environment
1909 Assert that compilation targets a freestanding environment.  This
1910 implies @option{-fno-builtin}.  A freestanding environment
1911 is one in which the standard library may not exist, and program startup may
1912 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1913 This is equivalent to @option{-fno-hosted}.
1915 @xref{Standards,,Language Standards Supported by GCC}, for details of
1916 freestanding and hosted environments.
1918 @item -fopenacc
1919 @opindex fopenacc
1920 @cindex OpenACC accelerator programming
1921 Enable handling of OpenACC directives @code{#pragma acc} in C/C++ and
1922 @code{!$acc} in Fortran.  When @option{-fopenacc} is specified, the
1923 compiler generates accelerated code according to the OpenACC Application
1924 Programming Interface v2.0 @w{@uref{http://www.openacc.org/}}.  This option
1925 implies @option{-pthread}, and thus is only supported on targets that
1926 have support for @option{-pthread}.
1928 Note that this is an experimental feature, incomplete, and subject to
1929 change in future versions of GCC.  See
1930 @w{@uref{https://gcc.gnu.org/wiki/OpenACC}} for more information.
1932 @item -fopenmp
1933 @opindex fopenmp
1934 @cindex OpenMP parallel
1935 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1936 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1937 compiler generates parallel code according to the OpenMP Application
1938 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1939 implies @option{-pthread}, and thus is only supported on targets that
1940 have support for @option{-pthread}. @option{-fopenmp} implies
1941 @option{-fopenmp-simd}.
1943 @item -fopenmp-simd
1944 @opindex fopenmp-simd
1945 @cindex OpenMP SIMD
1946 @cindex SIMD
1947 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1948 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1949 are ignored.
1951 @item -fcilkplus
1952 @opindex fcilkplus
1953 @cindex Enable Cilk Plus
1954 Enable the usage of Cilk Plus language extension features for C/C++.
1955 When the option @option{-fcilkplus} is specified, enable the usage of
1956 the Cilk Plus Language extension features for C/C++.  The present
1957 implementation follows ABI version 1.2.  This is an experimental
1958 feature that is only partially complete, and whose interface may
1959 change in future versions of GCC as the official specification
1960 changes.  Currently, all features but @code{_Cilk_for} have been
1961 implemented.
1963 @item -fgnu-tm
1964 @opindex fgnu-tm
1965 When the option @option{-fgnu-tm} is specified, the compiler
1966 generates code for the Linux variant of Intel's current Transactional
1967 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1968 an experimental feature whose interface may change in future versions
1969 of GCC, as the official specification changes.  Please note that not
1970 all architectures are supported for this feature.
1972 For more information on GCC's support for transactional memory,
1973 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1974 Transactional Memory Library}.
1976 Note that the transactional memory feature is not supported with
1977 non-call exceptions (@option{-fnon-call-exceptions}).
1979 @item -fms-extensions
1980 @opindex fms-extensions
1981 Accept some non-standard constructs used in Microsoft header files.
1983 In C++ code, this allows member names in structures to be similar
1984 to previous types declarations.
1986 @smallexample
1987 typedef int UOW;
1988 struct ABC @{
1989   UOW UOW;
1991 @end smallexample
1993 Some cases of unnamed fields in structures and unions are only
1994 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1995 fields within structs/unions}, for details.
1997 Note that this option is off for all targets but x86 
1998 targets using ms-abi.
2000 @item -fplan9-extensions
2001 @opindex fplan9-extensions
2002 Accept some non-standard constructs used in Plan 9 code.
2004 This enables @option{-fms-extensions}, permits passing pointers to
2005 structures with anonymous fields to functions that expect pointers to
2006 elements of the type of the field, and permits referring to anonymous
2007 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
2008 struct/union fields within structs/unions}, for details.  This is only
2009 supported for C, not C++.
2011 @item -trigraphs
2012 @opindex trigraphs
2013 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
2014 options for strict ISO C conformance) implies @option{-trigraphs}.
2016 @cindex traditional C language
2017 @cindex C language, traditional
2018 @item -traditional
2019 @itemx -traditional-cpp
2020 @opindex traditional-cpp
2021 @opindex traditional
2022 Formerly, these options caused GCC to attempt to emulate a pre-standard
2023 C compiler.  They are now only supported with the @option{-E} switch.
2024 The preprocessor continues to support a pre-standard mode.  See the GNU
2025 CPP manual for details.
2027 @item -fcond-mismatch
2028 @opindex fcond-mismatch
2029 Allow conditional expressions with mismatched types in the second and
2030 third arguments.  The value of such an expression is void.  This option
2031 is not supported for C++.
2033 @item -flax-vector-conversions
2034 @opindex flax-vector-conversions
2035 Allow implicit conversions between vectors with differing numbers of
2036 elements and/or incompatible element types.  This option should not be
2037 used for new code.
2039 @item -funsigned-char
2040 @opindex funsigned-char
2041 Let the type @code{char} be unsigned, like @code{unsigned char}.
2043 Each kind of machine has a default for what @code{char} should
2044 be.  It is either like @code{unsigned char} by default or like
2045 @code{signed char} by default.
2047 Ideally, a portable program should always use @code{signed char} or
2048 @code{unsigned char} when it depends on the signedness of an object.
2049 But many programs have been written to use plain @code{char} and
2050 expect it to be signed, or expect it to be unsigned, depending on the
2051 machines they were written for.  This option, and its inverse, let you
2052 make such a program work with the opposite default.
2054 The type @code{char} is always a distinct type from each of
2055 @code{signed char} or @code{unsigned char}, even though its behavior
2056 is always just like one of those two.
2058 @item -fsigned-char
2059 @opindex fsigned-char
2060 Let the type @code{char} be signed, like @code{signed char}.
2062 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2063 the negative form of @option{-funsigned-char}.  Likewise, the option
2064 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2066 @item -fsigned-bitfields
2067 @itemx -funsigned-bitfields
2068 @itemx -fno-signed-bitfields
2069 @itemx -fno-unsigned-bitfields
2070 @opindex fsigned-bitfields
2071 @opindex funsigned-bitfields
2072 @opindex fno-signed-bitfields
2073 @opindex fno-unsigned-bitfields
2074 These options control whether a bit-field is signed or unsigned, when the
2075 declaration does not use either @code{signed} or @code{unsigned}.  By
2076 default, such a bit-field is signed, because this is consistent: the
2077 basic integer types such as @code{int} are signed types.
2078 @end table
2080 @node C++ Dialect Options
2081 @section Options Controlling C++ Dialect
2083 @cindex compiler options, C++
2084 @cindex C++ options, command-line
2085 @cindex options, C++
2086 This section describes the command-line options that are only meaningful
2087 for C++ programs.  You can also use most of the GNU compiler options
2088 regardless of what language your program is in.  For example, you
2089 might compile a file @file{firstClass.C} like this:
2091 @smallexample
2092 g++ -g -fstrict-enums -O -c firstClass.C
2093 @end smallexample
2095 @noindent
2096 In this example, only @option{-fstrict-enums} is an option meant
2097 only for C++ programs; you can use the other options with any
2098 language supported by GCC@.
2100 Here is a list of options that are @emph{only} for compiling C++ programs:
2102 @table @gcctabopt
2104 @item -fabi-version=@var{n}
2105 @opindex fabi-version
2106 Use version @var{n} of the C++ ABI@.  The default is version 0.
2108 Version 0 refers to the version conforming most closely to
2109 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2110 will change in different versions of G++ as ABI bugs are fixed.
2112 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.
2114 Version 2 is the version of the C++ ABI that first appeared in G++
2115 3.4, and was the default through G++ 4.9.
2117 Version 3 corrects an error in mangling a constant address as a
2118 template argument.
2120 Version 4, which first appeared in G++ 4.5, implements a standard
2121 mangling for vector types.
2123 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2124 attribute const/volatile on function pointer types, decltype of a
2125 plain decl, and use of a function parameter in the declaration of
2126 another parameter.
2128 Version 6, which first appeared in G++ 4.7, corrects the promotion
2129 behavior of C++11 scoped enums and the mangling of template argument
2130 packs, const/static_cast, prefix ++ and --, and a class scope function
2131 used as a template argument.
2133 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2134 builtin type and corrects the mangling of lambdas in default argument
2135 scope.
2137 Version 8, which first appeared in G++ 4.9, corrects the substitution
2138 behavior of function types with function-cv-qualifiers.
2140 Version 9, which first appeared in G++ 5.2, corrects the alignment of
2141 @code{nullptr_t}.
2143 Version 10, which first appeared in G++ 6.1, adds mangling of
2144 attributes that affect type identity, such as ia32 calling convention
2145 attributes (e.g. @samp{stdcall}).
2147 See also @option{-Wabi}.
2149 @item -fabi-compat-version=@var{n}
2150 @opindex fabi-compat-version
2151 On targets that support strong aliases, G++
2152 works around mangling changes by creating an alias with the correct
2153 mangled name when defining a symbol with an incorrect mangled name.
2154 This switch specifies which ABI version to use for the alias.
2156 With @option{-fabi-version=0} (the default), this defaults to 8 (GCC 5
2157 compatibility).  If another ABI version is explicitly selected, this
2158 defaults to 0.  For compatibility with GCC versions 3.2 through 4.9,
2159 use @option{-fabi-compat-version=2}.
2161 If this option is not provided but @option{-Wabi=@var{n}} is, that
2162 version is used for compatibility aliases.  If this option is provided
2163 along with @option{-Wabi} (without the version), the version from this
2164 option is used for the warning.
2166 @item -fno-access-control
2167 @opindex fno-access-control
2168 Turn off all access checking.  This switch is mainly useful for working
2169 around bugs in the access control code.
2171 @item -fcheck-new
2172 @opindex fcheck-new
2173 Check that the pointer returned by @code{operator new} is non-null
2174 before attempting to modify the storage allocated.  This check is
2175 normally unnecessary because the C++ standard specifies that
2176 @code{operator new} only returns @code{0} if it is declared
2177 @code{throw()}, in which case the compiler always checks the
2178 return value even without this option.  In all other cases, when
2179 @code{operator new} has a non-empty exception specification, memory
2180 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2181 @samp{new (nothrow)}.
2183 @item -fconstexpr-depth=@var{n}
2184 @opindex fconstexpr-depth
2185 Set the maximum nested evaluation depth for C++11 constexpr functions
2186 to @var{n}.  A limit is needed to detect endless recursion during
2187 constant expression evaluation.  The minimum specified by the standard
2188 is 512.
2190 @item -fdeduce-init-list
2191 @opindex fdeduce-init-list
2192 Enable deduction of a template type parameter as
2193 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2195 @smallexample
2196 template <class T> auto forward(T t) -> decltype (realfn (t))
2198   return realfn (t);
2201 void f()
2203   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2205 @end smallexample
2207 This deduction was implemented as a possible extension to the
2208 originally proposed semantics for the C++11 standard, but was not part
2209 of the final standard, so it is disabled by default.  This option is
2210 deprecated, and may be removed in a future version of G++.
2212 @item -ffriend-injection
2213 @opindex ffriend-injection
2214 Inject friend functions into the enclosing namespace, so that they are
2215 visible outside the scope of the class in which they are declared.
2216 Friend functions were documented to work this way in the old Annotated
2217 C++ Reference Manual.  
2218 However, in ISO C++ a friend function that is not declared
2219 in an enclosing scope can only be found using argument dependent
2220 lookup.  GCC defaults to the standard behavior.
2222 This option is for compatibility, and may be removed in a future
2223 release of G++.
2225 @item -fno-elide-constructors
2226 @opindex fno-elide-constructors
2227 The C++ standard allows an implementation to omit creating a temporary
2228 that is only used to initialize another object of the same type.
2229 Specifying this option disables that optimization, and forces G++ to
2230 call the copy constructor in all cases.
2232 @item -fno-enforce-eh-specs
2233 @opindex fno-enforce-eh-specs
2234 Don't generate code to check for violation of exception specifications
2235 at run time.  This option violates the C++ standard, but may be useful
2236 for reducing code size in production builds, much like defining
2237 @code{NDEBUG}.  This does not give user code permission to throw
2238 exceptions in violation of the exception specifications; the compiler
2239 still optimizes based on the specifications, so throwing an
2240 unexpected exception results in undefined behavior at run time.
2242 @item -fextern-tls-init
2243 @itemx -fno-extern-tls-init
2244 @opindex fextern-tls-init
2245 @opindex fno-extern-tls-init
2246 The C++11 and OpenMP standards allow @code{thread_local} and
2247 @code{threadprivate} variables to have dynamic (runtime)
2248 initialization.  To support this, any use of such a variable goes
2249 through a wrapper function that performs any necessary initialization.
2250 When the use and definition of the variable are in the same
2251 translation unit, this overhead can be optimized away, but when the
2252 use is in a different translation unit there is significant overhead
2253 even if the variable doesn't actually need dynamic initialization.  If
2254 the programmer can be sure that no use of the variable in a
2255 non-defining TU needs to trigger dynamic initialization (either
2256 because the variable is statically initialized, or a use of the
2257 variable in the defining TU will be executed before any uses in
2258 another TU), they can avoid this overhead with the
2259 @option{-fno-extern-tls-init} option.
2261 On targets that support symbol aliases, the default is
2262 @option{-fextern-tls-init}.  On targets that do not support symbol
2263 aliases, the default is @option{-fno-extern-tls-init}.
2265 @item -ffor-scope
2266 @itemx -fno-for-scope
2267 @opindex ffor-scope
2268 @opindex fno-for-scope
2269 If @option{-ffor-scope} is specified, the scope of variables declared in
2270 a @i{for-init-statement} is limited to the @code{for} loop itself,
2271 as specified by the C++ standard.
2272 If @option{-fno-for-scope} is specified, the scope of variables declared in
2273 a @i{for-init-statement} extends to the end of the enclosing scope,
2274 as was the case in old versions of G++, and other (traditional)
2275 implementations of C++.
2277 If neither flag is given, the default is to follow the standard,
2278 but to allow and give a warning for old-style code that would
2279 otherwise be invalid, or have different behavior.
2281 @item -fno-gnu-keywords
2282 @opindex fno-gnu-keywords
2283 Do not recognize @code{typeof} as a keyword, so that code can use this
2284 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2285 @option{-ansi} implies @option{-fno-gnu-keywords}.
2287 @item -fno-implicit-templates
2288 @opindex fno-implicit-templates
2289 Never emit code for non-inline templates that are instantiated
2290 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2291 @xref{Template Instantiation}, for more information.
2293 @item -fno-implicit-inline-templates
2294 @opindex fno-implicit-inline-templates
2295 Don't emit code for implicit instantiations of inline templates, either.
2296 The default is to handle inlines differently so that compiles with and
2297 without optimization need the same set of explicit instantiations.
2299 @item -fno-implement-inlines
2300 @opindex fno-implement-inlines
2301 To save space, do not emit out-of-line copies of inline functions
2302 controlled by @code{#pragma implementation}.  This causes linker
2303 errors if these functions are not inlined everywhere they are called.
2305 @item -fms-extensions
2306 @opindex fms-extensions
2307 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2308 int and getting a pointer to member function via non-standard syntax.
2310 @item -fno-nonansi-builtins
2311 @opindex fno-nonansi-builtins
2312 Disable built-in declarations of functions that are not mandated by
2313 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2314 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2316 @item -fnothrow-opt
2317 @opindex fnothrow-opt
2318 Treat a @code{throw()} exception specification as if it were a
2319 @code{noexcept} specification to reduce or eliminate the text size
2320 overhead relative to a function with no exception specification.  If
2321 the function has local variables of types with non-trivial
2322 destructors, the exception specification actually makes the
2323 function smaller because the EH cleanups for those variables can be
2324 optimized away.  The semantic effect is that an exception thrown out of
2325 a function with such an exception specification results in a call
2326 to @code{terminate} rather than @code{unexpected}.
2328 @item -fno-operator-names
2329 @opindex fno-operator-names
2330 Do not treat the operator name keywords @code{and}, @code{bitand},
2331 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2332 synonyms as keywords.
2334 @item -fno-optional-diags
2335 @opindex fno-optional-diags
2336 Disable diagnostics that the standard says a compiler does not need to
2337 issue.  Currently, the only such diagnostic issued by G++ is the one for
2338 a name having multiple meanings within a class.
2340 @item -fpermissive
2341 @opindex fpermissive
2342 Downgrade some diagnostics about nonconformant code from errors to
2343 warnings.  Thus, using @option{-fpermissive} allows some
2344 nonconforming code to compile.
2346 @item -fno-pretty-templates
2347 @opindex fno-pretty-templates
2348 When an error message refers to a specialization of a function
2349 template, the compiler normally prints the signature of the
2350 template followed by the template arguments and any typedefs or
2351 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2352 rather than @code{void f(int)}) so that it's clear which template is
2353 involved.  When an error message refers to a specialization of a class
2354 template, the compiler omits any template arguments that match
2355 the default template arguments for that template.  If either of these
2356 behaviors make it harder to understand the error message rather than
2357 easier, you can use @option{-fno-pretty-templates} to disable them.
2359 @item -frepo
2360 @opindex frepo
2361 Enable automatic template instantiation at link time.  This option also
2362 implies @option{-fno-implicit-templates}.  @xref{Template
2363 Instantiation}, for more information.
2365 @item -fno-rtti
2366 @opindex fno-rtti
2367 Disable generation of information about every class with virtual
2368 functions for use by the C++ run-time type identification features
2369 (@code{dynamic_cast} and @code{typeid}).  If you don't use those parts
2370 of the language, you can save some space by using this flag.  Note that
2371 exception handling uses the same information, but G++ generates it as
2372 needed. The @code{dynamic_cast} operator can still be used for casts that
2373 do not require run-time type information, i.e.@: casts to @code{void *} or to
2374 unambiguous base classes.
2376 @item -fsized-deallocation
2377 @opindex fsized-deallocation
2378 Enable the built-in global declarations
2379 @smallexample
2380 void operator delete (void *, std::size_t) noexcept;
2381 void operator delete[] (void *, std::size_t) noexcept;
2382 @end smallexample
2383 as introduced in C++14.  This is useful for user-defined replacement
2384 deallocation functions that, for example, use the size of the object
2385 to make deallocation faster.  Enabled by default under
2386 @option{-std=c++14} and above.  The flag @option{-Wsized-deallocation}
2387 warns about places that might want to add a definition.
2389 @item -fstats
2390 @opindex fstats
2391 Emit statistics about front-end processing at the end of the compilation.
2392 This information is generally only useful to the G++ development team.
2394 @item -fstrict-enums
2395 @opindex fstrict-enums
2396 Allow the compiler to optimize using the assumption that a value of
2397 enumerated type can only be one of the values of the enumeration (as
2398 defined in the C++ standard; basically, a value that can be
2399 represented in the minimum number of bits needed to represent all the
2400 enumerators).  This assumption may not be valid if the program uses a
2401 cast to convert an arbitrary integer value to the enumerated type.
2403 @item -ftemplate-backtrace-limit=@var{n}
2404 @opindex ftemplate-backtrace-limit
2405 Set the maximum number of template instantiation notes for a single
2406 warning or error to @var{n}.  The default value is 10.
2408 @item -ftemplate-depth=@var{n}
2409 @opindex ftemplate-depth
2410 Set the maximum instantiation depth for template classes to @var{n}.
2411 A limit on the template instantiation depth is needed to detect
2412 endless recursions during template class instantiation.  ANSI/ISO C++
2413 conforming programs must not rely on a maximum depth greater than 17
2414 (changed to 1024 in C++11).  The default value is 900, as the compiler
2415 can run out of stack space before hitting 1024 in some situations.
2417 @item -fno-threadsafe-statics
2418 @opindex fno-threadsafe-statics
2419 Do not emit the extra code to use the routines specified in the C++
2420 ABI for thread-safe initialization of local statics.  You can use this
2421 option to reduce code size slightly in code that doesn't need to be
2422 thread-safe.
2424 @item -fuse-cxa-atexit
2425 @opindex fuse-cxa-atexit
2426 Register destructors for objects with static storage duration with the
2427 @code{__cxa_atexit} function rather than the @code{atexit} function.
2428 This option is required for fully standards-compliant handling of static
2429 destructors, but only works if your C library supports
2430 @code{__cxa_atexit}.
2432 @item -fno-use-cxa-get-exception-ptr
2433 @opindex fno-use-cxa-get-exception-ptr
2434 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2435 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2436 if the runtime routine is not available.
2438 @item -fvisibility-inlines-hidden
2439 @opindex fvisibility-inlines-hidden
2440 This switch declares that the user does not attempt to compare
2441 pointers to inline functions or methods where the addresses of the two functions
2442 are taken in different shared objects.
2444 The effect of this is that GCC may, effectively, mark inline methods with
2445 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2446 appear in the export table of a DSO and do not require a PLT indirection
2447 when used within the DSO@.  Enabling this option can have a dramatic effect
2448 on load and link times of a DSO as it massively reduces the size of the
2449 dynamic export table when the library makes heavy use of templates.
2451 The behavior of this switch is not quite the same as marking the
2452 methods as hidden directly, because it does not affect static variables
2453 local to the function or cause the compiler to deduce that
2454 the function is defined in only one shared object.
2456 You may mark a method as having a visibility explicitly to negate the
2457 effect of the switch for that method.  For example, if you do want to
2458 compare pointers to a particular inline method, you might mark it as
2459 having default visibility.  Marking the enclosing class with explicit
2460 visibility has no effect.
2462 Explicitly instantiated inline methods are unaffected by this option
2463 as their linkage might otherwise cross a shared library boundary.
2464 @xref{Template Instantiation}.
2466 @item -fvisibility-ms-compat
2467 @opindex fvisibility-ms-compat
2468 This flag attempts to use visibility settings to make GCC's C++
2469 linkage model compatible with that of Microsoft Visual Studio.
2471 The flag makes these changes to GCC's linkage model:
2473 @enumerate
2474 @item
2475 It sets the default visibility to @code{hidden}, like
2476 @option{-fvisibility=hidden}.
2478 @item
2479 Types, but not their members, are not hidden by default.
2481 @item
2482 The One Definition Rule is relaxed for types without explicit
2483 visibility specifications that are defined in more than one
2484 shared object: those declarations are permitted if they are
2485 permitted when this option is not used.
2486 @end enumerate
2488 In new code it is better to use @option{-fvisibility=hidden} and
2489 export those classes that are intended to be externally visible.
2490 Unfortunately it is possible for code to rely, perhaps accidentally,
2491 on the Visual Studio behavior.
2493 Among the consequences of these changes are that static data members
2494 of the same type with the same name but defined in different shared
2495 objects are different, so changing one does not change the other;
2496 and that pointers to function members defined in different shared
2497 objects may not compare equal.  When this flag is given, it is a
2498 violation of the ODR to define types with the same name differently.
2500 @item -fvtable-verify=@r{[}std@r{|}preinit@r{|}none@r{]}
2501 @opindex fvtable-verify
2502 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2503 feature that verifies at run time, for every virtual call, that
2504 the vtable pointer through which the call is made is valid for the type of
2505 the object, and has not been corrupted or overwritten.  If an invalid vtable
2506 pointer is detected at run time, an error is reported and execution of the
2507 program is immediately halted.
2509 This option causes run-time data structures to be built at program startup,
2510 which are used for verifying the vtable pointers.  
2511 The options @samp{std} and @samp{preinit}
2512 control the timing of when these data structures are built.  In both cases the
2513 data structures are built before execution reaches @code{main}.  Using
2514 @option{-fvtable-verify=std} causes the data structures to be built after
2515 shared libraries have been loaded and initialized.
2516 @option{-fvtable-verify=preinit} causes them to be built before shared
2517 libraries have been loaded and initialized.
2519 If this option appears multiple times in the command line with different
2520 values specified, @samp{none} takes highest priority over both @samp{std} and
2521 @samp{preinit}; @samp{preinit} takes priority over @samp{std}.
2523 @item -fvtv-debug
2524 @opindex fvtv-debug
2525 When used in conjunction with @option{-fvtable-verify=std} or 
2526 @option{-fvtable-verify=preinit}, causes debug versions of the 
2527 runtime functions for the vtable verification feature to be called.  
2528 This flag also causes the compiler to log information about which 
2529 vtable pointers it finds for each class.
2530 This information is written to a file named @file{vtv_set_ptr_data.log} 
2531 in the directory named by the environment variable @env{VTV_LOGS_DIR} 
2532 if that is defined or the current working directory otherwise.
2534 Note:  This feature @emph{appends} data to the log file. If you want a fresh log
2535 file, be sure to delete any existing one.
2537 @item -fvtv-counts
2538 @opindex fvtv-counts
2539 This is a debugging flag.  When used in conjunction with
2540 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2541 causes the compiler to keep track of the total number of virtual calls
2542 it encounters and the number of verifications it inserts.  It also
2543 counts the number of calls to certain run-time library functions
2544 that it inserts and logs this information for each compilation unit.
2545 The compiler writes this information to a file named
2546 @file{vtv_count_data.log} in the directory named by the environment
2547 variable @env{VTV_LOGS_DIR} if that is defined or the current working
2548 directory otherwise.  It also counts the size of the vtable pointer sets
2549 for each class, and writes this information to @file{vtv_class_set_sizes.log}
2550 in the same directory.
2552 Note:  This feature @emph{appends} data to the log files.  To get fresh log
2553 files, be sure to delete any existing ones.
2555 @item -fno-weak
2556 @opindex fno-weak
2557 Do not use weak symbol support, even if it is provided by the linker.
2558 By default, G++ uses weak symbols if they are available.  This
2559 option exists only for testing, and should not be used by end-users;
2560 it results in inferior code and has no benefits.  This option may
2561 be removed in a future release of G++.
2563 @item -nostdinc++
2564 @opindex nostdinc++
2565 Do not search for header files in the standard directories specific to
2566 C++, but do still search the other standard directories.  (This option
2567 is used when building the C++ library.)
2568 @end table
2570 In addition, these optimization, warning, and code generation options
2571 have meanings only for C++ programs:
2573 @table @gcctabopt
2574 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2575 @opindex Wabi
2576 @opindex Wno-abi
2577 Warn when G++ it generates code that is probably not compatible with
2578 the vendor-neutral C++ ABI@.  Since G++ now defaults to updating the
2579 ABI with each major release, normally @option{-Wabi} will warn only if
2580 there is a check added later in a release series for an ABI issue
2581 discovered since the initial release.  @option{-Wabi} will warn about
2582 more things if an older ABI version is selected (with
2583 @option{-fabi-version=@var{n}}).
2585 @option{-Wabi} can also be used with an explicit version number to
2586 warn about compatibility with a particular @option{-fabi-version}
2587 level, e.g. @option{-Wabi=2} to warn about changes relative to
2588 @option{-fabi-version=2}.
2590 If an explicit version number is provided and
2591 @option{-fabi-compat-version} is not specified, the version number
2592 from this option is used for compatibility aliases.  If no explicit
2593 version number is provided with this option, but
2594 @option{-fabi-compat-version} is specified, that version number is
2595 used for ABI warnings.
2597 Although an effort has been made to warn about
2598 all such cases, there are probably some cases that are not warned about,
2599 even though G++ is generating incompatible code.  There may also be
2600 cases where warnings are emitted even though the code that is generated
2601 is compatible.
2603 You should rewrite your code to avoid these warnings if you are
2604 concerned about the fact that code generated by G++ may not be binary
2605 compatible with code generated by other compilers.
2607 Known incompatibilities in @option{-fabi-version=2} (which was the
2608 default from GCC 3.4 to 4.9) include:
2610 @itemize @bullet
2612 @item
2613 A template with a non-type template parameter of reference type was
2614 mangled incorrectly:
2615 @smallexample
2616 extern int N;
2617 template <int &> struct S @{@};
2618 void n (S<N>) @{2@}
2619 @end smallexample
2621 This was fixed in @option{-fabi-version=3}.
2623 @item
2624 SIMD vector types declared using @code{__attribute ((vector_size))} were
2625 mangled in a non-standard way that does not allow for overloading of
2626 functions taking vectors of different sizes.
2628 The mangling was changed in @option{-fabi-version=4}.
2630 @item
2631 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2632 qualifiers, and @code{decltype} of a plain declaration was folded away.
2634 These mangling issues were fixed in @option{-fabi-version=5}.
2636 @item
2637 Scoped enumerators passed as arguments to a variadic function are
2638 promoted like unscoped enumerators, causing @code{va_arg} to complain.
2639 On most targets this does not actually affect the parameter passing
2640 ABI, as there is no way to pass an argument smaller than @code{int}.
2642 Also, the ABI changed the mangling of template argument packs,
2643 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2644 a class scope function used as a template argument.
2646 These issues were corrected in @option{-fabi-version=6}.
2648 @item
2649 Lambdas in default argument scope were mangled incorrectly, and the
2650 ABI changed the mangling of @code{nullptr_t}.
2652 These issues were corrected in @option{-fabi-version=7}.
2654 @item
2655 When mangling a function type with function-cv-qualifiers, the
2656 un-qualified function type was incorrectly treated as a substitution
2657 candidate.
2659 This was fixed in @option{-fabi-version=8}, the default for GCC 5.1.
2661 @item
2662 @code{decltype(nullptr)} incorrectly had an alignment of 1, leading to
2663 unaligned accesses.  Note that this did not affect the ABI of a
2664 function with a @code{nullptr_t} parameter, as parameters have a
2665 minimum alignment.
2667 This was fixed in @option{-fabi-version=9}, the default for GCC 5.2.
2669 @item
2670 Target-specific attributes that affect the identity of a type, such as
2671 ia32 calling conventions on a function type (stdcall, regparm, etc.),
2672 did not affect the mangled name, leading to name collisions when
2673 function pointers were used as template arguments.
2675 This was fixed in @option{-fabi-version=10}, the default for GCC 6.1.
2677 @end itemize
2679 It also warns about psABI-related changes.  The known psABI changes at this
2680 point include:
2682 @itemize @bullet
2684 @item
2685 For SysV/x86-64, unions with @code{long double} members are 
2686 passed in memory as specified in psABI.  For example:
2688 @smallexample
2689 union U @{
2690   long double ld;
2691   int i;
2693 @end smallexample
2695 @noindent
2696 @code{union U} is always passed in memory.
2698 @end itemize
2700 @item -Wabi-tag @r{(C++ and Objective-C++ only)}
2701 @opindex Wabi-tag
2702 @opindex -Wabi-tag
2703 Warn when a type with an ABI tag is used in a context that does not
2704 have that ABI tag.  See @ref{C++ Attributes} for more information
2705 about ABI tags.
2707 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2708 @opindex Wctor-dtor-privacy
2709 @opindex Wno-ctor-dtor-privacy
2710 Warn when a class seems unusable because all the constructors or
2711 destructors in that class are private, and it has neither friends nor
2712 public static member functions.  Also warn if there are no non-private
2713 methods, and there's at least one private member function that isn't
2714 a constructor or destructor.
2716 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2717 @opindex Wdelete-non-virtual-dtor
2718 @opindex Wno-delete-non-virtual-dtor
2719 Warn when @code{delete} is used to destroy an instance of a class that
2720 has virtual functions and non-virtual destructor. It is unsafe to delete
2721 an instance of a derived class through a pointer to a base class if the
2722 base class does not have a virtual destructor.  This warning is enabled
2723 by @option{-Wall}.
2725 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2726 @opindex Wliteral-suffix
2727 @opindex Wno-literal-suffix
2728 Warn when a string or character literal is followed by a ud-suffix which does
2729 not begin with an underscore.  As a conforming extension, GCC treats such
2730 suffixes as separate preprocessing tokens in order to maintain backwards
2731 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2732 For example:
2734 @smallexample
2735 #define __STDC_FORMAT_MACROS
2736 #include <inttypes.h>
2737 #include <stdio.h>
2739 int main() @{
2740   int64_t i64 = 123;
2741   printf("My int64: %" PRId64"\n", i64);
2743 @end smallexample
2745 In this case, @code{PRId64} is treated as a separate preprocessing token.
2747 This warning is enabled by default.
2749 @item -Wlto-type-mismatch
2750 @opindex Wlto-type-mismatch
2751 @opindex Wno-lto-type-mistmach
2753 During the link-time optimization warn about type mismatches in between
2754 global declarations from different compilation units.
2755 Requires @option{-flto} to be enabled.  Enabled by default.
2757 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2758 @opindex Wnarrowing
2759 @opindex Wno-narrowing
2760 Warn when a narrowing conversion prohibited by C++11 occurs within
2761 @samp{@{ @}}, e.g.
2763 @smallexample
2764 int i = @{ 2.2 @}; // error: narrowing from double to int
2765 @end smallexample
2767 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2769 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2770 required by the standard.  Note that this does not affect the meaning
2771 of well-formed code; narrowing conversions are still considered
2772 ill-formed in SFINAE context.
2774 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2775 @opindex Wnoexcept
2776 @opindex Wno-noexcept
2777 Warn when a noexcept-expression evaluates to false because of a call
2778 to a function that does not have a non-throwing exception
2779 specification (i.e. @code{throw()} or @code{noexcept}) but is known by
2780 the compiler to never throw an exception.
2782 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2783 @opindex Wnon-virtual-dtor
2784 @opindex Wno-non-virtual-dtor
2785 Warn when a class has virtual functions and an accessible non-virtual
2786 destructor itself or in an accessible polymorphic base class, in which
2787 case it is possible but unsafe to delete an instance of a derived
2788 class through a pointer to the class itself or base class.  This
2789 warning is automatically enabled if @option{-Weffc++} is specified.
2791 @item -Wreorder @r{(C++ and Objective-C++ only)}
2792 @opindex Wreorder
2793 @opindex Wno-reorder
2794 @cindex reordering, warning
2795 @cindex warning for reordering of member initializers
2796 Warn when the order of member initializers given in the code does not
2797 match the order in which they must be executed.  For instance:
2799 @smallexample
2800 struct A @{
2801   int i;
2802   int j;
2803   A(): j (0), i (1) @{ @}
2805 @end smallexample
2807 @noindent
2808 The compiler rearranges the member initializers for @code{i}
2809 and @code{j} to match the declaration order of the members, emitting
2810 a warning to that effect.  This warning is enabled by @option{-Wall}.
2812 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2813 @opindex fext-numeric-literals
2814 @opindex fno-ext-numeric-literals
2815 Accept imaginary, fixed-point, or machine-defined
2816 literal number suffixes as GNU extensions.
2817 When this option is turned off these suffixes are treated
2818 as C++11 user-defined literal numeric suffixes.
2819 This is on by default for all pre-C++11 dialects and all GNU dialects:
2820 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2821 @option{-std=gnu++14}.
2822 This option is off by default
2823 for ISO C++11 onwards (@option{-std=c++11}, ...).
2824 @end table
2826 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2828 @table @gcctabopt
2829 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2830 @opindex Weffc++
2831 @opindex Wno-effc++
2832 Warn about violations of the following style guidelines from Scott Meyers'
2833 @cite{Effective C++} series of books:
2835 @itemize @bullet
2836 @item
2837 Define a copy constructor and an assignment operator for classes
2838 with dynamically-allocated memory.
2840 @item
2841 Prefer initialization to assignment in constructors.
2843 @item
2844 Have @code{operator=} return a reference to @code{*this}.
2846 @item
2847 Don't try to return a reference when you must return an object.
2849 @item
2850 Distinguish between prefix and postfix forms of increment and
2851 decrement operators.
2853 @item
2854 Never overload @code{&&}, @code{||}, or @code{,}.
2856 @end itemize
2858 This option also enables @option{-Wnon-virtual-dtor}, which is also
2859 one of the effective C++ recommendations.  However, the check is
2860 extended to warn about the lack of virtual destructor in accessible
2861 non-polymorphic bases classes too.
2863 When selecting this option, be aware that the standard library
2864 headers do not obey all of these guidelines; use @samp{grep -v}
2865 to filter out those warnings.
2867 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2868 @opindex Wstrict-null-sentinel
2869 @opindex Wno-strict-null-sentinel
2870 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2871 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2872 to @code{__null}.  Although it is a null pointer constant rather than a
2873 null pointer, it is guaranteed to be of the same size as a pointer.
2874 But this use is not portable across different compilers.
2876 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2877 @opindex Wno-non-template-friend
2878 @opindex Wnon-template-friend
2879 Disable warnings when non-templatized friend functions are declared
2880 within a template.  Since the advent of explicit template specification
2881 support in G++, if the name of the friend is an unqualified-id (i.e.,
2882 @samp{friend foo(int)}), the C++ language specification demands that the
2883 friend declare or define an ordinary, nontemplate function.  (Section
2884 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2885 could be interpreted as a particular specialization of a templatized
2886 function.  Because this non-conforming behavior is no longer the default
2887 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2888 check existing code for potential trouble spots and is on by default.
2889 This new compiler behavior can be turned off with
2890 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2891 but disables the helpful warning.
2893 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2894 @opindex Wold-style-cast
2895 @opindex Wno-old-style-cast
2896 Warn if an old-style (C-style) cast to a non-void type is used within
2897 a C++ program.  The new-style casts (@code{dynamic_cast},
2898 @code{static_cast}, @code{reinterpret_cast}, and @code{const_cast}) are
2899 less vulnerable to unintended effects and much easier to search for.
2901 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2902 @opindex Woverloaded-virtual
2903 @opindex Wno-overloaded-virtual
2904 @cindex overloaded virtual function, warning
2905 @cindex warning for overloaded virtual function
2906 Warn when a function declaration hides virtual functions from a
2907 base class.  For example, in:
2909 @smallexample
2910 struct A @{
2911   virtual void f();
2914 struct B: public A @{
2915   void f(int);
2917 @end smallexample
2919 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2920 like:
2922 @smallexample
2923 B* b;
2924 b->f();
2925 @end smallexample
2927 @noindent
2928 fails to compile.
2930 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2931 @opindex Wno-pmf-conversions
2932 @opindex Wpmf-conversions
2933 Disable the diagnostic for converting a bound pointer to member function
2934 to a plain pointer.
2936 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2937 @opindex Wsign-promo
2938 @opindex Wno-sign-promo
2939 Warn when overload resolution chooses a promotion from unsigned or
2940 enumerated type to a signed type, over a conversion to an unsigned type of
2941 the same size.  Previous versions of G++ tried to preserve
2942 unsignedness, but the standard mandates the current behavior.
2944 @item -Wtemplates @r{(C++ and Objective-C++ only)}
2945 @opindex Wtemplates
2946 Warn when a primary template declaration is encountered.  Some coding
2947 rules disallow templates, and this may be used to enforce that rule.
2948 The warning is inactive inside a system header file, such as the STL, so
2949 one can still use the STL.  One may also instantiate or specialize
2950 templates.
2952 @item -Wmultiple-inheritance @r{(C++ and Objective-C++ only)}
2953 @opindex Wmultiple-inheritance
2954 Warn when a class is defined with multiple direct base classes.  Some
2955 coding rules disallow multiple inheritance, and this may be used to
2956 enforce that rule.  The warning is inactive inside a system header file,
2957 such as the STL, so one can still use the STL.  One may also define
2958 classes that indirectly use multiple inheritance.
2960 @item -Wvirtual-inheritance
2961 @opindex Wvirtual-inheritance
2962 Warn when a class is defined with a virtual direct base classe.  Some
2963 coding rules disallow multiple inheritance, and this may be used to
2964 enforce that rule.  The warning is inactive inside a system header file,
2965 such as the STL, so one can still use the STL.  One may also define
2966 classes that indirectly use virtual inheritance.
2968 @item -Wnamespaces
2969 @opindex Wnamespaces
2970 Warn when a namespace definition is opened.  Some coding rules disallow
2971 namespaces, and this may be used to enforce that rule.  The warning is
2972 inactive inside a system header file, such as the STL, so one can still
2973 use the STL.  One may also use using directives and qualified names.
2975 @item -Wno-terminate @r{(C++ and Objective-C++ only)}
2976 @opindex Wterminate
2977 @opindex Wno-terminate
2978 Disable the warning about a throw-expression that will immediately
2979 result in a call to @code{terminate}.
2980 @end table
2982 @node Objective-C and Objective-C++ Dialect Options
2983 @section Options Controlling Objective-C and Objective-C++ Dialects
2985 @cindex compiler options, Objective-C and Objective-C++
2986 @cindex Objective-C and Objective-C++ options, command-line
2987 @cindex options, Objective-C and Objective-C++
2988 (NOTE: This manual does not describe the Objective-C and Objective-C++
2989 languages themselves.  @xref{Standards,,Language Standards
2990 Supported by GCC}, for references.)
2992 This section describes the command-line options that are only meaningful
2993 for Objective-C and Objective-C++ programs.  You can also use most of
2994 the language-independent GNU compiler options.
2995 For example, you might compile a file @file{some_class.m} like this:
2997 @smallexample
2998 gcc -g -fgnu-runtime -O -c some_class.m
2999 @end smallexample
3001 @noindent
3002 In this example, @option{-fgnu-runtime} is an option meant only for
3003 Objective-C and Objective-C++ programs; you can use the other options with
3004 any language supported by GCC@.
3006 Note that since Objective-C is an extension of the C language, Objective-C
3007 compilations may also use options specific to the C front-end (e.g.,
3008 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
3009 C++-specific options (e.g., @option{-Wabi}).
3011 Here is a list of options that are @emph{only} for compiling Objective-C
3012 and Objective-C++ programs:
3014 @table @gcctabopt
3015 @item -fconstant-string-class=@var{class-name}
3016 @opindex fconstant-string-class
3017 Use @var{class-name} as the name of the class to instantiate for each
3018 literal string specified with the syntax @code{@@"@dots{}"}.  The default
3019 class name is @code{NXConstantString} if the GNU runtime is being used, and
3020 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
3021 @option{-fconstant-cfstrings} option, if also present, overrides the
3022 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
3023 to be laid out as constant CoreFoundation strings.
3025 @item -fgnu-runtime
3026 @opindex fgnu-runtime
3027 Generate object code compatible with the standard GNU Objective-C
3028 runtime.  This is the default for most types of systems.
3030 @item -fnext-runtime
3031 @opindex fnext-runtime
3032 Generate output compatible with the NeXT runtime.  This is the default
3033 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
3034 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
3035 used.
3037 @item -fno-nil-receivers
3038 @opindex fno-nil-receivers
3039 Assume that all Objective-C message dispatches (@code{[receiver
3040 message:arg]}) in this translation unit ensure that the receiver is
3041 not @code{nil}.  This allows for more efficient entry points in the
3042 runtime to be used.  This option is only available in conjunction with
3043 the NeXT runtime and ABI version 0 or 1.
3045 @item -fobjc-abi-version=@var{n}
3046 @opindex fobjc-abi-version
3047 Use version @var{n} of the Objective-C ABI for the selected runtime.
3048 This option is currently supported only for the NeXT runtime.  In that
3049 case, Version 0 is the traditional (32-bit) ABI without support for
3050 properties and other Objective-C 2.0 additions.  Version 1 is the
3051 traditional (32-bit) ABI with support for properties and other
3052 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
3053 nothing is specified, the default is Version 0 on 32-bit target
3054 machines, and Version 2 on 64-bit target machines.
3056 @item -fobjc-call-cxx-cdtors
3057 @opindex fobjc-call-cxx-cdtors
3058 For each Objective-C class, check if any of its instance variables is a
3059 C++ object with a non-trivial default constructor.  If so, synthesize a
3060 special @code{- (id) .cxx_construct} instance method which runs
3061 non-trivial default constructors on any such instance variables, in order,
3062 and then return @code{self}.  Similarly, check if any instance variable
3063 is a C++ object with a non-trivial destructor, and if so, synthesize a
3064 special @code{- (void) .cxx_destruct} method which runs
3065 all such default destructors, in reverse order.
3067 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
3068 methods thusly generated only operate on instance variables
3069 declared in the current Objective-C class, and not those inherited
3070 from superclasses.  It is the responsibility of the Objective-C
3071 runtime to invoke all such methods in an object's inheritance
3072 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
3073 by the runtime immediately after a new object instance is allocated;
3074 the @code{- (void) .cxx_destruct} methods are invoked immediately
3075 before the runtime deallocates an object instance.
3077 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
3078 support for invoking the @code{- (id) .cxx_construct} and
3079 @code{- (void) .cxx_destruct} methods.
3081 @item -fobjc-direct-dispatch
3082 @opindex fobjc-direct-dispatch
3083 Allow fast jumps to the message dispatcher.  On Darwin this is
3084 accomplished via the comm page.
3086 @item -fobjc-exceptions
3087 @opindex fobjc-exceptions
3088 Enable syntactic support for structured exception handling in
3089 Objective-C, similar to what is offered by C++ and Java.  This option
3090 is required to use the Objective-C keywords @code{@@try},
3091 @code{@@throw}, @code{@@catch}, @code{@@finally} and
3092 @code{@@synchronized}.  This option is available with both the GNU
3093 runtime and the NeXT runtime (but not available in conjunction with
3094 the NeXT runtime on Mac OS X 10.2 and earlier).
3096 @item -fobjc-gc
3097 @opindex fobjc-gc
3098 Enable garbage collection (GC) in Objective-C and Objective-C++
3099 programs.  This option is only available with the NeXT runtime; the
3100 GNU runtime has a different garbage collection implementation that
3101 does not require special compiler flags.
3103 @item -fobjc-nilcheck
3104 @opindex fobjc-nilcheck
3105 For the NeXT runtime with version 2 of the ABI, check for a nil
3106 receiver in method invocations before doing the actual method call.
3107 This is the default and can be disabled using
3108 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
3109 checked for nil in this way no matter what this flag is set to.
3110 Currently this flag does nothing when the GNU runtime, or an older
3111 version of the NeXT runtime ABI, is used.
3113 @item -fobjc-std=objc1
3114 @opindex fobjc-std
3115 Conform to the language syntax of Objective-C 1.0, the language
3116 recognized by GCC 4.0.  This only affects the Objective-C additions to
3117 the C/C++ language; it does not affect conformance to C/C++ standards,
3118 which is controlled by the separate C/C++ dialect option flags.  When
3119 this option is used with the Objective-C or Objective-C++ compiler,
3120 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
3121 This is useful if you need to make sure that your Objective-C code can
3122 be compiled with older versions of GCC@.
3124 @item -freplace-objc-classes
3125 @opindex freplace-objc-classes
3126 Emit a special marker instructing @command{ld(1)} not to statically link in
3127 the resulting object file, and allow @command{dyld(1)} to load it in at
3128 run time instead.  This is used in conjunction with the Fix-and-Continue
3129 debugging mode, where the object file in question may be recompiled and
3130 dynamically reloaded in the course of program execution, without the need
3131 to restart the program itself.  Currently, Fix-and-Continue functionality
3132 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
3133 and later.
3135 @item -fzero-link
3136 @opindex fzero-link
3137 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
3138 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
3139 compile time) with static class references that get initialized at load time,
3140 which improves run-time performance.  Specifying the @option{-fzero-link} flag
3141 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
3142 to be retained.  This is useful in Zero-Link debugging mode, since it allows
3143 for individual class implementations to be modified during program execution.
3144 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3145 regardless of command-line options.
3147 @item -fno-local-ivars
3148 @opindex fno-local-ivars
3149 @opindex flocal-ivars
3150 By default instance variables in Objective-C can be accessed as if
3151 they were local variables from within the methods of the class they're
3152 declared in.  This can lead to shadowing between instance variables
3153 and other variables declared either locally inside a class method or
3154 globally with the same name.  Specifying the @option{-fno-local-ivars}
3155 flag disables this behavior thus avoiding variable shadowing issues.
3157 @item -fivar-visibility=@r{[}public@r{|}protected@r{|}private@r{|}package@r{]}
3158 @opindex fivar-visibility
3159 Set the default instance variable visibility to the specified option
3160 so that instance variables declared outside the scope of any access
3161 modifier directives default to the specified visibility.
3163 @item -gen-decls
3164 @opindex gen-decls
3165 Dump interface declarations for all classes seen in the source file to a
3166 file named @file{@var{sourcename}.decl}.
3168 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3169 @opindex Wassign-intercept
3170 @opindex Wno-assign-intercept
3171 Warn whenever an Objective-C assignment is being intercepted by the
3172 garbage collector.
3174 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3175 @opindex Wno-protocol
3176 @opindex Wprotocol
3177 If a class is declared to implement a protocol, a warning is issued for
3178 every method in the protocol that is not implemented by the class.  The
3179 default behavior is to issue a warning for every method not explicitly
3180 implemented in the class, even if a method implementation is inherited
3181 from the superclass.  If you use the @option{-Wno-protocol} option, then
3182 methods inherited from the superclass are considered to be implemented,
3183 and no warning is issued for them.
3185 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3186 @opindex Wselector
3187 @opindex Wno-selector
3188 Warn if multiple methods of different types for the same selector are
3189 found during compilation.  The check is performed on the list of methods
3190 in the final stage of compilation.  Additionally, a check is performed
3191 for each selector appearing in a @code{@@selector(@dots{})}
3192 expression, and a corresponding method for that selector has been found
3193 during compilation.  Because these checks scan the method table only at
3194 the end of compilation, these warnings are not produced if the final
3195 stage of compilation is not reached, for example because an error is
3196 found during compilation, or because the @option{-fsyntax-only} option is
3197 being used.
3199 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3200 @opindex Wstrict-selector-match
3201 @opindex Wno-strict-selector-match
3202 Warn if multiple methods with differing argument and/or return types are
3203 found for a given selector when attempting to send a message using this
3204 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3205 is off (which is the default behavior), the compiler omits such warnings
3206 if any differences found are confined to types that share the same size
3207 and alignment.
3209 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3210 @opindex Wundeclared-selector
3211 @opindex Wno-undeclared-selector
3212 Warn if a @code{@@selector(@dots{})} expression referring to an
3213 undeclared selector is found.  A selector is considered undeclared if no
3214 method with that name has been declared before the
3215 @code{@@selector(@dots{})} expression, either explicitly in an
3216 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3217 an @code{@@implementation} section.  This option always performs its
3218 checks as soon as a @code{@@selector(@dots{})} expression is found,
3219 while @option{-Wselector} only performs its checks in the final stage of
3220 compilation.  This also enforces the coding style convention
3221 that methods and selectors must be declared before being used.
3223 @item -print-objc-runtime-info
3224 @opindex print-objc-runtime-info
3225 Generate C header describing the largest structure that is passed by
3226 value, if any.
3228 @end table
3230 @node Diagnostic Message Formatting Options
3231 @section Options to Control Diagnostic Messages Formatting
3232 @cindex options to control diagnostics formatting
3233 @cindex diagnostic messages
3234 @cindex message formatting
3236 Traditionally, diagnostic messages have been formatted irrespective of
3237 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3238 options described below
3239 to control the formatting algorithm for diagnostic messages, 
3240 e.g.@: how many characters per line, how often source location
3241 information should be reported.  Note that some language front ends may not
3242 honor these options.
3244 @table @gcctabopt
3245 @item -fmessage-length=@var{n}
3246 @opindex fmessage-length
3247 Try to format error messages so that they fit on lines of about
3248 @var{n} characters.  If @var{n} is zero, then no line-wrapping is
3249 done; each error message appears on a single line.  This is the
3250 default for all front ends.
3252 @item -fdiagnostics-show-location=once
3253 @opindex fdiagnostics-show-location
3254 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3255 reporter to emit source location information @emph{once}; that is, in
3256 case the message is too long to fit on a single physical line and has to
3257 be wrapped, the source location won't be emitted (as prefix) again,
3258 over and over, in subsequent continuation lines.  This is the default
3259 behavior.
3261 @item -fdiagnostics-show-location=every-line
3262 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3263 messages reporter to emit the same source location information (as
3264 prefix) for physical lines that result from the process of breaking
3265 a message which is too long to fit on a single line.
3267 @item -fdiagnostics-color[=@var{WHEN}]
3268 @itemx -fno-diagnostics-color
3269 @opindex fdiagnostics-color
3270 @cindex highlight, color, colour
3271 @vindex GCC_COLORS @r{environment variable}
3272 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3273 or @samp{auto}.  The default depends on how the compiler has been configured,
3274 it can be any of the above @var{WHEN} options or also @samp{never}
3275 if @env{GCC_COLORS} environment variable isn't present in the environment,
3276 and @samp{auto} otherwise.
3277 @samp{auto} means to use color only when the standard error is a terminal.
3278 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3279 aliases for @option{-fdiagnostics-color=always} and
3280 @option{-fdiagnostics-color=never}, respectively.
3282 The colors are defined by the environment variable @env{GCC_COLORS}.
3283 Its value is a colon-separated list of capabilities and Select Graphic
3284 Rendition (SGR) substrings. SGR commands are interpreted by the
3285 terminal or terminal emulator.  (See the section in the documentation
3286 of your text terminal for permitted values and their meanings as
3287 character attributes.)  These substring values are integers in decimal
3288 representation and can be concatenated with semicolons.
3289 Common values to concatenate include
3290 @samp{1} for bold,
3291 @samp{4} for underline,
3292 @samp{5} for blink,
3293 @samp{7} for inverse,
3294 @samp{39} for default foreground color,
3295 @samp{30} to @samp{37} for foreground colors,
3296 @samp{90} to @samp{97} for 16-color mode foreground colors,
3297 @samp{38;5;0} to @samp{38;5;255}
3298 for 88-color and 256-color modes foreground colors,
3299 @samp{49} for default background color,
3300 @samp{40} to @samp{47} for background colors,
3301 @samp{100} to @samp{107} for 16-color mode background colors,
3302 and @samp{48;5;0} to @samp{48;5;255}
3303 for 88-color and 256-color modes background colors.
3305 The default @env{GCC_COLORS} is
3306 @smallexample
3307 error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01
3308 @end smallexample
3309 @noindent
3310 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3311 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3312 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3313 string disables colors.
3314 Supported capabilities are as follows.
3316 @table @code
3317 @item error=
3318 @vindex error GCC_COLORS @r{capability}
3319 SGR substring for error: markers.
3321 @item warning=
3322 @vindex warning GCC_COLORS @r{capability}
3323 SGR substring for warning: markers.
3325 @item note=
3326 @vindex note GCC_COLORS @r{capability}
3327 SGR substring for note: markers.
3329 @item caret=
3330 @vindex caret GCC_COLORS @r{capability}
3331 SGR substring for caret line.
3333 @item locus=
3334 @vindex locus GCC_COLORS @r{capability}
3335 SGR substring for location information, @samp{file:line} or
3336 @samp{file:line:column} etc.
3338 @item quote=
3339 @vindex quote GCC_COLORS @r{capability}
3340 SGR substring for information printed within quotes.
3341 @end table
3343 @item -fno-diagnostics-show-option
3344 @opindex fno-diagnostics-show-option
3345 @opindex fdiagnostics-show-option
3346 By default, each diagnostic emitted includes text indicating the
3347 command-line option that directly controls the diagnostic (if such an
3348 option is known to the diagnostic machinery).  Specifying the
3349 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3351 @item -fno-diagnostics-show-caret
3352 @opindex fno-diagnostics-show-caret
3353 @opindex fdiagnostics-show-caret
3354 By default, each diagnostic emitted includes the original source line
3355 and a caret '^' indicating the column.  This option suppresses this
3356 information.  The source line is truncated to @var{n} characters, if
3357 the @option{-fmessage-length=n} option is given.  When the output is done
3358 to the terminal, the width is limited to the width given by the
3359 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3361 @end table
3363 @node Warning Options
3364 @section Options to Request or Suppress Warnings
3365 @cindex options to control warnings
3366 @cindex warning messages
3367 @cindex messages, warning
3368 @cindex suppressing warnings
3370 Warnings are diagnostic messages that report constructions that
3371 are not inherently erroneous but that are risky or suggest there
3372 may have been an error.
3374 The following language-independent options do not enable specific
3375 warnings but control the kinds of diagnostics produced by GCC@.
3377 @table @gcctabopt
3378 @cindex syntax checking
3379 @item -fsyntax-only
3380 @opindex fsyntax-only
3381 Check the code for syntax errors, but don't do anything beyond that.
3383 @item -fmax-errors=@var{n}
3384 @opindex fmax-errors
3385 Limits the maximum number of error messages to @var{n}, at which point
3386 GCC bails out rather than attempting to continue processing the source
3387 code.  If @var{n} is 0 (the default), there is no limit on the number
3388 of error messages produced.  If @option{-Wfatal-errors} is also
3389 specified, then @option{-Wfatal-errors} takes precedence over this
3390 option.
3392 @item -w
3393 @opindex w
3394 Inhibit all warning messages.
3396 @item -Werror
3397 @opindex Werror
3398 @opindex Wno-error
3399 Make all warnings into errors.
3401 @item -Werror=
3402 @opindex Werror=
3403 @opindex Wno-error=
3404 Make the specified warning into an error.  The specifier for a warning
3405 is appended; for example @option{-Werror=switch} turns the warnings
3406 controlled by @option{-Wswitch} into errors.  This switch takes a
3407 negative form, to be used to negate @option{-Werror} for specific
3408 warnings; for example @option{-Wno-error=switch} makes
3409 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3410 is in effect.
3412 The warning message for each controllable warning includes the
3413 option that controls the warning.  That option can then be used with
3414 @option{-Werror=} and @option{-Wno-error=} as described above.
3415 (Printing of the option in the warning message can be disabled using the
3416 @option{-fno-diagnostics-show-option} flag.)
3418 Note that specifying @option{-Werror=}@var{foo} automatically implies
3419 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3420 imply anything.
3422 @item -Wfatal-errors
3423 @opindex Wfatal-errors
3424 @opindex Wno-fatal-errors
3425 This option causes the compiler to abort compilation on the first error
3426 occurred rather than trying to keep going and printing further error
3427 messages.
3429 @end table
3431 You can request many specific warnings with options beginning with
3432 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3433 implicit declarations.  Each of these specific warning options also
3434 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3435 example, @option{-Wno-implicit}.  This manual lists only one of the
3436 two forms, whichever is not the default.  For further
3437 language-specific options also refer to @ref{C++ Dialect Options} and
3438 @ref{Objective-C and Objective-C++ Dialect Options}.
3440 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3441 options, such as @option{-Wunused}, which may turn on further options,
3442 such as @option{-Wunused-value}. The combined effect of positive and
3443 negative forms is that more specific options have priority over less
3444 specific ones, independently of their position in the command-line. For
3445 options of the same specificity, the last one takes effect. Options
3446 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3447 as if they appeared at the end of the command-line.
3449 When an unrecognized warning option is requested (e.g.,
3450 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3451 that the option is not recognized.  However, if the @option{-Wno-} form
3452 is used, the behavior is slightly different: no diagnostic is
3453 produced for @option{-Wno-unknown-warning} unless other diagnostics
3454 are being produced.  This allows the use of new @option{-Wno-} options
3455 with old compilers, but if something goes wrong, the compiler
3456 warns that an unrecognized option is present.
3458 @table @gcctabopt
3459 @item -Wpedantic
3460 @itemx -pedantic
3461 @opindex pedantic
3462 @opindex Wpedantic
3463 Issue all the warnings demanded by strict ISO C and ISO C++;
3464 reject all programs that use forbidden extensions, and some other
3465 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3466 version of the ISO C standard specified by any @option{-std} option used.
3468 Valid ISO C and ISO C++ programs should compile properly with or without
3469 this option (though a rare few require @option{-ansi} or a
3470 @option{-std} option specifying the required version of ISO C)@.  However,
3471 without this option, certain GNU extensions and traditional C and C++
3472 features are supported as well.  With this option, they are rejected.
3474 @option{-Wpedantic} does not cause warning messages for use of the
3475 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3476 warnings are also disabled in the expression that follows
3477 @code{__extension__}.  However, only system header files should use
3478 these escape routes; application programs should avoid them.
3479 @xref{Alternate Keywords}.
3481 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3482 C conformance.  They soon find that it does not do quite what they want:
3483 it finds some non-ISO practices, but not all---only those for which
3484 ISO C @emph{requires} a diagnostic, and some others for which
3485 diagnostics have been added.
3487 A feature to report any failure to conform to ISO C might be useful in
3488 some instances, but would require considerable additional work and would
3489 be quite different from @option{-Wpedantic}.  We don't have plans to
3490 support such a feature in the near future.
3492 Where the standard specified with @option{-std} represents a GNU
3493 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3494 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3495 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3496 where they are required by the base standard.  (It does not make sense
3497 for such warnings to be given only for features not in the specified GNU
3498 C dialect, since by definition the GNU dialects of C include all
3499 features the compiler supports with the given option, and there would be
3500 nothing to warn about.)
3502 @item -pedantic-errors
3503 @opindex pedantic-errors
3504 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3505 requires a diagnostic, in some cases where there is undefined behavior
3506 at compile-time and in some other cases that do not prevent compilation
3507 of programs that are valid according to the standard. This is not
3508 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3509 by this option and not enabled by the latter and vice versa.
3511 @item -Wall
3512 @opindex Wall
3513 @opindex Wno-all
3514 This enables all the warnings about constructions that some users
3515 consider questionable, and that are easy to avoid (or modify to
3516 prevent the warning), even in conjunction with macros.  This also
3517 enables some language-specific warnings described in @ref{C++ Dialect
3518 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3520 @option{-Wall} turns on the following warning flags:
3522 @gccoptlist{-Waddress   @gol
3523 -Warray-bounds=1 @r{(only with} @option{-O2}@r{)}  @gol
3524 -Wc++11-compat  -Wc++14-compat@gol
3525 -Wchar-subscripts  @gol
3526 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3527 -Wimplicit-int @r{(C and Objective-C only)} @gol
3528 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3529 -Wbool-compare  @gol
3530 -Wduplicated-cond  @gol
3531 -Wcomment  @gol
3532 -Wformat   @gol
3533 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3534 -Wmaybe-uninitialized @gol
3535 -Wmissing-braces @r{(only for C/ObjC)} @gol
3536 -Wnonnull  @gol
3537 -Wopenmp-simd @gol
3538 -Wparentheses  @gol
3539 -Wpointer-sign  @gol
3540 -Wreorder   @gol
3541 -Wreturn-type  @gol
3542 -Wsequence-point  @gol
3543 -Wsign-compare @r{(only in C++)}  @gol
3544 -Wstrict-aliasing  @gol
3545 -Wstrict-overflow=1  @gol
3546 -Wswitch  @gol
3547 -Wtautological-compare  @gol
3548 -Wtrigraphs  @gol
3549 -Wuninitialized  @gol
3550 -Wunknown-pragmas  @gol
3551 -Wunused-function  @gol
3552 -Wunused-label     @gol
3553 -Wunused-value     @gol
3554 -Wunused-variable  @gol
3555 -Wvolatile-register-var @gol
3558 Note that some warning flags are not implied by @option{-Wall}.  Some of
3559 them warn about constructions that users generally do not consider
3560 questionable, but which occasionally you might wish to check for;
3561 others warn about constructions that are necessary or hard to avoid in
3562 some cases, and there is no simple way to modify the code to suppress
3563 the warning. Some of them are enabled by @option{-Wextra} but many of
3564 them must be enabled individually.
3566 @item -Wextra
3567 @opindex W
3568 @opindex Wextra
3569 @opindex Wno-extra
3570 This enables some extra warning flags that are not enabled by
3571 @option{-Wall}. (This option used to be called @option{-W}.  The older
3572 name is still supported, but the newer name is more descriptive.)
3574 @gccoptlist{-Wclobbered  @gol
3575 -Wempty-body  @gol
3576 -Wignored-qualifiers @gol
3577 -Wmissing-field-initializers  @gol
3578 -Wmissing-parameter-type @r{(C only)}  @gol
3579 -Wold-style-declaration @r{(C only)}  @gol
3580 -Woverride-init  @gol
3581 -Wsign-compare  @gol
3582 -Wtype-limits  @gol
3583 -Wuninitialized  @gol
3584 -Wshift-negative-value  @gol
3585 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3586 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3589 The option @option{-Wextra} also prints warning messages for the
3590 following cases:
3592 @itemize @bullet
3594 @item
3595 A pointer is compared against integer zero with @code{<}, @code{<=},
3596 @code{>}, or @code{>=}.
3598 @item
3599 (C++ only) An enumerator and a non-enumerator both appear in a
3600 conditional expression.
3602 @item
3603 (C++ only) Ambiguous virtual bases.
3605 @item
3606 (C++ only) Subscripting an array that has been declared @code{register}.
3608 @item
3609 (C++ only) Taking the address of a variable that has been declared
3610 @code{register}.
3612 @item
3613 (C++ only) A base class is not initialized in a derived class's copy
3614 constructor.
3616 @end itemize
3618 @item -Wchar-subscripts
3619 @opindex Wchar-subscripts
3620 @opindex Wno-char-subscripts
3621 Warn if an array subscript has type @code{char}.  This is a common cause
3622 of error, as programmers often forget that this type is signed on some
3623 machines.
3624 This warning is enabled by @option{-Wall}.
3626 @item -Wcomment
3627 @opindex Wcomment
3628 @opindex Wno-comment
3629 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3630 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3631 This warning is enabled by @option{-Wall}.
3633 @item -Wno-coverage-mismatch
3634 @opindex Wno-coverage-mismatch
3635 Warn if feedback profiles do not match when using the
3636 @option{-fprofile-use} option.
3637 If a source file is changed between compiling with @option{-fprofile-gen} and
3638 with @option{-fprofile-use}, the files with the profile feedback can fail
3639 to match the source file and GCC cannot use the profile feedback
3640 information.  By default, this warning is enabled and is treated as an
3641 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3642 warning or @option{-Wno-error=coverage-mismatch} can be used to
3643 disable the error.  Disabling the error for this warning can result in
3644 poorly optimized code and is useful only in the
3645 case of very minor changes such as bug fixes to an existing code-base.
3646 Completely disabling the warning is not recommended.
3648 @item -Wno-cpp
3649 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3651 Suppress warning messages emitted by @code{#warning} directives.
3653 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3654 @opindex Wdouble-promotion
3655 @opindex Wno-double-promotion
3656 Give a warning when a value of type @code{float} is implicitly
3657 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3658 floating-point unit implement @code{float} in hardware, but emulate
3659 @code{double} in software.  On such a machine, doing computations
3660 using @code{double} values is much more expensive because of the
3661 overhead required for software emulation.
3663 It is easy to accidentally do computations with @code{double} because
3664 floating-point literals are implicitly of type @code{double}.  For
3665 example, in:
3666 @smallexample
3667 @group
3668 float area(float radius)
3670    return 3.14159 * radius * radius;
3672 @end group
3673 @end smallexample
3674 the compiler performs the entire computation with @code{double}
3675 because the floating-point literal is a @code{double}.
3677 @item -Wformat
3678 @itemx -Wformat=@var{n}
3679 @opindex Wformat
3680 @opindex Wno-format
3681 @opindex ffreestanding
3682 @opindex fno-builtin
3683 @opindex Wformat=
3684 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3685 the arguments supplied have types appropriate to the format string
3686 specified, and that the conversions specified in the format string make
3687 sense.  This includes standard functions, and others specified by format
3688 attributes (@pxref{Function Attributes}), in the @code{printf},
3689 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3690 not in the C standard) families (or other target-specific families).
3691 Which functions are checked without format attributes having been
3692 specified depends on the standard version selected, and such checks of
3693 functions without the attribute specified are disabled by
3694 @option{-ffreestanding} or @option{-fno-builtin}.
3696 The formats are checked against the format features supported by GNU
3697 libc version 2.2.  These include all ISO C90 and C99 features, as well
3698 as features from the Single Unix Specification and some BSD and GNU
3699 extensions.  Other library implementations may not support all these
3700 features; GCC does not support warning about features that go beyond a
3701 particular library's limitations.  However, if @option{-Wpedantic} is used
3702 with @option{-Wformat}, warnings are given about format features not
3703 in the selected standard version (but not for @code{strfmon} formats,
3704 since those are not in any version of the C standard).  @xref{C Dialect
3705 Options,,Options Controlling C Dialect}.
3707 @table @gcctabopt
3708 @item -Wformat=1
3709 @itemx -Wformat
3710 @opindex Wformat
3711 @opindex Wformat=1
3712 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3713 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3714 @option{-Wformat} also checks for null format arguments for several
3715 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3716 aspects of this level of format checking can be disabled by the
3717 options: @option{-Wno-format-contains-nul},
3718 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3719 @option{-Wformat} is enabled by @option{-Wall}.
3721 @item -Wno-format-contains-nul
3722 @opindex Wno-format-contains-nul
3723 @opindex Wformat-contains-nul
3724 If @option{-Wformat} is specified, do not warn about format strings that
3725 contain NUL bytes.
3727 @item -Wno-format-extra-args
3728 @opindex Wno-format-extra-args
3729 @opindex Wformat-extra-args
3730 If @option{-Wformat} is specified, do not warn about excess arguments to a
3731 @code{printf} or @code{scanf} format function.  The C standard specifies
3732 that such arguments are ignored.
3734 Where the unused arguments lie between used arguments that are
3735 specified with @samp{$} operand number specifications, normally
3736 warnings are still given, since the implementation could not know what
3737 type to pass to @code{va_arg} to skip the unused arguments.  However,
3738 in the case of @code{scanf} formats, this option suppresses the
3739 warning if the unused arguments are all pointers, since the Single
3740 Unix Specification says that such unused arguments are allowed.
3742 @item -Wno-format-zero-length
3743 @opindex Wno-format-zero-length
3744 @opindex Wformat-zero-length
3745 If @option{-Wformat} is specified, do not warn about zero-length formats.
3746 The C standard specifies that zero-length formats are allowed.
3749 @item -Wformat=2
3750 @opindex Wformat=2
3751 Enable @option{-Wformat} plus additional format checks.  Currently
3752 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3753 -Wformat-y2k}.
3755 @item -Wformat-nonliteral
3756 @opindex Wformat-nonliteral
3757 @opindex Wno-format-nonliteral
3758 If @option{-Wformat} is specified, also warn if the format string is not a
3759 string literal and so cannot be checked, unless the format function
3760 takes its format arguments as a @code{va_list}.
3762 @item -Wformat-security
3763 @opindex Wformat-security
3764 @opindex Wno-format-security
3765 If @option{-Wformat} is specified, also warn about uses of format
3766 functions that represent possible security problems.  At present, this
3767 warns about calls to @code{printf} and @code{scanf} functions where the
3768 format string is not a string literal and there are no format arguments,
3769 as in @code{printf (foo);}.  This may be a security hole if the format
3770 string came from untrusted input and contains @samp{%n}.  (This is
3771 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3772 in future warnings may be added to @option{-Wformat-security} that are not
3773 included in @option{-Wformat-nonliteral}.)
3775 @item -Wformat-signedness
3776 @opindex Wformat-signedness
3777 @opindex Wno-format-signedness
3778 If @option{-Wformat} is specified, also warn if the format string
3779 requires an unsigned argument and the argument is signed and vice versa.
3781 @item -Wformat-y2k
3782 @opindex Wformat-y2k
3783 @opindex Wno-format-y2k
3784 If @option{-Wformat} is specified, also warn about @code{strftime}
3785 formats that may yield only a two-digit year.
3786 @end table
3788 @item -Wnonnull
3789 @opindex Wnonnull
3790 @opindex Wno-nonnull
3791 Warn about passing a null pointer for arguments marked as
3792 requiring a non-null value by the @code{nonnull} function attribute.
3794 Also warns when comparing an argument marked with the @code{nonnull}
3795 function attribute against null inside the function.
3797 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3798 can be disabled with the @option{-Wno-nonnull} option.
3800 @item -Wnull-dereference
3801 @opindex Wnull-dereference
3802 @opindex Wno-null-dereference
3803 Warn if the compiler detects paths that trigger erroneous or
3804 undefined behavior due to dereferencing a null pointer.  This option
3805 is only active when @option{-fdelete-null-pointer-checks} is active,
3806 which is enabled by optimizations in most targets.  The precision of
3807 the warnings depends on the optimization options used.
3809 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3810 @opindex Winit-self
3811 @opindex Wno-init-self
3812 Warn about uninitialized variables that are initialized with themselves.
3813 Note this option can only be used with the @option{-Wuninitialized} option.
3815 For example, GCC warns about @code{i} being uninitialized in the
3816 following snippet only when @option{-Winit-self} has been specified:
3817 @smallexample
3818 @group
3819 int f()
3821   int i = i;
3822   return i;
3824 @end group
3825 @end smallexample
3827 This warning is enabled by @option{-Wall} in C++.
3829 @item -Wimplicit-int @r{(C and Objective-C only)}
3830 @opindex Wimplicit-int
3831 @opindex Wno-implicit-int
3832 Warn when a declaration does not specify a type.
3833 This warning is enabled by @option{-Wall}.
3835 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3836 @opindex Wimplicit-function-declaration
3837 @opindex Wno-implicit-function-declaration
3838 Give a warning whenever a function is used before being declared. In
3839 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3840 enabled by default and it is made into an error by
3841 @option{-pedantic-errors}. This warning is also enabled by
3842 @option{-Wall}.
3844 @item -Wimplicit @r{(C and Objective-C only)}
3845 @opindex Wimplicit
3846 @opindex Wno-implicit
3847 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3848 This warning is enabled by @option{-Wall}.
3850 @item -Wignored-qualifiers @r{(C and C++ only)}
3851 @opindex Wignored-qualifiers
3852 @opindex Wno-ignored-qualifiers
3853 Warn if the return type of a function has a type qualifier
3854 such as @code{const}.  For ISO C such a type qualifier has no effect,
3855 since the value returned by a function is not an lvalue.
3856 For C++, the warning is only emitted for scalar types or @code{void}.
3857 ISO C prohibits qualified @code{void} return types on function
3858 definitions, so such return types always receive a warning
3859 even without this option.
3861 This warning is also enabled by @option{-Wextra}.
3863 @item -Wmain
3864 @opindex Wmain
3865 @opindex Wno-main
3866 Warn if the type of @code{main} is suspicious.  @code{main} should be
3867 a function with external linkage, returning int, taking either zero
3868 arguments, two, or three arguments of appropriate types.  This warning
3869 is enabled by default in C++ and is enabled by either @option{-Wall}
3870 or @option{-Wpedantic}.
3872 @item -Wmisleading-indentation @r{(C and C++ only)}
3873 @opindex Wmisleading-indentation
3874 @opindex Wno-misleading-indentation
3875 Warn when the indentation of the code does not reflect the block structure.
3876 Specifically, a warning is issued for @code{if}, @code{else}, @code{while}, and
3877 @code{for} clauses with a guarded statement that does not use braces,
3878 followed by an unguarded statement with the same indentation.
3880 This warning is disabled by default.
3882 In the following example, the call to ``bar'' is misleadingly indented as
3883 if it were guarded by the ``if'' conditional.
3885 @smallexample
3886   if (some_condition ())
3887     foo ();
3888     bar ();  /* Gotcha: this is not guarded by the "if".  */
3889 @end smallexample
3891 In the case of mixed tabs and spaces, the warning uses the
3892 @option{-ftabstop=} option to determine if the statements line up
3893 (defaulting to 8).
3895 The warning is not issued for code involving multiline preprocessor logic
3896 such as the following example.
3898 @smallexample
3899   if (flagA)
3900     foo (0);
3901 #if SOME_CONDITION_THAT_DOES_NOT_HOLD
3902   if (flagB)
3903 #endif
3904     foo (1);
3905 @end smallexample
3907 The warning is not issued after a @code{#line} directive, since this
3908 typically indicates autogenerated code, and no assumptions can be made
3909 about the layout of the file that the directive references.
3911 @item -Wmissing-braces
3912 @opindex Wmissing-braces
3913 @opindex Wno-missing-braces
3914 Warn if an aggregate or union initializer is not fully bracketed.  In
3915 the following example, the initializer for @code{a} is not fully
3916 bracketed, but that for @code{b} is fully bracketed.  This warning is
3917 enabled by @option{-Wall} in C.
3919 @smallexample
3920 int a[2][2] = @{ 0, 1, 2, 3 @};
3921 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3922 @end smallexample
3924 This warning is enabled by @option{-Wall}.
3926 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3927 @opindex Wmissing-include-dirs
3928 @opindex Wno-missing-include-dirs
3929 Warn if a user-supplied include directory does not exist.
3931 @item -Wparentheses
3932 @opindex Wparentheses
3933 @opindex Wno-parentheses
3934 Warn if parentheses are omitted in certain contexts, such
3935 as when there is an assignment in a context where a truth value
3936 is expected, or when operators are nested whose precedence people
3937 often get confused about.
3939 Also warn if a comparison like @code{x<=y<=z} appears; this is
3940 equivalent to @code{(x<=y ? 1 : 0) <= z}, which is a different
3941 interpretation from that of ordinary mathematical notation.
3943 Also warn about constructions where there may be confusion to which
3944 @code{if} statement an @code{else} branch belongs.  Here is an example of
3945 such a case:
3947 @smallexample
3948 @group
3950   if (a)
3951     if (b)
3952       foo ();
3953   else
3954     bar ();
3956 @end group
3957 @end smallexample
3959 In C/C++, every @code{else} branch belongs to the innermost possible
3960 @code{if} statement, which in this example is @code{if (b)}.  This is
3961 often not what the programmer expected, as illustrated in the above
3962 example by indentation the programmer chose.  When there is the
3963 potential for this confusion, GCC issues a warning when this flag
3964 is specified.  To eliminate the warning, add explicit braces around
3965 the innermost @code{if} statement so there is no way the @code{else}
3966 can belong to the enclosing @code{if}.  The resulting code
3967 looks like this:
3969 @smallexample
3970 @group
3972   if (a)
3973     @{
3974       if (b)
3975         foo ();
3976       else
3977         bar ();
3978     @}
3980 @end group
3981 @end smallexample
3983 Also warn for dangerous uses of the GNU extension to
3984 @code{?:} with omitted middle operand. When the condition
3985 in the @code{?}: operator is a boolean expression, the omitted value is
3986 always 1.  Often programmers expect it to be a value computed
3987 inside the conditional expression instead.
3989 This warning is enabled by @option{-Wall}.
3991 @item -Wsequence-point
3992 @opindex Wsequence-point
3993 @opindex Wno-sequence-point
3994 Warn about code that may have undefined semantics because of violations
3995 of sequence point rules in the C and C++ standards.
3997 The C and C++ standards define the order in which expressions in a C/C++
3998 program are evaluated in terms of @dfn{sequence points}, which represent
3999 a partial ordering between the execution of parts of the program: those
4000 executed before the sequence point, and those executed after it.  These
4001 occur after the evaluation of a full expression (one which is not part
4002 of a larger expression), after the evaluation of the first operand of a
4003 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
4004 function is called (but after the evaluation of its arguments and the
4005 expression denoting the called function), and in certain other places.
4006 Other than as expressed by the sequence point rules, the order of
4007 evaluation of subexpressions of an expression is not specified.  All
4008 these rules describe only a partial order rather than a total order,
4009 since, for example, if two functions are called within one expression
4010 with no sequence point between them, the order in which the functions
4011 are called is not specified.  However, the standards committee have
4012 ruled that function calls do not overlap.
4014 It is not specified when between sequence points modifications to the
4015 values of objects take effect.  Programs whose behavior depends on this
4016 have undefined behavior; the C and C++ standards specify that ``Between
4017 the previous and next sequence point an object shall have its stored
4018 value modified at most once by the evaluation of an expression.
4019 Furthermore, the prior value shall be read only to determine the value
4020 to be stored.''.  If a program breaks these rules, the results on any
4021 particular implementation are entirely unpredictable.
4023 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
4024 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
4025 diagnosed by this option, and it may give an occasional false positive
4026 result, but in general it has been found fairly effective at detecting
4027 this sort of problem in programs.
4029 The standard is worded confusingly, therefore there is some debate
4030 over the precise meaning of the sequence point rules in subtle cases.
4031 Links to discussions of the problem, including proposed formal
4032 definitions, may be found on the GCC readings page, at
4033 @uref{http://gcc.gnu.org/@/readings.html}.
4035 This warning is enabled by @option{-Wall} for C and C++.
4037 @item -Wno-return-local-addr
4038 @opindex Wno-return-local-addr
4039 @opindex Wreturn-local-addr
4040 Do not warn about returning a pointer (or in C++, a reference) to a
4041 variable that goes out of scope after the function returns.
4043 @item -Wreturn-type
4044 @opindex Wreturn-type
4045 @opindex Wno-return-type
4046 Warn whenever a function is defined with a return type that defaults
4047 to @code{int}.  Also warn about any @code{return} statement with no
4048 return value in a function whose return type is not @code{void}
4049 (falling off the end of the function body is considered returning
4050 without a value), and about a @code{return} statement with an
4051 expression in a function whose return type is @code{void}.
4053 For C++, a function without return type always produces a diagnostic
4054 message, even when @option{-Wno-return-type} is specified.  The only
4055 exceptions are @code{main} and functions defined in system headers.
4057 This warning is enabled by @option{-Wall}.
4059 @item -Wshift-count-negative
4060 @opindex Wshift-count-negative
4061 @opindex Wno-shift-count-negative
4062 Warn if shift count is negative. This warning is enabled by default.
4064 @item -Wshift-count-overflow
4065 @opindex Wshift-count-overflow
4066 @opindex Wno-shift-count-overflow
4067 Warn if shift count >= width of type. This warning is enabled by default.
4069 @item -Wshift-negative-value
4070 @opindex Wshift-negative-value
4071 @opindex Wno-shift-negative-value
4072 Warn if left shifting a negative value.  This warning is enabled by
4073 @option{-Wextra} in C99 and C++11 modes (and newer).
4075 @item -Wshift-overflow
4076 @itemx -Wshift-overflow=@var{n}
4077 @opindex Wshift-overflow
4078 @opindex Wno-shift-overflow
4079 Warn about left shift overflows.  This warning is enabled by
4080 default in C99 and C++11 modes (and newer).
4082 @table @gcctabopt
4083 @item -Wshift-overflow=1
4084 This is the warning level of @option{-Wshift-overflow} and is enabled
4085 by default in C99 and C++11 modes (and newer).  This warning level does
4086 not warn about left-shifting 1 into the sign bit.  (However, in C, such
4087 an overflow is still rejected in contexts where an integer constant expression
4088 is required.)
4090 @item -Wshift-overflow=2
4091 This warning level also warns about left-shifting 1 into the sign bit,
4092 unless C++14 mode is active.
4093 @end table
4095 @item -Wswitch
4096 @opindex Wswitch
4097 @opindex Wno-switch
4098 Warn whenever a @code{switch} statement has an index of enumerated type
4099 and lacks a @code{case} for one or more of the named codes of that
4100 enumeration.  (The presence of a @code{default} label prevents this
4101 warning.)  @code{case} labels outside the enumeration range also
4102 provoke warnings when this option is used (even if there is a
4103 @code{default} label).
4104 This warning is enabled by @option{-Wall}.
4106 @item -Wswitch-default
4107 @opindex Wswitch-default
4108 @opindex Wno-switch-default
4109 Warn whenever a @code{switch} statement does not have a @code{default}
4110 case.
4112 @item -Wswitch-enum
4113 @opindex Wswitch-enum
4114 @opindex Wno-switch-enum
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.  @code{case} labels outside the enumeration range also
4118 provoke warnings when this option is used.  The only difference
4119 between @option{-Wswitch} and this option is that this option gives a
4120 warning about an omitted enumeration code even if there is a
4121 @code{default} label.
4123 @item -Wswitch-bool
4124 @opindex Wswitch-bool
4125 @opindex Wno-switch-bool
4126 Warn whenever a @code{switch} statement has an index of boolean type
4127 and the case values are outside the range of a boolean type.
4128 It is possible to suppress this warning by casting the controlling
4129 expression to a type other than @code{bool}.  For example:
4130 @smallexample
4131 @group
4132 switch ((int) (a == 4))
4133   @{
4134   @dots{}
4135   @}
4136 @end group
4137 @end smallexample
4138 This warning is enabled by default for C and C++ programs.
4140 @item -Wsync-nand @r{(C and C++ only)}
4141 @opindex Wsync-nand
4142 @opindex Wno-sync-nand
4143 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
4144 built-in functions are used.  These functions changed semantics in GCC 4.4.
4146 @item -Wtrigraphs
4147 @opindex Wtrigraphs
4148 @opindex Wno-trigraphs
4149 Warn if any trigraphs are encountered that might change the meaning of
4150 the program (trigraphs within comments are not warned about).
4151 This warning is enabled by @option{-Wall}.
4153 @item -Wunused-but-set-parameter
4154 @opindex Wunused-but-set-parameter
4155 @opindex Wno-unused-but-set-parameter
4156 Warn whenever a function parameter is assigned to, but otherwise unused
4157 (aside from its declaration).
4159 To suppress this warning use the @code{unused} attribute
4160 (@pxref{Variable Attributes}).
4162 This warning is also enabled by @option{-Wunused} together with
4163 @option{-Wextra}.
4165 @item -Wunused-but-set-variable
4166 @opindex Wunused-but-set-variable
4167 @opindex Wno-unused-but-set-variable
4168 Warn whenever a local variable is assigned to, but otherwise unused
4169 (aside from its declaration).
4170 This warning is enabled by @option{-Wall}.
4172 To suppress this warning use the @code{unused} attribute
4173 (@pxref{Variable Attributes}).
4175 This warning is also enabled by @option{-Wunused}, which is enabled
4176 by @option{-Wall}.
4178 @item -Wunused-function
4179 @opindex Wunused-function
4180 @opindex Wno-unused-function
4181 Warn whenever a static function is declared but not defined or a
4182 non-inline static function is unused.
4183 This warning is enabled by @option{-Wall}.
4185 @item -Wunused-label
4186 @opindex Wunused-label
4187 @opindex Wno-unused-label
4188 Warn whenever a label is declared but not used.
4189 This warning is enabled by @option{-Wall}.
4191 To suppress this warning use the @code{unused} attribute
4192 (@pxref{Variable Attributes}).
4194 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
4195 @opindex Wunused-local-typedefs
4196 Warn when a typedef locally defined in a function is not used.
4197 This warning is enabled by @option{-Wall}.
4199 @item -Wunused-parameter
4200 @opindex Wunused-parameter
4201 @opindex Wno-unused-parameter
4202 Warn whenever a function parameter is unused aside from its declaration.
4204 To suppress this warning use the @code{unused} attribute
4205 (@pxref{Variable Attributes}).
4207 @item -Wno-unused-result
4208 @opindex Wunused-result
4209 @opindex Wno-unused-result
4210 Do not warn if a caller of a function marked with attribute
4211 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
4212 its return value. The default is @option{-Wunused-result}.
4214 @item -Wunused-variable
4215 @opindex Wunused-variable
4216 @opindex Wno-unused-variable
4217 Warn whenever a local or static variable is unused aside from its
4218 declaration. This option implies @option{-Wunused-const-variable} for C,
4219 but not for C++. This warning is enabled by @option{-Wall}.
4221 To suppress this warning use the @code{unused} attribute
4222 (@pxref{Variable Attributes}).
4224 @item -Wunused-const-variable
4225 @opindex Wunused-const-variable
4226 @opindex Wno-unused-const-variable
4227 Warn whenever a constant static variable is unused aside from its declaration.
4228 This warning is enabled by @option{-Wunused-variable} for C, but not for C++.
4229 In C++ this is normally not an error since const variables take the place of
4230 @code{#define}s in C++.
4232 To suppress this warning use the @code{unused} attribute
4233 (@pxref{Variable Attributes}).
4235 @item -Wunused-value
4236 @opindex Wunused-value
4237 @opindex Wno-unused-value
4238 Warn whenever a statement computes a result that is explicitly not
4239 used. To suppress this warning cast the unused expression to
4240 @code{void}. This includes an expression-statement or the left-hand
4241 side of a comma expression that contains no side effects. For example,
4242 an expression such as @code{x[i,j]} causes a warning, while
4243 @code{x[(void)i,j]} does not.
4245 This warning is enabled by @option{-Wall}.
4247 @item -Wunused
4248 @opindex Wunused
4249 @opindex Wno-unused
4250 All the above @option{-Wunused} options combined.
4252 In order to get a warning about an unused function parameter, you must
4253 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4254 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4256 @item -Wuninitialized
4257 @opindex Wuninitialized
4258 @opindex Wno-uninitialized
4259 Warn if an automatic variable is used without first being initialized
4260 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4261 warn if a non-static reference or non-static @code{const} member
4262 appears in a class without constructors.
4264 If you want to warn about code that uses the uninitialized value of the
4265 variable in its own initializer, use the @option{-Winit-self} option.
4267 These warnings occur for individual uninitialized or clobbered
4268 elements of structure, union or array variables as well as for
4269 variables that are uninitialized or clobbered as a whole.  They do
4270 not occur for variables or elements declared @code{volatile}.  Because
4271 these warnings depend on optimization, the exact variables or elements
4272 for which there are warnings depends on the precise optimization
4273 options and version of GCC used.
4275 Note that there may be no warning about a variable that is used only
4276 to compute a value that itself is never used, because such
4277 computations may be deleted by data flow analysis before the warnings
4278 are printed.
4280 @item -Wmaybe-uninitialized
4281 @opindex Wmaybe-uninitialized
4282 @opindex Wno-maybe-uninitialized
4283 For an automatic variable, if there exists a path from the function
4284 entry to a use of the variable that is initialized, but there exist
4285 some other paths for which the variable is not initialized, the compiler
4286 emits a warning if it cannot prove the uninitialized paths are not
4287 executed at run time. These warnings are made optional because GCC is
4288 not smart enough to see all the reasons why the code might be correct
4289 in spite of appearing to have an error.  Here is one example of how
4290 this can happen:
4292 @smallexample
4293 @group
4295   int x;
4296   switch (y)
4297     @{
4298     case 1: x = 1;
4299       break;
4300     case 2: x = 4;
4301       break;
4302     case 3: x = 5;
4303     @}
4304   foo (x);
4306 @end group
4307 @end smallexample
4309 @noindent
4310 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4311 always initialized, but GCC doesn't know this. To suppress the
4312 warning, you need to provide a default case with assert(0) or
4313 similar code.
4315 @cindex @code{longjmp} warnings
4316 This option also warns when a non-volatile automatic variable might be
4317 changed by a call to @code{longjmp}.  These warnings as well are possible
4318 only in optimizing compilation.
4320 The compiler sees only the calls to @code{setjmp}.  It cannot know
4321 where @code{longjmp} will be called; in fact, a signal handler could
4322 call it at any point in the code.  As a result, you may get a warning
4323 even when there is in fact no problem because @code{longjmp} cannot
4324 in fact be called at the place that would cause a problem.
4326 Some spurious warnings can be avoided if you declare all the functions
4327 you use that never return as @code{noreturn}.  @xref{Function
4328 Attributes}.
4330 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4332 @item -Wunknown-pragmas
4333 @opindex Wunknown-pragmas
4334 @opindex Wno-unknown-pragmas
4335 @cindex warning for unknown pragmas
4336 @cindex unknown pragmas, warning
4337 @cindex pragmas, warning of unknown
4338 Warn when a @code{#pragma} directive is encountered that is not understood by 
4339 GCC@.  If this command-line option is used, warnings are even issued
4340 for unknown pragmas in system header files.  This is not the case if
4341 the warnings are only enabled by the @option{-Wall} command-line option.
4343 @item -Wno-pragmas
4344 @opindex Wno-pragmas
4345 @opindex Wpragmas
4346 Do not warn about misuses of pragmas, such as incorrect parameters,
4347 invalid syntax, or conflicts between pragmas.  See also
4348 @option{-Wunknown-pragmas}.
4350 @item -Wstrict-aliasing
4351 @opindex Wstrict-aliasing
4352 @opindex Wno-strict-aliasing
4353 This option is only active when @option{-fstrict-aliasing} is active.
4354 It warns about code that might break the strict aliasing rules that the
4355 compiler is using for optimization.  The warning does not catch all
4356 cases, but does attempt to catch the more common pitfalls.  It is
4357 included in @option{-Wall}.
4358 It is equivalent to @option{-Wstrict-aliasing=3}
4360 @item -Wstrict-aliasing=n
4361 @opindex Wstrict-aliasing=n
4362 This option is only active when @option{-fstrict-aliasing} is active.
4363 It warns about code that might break the strict aliasing rules that the
4364 compiler is using for optimization.
4365 Higher levels correspond to higher accuracy (fewer false positives).
4366 Higher levels also correspond to more effort, similar to the way @option{-O} 
4367 works.
4368 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4370 Level 1: Most aggressive, quick, least accurate.
4371 Possibly useful when higher levels
4372 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4373 false negatives.  However, it has many false positives.
4374 Warns for all pointer conversions between possibly incompatible types,
4375 even if never dereferenced.  Runs in the front end only.
4377 Level 2: Aggressive, quick, not too precise.
4378 May still have many false positives (not as many as level 1 though),
4379 and few false negatives (but possibly more than level 1).
4380 Unlike level 1, it only warns when an address is taken.  Warns about
4381 incomplete types.  Runs in the front end only.
4383 Level 3 (default for @option{-Wstrict-aliasing}):
4384 Should have very few false positives and few false
4385 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4386 Takes care of the common pun+dereference pattern in the front end:
4387 @code{*(int*)&some_float}.
4388 If optimization is enabled, it also runs in the back end, where it deals
4389 with multiple statement cases using flow-sensitive points-to information.
4390 Only warns when the converted pointer is dereferenced.
4391 Does not warn about incomplete types.
4393 @item -Wstrict-overflow
4394 @itemx -Wstrict-overflow=@var{n}
4395 @opindex Wstrict-overflow
4396 @opindex Wno-strict-overflow
4397 This option is only active when @option{-fstrict-overflow} is active.
4398 It warns about cases where the compiler optimizes based on the
4399 assumption that signed overflow does not occur.  Note that it does not
4400 warn about all cases where the code might overflow: it only warns
4401 about cases where the compiler implements some optimization.  Thus
4402 this warning depends on the optimization level.
4404 An optimization that assumes that signed overflow does not occur is
4405 perfectly safe if the values of the variables involved are such that
4406 overflow never does, in fact, occur.  Therefore this warning can
4407 easily give a false positive: a warning about code that is not
4408 actually a problem.  To help focus on important issues, several
4409 warning levels are defined.  No warnings are issued for the use of
4410 undefined signed overflow when estimating how many iterations a loop
4411 requires, in particular when determining whether a loop will be
4412 executed at all.
4414 @table @gcctabopt
4415 @item -Wstrict-overflow=1
4416 Warn about cases that are both questionable and easy to avoid.  For
4417 example,  with @option{-fstrict-overflow}, the compiler simplifies
4418 @code{x + 1 > x} to @code{1}.  This level of
4419 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4420 are not, and must be explicitly requested.
4422 @item -Wstrict-overflow=2
4423 Also warn about other cases where a comparison is simplified to a
4424 constant.  For example: @code{abs (x) >= 0}.  This can only be
4425 simplified when @option{-fstrict-overflow} is in effect, because
4426 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4427 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4428 @option{-Wstrict-overflow=2}.
4430 @item -Wstrict-overflow=3
4431 Also warn about other cases where a comparison is simplified.  For
4432 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4434 @item -Wstrict-overflow=4
4435 Also warn about other simplifications not covered by the above cases.
4436 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4438 @item -Wstrict-overflow=5
4439 Also warn about cases where the compiler reduces the magnitude of a
4440 constant involved in a comparison.  For example: @code{x + 2 > y} is
4441 simplified to @code{x + 1 >= y}.  This is reported only at the
4442 highest warning level because this simplification applies to many
4443 comparisons, so this warning level gives a very large number of
4444 false positives.
4445 @end table
4447 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4448 @opindex Wsuggest-attribute=
4449 @opindex Wno-suggest-attribute=
4450 Warn for cases where adding an attribute may be beneficial. The
4451 attributes currently supported are listed below.
4453 @table @gcctabopt
4454 @item -Wsuggest-attribute=pure
4455 @itemx -Wsuggest-attribute=const
4456 @itemx -Wsuggest-attribute=noreturn
4457 @opindex Wsuggest-attribute=pure
4458 @opindex Wno-suggest-attribute=pure
4459 @opindex Wsuggest-attribute=const
4460 @opindex Wno-suggest-attribute=const
4461 @opindex Wsuggest-attribute=noreturn
4462 @opindex Wno-suggest-attribute=noreturn
4464 Warn about functions that might be candidates for attributes
4465 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4466 functions visible in other compilation units or (in the case of @code{pure} and
4467 @code{const}) if it cannot prove that the function returns normally. A function
4468 returns normally if it doesn't contain an infinite loop or return abnormally
4469 by throwing, calling @code{abort} or trapping.  This analysis requires option
4470 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4471 higher.  Higher optimization levels improve the accuracy of the analysis.
4473 @item -Wsuggest-attribute=format
4474 @itemx -Wmissing-format-attribute
4475 @opindex Wsuggest-attribute=format
4476 @opindex Wmissing-format-attribute
4477 @opindex Wno-suggest-attribute=format
4478 @opindex Wno-missing-format-attribute
4479 @opindex Wformat
4480 @opindex Wno-format
4482 Warn about function pointers that might be candidates for @code{format}
4483 attributes.  Note these are only possible candidates, not absolute ones.
4484 GCC guesses that function pointers with @code{format} attributes that
4485 are used in assignment, initialization, parameter passing or return
4486 statements should have a corresponding @code{format} attribute in the
4487 resulting type.  I.e.@: the left-hand side of the assignment or
4488 initialization, the type of the parameter variable, or the return type
4489 of the containing function respectively should also have a @code{format}
4490 attribute to avoid the warning.
4492 GCC also warns about function definitions that might be
4493 candidates for @code{format} attributes.  Again, these are only
4494 possible candidates.  GCC guesses that @code{format} attributes
4495 might be appropriate for any function that calls a function like
4496 @code{vprintf} or @code{vscanf}, but this might not always be the
4497 case, and some functions for which @code{format} attributes are
4498 appropriate may not be detected.
4499 @end table
4501 @item -Wsuggest-final-types
4502 @opindex Wno-suggest-final-types
4503 @opindex Wsuggest-final-types
4504 Warn about types with virtual methods where code quality would be improved
4505 if the type were declared with the C++11 @code{final} specifier, 
4506 or, if possible,
4507 declared in an anonymous namespace. This allows GCC to more aggressively
4508 devirtualize the polymorphic calls. This warning is more effective with link
4509 time optimization, where the information about the class hierarchy graph is
4510 more complete.
4512 @item -Wsuggest-final-methods
4513 @opindex Wno-suggest-final-methods
4514 @opindex Wsuggest-final-methods
4515 Warn about virtual methods where code quality would be improved if the method
4516 were declared with the C++11 @code{final} specifier, 
4517 or, if possible, its type were
4518 declared in an anonymous namespace or with the @code{final} specifier.
4519 This warning is
4520 more effective with link time optimization, where the information about the
4521 class hierarchy graph is more complete. It is recommended to first consider
4522 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4523 annotations.
4525 @item -Wsuggest-override
4526 Warn about overriding virtual functions that are not marked with the override
4527 keyword.
4529 @item -Warray-bounds
4530 @itemx -Warray-bounds=@var{n}
4531 @opindex Wno-array-bounds
4532 @opindex Warray-bounds
4533 This option is only active when @option{-ftree-vrp} is active
4534 (default for @option{-O2} and above). It warns about subscripts to arrays
4535 that are always out of bounds. This warning is enabled by @option{-Wall}.
4537 @table @gcctabopt
4538 @item -Warray-bounds=1
4539 This is the warning level of @option{-Warray-bounds} and is enabled
4540 by @option{-Wall}; higher levels are not, and must be explicitly requested.
4542 @item -Warray-bounds=2
4543 This warning level also warns about out of bounds access for
4544 arrays at the end of a struct and for arrays accessed through
4545 pointers. This warning level may give a larger number of
4546 false positives and is deactivated by default.
4547 @end table
4549 @item -Wbool-compare
4550 @opindex Wno-bool-compare
4551 @opindex Wbool-compare
4552 Warn about boolean expression compared with an integer value different from
4553 @code{true}/@code{false}.  For instance, the following comparison is
4554 always false:
4555 @smallexample
4556 int n = 5;
4557 @dots{}
4558 if ((n > 1) == 2) @{ @dots{} @}
4559 @end smallexample
4560 This warning is enabled by @option{-Wall}.
4562 @item -Wduplicated-cond
4563 @opindex Wno-duplicated-cond
4564 @opindex Wduplicated-cond
4565 Warn about duplicated conditions in an if-else-if chain.  For instance,
4566 warn for the following code:
4567 @smallexample
4568 if (p->q != NULL) @{ @dots{} @}
4569 else if (p->q != NULL) @{ @dots{} @}
4570 @end smallexample
4571 This warning is enabled by @option{-Wall}.
4573 @item -Wframe-address
4574 @opindex Wno-frame-address
4575 @opindex Wframe-address
4576 Warn when the @samp{__builtin_frame_address} or @samp{__builtin_return_address}
4577 is called with an argument greater than 0.  Such calls may return indeterminate
4578 values or crash the program.  The warning is included in @option{-Wall}.
4580 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4581 @opindex Wno-discarded-qualifiers
4582 @opindex Wdiscarded-qualifiers
4583 Do not warn if type qualifiers on pointers are being discarded.
4584 Typically, the compiler warns if a @code{const char *} variable is
4585 passed to a function that takes a @code{char *} parameter.  This option
4586 can be used to suppress such a warning.
4588 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4589 @opindex Wno-discarded-array-qualifiers
4590 @opindex Wdiscarded-array-qualifiers
4591 Do not warn if type qualifiers on arrays which are pointer targets
4592 are being discarded. Typically, the compiler warns if a
4593 @code{const int (*)[]} variable is passed to a function that
4594 takes a @code{int (*)[]} parameter.  This option can be used to
4595 suppress such a warning.
4597 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4598 @opindex Wno-incompatible-pointer-types
4599 @opindex Wincompatible-pointer-types
4600 Do not warn when there is a conversion between pointers that have incompatible
4601 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4602 which warns for pointer argument passing or assignment with different
4603 signedness.
4605 @item -Wno-int-conversion @r{(C and Objective-C only)}
4606 @opindex Wno-int-conversion
4607 @opindex Wint-conversion
4608 Do not warn about incompatible integer to pointer and pointer to integer
4609 conversions.  This warning is about implicit conversions; for explicit
4610 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4611 @option{-Wno-pointer-to-int-cast} may be used.
4613 @item -Wno-div-by-zero
4614 @opindex Wno-div-by-zero
4615 @opindex Wdiv-by-zero
4616 Do not warn about compile-time integer division by zero.  Floating-point
4617 division by zero is not warned about, as it can be a legitimate way of
4618 obtaining infinities and NaNs.
4620 @item -Wsystem-headers
4621 @opindex Wsystem-headers
4622 @opindex Wno-system-headers
4623 @cindex warnings from system headers
4624 @cindex system headers, warnings from
4625 Print warning messages for constructs found in system header files.
4626 Warnings from system headers are normally suppressed, on the assumption
4627 that they usually do not indicate real problems and would only make the
4628 compiler output harder to read.  Using this command-line option tells
4629 GCC to emit warnings from system headers as if they occurred in user
4630 code.  However, note that using @option{-Wall} in conjunction with this
4631 option does @emph{not} warn about unknown pragmas in system
4632 headers---for that, @option{-Wunknown-pragmas} must also be used.
4634 @item -Wtautological-compare
4635 @opindex Wtautological-compare
4636 @opindex Wno-tautological-compare
4637 Warn if a self-comparison always evaluates to true or false.  This
4638 warning detects various mistakes such as:
4639 @smallexample
4640 int i = 1;
4641 @dots{}
4642 if (i > i) @{ @dots{} @}
4643 @end smallexample
4644 This warning is enabled by @option{-Wall}.
4646 @item -Wtrampolines
4647 @opindex Wtrampolines
4648 @opindex Wno-trampolines
4649 Warn about trampolines generated for pointers to nested functions.
4650 A trampoline is a small piece of data or code that is created at run
4651 time on the stack when the address of a nested function is taken, and is
4652 used to call the nested function indirectly.  For some targets, it is
4653 made up of data only and thus requires no special treatment.  But, for
4654 most targets, it is made up of code and thus requires the stack to be
4655 made executable in order for the program to work properly.
4657 @item -Wfloat-equal
4658 @opindex Wfloat-equal
4659 @opindex Wno-float-equal
4660 Warn if floating-point values are used in equality comparisons.
4662 The idea behind this is that sometimes it is convenient (for the
4663 programmer) to consider floating-point values as approximations to
4664 infinitely precise real numbers.  If you are doing this, then you need
4665 to compute (by analyzing the code, or in some other way) the maximum or
4666 likely maximum error that the computation introduces, and allow for it
4667 when performing comparisons (and when producing output, but that's a
4668 different problem).  In particular, instead of testing for equality, you
4669 should check to see whether the two values have ranges that overlap; and
4670 this is done with the relational operators, so equality comparisons are
4671 probably mistaken.
4673 @item -Wtraditional @r{(C and Objective-C only)}
4674 @opindex Wtraditional
4675 @opindex Wno-traditional
4676 Warn about certain constructs that behave differently in traditional and
4677 ISO C@.  Also warn about ISO C constructs that have no traditional C
4678 equivalent, and/or problematic constructs that should be avoided.
4680 @itemize @bullet
4681 @item
4682 Macro parameters that appear within string literals in the macro body.
4683 In traditional C macro replacement takes place within string literals,
4684 but in ISO C it does not.
4686 @item
4687 In traditional C, some preprocessor directives did not exist.
4688 Traditional preprocessors only considered a line to be a directive
4689 if the @samp{#} appeared in column 1 on the line.  Therefore
4690 @option{-Wtraditional} warns about directives that traditional C
4691 understands but ignores because the @samp{#} does not appear as the
4692 first character on the line.  It also suggests you hide directives like
4693 @code{#pragma} not understood by traditional C by indenting them.  Some
4694 traditional implementations do not recognize @code{#elif}, so this option
4695 suggests avoiding it altogether.
4697 @item
4698 A function-like macro that appears without arguments.
4700 @item
4701 The unary plus operator.
4703 @item
4704 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4705 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4706 constants.)  Note, these suffixes appear in macros defined in the system
4707 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4708 Use of these macros in user code might normally lead to spurious
4709 warnings, however GCC's integrated preprocessor has enough context to
4710 avoid warning in these cases.
4712 @item
4713 A function declared external in one block and then used after the end of
4714 the block.
4716 @item
4717 A @code{switch} statement has an operand of type @code{long}.
4719 @item
4720 A non-@code{static} function declaration follows a @code{static} one.
4721 This construct is not accepted by some traditional C compilers.
4723 @item
4724 The ISO type of an integer constant has a different width or
4725 signedness from its traditional type.  This warning is only issued if
4726 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4727 typically represent bit patterns, are not warned about.
4729 @item
4730 Usage of ISO string concatenation is detected.
4732 @item
4733 Initialization of automatic aggregates.
4735 @item
4736 Identifier conflicts with labels.  Traditional C lacks a separate
4737 namespace for labels.
4739 @item
4740 Initialization of unions.  If the initializer is zero, the warning is
4741 omitted.  This is done under the assumption that the zero initializer in
4742 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4743 initializer warnings and relies on default initialization to zero in the
4744 traditional C case.
4746 @item
4747 Conversions by prototypes between fixed/floating-point values and vice
4748 versa.  The absence of these prototypes when compiling with traditional
4749 C causes serious problems.  This is a subset of the possible
4750 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4752 @item
4753 Use of ISO C style function definitions.  This warning intentionally is
4754 @emph{not} issued for prototype declarations or variadic functions
4755 because these ISO C features appear in your code when using
4756 libiberty's traditional C compatibility macros, @code{PARAMS} and
4757 @code{VPARAMS}.  This warning is also bypassed for nested functions
4758 because that feature is already a GCC extension and thus not relevant to
4759 traditional C compatibility.
4760 @end itemize
4762 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4763 @opindex Wtraditional-conversion
4764 @opindex Wno-traditional-conversion
4765 Warn if a prototype causes a type conversion that is different from what
4766 would happen to the same argument in the absence of a prototype.  This
4767 includes conversions of fixed point to floating and vice versa, and
4768 conversions changing the width or signedness of a fixed-point argument
4769 except when the same as the default promotion.
4771 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4772 @opindex Wdeclaration-after-statement
4773 @opindex Wno-declaration-after-statement
4774 Warn when a declaration is found after a statement in a block.  This
4775 construct, known from C++, was introduced with ISO C99 and is by default
4776 allowed in GCC@.  It is not supported by ISO C90.  @xref{Mixed Declarations}.
4778 @item -Wundef
4779 @opindex Wundef
4780 @opindex Wno-undef
4781 Warn if an undefined identifier is evaluated in an @code{#if} directive.
4783 @item -Wno-endif-labels
4784 @opindex Wno-endif-labels
4785 @opindex Wendif-labels
4786 Do not warn whenever an @code{#else} or an @code{#endif} are followed by text.
4788 @item -Wshadow
4789 @opindex Wshadow
4790 @opindex Wno-shadow
4791 Warn whenever a local variable or type declaration shadows another
4792 variable, parameter, type, class member (in C++), or instance variable
4793 (in Objective-C) or whenever a built-in function is shadowed. Note
4794 that in C++, the compiler warns if a local variable shadows an
4795 explicit typedef, but not if it shadows a struct/class/enum.
4797 @item -Wno-shadow-ivar @r{(Objective-C only)}
4798 @opindex Wno-shadow-ivar
4799 @opindex Wshadow-ivar
4800 Do not warn whenever a local variable shadows an instance variable in an
4801 Objective-C method.
4803 @item -Wlarger-than=@var{len}
4804 @opindex Wlarger-than=@var{len}
4805 @opindex Wlarger-than-@var{len}
4806 Warn whenever an object of larger than @var{len} bytes is defined.
4808 @item -Wframe-larger-than=@var{len}
4809 @opindex Wframe-larger-than
4810 Warn if the size of a function frame is larger than @var{len} bytes.
4811 The computation done to determine the stack frame size is approximate
4812 and not conservative.
4813 The actual requirements may be somewhat greater than @var{len}
4814 even if you do not get a warning.  In addition, any space allocated
4815 via @code{alloca}, variable-length arrays, or related constructs
4816 is not included by the compiler when determining
4817 whether or not to issue a warning.
4819 @item -Wno-free-nonheap-object
4820 @opindex Wno-free-nonheap-object
4821 @opindex Wfree-nonheap-object
4822 Do not warn when attempting to free an object that was not allocated
4823 on the heap.
4825 @item -Wstack-usage=@var{len}
4826 @opindex Wstack-usage
4827 Warn if the stack usage of a function might be larger than @var{len} bytes.
4828 The computation done to determine the stack usage is conservative.
4829 Any space allocated via @code{alloca}, variable-length arrays, or related
4830 constructs is included by the compiler when determining whether or not to
4831 issue a warning.
4833 The message is in keeping with the output of @option{-fstack-usage}.
4835 @itemize
4836 @item
4837 If the stack usage is fully static but exceeds the specified amount, it's:
4839 @smallexample
4840   warning: stack usage is 1120 bytes
4841 @end smallexample
4842 @item
4843 If the stack usage is (partly) dynamic but bounded, it's:
4845 @smallexample
4846   warning: stack usage might be 1648 bytes
4847 @end smallexample
4848 @item
4849 If the stack usage is (partly) dynamic and not bounded, it's:
4851 @smallexample
4852   warning: stack usage might be unbounded
4853 @end smallexample
4854 @end itemize
4856 @item -Wunsafe-loop-optimizations
4857 @opindex Wunsafe-loop-optimizations
4858 @opindex Wno-unsafe-loop-optimizations
4859 Warn if the loop cannot be optimized because the compiler cannot
4860 assume anything on the bounds of the loop indices.  With
4861 @option{-funsafe-loop-optimizations} warn if the compiler makes
4862 such assumptions.
4864 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4865 @opindex Wno-pedantic-ms-format
4866 @opindex Wpedantic-ms-format
4867 When used in combination with @option{-Wformat}
4868 and @option{-pedantic} without GNU extensions, this option
4869 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4870 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4871 which depend on the MS runtime.
4873 @item -Wpointer-arith
4874 @opindex Wpointer-arith
4875 @opindex Wno-pointer-arith
4876 Warn about anything that depends on the ``size of'' a function type or
4877 of @code{void}.  GNU C assigns these types a size of 1, for
4878 convenience in calculations with @code{void *} pointers and pointers
4879 to functions.  In C++, warn also when an arithmetic operation involves
4880 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4882 @item -Wtype-limits
4883 @opindex Wtype-limits
4884 @opindex Wno-type-limits
4885 Warn if a comparison is always true or always false due to the limited
4886 range of the data type, but do not warn for constant expressions.  For
4887 example, warn if an unsigned variable is compared against zero with
4888 @code{<} or @code{>=}.  This warning is also enabled by
4889 @option{-Wextra}.
4891 @item -Wbad-function-cast @r{(C and Objective-C only)}
4892 @opindex Wbad-function-cast
4893 @opindex Wno-bad-function-cast
4894 Warn when a function call is cast to a non-matching type.
4895 For example, warn if a call to a function returning an integer type 
4896 is cast to a pointer type.
4898 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4899 @opindex Wc90-c99-compat
4900 @opindex Wno-c90-c99-compat
4901 Warn about features not present in ISO C90, but present in ISO C99.
4902 For instance, warn about use of variable length arrays, @code{long long}
4903 type, @code{bool} type, compound literals, designated initializers, and so
4904 on.  This option is independent of the standards mode.  Warnings are disabled
4905 in the expression that follows @code{__extension__}.
4907 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4908 @opindex Wc99-c11-compat
4909 @opindex Wno-c99-c11-compat
4910 Warn about features not present in ISO C99, but present in ISO C11.
4911 For instance, warn about use of anonymous structures and unions,
4912 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4913 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4914 and so on.  This option is independent of the standards mode.  Warnings are
4915 disabled in the expression that follows @code{__extension__}.
4917 @item -Wc++-compat @r{(C and Objective-C only)}
4918 @opindex Wc++-compat
4919 Warn about ISO C constructs that are outside of the common subset of
4920 ISO C and ISO C++, e.g.@: request for implicit conversion from
4921 @code{void *} to a pointer to non-@code{void} type.
4923 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4924 @opindex Wc++11-compat
4925 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4926 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4927 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4928 enabled by @option{-Wall}.
4930 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4931 @opindex Wc++14-compat
4932 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4933 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4935 @item -Wcast-qual
4936 @opindex Wcast-qual
4937 @opindex Wno-cast-qual
4938 Warn whenever a pointer is cast so as to remove a type qualifier from
4939 the target type.  For example, warn if a @code{const char *} is cast
4940 to an ordinary @code{char *}.
4942 Also warn when making a cast that introduces a type qualifier in an
4943 unsafe way.  For example, casting @code{char **} to @code{const char **}
4944 is unsafe, as in this example:
4946 @smallexample
4947   /* p is char ** value.  */
4948   const char **q = (const char **) p;
4949   /* Assignment of readonly string to const char * is OK.  */
4950   *q = "string";
4951   /* Now char** pointer points to read-only memory.  */
4952   **p = 'b';
4953 @end smallexample
4955 @item -Wcast-align
4956 @opindex Wcast-align
4957 @opindex Wno-cast-align
4958 Warn whenever a pointer is cast such that the required alignment of the
4959 target is increased.  For example, warn if a @code{char *} is cast to
4960 an @code{int *} on machines where integers can only be accessed at
4961 two- or four-byte boundaries.
4963 @item -Wwrite-strings
4964 @opindex Wwrite-strings
4965 @opindex Wno-write-strings
4966 When compiling C, give string constants the type @code{const
4967 char[@var{length}]} so that copying the address of one into a
4968 non-@code{const} @code{char *} pointer produces a warning.  These
4969 warnings help you find at compile time code that can try to write
4970 into a string constant, but only if you have been very careful about
4971 using @code{const} in declarations and prototypes.  Otherwise, it is
4972 just a nuisance. This is why we did not make @option{-Wall} request
4973 these warnings.
4975 When compiling C++, warn about the deprecated conversion from string
4976 literals to @code{char *}.  This warning is enabled by default for C++
4977 programs.
4979 @item -Wclobbered
4980 @opindex Wclobbered
4981 @opindex Wno-clobbered
4982 Warn for variables that might be changed by @code{longjmp} or
4983 @code{vfork}.  This warning is also enabled by @option{-Wextra}.
4985 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4986 @opindex Wconditionally-supported
4987 @opindex Wno-conditionally-supported
4988 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4990 @item -Wconversion
4991 @opindex Wconversion
4992 @opindex Wno-conversion
4993 Warn for implicit conversions that may alter a value. This includes
4994 conversions between real and integer, like @code{abs (x)} when
4995 @code{x} is @code{double}; conversions between signed and unsigned,
4996 like @code{unsigned ui = -1}; and conversions to smaller types, like
4997 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4998 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4999 changed by the conversion like in @code{abs (2.0)}.  Warnings about
5000 conversions between signed and unsigned integers can be disabled by
5001 using @option{-Wno-sign-conversion}.
5003 For C++, also warn for confusing overload resolution for user-defined
5004 conversions; and conversions that never use a type conversion
5005 operator: conversions to @code{void}, the same type, a base class or a
5006 reference to them. Warnings about conversions between signed and
5007 unsigned integers are disabled by default in C++ unless
5008 @option{-Wsign-conversion} is explicitly enabled.
5010 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
5011 @opindex Wconversion-null
5012 @opindex Wno-conversion-null
5013 Do not warn for conversions between @code{NULL} and non-pointer
5014 types. @option{-Wconversion-null} is enabled by default.
5016 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
5017 @opindex Wzero-as-null-pointer-constant
5018 @opindex Wno-zero-as-null-pointer-constant
5019 Warn when a literal '0' is used as null pointer constant.  This can
5020 be useful to facilitate the conversion to @code{nullptr} in C++11.
5022 @item -Wsubobject-linkage @r{(C++ and Objective-C++ only)}
5023 @opindex Wsubobject-linkage
5024 @opindex Wno-subobject-linkage
5025 Warn if a class type has a base or a field whose type uses the anonymous
5026 namespace or depends on a type with no linkage.  If a type A depends on
5027 a type B with no or internal linkage, defining it in multiple
5028 translation units would be an ODR violation because the meaning of B
5029 is different in each translation unit.  If A only appears in a single
5030 translation unit, the best way to silence the warning is to give it
5031 internal linkage by putting it in an anonymous namespace as well.  The
5032 compiler doesn't give this warning for types defined in the main .C
5033 file, as those are unlikely to have multiple definitions.
5034 @option{-Wsubobject-linkage} is enabled by default.
5036 @item -Wdate-time
5037 @opindex Wdate-time
5038 @opindex Wno-date-time
5039 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
5040 are encountered as they might prevent bit-wise-identical reproducible
5041 compilations.
5043 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
5044 @opindex Wdelete-incomplete
5045 @opindex Wno-delete-incomplete
5046 Warn when deleting a pointer to incomplete type, which may cause
5047 undefined behavior at runtime.  This warning is enabled by default.
5049 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
5050 @opindex Wuseless-cast
5051 @opindex Wno-useless-cast
5052 Warn when an expression is casted to its own type.
5054 @item -Wempty-body
5055 @opindex Wempty-body
5056 @opindex Wno-empty-body
5057 Warn if an empty body occurs in an @code{if}, @code{else} or @code{do
5058 while} statement.  This warning is also enabled by @option{-Wextra}.
5060 @item -Wenum-compare
5061 @opindex Wenum-compare
5062 @opindex Wno-enum-compare
5063 Warn about a comparison between values of different enumerated types.
5064 In C++ enumeral mismatches in conditional expressions are also
5065 diagnosed and the warning is enabled by default.  In C this warning is 
5066 enabled by @option{-Wall}.
5068 @item -Wjump-misses-init @r{(C, Objective-C only)}
5069 @opindex Wjump-misses-init
5070 @opindex Wno-jump-misses-init
5071 Warn if a @code{goto} statement or a @code{switch} statement jumps
5072 forward across the initialization of a variable, or jumps backward to a
5073 label after the variable has been initialized.  This only warns about
5074 variables that are initialized when they are declared.  This warning is
5075 only supported for C and Objective-C; in C++ this sort of branch is an
5076 error in any case.
5078 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
5079 can be disabled with the @option{-Wno-jump-misses-init} option.
5081 @item -Wsign-compare
5082 @opindex Wsign-compare
5083 @opindex Wno-sign-compare
5084 @cindex warning for comparison of signed and unsigned values
5085 @cindex comparison of signed and unsigned values, warning
5086 @cindex signed and unsigned values, comparison warning
5087 Warn when a comparison between signed and unsigned values could produce
5088 an incorrect result when the signed value is converted to unsigned.
5089 This warning is also enabled by @option{-Wextra}; to get the other warnings
5090 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
5092 @item -Wsign-conversion
5093 @opindex Wsign-conversion
5094 @opindex Wno-sign-conversion
5095 Warn for implicit conversions that may change the sign of an integer
5096 value, like assigning a signed integer expression to an unsigned
5097 integer variable. An explicit cast silences the warning. In C, this
5098 option is enabled also by @option{-Wconversion}.
5100 @item -Wfloat-conversion
5101 @opindex Wfloat-conversion
5102 @opindex Wno-float-conversion
5103 Warn for implicit conversions that reduce the precision of a real value.
5104 This includes conversions from real to integer, and from higher precision
5105 real to lower precision real values.  This option is also enabled by
5106 @option{-Wconversion}.
5108 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
5109 @opindex Wsized-deallocation
5110 @opindex Wno-sized-deallocation
5111 Warn about a definition of an unsized deallocation function
5112 @smallexample
5113 void operator delete (void *) noexcept;
5114 void operator delete[] (void *) noexcept;
5115 @end smallexample
5116 without a definition of the corresponding sized deallocation function
5117 @smallexample
5118 void operator delete (void *, std::size_t) noexcept;
5119 void operator delete[] (void *, std::size_t) noexcept;
5120 @end smallexample
5121 or vice versa.  Enabled by @option{-Wextra} along with
5122 @option{-fsized-deallocation}.
5124 @item -Wsizeof-pointer-memaccess
5125 @opindex Wsizeof-pointer-memaccess
5126 @opindex Wno-sizeof-pointer-memaccess
5127 Warn for suspicious length parameters to certain string and memory built-in
5128 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
5129 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
5130 but a pointer, and suggests a possible fix, or about
5131 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
5132 @option{-Wall}.
5134 @item -Wsizeof-array-argument
5135 @opindex Wsizeof-array-argument
5136 @opindex Wno-sizeof-array-argument
5137 Warn when the @code{sizeof} operator is applied to a parameter that is
5138 declared as an array in a function definition.  This warning is enabled by
5139 default for C and C++ programs.
5141 @item -Wmemset-transposed-args
5142 @opindex Wmemset-transposed-args
5143 @opindex Wno-memset-transposed-args
5144 Warn for suspicious calls to the @code{memset} built-in function, if the
5145 second argument is not zero and the third argument is zero.  This warns e.g.@
5146 about @code{memset (buf, sizeof buf, 0)} where most probably
5147 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
5148 is only emitted if the third argument is literal zero.  If it is some
5149 expression that is folded to zero, a cast of zero to some type, etc., 
5150 it is far less likely that the user has mistakenly exchanged the arguments 
5151 and no warning is emitted.  This warning is enabled by @option{-Wall}.
5153 @item -Waddress
5154 @opindex Waddress
5155 @opindex Wno-address
5156 Warn about suspicious uses of memory addresses. These include using
5157 the address of a function in a conditional expression, such as
5158 @code{void func(void); if (func)}, and comparisons against the memory
5159 address of a string literal, such as @code{if (x == "abc")}.  Such
5160 uses typically indicate a programmer error: the address of a function
5161 always evaluates to true, so their use in a conditional usually
5162 indicate that the programmer forgot the parentheses in a function
5163 call; and comparisons against string literals result in unspecified
5164 behavior and are not portable in C, so they usually indicate that the
5165 programmer intended to use @code{strcmp}.  This warning is enabled by
5166 @option{-Wall}.
5168 @item -Wlogical-op
5169 @opindex Wlogical-op
5170 @opindex Wno-logical-op
5171 Warn about suspicious uses of logical operators in expressions.
5172 This includes using logical operators in contexts where a
5173 bit-wise operator is likely to be expected.  Also warns when
5174 the operands of a logical operator are the same:
5175 @smallexample
5176 extern int a;
5177 if (a < 0 && a < 0) @{ @dots{} @}
5178 @end smallexample
5180 @item -Wlogical-not-parentheses
5181 @opindex Wlogical-not-parentheses
5182 @opindex Wno-logical-not-parentheses
5183 Warn about logical not used on the left hand side operand of a comparison.
5184 This option does not warn if the RHS operand is of a boolean type.  Its
5185 purpose is to detect suspicious code like the following:
5186 @smallexample
5187 int a;
5188 @dots{}
5189 if (!a > 1) @{ @dots{} @}
5190 @end smallexample
5192 It is possible to suppress the warning by wrapping the LHS into
5193 parentheses:
5194 @smallexample
5195 if ((!a) > 1) @{ @dots{} @}
5196 @end smallexample
5198 This warning is enabled by @option{-Wall}.
5200 @item -Waggregate-return
5201 @opindex Waggregate-return
5202 @opindex Wno-aggregate-return
5203 Warn if any functions that return structures or unions are defined or
5204 called.  (In languages where you can return an array, this also elicits
5205 a warning.)
5207 @item -Wno-aggressive-loop-optimizations
5208 @opindex Wno-aggressive-loop-optimizations
5209 @opindex Waggressive-loop-optimizations
5210 Warn if in a loop with constant number of iterations the compiler detects
5211 undefined behavior in some statement during one or more of the iterations.
5213 @item -Wno-attributes
5214 @opindex Wno-attributes
5215 @opindex Wattributes
5216 Do not warn if an unexpected @code{__attribute__} is used, such as
5217 unrecognized attributes, function attributes applied to variables,
5218 etc.  This does not stop errors for incorrect use of supported
5219 attributes.
5221 @item -Wno-builtin-macro-redefined
5222 @opindex Wno-builtin-macro-redefined
5223 @opindex Wbuiltin-macro-redefined
5224 Do not warn if certain built-in macros are redefined.  This suppresses
5225 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
5226 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
5228 @item -Wstrict-prototypes @r{(C and Objective-C only)}
5229 @opindex Wstrict-prototypes
5230 @opindex Wno-strict-prototypes
5231 Warn if a function is declared or defined without specifying the
5232 argument types.  (An old-style function definition is permitted without
5233 a warning if preceded by a declaration that specifies the argument
5234 types.)
5236 @item -Wold-style-declaration @r{(C and Objective-C only)}
5237 @opindex Wold-style-declaration
5238 @opindex Wno-old-style-declaration
5239 Warn for obsolescent usages, according to the C Standard, in a
5240 declaration. For example, warn if storage-class specifiers like
5241 @code{static} are not the first things in a declaration.  This warning
5242 is also enabled by @option{-Wextra}.
5244 @item -Wold-style-definition @r{(C and Objective-C only)}
5245 @opindex Wold-style-definition
5246 @opindex Wno-old-style-definition
5247 Warn if an old-style function definition is used.  A warning is given
5248 even if there is a previous prototype.
5250 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
5251 @opindex Wmissing-parameter-type
5252 @opindex Wno-missing-parameter-type
5253 A function parameter is declared without a type specifier in K&R-style
5254 functions:
5256 @smallexample
5257 void foo(bar) @{ @}
5258 @end smallexample
5260 This warning is also enabled by @option{-Wextra}.
5262 @item -Wmissing-prototypes @r{(C and Objective-C only)}
5263 @opindex Wmissing-prototypes
5264 @opindex Wno-missing-prototypes
5265 Warn if a global function is defined without a previous prototype
5266 declaration.  This warning is issued even if the definition itself
5267 provides a prototype.  Use this option to detect global functions
5268 that do not have a matching prototype declaration in a header file.
5269 This option is not valid for C++ because all function declarations
5270 provide prototypes and a non-matching declaration declares an
5271 overload rather than conflict with an earlier declaration.
5272 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
5274 @item -Wmissing-declarations
5275 @opindex Wmissing-declarations
5276 @opindex Wno-missing-declarations
5277 Warn if a global function is defined without a previous declaration.
5278 Do so even if the definition itself provides a prototype.
5279 Use this option to detect global functions that are not declared in
5280 header files.  In C, no warnings are issued for functions with previous
5281 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
5282 missing prototypes.  In C++, no warnings are issued for function templates,
5283 or for inline functions, or for functions in anonymous namespaces.
5285 @item -Wmissing-field-initializers
5286 @opindex Wmissing-field-initializers
5287 @opindex Wno-missing-field-initializers
5288 @opindex W
5289 @opindex Wextra
5290 @opindex Wno-extra
5291 Warn if a structure's initializer has some fields missing.  For
5292 example, the following code causes such a warning, because
5293 @code{x.h} is implicitly zero:
5295 @smallexample
5296 struct s @{ int f, g, h; @};
5297 struct s x = @{ 3, 4 @};
5298 @end smallexample
5300 This option does not warn about designated initializers, so the following
5301 modification does not trigger a warning:
5303 @smallexample
5304 struct s @{ int f, g, h; @};
5305 struct s x = @{ .f = 3, .g = 4 @};
5306 @end smallexample
5308 In C++ this option does not warn either about the empty @{ @}
5309 initializer, for example:
5311 @smallexample
5312 struct s @{ int f, g, h; @};
5313 s x = @{ @};
5314 @end smallexample
5316 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5317 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5319 @item -Wno-multichar
5320 @opindex Wno-multichar
5321 @opindex Wmultichar
5322 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5323 Usually they indicate a typo in the user's code, as they have
5324 implementation-defined values, and should not be used in portable code.
5326 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5327 @opindex Wnormalized=
5328 @opindex Wnormalized
5329 @opindex Wno-normalized
5330 @cindex NFC
5331 @cindex NFKC
5332 @cindex character set, input normalization
5333 In ISO C and ISO C++, two identifiers are different if they are
5334 different sequences of characters.  However, sometimes when characters
5335 outside the basic ASCII character set are used, you can have two
5336 different character sequences that look the same.  To avoid confusion,
5337 the ISO 10646 standard sets out some @dfn{normalization rules} which
5338 when applied ensure that two sequences that look the same are turned into
5339 the same sequence.  GCC can warn you if you are using identifiers that
5340 have not been normalized; this option controls that warning.
5342 There are four levels of warning supported by GCC@.  The default is
5343 @option{-Wnormalized=nfc}, which warns about any identifier that is
5344 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5345 recommended form for most uses.  It is equivalent to
5346 @option{-Wnormalized}.
5348 Unfortunately, there are some characters allowed in identifiers by
5349 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5350 identifiers.  That is, there's no way to use these symbols in portable
5351 ISO C or C++ and have all your identifiers in NFC@.
5352 @option{-Wnormalized=id} suppresses the warning for these characters.
5353 It is hoped that future versions of the standards involved will correct
5354 this, which is why this option is not the default.
5356 You can switch the warning off for all characters by writing
5357 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5358 only do this if you are using some other normalization scheme (like
5359 ``D''), because otherwise you can easily create bugs that are
5360 literally impossible to see.
5362 Some characters in ISO 10646 have distinct meanings but look identical
5363 in some fonts or display methodologies, especially once formatting has
5364 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5365 LETTER N'', displays just like a regular @code{n} that has been
5366 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5367 normalization scheme to convert all these into a standard form as
5368 well, and GCC warns if your code is not in NFKC if you use
5369 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5370 about every identifier that contains the letter O because it might be
5371 confused with the digit 0, and so is not the default, but may be
5372 useful as a local coding convention if the programming environment 
5373 cannot be fixed to display these characters distinctly.
5375 @item -Wno-deprecated
5376 @opindex Wno-deprecated
5377 @opindex Wdeprecated
5378 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5380 @item -Wno-deprecated-declarations
5381 @opindex Wno-deprecated-declarations
5382 @opindex Wdeprecated-declarations
5383 Do not warn about uses of functions (@pxref{Function Attributes}),
5384 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5385 Attributes}) marked as deprecated by using the @code{deprecated}
5386 attribute.
5388 @item -Wno-overflow
5389 @opindex Wno-overflow
5390 @opindex Woverflow
5391 Do not warn about compile-time overflow in constant expressions.
5393 @item -Wno-odr
5394 @opindex Wno-odr
5395 @opindex Wodr
5396 Warn about One Definition Rule violations during link-time optimization.
5397 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5399 @item -Wopenmp-simd
5400 @opindex Wopenm-simd
5401 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5402 simd directive set by user.  The @option{-fsimd-cost-model=unlimited}
5403 option can be used to relax the cost model.
5405 @item -Woverride-init @r{(C and Objective-C only)}
5406 @opindex Woverride-init
5407 @opindex Wno-override-init
5408 @opindex W
5409 @opindex Wextra
5410 @opindex Wno-extra
5411 Warn if an initialized field without side effects is overridden when
5412 using designated initializers (@pxref{Designated Inits, , Designated
5413 Initializers}).
5415 This warning is included in @option{-Wextra}.  To get other
5416 @option{-Wextra} warnings without this one, use @option{-Wextra
5417 -Wno-override-init}.
5419 @item -Woverride-init-side-effects @r{(C and Objective-C only)}
5420 @opindex Woverride-init-side-effects
5421 @opindex Wno-override-init-side-effects
5422 Warn if an initialized field with side effects is overridden when
5423 using designated initializers (@pxref{Designated Inits, , Designated
5424 Initializers}).  This warning is enabled by default.
5426 @item -Wpacked
5427 @opindex Wpacked
5428 @opindex Wno-packed
5429 Warn if a structure is given the packed attribute, but the packed
5430 attribute has no effect on the layout or size of the structure.
5431 Such structures may be mis-aligned for little benefit.  For
5432 instance, in this code, the variable @code{f.x} in @code{struct bar}
5433 is misaligned even though @code{struct bar} does not itself
5434 have the packed attribute:
5436 @smallexample
5437 @group
5438 struct foo @{
5439   int x;
5440   char a, b, c, d;
5441 @} __attribute__((packed));
5442 struct bar @{
5443   char z;
5444   struct foo f;
5446 @end group
5447 @end smallexample
5449 @item -Wpacked-bitfield-compat
5450 @opindex Wpacked-bitfield-compat
5451 @opindex Wno-packed-bitfield-compat
5452 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5453 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5454 the change can lead to differences in the structure layout.  GCC
5455 informs you when the offset of such a field has changed in GCC 4.4.
5456 For example there is no longer a 4-bit padding between field @code{a}
5457 and @code{b} in this structure:
5459 @smallexample
5460 struct foo
5462   char a:4;
5463   char b:8;
5464 @} __attribute__ ((packed));
5465 @end smallexample
5467 This warning is enabled by default.  Use
5468 @option{-Wno-packed-bitfield-compat} to disable this warning.
5470 @item -Wpadded
5471 @opindex Wpadded
5472 @opindex Wno-padded
5473 Warn if padding is included in a structure, either to align an element
5474 of the structure or to align the whole structure.  Sometimes when this
5475 happens it is possible to rearrange the fields of the structure to
5476 reduce the padding and so make the structure smaller.
5478 @item -Wredundant-decls
5479 @opindex Wredundant-decls
5480 @opindex Wno-redundant-decls
5481 Warn if anything is declared more than once in the same scope, even in
5482 cases where multiple declaration is valid and changes nothing.
5484 @item -Wnested-externs @r{(C and Objective-C only)}
5485 @opindex Wnested-externs
5486 @opindex Wno-nested-externs
5487 Warn if an @code{extern} declaration is encountered within a function.
5489 @item -Wno-inherited-variadic-ctor
5490 @opindex Winherited-variadic-ctor
5491 @opindex Wno-inherited-variadic-ctor
5492 Suppress warnings about use of C++11 inheriting constructors when the
5493 base class inherited from has a C variadic constructor; the warning is
5494 on by default because the ellipsis is not inherited.
5496 @item -Winline
5497 @opindex Winline
5498 @opindex Wno-inline
5499 Warn if a function that is declared as inline cannot be inlined.
5500 Even with this option, the compiler does not warn about failures to
5501 inline functions declared in system headers.
5503 The compiler uses a variety of heuristics to determine whether or not
5504 to inline a function.  For example, the compiler takes into account
5505 the size of the function being inlined and the amount of inlining
5506 that has already been done in the current function.  Therefore,
5507 seemingly insignificant changes in the source program can cause the
5508 warnings produced by @option{-Winline} to appear or disappear.
5510 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5511 @opindex Wno-invalid-offsetof
5512 @opindex Winvalid-offsetof
5513 Suppress warnings from applying the @code{offsetof} macro to a non-POD
5514 type.  According to the 2014 ISO C++ standard, applying @code{offsetof}
5515 to a non-standard-layout type is undefined.  In existing C++ implementations,
5516 however, @code{offsetof} typically gives meaningful results.
5517 This flag is for users who are aware that they are
5518 writing nonportable code and who have deliberately chosen to ignore the
5519 warning about it.
5521 The restrictions on @code{offsetof} may be relaxed in a future version
5522 of the C++ standard.
5524 @item -Wno-int-to-pointer-cast
5525 @opindex Wno-int-to-pointer-cast
5526 @opindex Wint-to-pointer-cast
5527 Suppress warnings from casts to pointer type of an integer of a
5528 different size. In C++, casting to a pointer type of smaller size is
5529 an error. @option{Wint-to-pointer-cast} is enabled by default.
5532 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5533 @opindex Wno-pointer-to-int-cast
5534 @opindex Wpointer-to-int-cast
5535 Suppress warnings from casts from a pointer to an integer type of a
5536 different size.
5538 @item -Winvalid-pch
5539 @opindex Winvalid-pch
5540 @opindex Wno-invalid-pch
5541 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5542 the search path but can't be used.
5544 @item -Wlong-long
5545 @opindex Wlong-long
5546 @opindex Wno-long-long
5547 Warn if @code{long long} type is used.  This is enabled by either
5548 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5549 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5551 @item -Wvariadic-macros
5552 @opindex Wvariadic-macros
5553 @opindex Wno-variadic-macros
5554 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5555 alternate syntax is used in ISO C99 mode.  This is enabled by either
5556 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5557 messages, use @option{-Wno-variadic-macros}.
5559 @item -Wvarargs
5560 @opindex Wvarargs
5561 @opindex Wno-varargs
5562 Warn upon questionable usage of the macros used to handle variable
5563 arguments like @code{va_start}.  This is default.  To inhibit the
5564 warning messages, use @option{-Wno-varargs}.
5566 @item -Wvector-operation-performance
5567 @opindex Wvector-operation-performance
5568 @opindex Wno-vector-operation-performance
5569 Warn if vector operation is not implemented via SIMD capabilities of the
5570 architecture.  Mainly useful for the performance tuning.
5571 Vector operation can be implemented @code{piecewise}, which means that the
5572 scalar operation is performed on every vector element; 
5573 @code{in parallel}, which means that the vector operation is implemented
5574 using scalars of wider type, which normally is more performance efficient;
5575 and @code{as a single scalar}, which means that vector fits into a
5576 scalar type.
5578 @item -Wno-virtual-move-assign
5579 @opindex Wvirtual-move-assign
5580 @opindex Wno-virtual-move-assign
5581 Suppress warnings about inheriting from a virtual base with a
5582 non-trivial C++11 move assignment operator.  This is dangerous because
5583 if the virtual base is reachable along more than one path, it is
5584 moved multiple times, which can mean both objects end up in the
5585 moved-from state.  If the move assignment operator is written to avoid
5586 moving from a moved-from object, this warning can be disabled.
5588 @item -Wvla
5589 @opindex Wvla
5590 @opindex Wno-vla
5591 Warn if variable length array is used in the code.
5592 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5593 the variable length array.
5595 @item -Wvolatile-register-var
5596 @opindex Wvolatile-register-var
5597 @opindex Wno-volatile-register-var
5598 Warn if a register variable is declared volatile.  The volatile
5599 modifier does not inhibit all optimizations that may eliminate reads
5600 and/or writes to register variables.  This warning is enabled by
5601 @option{-Wall}.
5603 @item -Wdisabled-optimization
5604 @opindex Wdisabled-optimization
5605 @opindex Wno-disabled-optimization
5606 Warn if a requested optimization pass is disabled.  This warning does
5607 not generally indicate that there is anything wrong with your code; it
5608 merely indicates that GCC's optimizers are unable to handle the code
5609 effectively.  Often, the problem is that your code is too big or too
5610 complex; GCC refuses to optimize programs when the optimization
5611 itself is likely to take inordinate amounts of time.
5613 @item -Wpointer-sign @r{(C and Objective-C only)}
5614 @opindex Wpointer-sign
5615 @opindex Wno-pointer-sign
5616 Warn for pointer argument passing or assignment with different signedness.
5617 This option is only supported for C and Objective-C@.  It is implied by
5618 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5619 @option{-Wno-pointer-sign}.
5621 @item -Wstack-protector
5622 @opindex Wstack-protector
5623 @opindex Wno-stack-protector
5624 This option is only active when @option{-fstack-protector} is active.  It
5625 warns about functions that are not protected against stack smashing.
5627 @item -Woverlength-strings
5628 @opindex Woverlength-strings
5629 @opindex Wno-overlength-strings
5630 Warn about string constants that are longer than the ``minimum
5631 maximum'' length specified in the C standard.  Modern compilers
5632 generally allow string constants that are much longer than the
5633 standard's minimum limit, but very portable programs should avoid
5634 using longer strings.
5636 The limit applies @emph{after} string constant concatenation, and does
5637 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5638 C99, it was raised to 4095.  C++98 does not specify a normative
5639 minimum maximum, so we do not diagnose overlength strings in C++@.
5641 This option is implied by @option{-Wpedantic}, and can be disabled with
5642 @option{-Wno-overlength-strings}.
5644 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5645 @opindex Wunsuffixed-float-constants
5647 Issue a warning for any floating constant that does not have
5648 a suffix.  When used together with @option{-Wsystem-headers} it
5649 warns about such constants in system header files.  This can be useful
5650 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5651 from the decimal floating-point extension to C99.
5653 @item -Wno-designated-init @r{(C and Objective-C only)}
5654 Suppress warnings when a positional initializer is used to initialize
5655 a structure that has been marked with the @code{designated_init}
5656 attribute.
5658 @end table
5660 @node Debugging Options
5661 @section Options for Debugging Your Program or GCC
5662 @cindex options, debugging
5663 @cindex debugging information options
5665 GCC has various special options that are used for debugging
5666 either your program or GCC:
5668 @table @gcctabopt
5669 @item -g
5670 @opindex g
5671 Produce debugging information in the operating system's native format
5672 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5673 information.
5675 On most systems that use stabs format, @option{-g} enables use of extra
5676 debugging information that only GDB can use; this extra information
5677 makes debugging work better in GDB but probably makes other debuggers
5678 crash or
5679 refuse to read the program.  If you want to control for certain whether
5680 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5681 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5683 GCC allows you to use @option{-g} with
5684 @option{-O}.  The shortcuts taken by optimized code may occasionally
5685 produce surprising results: some variables you declared may not exist
5686 at all; flow of control may briefly move where you did not expect it;
5687 some statements may not be executed because they compute constant
5688 results or their values are already at hand; some statements may
5689 execute in different places because they have been moved out of loops.
5691 Nevertheless it proves possible to debug optimized output.  This makes
5692 it reasonable to use the optimizer for programs that might have bugs.
5694 The following options are useful when GCC is generated with the
5695 capability for more than one debugging format.
5697 @item -gsplit-dwarf
5698 @opindex gsplit-dwarf
5699 Separate as much dwarf debugging information as possible into a
5700 separate output file with the extension .dwo.  This option allows
5701 the build system to avoid linking files with debug information.  To
5702 be useful, this option requires a debugger capable of reading .dwo
5703 files.
5705 @item -ggdb
5706 @opindex ggdb
5707 Produce debugging information for use by GDB@.  This means to use the
5708 most expressive format available (DWARF 2, stabs, or the native format
5709 if neither of those are supported), including GDB extensions if at all
5710 possible.
5712 @item -gpubnames
5713 @opindex gpubnames
5714 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5716 @item -ggnu-pubnames
5717 @opindex ggnu-pubnames
5718 Generate .debug_pubnames and .debug_pubtypes sections in a format
5719 suitable for conversion into a GDB@ index.  This option is only useful
5720 with a linker that can produce GDB@ index version 7.
5722 @item -gstabs
5723 @opindex gstabs
5724 Produce debugging information in stabs format (if that is supported),
5725 without GDB extensions.  This is the format used by DBX on most BSD
5726 systems.  On MIPS, Alpha and System V Release 4 systems this option
5727 produces stabs debugging output that is not understood by DBX or SDB@.
5728 On System V Release 4 systems this option requires the GNU assembler.
5730 @item -feliminate-unused-debug-symbols
5731 @opindex feliminate-unused-debug-symbols
5732 Produce debugging information in stabs format (if that is supported),
5733 for only symbols that are actually used.
5735 @item -femit-class-debug-always
5736 @opindex femit-class-debug-always
5737 Instead of emitting debugging information for a C++ class in only one
5738 object file, emit it in all object files using the class.  This option
5739 should be used only with debuggers that are unable to handle the way GCC
5740 normally emits debugging information for classes because using this
5741 option increases the size of debugging information by as much as a
5742 factor of two.
5744 @item -fdebug-types-section
5745 @opindex fdebug-types-section
5746 @opindex fno-debug-types-section
5747 When using DWARF Version 4 or higher, type DIEs can be put into
5748 their own @code{.debug_types} section instead of making them part of the
5749 @code{.debug_info} section.  It is more efficient to put them in a separate
5750 comdat sections since the linker can then remove duplicates.
5751 But not all DWARF consumers support @code{.debug_types} sections yet
5752 and on some objects @code{.debug_types} produces larger instead of smaller
5753 debugging information.
5755 @item -gstabs+
5756 @opindex gstabs+
5757 Produce debugging information in stabs format (if that is supported),
5758 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5759 use of these extensions is likely to make other debuggers crash or
5760 refuse to read the program.
5762 @item -gcoff
5763 @opindex gcoff
5764 Produce debugging information in COFF format (if that is supported).
5765 This is the format used by SDB on most System V systems prior to
5766 System V Release 4.
5768 @item -gxcoff
5769 @opindex gxcoff
5770 Produce debugging information in XCOFF format (if that is supported).
5771 This is the format used by the DBX debugger on IBM RS/6000 systems.
5773 @item -gxcoff+
5774 @opindex gxcoff+
5775 Produce debugging information in XCOFF format (if that is supported),
5776 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5777 use of these extensions is likely to make other debuggers crash or
5778 refuse to read the program, and may cause assemblers other than the GNU
5779 assembler (GAS) to fail with an error.
5781 @item -gdwarf-@var{version}
5782 @opindex gdwarf-@var{version}
5783 Produce debugging information in DWARF format (if that is supported).
5784 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5785 for most targets is 4.  DWARF Version 5 is only experimental.
5787 Note that with DWARF Version 2, some ports require and always
5788 use some non-conflicting DWARF 3 extensions in the unwind tables.
5790 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5791 for maximum benefit.
5793 @item -grecord-gcc-switches
5794 @opindex grecord-gcc-switches
5795 This switch causes the command-line options used to invoke the
5796 compiler that may affect code generation to be appended to the
5797 DW_AT_producer attribute in DWARF debugging information.  The options
5798 are concatenated with spaces separating them from each other and from
5799 the compiler version.  See also @option{-frecord-gcc-switches} for another
5800 way of storing compiler options into the object file.  This is the default.
5802 @item -gno-record-gcc-switches
5803 @opindex gno-record-gcc-switches
5804 Disallow appending command-line options to the DW_AT_producer attribute
5805 in DWARF debugging information.
5807 @item -gstrict-dwarf
5808 @opindex gstrict-dwarf
5809 Disallow using extensions of later DWARF standard version than selected
5810 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5811 DWARF extensions from later standard versions is allowed.
5813 @item -gno-strict-dwarf
5814 @opindex gno-strict-dwarf
5815 Allow using extensions of later DWARF standard version than selected with
5816 @option{-gdwarf-@var{version}}.
5818 @item -gz@r{[}=@var{type}@r{]}
5819 @opindex gz
5820 Produce compressed debug sections in DWARF format, if that is supported.
5821 If @var{type} is not given, the default type depends on the capabilities
5822 of the assembler and linker used.  @var{type} may be one of
5823 @samp{none} (don't compress debug sections), @samp{zlib} (use zlib
5824 compression in ELF gABI format), or @samp{zlib-gnu} (use zlib
5825 compression in traditional GNU format).  If the linker doesn't support
5826 writing compressed debug sections, the option is rejected.  Otherwise,
5827 if the assembler does not support them, @option{-gz} is silently ignored
5828 when producing object files.
5830 @item -gvms
5831 @opindex gvms
5832 Produce debugging information in Alpha/VMS debug format (if that is
5833 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5835 @item -g@var{level}
5836 @itemx -ggdb@var{level}
5837 @itemx -gstabs@var{level}
5838 @itemx -gcoff@var{level}
5839 @itemx -gxcoff@var{level}
5840 @itemx -gvms@var{level}
5841 Request debugging information and also use @var{level} to specify how
5842 much information.  The default level is 2.
5844 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5845 @option{-g}.
5847 Level 1 produces minimal information, enough for making backtraces in
5848 parts of the program that you don't plan to debug.  This includes
5849 descriptions of functions and external variables, and line number
5850 tables, but no information about local variables.
5852 Level 3 includes extra information, such as all the macro definitions
5853 present in the program.  Some debuggers support macro expansion when
5854 you use @option{-g3}.
5856 @option{-gdwarf-2} does not accept a concatenated debug level, because
5857 GCC used to support an option @option{-gdwarf} that meant to generate
5858 debug information in version 1 of the DWARF format (which is very
5859 different from version 2), and it would have been too confusing.  That
5860 debug format is long obsolete, but the option cannot be changed now.
5861 Instead use an additional @option{-g@var{level}} option to change the
5862 debug level for DWARF.
5864 @item -gtoggle
5865 @opindex gtoggle
5866 Turn off generation of debug info, if leaving out this option
5867 generates it, or turn it on at level 2 otherwise.  The position of this
5868 argument in the command line does not matter; it takes effect after all
5869 other options are processed, and it does so only once, no matter how
5870 many times it is given.  This is mainly intended to be used with
5871 @option{-fcompare-debug}.
5873 @item -fsanitize=address
5874 @opindex fsanitize=address
5875 Enable AddressSanitizer, a fast memory error detector.
5876 Memory access instructions are instrumented to detect
5877 out-of-bounds and use-after-free bugs.
5878 See @uref{https://github.com/google/sanitizers/wiki/AddressSanitizer} for
5879 more details.  The run-time behavior can be influenced using the
5880 @env{ASAN_OPTIONS} environment variable.  When set to @code{help=1},
5881 the available options are shown at startup of the instrumended program.  See
5882 @url{https://github.com/google/sanitizers/wiki/AddressSanitizerFlags#run-time-flags}
5883 for a list of supported options.
5885 @item -fsanitize=kernel-address
5886 @opindex fsanitize=kernel-address
5887 Enable AddressSanitizer for Linux kernel.
5888 See @uref{https://github.com/google/kasan/wiki} for more details.
5890 @item -fsanitize=thread
5891 @opindex fsanitize=thread
5892 Enable ThreadSanitizer, a fast data race detector.
5893 Memory access instructions are instrumented to detect
5894 data race bugs.  See @uref{https://github.com/google/sanitizers/wiki#threadsanitizer} for more
5895 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5896 environment variable; see
5897 @url{https://github.com/google/sanitizers/wiki/ThreadSanitizerFlags} for a list of
5898 supported options.
5900 @item -fsanitize=leak
5901 @opindex fsanitize=leak
5902 Enable LeakSanitizer, a memory leak detector.
5903 This option only matters for linking of executables and if neither
5904 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5905 case the executable is linked against a library that overrides @code{malloc}
5906 and other allocator functions.  See
5907 @uref{https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer} for more
5908 details.  The run-time behavior can be influenced using the
5909 @env{LSAN_OPTIONS} environment variable.
5911 @item -fsanitize=undefined
5912 @opindex fsanitize=undefined
5913 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5914 Various computations are instrumented to detect undefined behavior
5915 at runtime.  Current suboptions are:
5917 @table @gcctabopt
5919 @item -fsanitize=shift
5920 @opindex fsanitize=shift
5921 This option enables checking that the result of a shift operation is
5922 not undefined.  Note that what exactly is considered undefined differs
5923 slightly between C and C++, as well as between ISO C90 and C99, etc.
5925 @item -fsanitize=integer-divide-by-zero
5926 @opindex fsanitize=integer-divide-by-zero
5927 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5929 @item -fsanitize=unreachable
5930 @opindex fsanitize=unreachable
5931 With this option, the compiler turns the @code{__builtin_unreachable}
5932 call into a diagnostics message call instead.  When reaching the
5933 @code{__builtin_unreachable} call, the behavior is undefined.
5935 @item -fsanitize=vla-bound
5936 @opindex fsanitize=vla-bound
5937 This option instructs the compiler to check that the size of a variable
5938 length array is positive.
5940 @item -fsanitize=null
5941 @opindex fsanitize=null
5942 This option enables pointer checking.  Particularly, the application
5943 built with this option turned on will issue an error message when it
5944 tries to dereference a NULL pointer, or if a reference (possibly an
5945 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5946 on an object pointed by a NULL pointer.
5948 @item -fsanitize=return
5949 @opindex fsanitize=return
5950 This option enables return statement checking.  Programs
5951 built with this option turned on will issue an error message
5952 when the end of a non-void function is reached without actually
5953 returning a value.  This option works in C++ only.
5955 @item -fsanitize=signed-integer-overflow
5956 @opindex fsanitize=signed-integer-overflow
5957 This option enables signed integer overflow checking.  We check that
5958 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5959 does not overflow in the signed arithmetics.  Note, integer promotion
5960 rules must be taken into account.  That is, the following is not an
5961 overflow:
5962 @smallexample
5963 signed char a = SCHAR_MAX;
5964 a++;
5965 @end smallexample
5967 @item -fsanitize=bounds
5968 @opindex fsanitize=bounds
5969 This option enables instrumentation of array bounds.  Various out of bounds
5970 accesses are detected.  Flexible array members, flexible array member-like
5971 arrays, and initializers of variables with static storage are not instrumented.
5973 @item -fsanitize=bounds-strict
5974 @opindex fsanitize=bounds-strict
5975 This option enables strict instrumentation of array bounds.  Most out of bounds
5976 accesses are detected, including flexible array members and flexible array
5977 member-like arrays.  Initializers of variables with static storage are not
5978 instrumented.
5980 @item -fsanitize=alignment
5981 @opindex fsanitize=alignment
5983 This option enables checking of alignment of pointers when they are
5984 dereferenced, or when a reference is bound to insufficiently aligned target,
5985 or when a method or constructor is invoked on insufficiently aligned object.
5987 @item -fsanitize=object-size
5988 @opindex fsanitize=object-size
5989 This option enables instrumentation of memory references using the
5990 @code{__builtin_object_size} function.  Various out of bounds pointer
5991 accesses are detected.
5993 @item -fsanitize=float-divide-by-zero
5994 @opindex fsanitize=float-divide-by-zero
5995 Detect floating-point division by zero.  Unlike other similar options,
5996 @option{-fsanitize=float-divide-by-zero} is not enabled by
5997 @option{-fsanitize=undefined}, since floating-point division by zero can
5998 be a legitimate way of obtaining infinities and NaNs.
6000 @item -fsanitize=float-cast-overflow
6001 @opindex fsanitize=float-cast-overflow
6002 This option enables floating-point type to integer conversion checking.
6003 We check that the result of the conversion does not overflow.
6004 Unlike other similar options, @option{-fsanitize=float-cast-overflow} is
6005 not enabled by @option{-fsanitize=undefined}.
6006 This option does not work well with @code{FE_INVALID} exceptions enabled.
6008 @item -fsanitize=nonnull-attribute
6009 @opindex fsanitize=nonnull-attribute
6011 This option enables instrumentation of calls, checking whether null values
6012 are not passed to arguments marked as requiring a non-null value by the
6013 @code{nonnull} function attribute.
6015 @item -fsanitize=returns-nonnull-attribute
6016 @opindex fsanitize=returns-nonnull-attribute
6018 This option enables instrumentation of return statements in functions
6019 marked with @code{returns_nonnull} function attribute, to detect returning
6020 of null values from such functions.
6022 @item -fsanitize=bool
6023 @opindex fsanitize=bool
6025 This option enables instrumentation of loads from bool.  If a value other
6026 than 0/1 is loaded, a run-time error is issued.
6028 @item -fsanitize=enum
6029 @opindex fsanitize=enum
6031 This option enables instrumentation of loads from an enum type.  If
6032 a value outside the range of values for the enum type is loaded,
6033 a run-time error is issued.
6035 @item -fsanitize=vptr
6036 @opindex fsanitize=vptr
6038 This option enables instrumentation of C++ member function calls, member
6039 accesses and some conversions between pointers to base and derived classes,
6040 to verify the referenced object has the correct dynamic type.
6042 @end table
6044 While @option{-ftrapv} causes traps for signed overflows to be emitted,
6045 @option{-fsanitize=undefined} gives a diagnostic message.
6046 This currently works only for the C family of languages.
6048 @item -fno-sanitize=all
6049 @opindex fno-sanitize=all
6051 This option disables all previously enabled sanitizers.
6052 @option{-fsanitize=all} is not allowed, as some sanitizers cannot be used
6053 together.
6055 @item -fasan-shadow-offset=@var{number}
6056 @opindex fasan-shadow-offset
6057 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
6058 It is useful for experimenting with different shadow memory layouts in
6059 Kernel AddressSanitizer.
6061 @item -fsanitize-sections=@var{s1},@var{s2},...
6062 @opindex fsanitize-sections
6063 Sanitize global variables in selected user-defined sections.  @var{si} may
6064 contain wildcards.
6066 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
6067 @opindex fsanitize-recover
6068 @opindex fno-sanitize-recover
6069 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
6070 mentioned in comma-separated list of @var{opts}.  Enabling this option
6071 for a sanitizer component causes it to attempt to continue
6072 running the program as if no error happened.  This means multiple
6073 runtime errors can be reported in a single program run, and the exit
6074 code of the program may indicate success even when errors
6075 have been reported.  The @option{-fno-sanitize-recover=} option
6076 can be used to alter
6077 this behavior: only the first detected error is reported
6078 and program then exits with a non-zero exit code.
6080 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
6081 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
6082 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
6083 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
6084 @option{-fsanitize-recover=all} and @option{-fno-sanitize-recover=all} is also
6085 accepted, the former enables recovery for all sanitizers that support it,
6086 the latter disables recovery for all sanitizers that support it.
6088 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
6089 @smallexample
6090 -fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
6091 @end smallexample
6092 @noindent
6093 Similarly @option{-fno-sanitize-recover} is equivalent to
6094 @smallexample
6095 -fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero
6096 @end smallexample
6098 @item -fsanitize-undefined-trap-on-error
6099 @opindex fsanitize-undefined-trap-on-error
6100 The @option{-fsanitize-undefined-trap-on-error} option instructs the compiler to
6101 report undefined behavior using @code{__builtin_trap} rather than
6102 a @code{libubsan} library routine.  The advantage of this is that the
6103 @code{libubsan} library is not needed and is not linked in, so this
6104 is usable even in freestanding environments.
6106 @item -fcheck-pointer-bounds
6107 @opindex fcheck-pointer-bounds
6108 @opindex fno-check-pointer-bounds
6109 @cindex Pointer Bounds Checker options
6110 Enable Pointer Bounds Checker instrumentation.  Each memory reference
6111 is instrumented with checks of the pointer used for memory access against
6112 bounds associated with that pointer.  
6114 Currently there
6115 is only an implementation for Intel MPX available, thus x86 target
6116 and @option{-mmpx} are required to enable this feature.  
6117 MPX-based instrumentation requires
6118 a runtime library to enable MPX in hardware and handle bounds
6119 violation signals.  By default when @option{-fcheck-pointer-bounds}
6120 and @option{-mmpx} options are used to link a program, the GCC driver
6121 links against the @file{libmpx} runtime library and @file{libmpxwrappers}
6122 library.  It also passes '-z bndplt' to a linker in case it supports this
6123 option (which is checked on libmpx configuration).  Note that old versions
6124 of linker may ignore option.  Gold linker doesn't support '-z bndplt'
6125 option.  With no '-z bndplt' support in linker all calls to dynamic libraries
6126 lose passed bounds reducing overall protection level.  It's highly
6127 recommended to use linker with '-z bndplt' support.  In case such linker
6128 is not available it is adviced to always use @option{-static-libmpxwrappers}
6129 for better protection level or use @option{-static} to completely avoid
6130 external calls to dynamic libraries.  MPX-based instrumentation
6131 may be used for debugging and also may be included in production code
6132 to increase program security.  Depending on usage, you may
6133 have different requirements for the runtime library.  The current version
6134 of the MPX runtime library is more oriented for use as a debugging
6135 tool.  MPX runtime library usage implies @option{-lpthread}.  See
6136 also @option{-static-libmpx}.  The runtime library  behavior can be
6137 influenced using various @env{CHKP_RT_*} environment variables.  See
6138 @uref{https://gcc.gnu.org/wiki/Intel%20MPX%20support%20in%20the%20GCC%20compiler}
6139 for more details.
6141 Generated instrumentation may be controlled by various
6142 @option{-fchkp-*} options and by the @code{bnd_variable_size}
6143 structure field attribute (@pxref{Type Attributes}) and
6144 @code{bnd_legacy}, and @code{bnd_instrument} function attributes
6145 (@pxref{Function Attributes}).  GCC also provides a number of built-in
6146 functions for controlling the Pointer Bounds Checker.  @xref{Pointer
6147 Bounds Checker builtins}, for more information.
6149 @item -fchecking
6150 @opindex fchecking
6151 @opindex fno-checking
6152 Enable internal consistency checking.  The default depends on
6153 the compiler configuration.
6155 @item -fchkp-check-incomplete-type
6156 @opindex fchkp-check-incomplete-type
6157 @opindex fno-chkp-check-incomplete-type
6158 Generate pointer bounds checks for variables with incomplete type.
6159 Enabled by default.
6161 @item -fchkp-narrow-bounds
6162 @opindex fchkp-narrow-bounds
6163 @opindex fno-chkp-narrow-bounds
6164 Controls bounds used by Pointer Bounds Checker for pointers to object
6165 fields.  If narrowing is enabled then field bounds are used.  Otherwise
6166 object bounds are used.  See also @option{-fchkp-narrow-to-innermost-array}
6167 and @option{-fchkp-first-field-has-own-bounds}.  Enabled by default.
6169 @item -fchkp-first-field-has-own-bounds
6170 @opindex fchkp-first-field-has-own-bounds
6171 @opindex fno-chkp-first-field-has-own-bounds
6172 Forces Pointer Bounds Checker to use narrowed bounds for the address of the
6173 first field in the structure.  By default a pointer to the first field has
6174 the same bounds as a pointer to the whole structure.
6176 @item -fchkp-narrow-to-innermost-array
6177 @opindex fchkp-narrow-to-innermost-array
6178 @opindex fno-chkp-narrow-to-innermost-array
6179 Forces Pointer Bounds Checker to use bounds of the innermost arrays in
6180 case of nested static array access.  By default this option is disabled and
6181 bounds of the outermost array are used.
6183 @item -fchkp-optimize
6184 @opindex fchkp-optimize
6185 @opindex fno-chkp-optimize
6186 Enables Pointer Bounds Checker optimizations.  Enabled by default at
6187 optimization levels @option{-O}, @option{-O2}, @option{-O3}.
6189 @item -fchkp-use-fast-string-functions
6190 @opindex fchkp-use-fast-string-functions
6191 @opindex fno-chkp-use-fast-string-functions
6192 Enables use of @code{*_nobnd} versions of string functions (not copying bounds)
6193 by Pointer Bounds Checker.  Disabled by default.
6195 @item -fchkp-use-nochk-string-functions
6196 @opindex fchkp-use-nochk-string-functions
6197 @opindex fno-chkp-use-nochk-string-functions
6198 Enables use of @code{*_nochk} versions of string functions (not checking bounds)
6199 by Pointer Bounds Checker.  Disabled by default.
6201 @item -fchkp-use-static-bounds
6202 @opindex fchkp-use-static-bounds
6203 @opindex fno-chkp-use-static-bounds
6204 Allow Pointer Bounds Checker to generate static bounds holding
6205 bounds of static variables.  Enabled by default.
6207 @item -fchkp-use-static-const-bounds
6208 @opindex fchkp-use-static-const-bounds
6209 @opindex fno-chkp-use-static-const-bounds
6210 Use statically-initialized bounds for constant bounds instead of
6211 generating them each time they are required.  By default enabled when
6212 @option{-fchkp-use-static-bounds} is enabled.
6214 @item -fchkp-treat-zero-dynamic-size-as-infinite
6215 @opindex fchkp-treat-zero-dynamic-size-as-infinite
6216 @opindex fno-chkp-treat-zero-dynamic-size-as-infinite
6217 With this option, objects with incomplete type whose
6218 dynamically-obtained size is zero are treated as having infinite size
6219 instead by Pointer Bounds
6220 Checker.  This option may be helpful if a program is linked with a library
6221 missing size information for some symbols.  Disabled by default.
6223 @item -fchkp-check-read
6224 @opindex fchkp-check-read
6225 @opindex fno-chkp-check-read
6226 Instructs Pointer Bounds Checker to generate checks for all read
6227 accesses to memory.  Enabled by default.
6229 @item -fchkp-check-write
6230 @opindex fchkp-check-write
6231 @opindex fno-chkp-check-write
6232 Instructs Pointer Bounds Checker to generate checks for all write
6233 accesses to memory.  Enabled by default.
6235 @item -fchkp-store-bounds
6236 @opindex fchkp-store-bounds
6237 @opindex fno-chkp-store-bounds
6238 Instructs Pointer Bounds Checker to generate bounds stores for
6239 pointer writes.  Enabled by default.
6241 @item -fchkp-instrument-calls
6242 @opindex fchkp-instrument-calls
6243 @opindex fno-chkp-instrument-calls
6244 Instructs Pointer Bounds Checker to pass pointer bounds to calls.
6245 Enabled by default.
6247 @item -fchkp-instrument-marked-only
6248 @opindex fchkp-instrument-marked-only
6249 @opindex fno-chkp-instrument-marked-only
6250 Instructs Pointer Bounds Checker to instrument only functions
6251 marked with the @code{bnd_instrument} attribute
6252 (@pxref{Function Attributes}).  Disabled by default.
6254 @item -fchkp-use-wrappers
6255 @opindex fchkp-use-wrappers
6256 @opindex fno-chkp-use-wrappers
6257 Allows Pointer Bounds Checker to replace calls to built-in functions
6258 with calls to wrapper functions.  When @option{-fchkp-use-wrappers}
6259 is used to link a program, the GCC driver automatically links
6260 against @file{libmpxwrappers}.  See also @option{-static-libmpxwrappers}.
6261 Enabled by default.
6263 @item -fdump-final-insns@r{[}=@var{file}@r{]}
6264 @opindex fdump-final-insns
6265 Dump the final internal representation (RTL) to @var{file}.  If the
6266 optional argument is omitted (or if @var{file} is @code{.}), the name
6267 of the dump file is determined by appending @code{.gkd} to the
6268 compilation output file name.
6270 @item -fcompare-debug@r{[}=@var{opts}@r{]}
6271 @opindex fcompare-debug
6272 @opindex fno-compare-debug
6273 If no error occurs during compilation, run the compiler a second time,
6274 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
6275 passed to the second compilation.  Dump the final internal
6276 representation in both compilations, and print an error if they differ.
6278 If the equal sign is omitted, the default @option{-gtoggle} is used.
6280 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
6281 and nonzero, implicitly enables @option{-fcompare-debug}.  If
6282 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
6283 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
6284 is used.
6286 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
6287 is equivalent to @option{-fno-compare-debug}, which disables the dumping
6288 of the final representation and the second compilation, preventing even
6289 @env{GCC_COMPARE_DEBUG} from taking effect.
6291 To verify full coverage during @option{-fcompare-debug} testing, set
6292 @env{GCC_COMPARE_DEBUG} to say @option{-fcompare-debug-not-overridden},
6293 which GCC rejects as an invalid option in any actual compilation
6294 (rather than preprocessing, assembly or linking).  To get just a
6295 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
6296 not overridden} will do.
6298 @item -fcompare-debug-second
6299 @opindex fcompare-debug-second
6300 This option is implicitly passed to the compiler for the second
6301 compilation requested by @option{-fcompare-debug}, along with options to
6302 silence warnings, and omitting other options that would cause
6303 side-effect compiler outputs to files or to the standard output.  Dump
6304 files and preserved temporary files are renamed so as to contain the
6305 @code{.gk} additional extension during the second compilation, to avoid
6306 overwriting those generated by the first.
6308 When this option is passed to the compiler driver, it causes the
6309 @emph{first} compilation to be skipped, which makes it useful for little
6310 other than debugging the compiler proper.
6312 @item -feliminate-dwarf2-dups
6313 @opindex feliminate-dwarf2-dups
6314 Compress DWARF 2 debugging information by eliminating duplicated
6315 information about each symbol.  This option only makes sense when
6316 generating DWARF 2 debugging information with @option{-gdwarf-2}.
6318 @item -femit-struct-debug-baseonly
6319 @opindex femit-struct-debug-baseonly
6320 Emit debug information for struct-like types
6321 only when the base name of the compilation source file
6322 matches the base name of file in which the struct is defined.
6324 This option substantially reduces the size of debugging information,
6325 but at significant potential loss in type information to the debugger.
6326 See @option{-femit-struct-debug-reduced} for a less aggressive option.
6327 See @option{-femit-struct-debug-detailed} for more detailed control.
6329 This option works only with DWARF 2.
6331 @item -femit-struct-debug-reduced
6332 @opindex femit-struct-debug-reduced
6333 Emit debug information for struct-like types
6334 only when the base name of the compilation source file
6335 matches the base name of file in which the type is defined,
6336 unless the struct is a template or defined in a system header.
6338 This option significantly reduces the size of debugging information,
6339 with some potential loss in type information to the debugger.
6340 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
6341 See @option{-femit-struct-debug-detailed} for more detailed control.
6343 This option works only with DWARF 2.
6345 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
6346 @opindex femit-struct-debug-detailed
6347 Specify the struct-like types
6348 for which the compiler generates debug information.
6349 The intent is to reduce duplicate struct debug information
6350 between different object files within the same program.
6352 This option is a detailed version of
6353 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
6354 which serves for most needs.
6356 A specification has the syntax@*
6357 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
6359 The optional first word limits the specification to
6360 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
6361 A struct type is used directly when it is the type of a variable, member.
6362 Indirect uses arise through pointers to structs.
6363 That is, when use of an incomplete struct is valid, the use is indirect.
6364 An example is
6365 @samp{struct one direct; struct two * indirect;}.
6367 The optional second word limits the specification to
6368 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
6369 Generic structs are a bit complicated to explain.
6370 For C++, these are non-explicit specializations of template classes,
6371 or non-template classes within the above.
6372 Other programming languages have generics,
6373 but @option{-femit-struct-debug-detailed} does not yet implement them.
6375 The third word specifies the source files for those
6376 structs for which the compiler should emit debug information.
6377 The values @samp{none} and @samp{any} have the normal meaning.
6378 The value @samp{base} means that
6379 the base of name of the file in which the type declaration appears
6380 must match the base of the name of the main compilation file.
6381 In practice, this means that when compiling @file{foo.c}, debug information
6382 is generated for types declared in that file and @file{foo.h},
6383 but not other header files.
6384 The value @samp{sys} means those types satisfying @samp{base}
6385 or declared in system or compiler headers.
6387 You may need to experiment to determine the best settings for your application.
6389 The default is @option{-femit-struct-debug-detailed=all}.
6391 This option works only with DWARF 2.
6393 @item -fno-merge-debug-strings
6394 @opindex fmerge-debug-strings
6395 @opindex fno-merge-debug-strings
6396 Direct the linker to not merge together strings in the debugging
6397 information that are identical in different object files.  Merging is
6398 not supported by all assemblers or linkers.  Merging decreases the size
6399 of the debug information in the output file at the cost of increasing
6400 link processing time.  Merging is enabled by default.
6402 @item -fdebug-prefix-map=@var{old}=@var{new}
6403 @opindex fdebug-prefix-map
6404 When compiling files in directory @file{@var{old}}, record debugging
6405 information describing them as in @file{@var{new}} instead.
6407 @item -fno-dwarf2-cfi-asm
6408 @opindex fdwarf2-cfi-asm
6409 @opindex fno-dwarf2-cfi-asm
6410 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
6411 instead of using GAS @code{.cfi_*} directives.
6413 @cindex @command{prof}
6414 @item -p
6415 @opindex p
6416 Generate extra code to write profile information suitable for the
6417 analysis program @command{prof}.  You must use this option when compiling
6418 the source files you want data about, and you must also use it when
6419 linking.
6421 @cindex @command{gprof}
6422 @item -pg
6423 @opindex pg
6424 Generate extra code to write profile information suitable for the
6425 analysis program @command{gprof}.  You must use this option when compiling
6426 the source files you want data about, and you must also use it when
6427 linking.
6429 @item -Q
6430 @opindex Q
6431 Makes the compiler print out each function name as it is compiled, and
6432 print some statistics about each pass when it finishes.
6434 @item -ftime-report
6435 @opindex ftime-report
6436 Makes the compiler print some statistics about the time consumed by each
6437 pass when it finishes.
6439 @item -fmem-report
6440 @opindex fmem-report
6441 Makes the compiler print some statistics about permanent memory
6442 allocation when it finishes.
6444 @item -fmem-report-wpa
6445 @opindex fmem-report-wpa
6446 Makes the compiler print some statistics about permanent memory
6447 allocation for the WPA phase only.
6449 @item -fpre-ipa-mem-report
6450 @opindex fpre-ipa-mem-report
6451 @item -fpost-ipa-mem-report
6452 @opindex fpost-ipa-mem-report
6453 Makes the compiler print some statistics about permanent memory
6454 allocation before or after interprocedural optimization.
6456 @item -fprofile-report
6457 @opindex fprofile-report
6458 Makes the compiler print some statistics about consistency of the
6459 (estimated) profile and effect of individual passes.
6461 @item -fstack-usage
6462 @opindex fstack-usage
6463 Makes the compiler output stack usage information for the program, on a
6464 per-function basis.  The filename for the dump is made by appending
6465 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
6466 the output file, if explicitly specified and it is not an executable,
6467 otherwise it is the basename of the source file.  An entry is made up
6468 of three fields:
6470 @itemize
6471 @item
6472 The name of the function.
6473 @item
6474 A number of bytes.
6475 @item
6476 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
6477 @end itemize
6479 The qualifier @code{static} means that the function manipulates the stack
6480 statically: a fixed number of bytes are allocated for the frame on function
6481 entry and released on function exit; no stack adjustments are otherwise made
6482 in the function.  The second field is this fixed number of bytes.
6484 The qualifier @code{dynamic} means that the function manipulates the stack
6485 dynamically: in addition to the static allocation described above, stack
6486 adjustments are made in the body of the function, for example to push/pop
6487 arguments around function calls.  If the qualifier @code{bounded} is also
6488 present, the amount of these adjustments is bounded at compile time and
6489 the second field is an upper bound of the total amount of stack used by
6490 the function.  If it is not present, the amount of these adjustments is
6491 not bounded at compile time and the second field only represents the
6492 bounded part.
6494 @item -fprofile-arcs
6495 @opindex fprofile-arcs
6496 Add code so that program flow @dfn{arcs} are instrumented.  During
6497 execution the program records how many times each branch and call is
6498 executed and how many times it is taken or returns.  When the compiled
6499 program exits it saves this data to a file called
6500 @file{@var{auxname}.gcda} for each source file.  The data may be used for
6501 profile-directed optimizations (@option{-fbranch-probabilities}), or for
6502 test coverage analysis (@option{-ftest-coverage}).  Each object file's
6503 @var{auxname} is generated from the name of the output file, if
6504 explicitly specified and it is not the final executable, otherwise it is
6505 the basename of the source file.  In both cases any suffix is removed
6506 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
6507 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
6508 @xref{Cross-profiling}.
6510 @cindex @command{gcov}
6511 @item --coverage
6512 @opindex coverage
6514 This option is used to compile and link code instrumented for coverage
6515 analysis.  The option is a synonym for @option{-fprofile-arcs}
6516 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6517 linking).  See the documentation for those options for more details.
6519 @itemize
6521 @item
6522 Compile the source files with @option{-fprofile-arcs} plus optimization
6523 and code generation options.  For test coverage analysis, use the
6524 additional @option{-ftest-coverage} option.  You do not need to profile
6525 every source file in a program.
6527 @item
6528 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6529 (the latter implies the former).
6531 @item
6532 Run the program on a representative workload to generate the arc profile
6533 information.  This may be repeated any number of times.  You can run
6534 concurrent instances of your program, and provided that the file system
6535 supports locking, the data files will be correctly updated.  Also
6536 @code{fork} calls are detected and correctly handled (double counting
6537 will not happen).
6539 @item
6540 For profile-directed optimizations, compile the source files again with
6541 the same optimization and code generation options plus
6542 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6543 Control Optimization}).
6545 @item
6546 For test coverage analysis, use @command{gcov} to produce human readable
6547 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6548 @command{gcov} documentation for further information.
6550 @end itemize
6552 With @option{-fprofile-arcs}, for each function of your program GCC
6553 creates a program flow graph, then finds a spanning tree for the graph.
6554 Only arcs that are not on the spanning tree have to be instrumented: the
6555 compiler adds code to count the number of times that these arcs are
6556 executed.  When an arc is the only exit or only entrance to a block, the
6557 instrumentation code can be added to the block; otherwise, a new basic
6558 block must be created to hold the instrumentation code.
6560 @need 2000
6561 @item -ftest-coverage
6562 @opindex ftest-coverage
6563 Produce a notes file that the @command{gcov} code-coverage utility
6564 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6565 show program coverage.  Each source file's note file is called
6566 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6567 above for a description of @var{auxname} and instructions on how to
6568 generate test coverage data.  Coverage data matches the source files
6569 more closely if you do not optimize.
6571 @item -fdbg-cnt-list
6572 @opindex fdbg-cnt-list
6573 Print the name and the counter upper bound for all debug counters.
6576 @item -fdbg-cnt=@var{counter-value-list}
6577 @opindex fdbg-cnt
6578 Set the internal debug counter upper bound.  @var{counter-value-list}
6579 is a comma-separated list of @var{name}:@var{value} pairs
6580 which sets the upper bound of each debug counter @var{name} to @var{value}.
6581 All debug counters have the initial upper bound of @code{UINT_MAX};
6582 thus @code{dbg_cnt} returns true always unless the upper bound
6583 is set by this option.
6584 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6585 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6587 @item -fenable-@var{kind}-@var{pass}
6588 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6589 @opindex fdisable-
6590 @opindex fenable-
6592 This is a set of options that are used to explicitly disable/enable
6593 optimization passes.  These options are intended for use for debugging GCC.
6594 Compiler users should use regular options for enabling/disabling
6595 passes instead.
6597 @table @gcctabopt
6599 @item -fdisable-ipa-@var{pass}
6600 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6601 statically invoked in the compiler multiple times, the pass name should be
6602 appended with a sequential number starting from 1.
6604 @item -fdisable-rtl-@var{pass}
6605 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6606 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6607 statically invoked in the compiler multiple times, the pass name should be
6608 appended with a sequential number starting from 1.  @var{range-list} is a 
6609 comma-separated list of function ranges or assembler names.  Each range is a number
6610 pair separated by a colon.  The range is inclusive in both ends.  If the range
6611 is trivial, the number pair can be simplified as a single number.  If the
6612 function's call graph node's @var{uid} falls within one of the specified ranges,
6613 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6614 function header of a dump file, and the pass names can be dumped by using
6615 option @option{-fdump-passes}.
6617 @item -fdisable-tree-@var{pass}
6618 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6619 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6620 option arguments.
6622 @item -fenable-ipa-@var{pass}
6623 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6624 statically invoked in the compiler multiple times, the pass name should be
6625 appended with a sequential number starting from 1.
6627 @item -fenable-rtl-@var{pass}
6628 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6629 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6630 description and examples.
6632 @item -fenable-tree-@var{pass}
6633 @itemx -fenable-tree-@var{pass}=@var{range-list}
6634 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6635 of option arguments.
6637 @end table
6639 Here are some examples showing uses of these options.
6641 @smallexample
6643 # disable ccp1 for all functions
6644    -fdisable-tree-ccp1
6645 # disable complete unroll for function whose cgraph node uid is 1
6646    -fenable-tree-cunroll=1
6647 # disable gcse2 for functions at the following ranges [1,1],
6648 # [300,400], and [400,1000]
6649 # disable gcse2 for functions foo and foo2
6650    -fdisable-rtl-gcse2=foo,foo2
6651 # disable early inlining
6652    -fdisable-tree-einline
6653 # disable ipa inlining
6654    -fdisable-ipa-inline
6655 # enable tree full unroll
6656    -fenable-tree-unroll
6658 @end smallexample
6660 @item -d@var{letters}
6661 @itemx -fdump-rtl-@var{pass}
6662 @itemx -fdump-rtl-@var{pass}=@var{filename}
6663 @opindex d
6664 @opindex fdump-rtl-@var{pass}
6665 Says to make debugging dumps during compilation at times specified by
6666 @var{letters}.  This is used for debugging the RTL-based passes of the
6667 compiler.  The file names for most of the dumps are made by appending
6668 a pass number and a word to the @var{dumpname}, and the files are
6669 created in the directory of the output file.  In case of
6670 @option{=@var{filename}} option, the dump is output on the given file
6671 instead of the pass numbered dump files.  Note that the pass number is
6672 assigned as passes are registered into the pass manager.  Most passes
6673 are registered in the order that they will execute and for these passes
6674 the number corresponds to the pass execution order.  However, passes
6675 registered by plugins, passes specific to compilation targets, or
6676 passes that are otherwise registered after all the other passes are
6677 numbered higher than a pass named "final", even if they are executed
6678 earlier.  @var{dumpname} is generated from the name of the output
6679 file if explicitly specified and not an executable, otherwise it is
6680 the basename of the source file.  These switches may have different
6681 effects when @option{-E} is used for preprocessing.
6683 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6684 @option{-d} option @var{letters}.  Here are the possible
6685 letters for use in @var{pass} and @var{letters}, and their meanings:
6687 @table @gcctabopt
6689 @item -fdump-rtl-alignments
6690 @opindex fdump-rtl-alignments
6691 Dump after branch alignments have been computed.
6693 @item -fdump-rtl-asmcons
6694 @opindex fdump-rtl-asmcons
6695 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6697 @item -fdump-rtl-auto_inc_dec
6698 @opindex fdump-rtl-auto_inc_dec
6699 Dump after auto-inc-dec discovery.  This pass is only run on
6700 architectures that have auto inc or auto dec instructions.
6702 @item -fdump-rtl-barriers
6703 @opindex fdump-rtl-barriers
6704 Dump after cleaning up the barrier instructions.
6706 @item -fdump-rtl-bbpart
6707 @opindex fdump-rtl-bbpart
6708 Dump after partitioning hot and cold basic blocks.
6710 @item -fdump-rtl-bbro
6711 @opindex fdump-rtl-bbro
6712 Dump after block reordering.
6714 @item -fdump-rtl-btl1
6715 @itemx -fdump-rtl-btl2
6716 @opindex fdump-rtl-btl2
6717 @opindex fdump-rtl-btl2
6718 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6719 after the two branch
6720 target load optimization passes.
6722 @item -fdump-rtl-bypass
6723 @opindex fdump-rtl-bypass
6724 Dump after jump bypassing and control flow optimizations.
6726 @item -fdump-rtl-combine
6727 @opindex fdump-rtl-combine
6728 Dump after the RTL instruction combination pass.
6730 @item -fdump-rtl-compgotos
6731 @opindex fdump-rtl-compgotos
6732 Dump after duplicating the computed gotos.
6734 @item -fdump-rtl-ce1
6735 @itemx -fdump-rtl-ce2
6736 @itemx -fdump-rtl-ce3
6737 @opindex fdump-rtl-ce1
6738 @opindex fdump-rtl-ce2
6739 @opindex fdump-rtl-ce3
6740 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6741 @option{-fdump-rtl-ce3} enable dumping after the three
6742 if conversion passes.
6744 @item -fdump-rtl-cprop_hardreg
6745 @opindex fdump-rtl-cprop_hardreg
6746 Dump after hard register copy propagation.
6748 @item -fdump-rtl-csa
6749 @opindex fdump-rtl-csa
6750 Dump after combining stack adjustments.
6752 @item -fdump-rtl-cse1
6753 @itemx -fdump-rtl-cse2
6754 @opindex fdump-rtl-cse1
6755 @opindex fdump-rtl-cse2
6756 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6757 the two common subexpression elimination passes.
6759 @item -fdump-rtl-dce
6760 @opindex fdump-rtl-dce
6761 Dump after the standalone dead code elimination passes.
6763 @item -fdump-rtl-dbr
6764 @opindex fdump-rtl-dbr
6765 Dump after delayed branch scheduling.
6767 @item -fdump-rtl-dce1
6768 @itemx -fdump-rtl-dce2
6769 @opindex fdump-rtl-dce1
6770 @opindex fdump-rtl-dce2
6771 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6772 the two dead store elimination passes.
6774 @item -fdump-rtl-eh
6775 @opindex fdump-rtl-eh
6776 Dump after finalization of EH handling code.
6778 @item -fdump-rtl-eh_ranges
6779 @opindex fdump-rtl-eh_ranges
6780 Dump after conversion of EH handling range regions.
6782 @item -fdump-rtl-expand
6783 @opindex fdump-rtl-expand
6784 Dump after RTL generation.
6786 @item -fdump-rtl-fwprop1
6787 @itemx -fdump-rtl-fwprop2
6788 @opindex fdump-rtl-fwprop1
6789 @opindex fdump-rtl-fwprop2
6790 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6791 dumping after the two forward propagation passes.
6793 @item -fdump-rtl-gcse1
6794 @itemx -fdump-rtl-gcse2
6795 @opindex fdump-rtl-gcse1
6796 @opindex fdump-rtl-gcse2
6797 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6798 after global common subexpression elimination.
6800 @item -fdump-rtl-init-regs
6801 @opindex fdump-rtl-init-regs
6802 Dump after the initialization of the registers.
6804 @item -fdump-rtl-initvals
6805 @opindex fdump-rtl-initvals
6806 Dump after the computation of the initial value sets.
6808 @item -fdump-rtl-into_cfglayout
6809 @opindex fdump-rtl-into_cfglayout
6810 Dump after converting to cfglayout mode.
6812 @item -fdump-rtl-ira
6813 @opindex fdump-rtl-ira
6814 Dump after iterated register allocation.
6816 @item -fdump-rtl-jump
6817 @opindex fdump-rtl-jump
6818 Dump after the second jump optimization.
6820 @item -fdump-rtl-loop2
6821 @opindex fdump-rtl-loop2
6822 @option{-fdump-rtl-loop2} enables dumping after the rtl
6823 loop optimization passes.
6825 @item -fdump-rtl-mach
6826 @opindex fdump-rtl-mach
6827 Dump after performing the machine dependent reorganization pass, if that
6828 pass exists.
6830 @item -fdump-rtl-mode_sw
6831 @opindex fdump-rtl-mode_sw
6832 Dump after removing redundant mode switches.
6834 @item -fdump-rtl-rnreg
6835 @opindex fdump-rtl-rnreg
6836 Dump after register renumbering.
6838 @item -fdump-rtl-outof_cfglayout
6839 @opindex fdump-rtl-outof_cfglayout
6840 Dump after converting from cfglayout mode.
6842 @item -fdump-rtl-peephole2
6843 @opindex fdump-rtl-peephole2
6844 Dump after the peephole pass.
6846 @item -fdump-rtl-postreload
6847 @opindex fdump-rtl-postreload
6848 Dump after post-reload optimizations.
6850 @item -fdump-rtl-pro_and_epilogue
6851 @opindex fdump-rtl-pro_and_epilogue
6852 Dump after generating the function prologues and epilogues.
6854 @item -fdump-rtl-sched1
6855 @itemx -fdump-rtl-sched2
6856 @opindex fdump-rtl-sched1
6857 @opindex fdump-rtl-sched2
6858 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6859 after the basic block scheduling passes.
6861 @item -fdump-rtl-ree
6862 @opindex fdump-rtl-ree
6863 Dump after sign/zero extension elimination.
6865 @item -fdump-rtl-seqabstr
6866 @opindex fdump-rtl-seqabstr
6867 Dump after common sequence discovery.
6869 @item -fdump-rtl-shorten
6870 @opindex fdump-rtl-shorten
6871 Dump after shortening branches.
6873 @item -fdump-rtl-sibling
6874 @opindex fdump-rtl-sibling
6875 Dump after sibling call optimizations.
6877 @item -fdump-rtl-split1
6878 @itemx -fdump-rtl-split2
6879 @itemx -fdump-rtl-split3
6880 @itemx -fdump-rtl-split4
6881 @itemx -fdump-rtl-split5
6882 @opindex fdump-rtl-split1
6883 @opindex fdump-rtl-split2
6884 @opindex fdump-rtl-split3
6885 @opindex fdump-rtl-split4
6886 @opindex fdump-rtl-split5
6887 These options enable dumping after five rounds of
6888 instruction splitting.
6890 @item -fdump-rtl-sms
6891 @opindex fdump-rtl-sms
6892 Dump after modulo scheduling.  This pass is only run on some
6893 architectures.
6895 @item -fdump-rtl-stack
6896 @opindex fdump-rtl-stack
6897 Dump after conversion from GCC's ``flat register file'' registers to the
6898 x87's stack-like registers.  This pass is only run on x86 variants.
6900 @item -fdump-rtl-subreg1
6901 @itemx -fdump-rtl-subreg2
6902 @opindex fdump-rtl-subreg1
6903 @opindex fdump-rtl-subreg2
6904 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6905 the two subreg expansion passes.
6907 @item -fdump-rtl-unshare
6908 @opindex fdump-rtl-unshare
6909 Dump after all rtl has been unshared.
6911 @item -fdump-rtl-vartrack
6912 @opindex fdump-rtl-vartrack
6913 Dump after variable tracking.
6915 @item -fdump-rtl-vregs
6916 @opindex fdump-rtl-vregs
6917 Dump after converting virtual registers to hard registers.
6919 @item -fdump-rtl-web
6920 @opindex fdump-rtl-web
6921 Dump after live range splitting.
6923 @item -fdump-rtl-regclass
6924 @itemx -fdump-rtl-subregs_of_mode_init
6925 @itemx -fdump-rtl-subregs_of_mode_finish
6926 @itemx -fdump-rtl-dfinit
6927 @itemx -fdump-rtl-dfinish
6928 @opindex fdump-rtl-regclass
6929 @opindex fdump-rtl-subregs_of_mode_init
6930 @opindex fdump-rtl-subregs_of_mode_finish
6931 @opindex fdump-rtl-dfinit
6932 @opindex fdump-rtl-dfinish
6933 These dumps are defined but always produce empty files.
6935 @item -da
6936 @itemx -fdump-rtl-all
6937 @opindex da
6938 @opindex fdump-rtl-all
6939 Produce all the dumps listed above.
6941 @item -dA
6942 @opindex dA
6943 Annotate the assembler output with miscellaneous debugging information.
6945 @item -dD
6946 @opindex dD
6947 Dump all macro definitions, at the end of preprocessing, in addition to
6948 normal output.
6950 @item -dH
6951 @opindex dH
6952 Produce a core dump whenever an error occurs.
6954 @item -dp
6955 @opindex dp
6956 Annotate the assembler output with a comment indicating which
6957 pattern and alternative is used.  The length of each instruction is
6958 also printed.
6960 @item -dP
6961 @opindex dP
6962 Dump the RTL in the assembler output as a comment before each instruction.
6963 Also turns on @option{-dp} annotation.
6965 @item -dx
6966 @opindex dx
6967 Just generate RTL for a function instead of compiling it.  Usually used
6968 with @option{-fdump-rtl-expand}.
6969 @end table
6971 @item -fdump-noaddr
6972 @opindex fdump-noaddr
6973 When doing debugging dumps, suppress address output.  This makes it more
6974 feasible to use diff on debugging dumps for compiler invocations with
6975 different compiler binaries and/or different
6976 text / bss / data / heap / stack / dso start locations.
6978 @item -freport-bug
6979 @opindex freport-bug
6980 Collect and dump debug information into temporary file if ICE in C/C++
6981 compiler occured.
6983 @item -fdump-unnumbered
6984 @opindex fdump-unnumbered
6985 When doing debugging dumps, suppress instruction numbers and address output.
6986 This makes it more feasible to use diff on debugging dumps for compiler
6987 invocations with different options, in particular with and without
6988 @option{-g}.
6990 @item -fdump-unnumbered-links
6991 @opindex fdump-unnumbered-links
6992 When doing debugging dumps (see @option{-d} option above), suppress
6993 instruction numbers for the links to the previous and next instructions
6994 in a sequence.
6996 @item -fdump-translation-unit @r{(C++ only)}
6997 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6998 @opindex fdump-translation-unit
6999 Dump a representation of the tree structure for the entire translation
7000 unit to a file.  The file name is made by appending @file{.tu} to the
7001 source file name, and the file is created in the same directory as the
7002 output file.  If the @samp{-@var{options}} form is used, @var{options}
7003 controls the details of the dump as described for the
7004 @option{-fdump-tree} options.
7006 @item -fdump-class-hierarchy @r{(C++ only)}
7007 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
7008 @opindex fdump-class-hierarchy
7009 Dump a representation of each class's hierarchy and virtual function
7010 table layout to a file.  The file name is made by appending
7011 @file{.class} to the source file name, and the file is created in the
7012 same directory as the output file.  If the @samp{-@var{options}} form
7013 is used, @var{options} controls the details of the dump as described
7014 for the @option{-fdump-tree} options.
7016 @item -fdump-ipa-@var{switch}
7017 @opindex fdump-ipa
7018 Control the dumping at various stages of inter-procedural analysis
7019 language tree to a file.  The file name is generated by appending a
7020 switch specific suffix to the source file name, and the file is created
7021 in the same directory as the output file.  The following dumps are
7022 possible:
7024 @table @samp
7025 @item all
7026 Enables all inter-procedural analysis dumps.
7028 @item cgraph
7029 Dumps information about call-graph optimization, unused function removal,
7030 and inlining decisions.
7032 @item inline
7033 Dump after function inlining.
7035 @end table
7037 @item -fdump-passes
7038 @opindex fdump-passes
7039 Dump the list of optimization passes that are turned on and off by
7040 the current command-line options.
7042 @item -fdump-statistics-@var{option}
7043 @opindex fdump-statistics
7044 Enable and control dumping of pass statistics in a separate file.  The
7045 file name is generated by appending a suffix ending in
7046 @samp{.statistics} to the source file name, and the file is created in
7047 the same directory as the output file.  If the @samp{-@var{option}}
7048 form is used, @samp{-stats} causes counters to be summed over the
7049 whole compilation unit while @samp{-details} dumps every event as
7050 the passes generate them.  The default with no option is to sum
7051 counters for each function compiled.
7053 @item -fdump-tree-@var{switch}
7054 @itemx -fdump-tree-@var{switch}-@var{options}
7055 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
7056 @opindex fdump-tree
7057 Control the dumping at various stages of processing the intermediate
7058 language tree to a file.  The file name is generated by appending a
7059 switch-specific suffix to the source file name, and the file is
7060 created in the same directory as the output file. In case of
7061 @option{=@var{filename}} option, the dump is output on the given file
7062 instead of the auto named dump files.  If the @samp{-@var{options}}
7063 form is used, @var{options} is a list of @samp{-} separated options
7064 which control the details of the dump.  Not all options are applicable
7065 to all dumps; those that are not meaningful are ignored.  The
7066 following options are available
7068 @table @samp
7069 @item address
7070 Print the address of each node.  Usually this is not meaningful as it
7071 changes according to the environment and source file.  Its primary use
7072 is for tying up a dump file with a debug environment.
7073 @item asmname
7074 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
7075 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
7076 use working backward from mangled names in the assembly file.
7077 @item slim
7078 When dumping front-end intermediate representations, inhibit dumping
7079 of members of a scope or body of a function merely because that scope
7080 has been reached.  Only dump such items when they are directly reachable
7081 by some other path.
7083 When dumping pretty-printed trees, this option inhibits dumping the
7084 bodies of control structures.
7086 When dumping RTL, print the RTL in slim (condensed) form instead of
7087 the default LISP-like representation.
7088 @item raw
7089 Print a raw representation of the tree.  By default, trees are
7090 pretty-printed into a C-like representation.
7091 @item details
7092 Enable more detailed dumps (not honored by every dump option). Also
7093 include information from the optimization passes.
7094 @item stats
7095 Enable dumping various statistics about the pass (not honored by every dump
7096 option).
7097 @item blocks
7098 Enable showing basic block boundaries (disabled in raw dumps).
7099 @item graph
7100 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
7101 dump a representation of the control flow graph suitable for viewing with
7102 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
7103 the file is pretty-printed as a subgraph, so that GraphViz can render them
7104 all in a single plot.
7106 This option currently only works for RTL dumps, and the RTL is always
7107 dumped in slim form.
7108 @item vops
7109 Enable showing virtual operands for every statement.
7110 @item lineno
7111 Enable showing line numbers for statements.
7112 @item uid
7113 Enable showing the unique ID (@code{DECL_UID}) for each variable.
7114 @item verbose
7115 Enable showing the tree dump for each statement.
7116 @item eh
7117 Enable showing the EH region number holding each statement.
7118 @item scev
7119 Enable showing scalar evolution analysis details.
7120 @item optimized
7121 Enable showing optimization information (only available in certain
7122 passes).
7123 @item missed
7124 Enable showing missed optimization information (only available in certain
7125 passes).
7126 @item note
7127 Enable other detailed optimization information (only available in
7128 certain passes).
7129 @item =@var{filename}
7130 Instead of an auto named dump file, output into the given file
7131 name. The file names @file{stdout} and @file{stderr} are treated
7132 specially and are considered already open standard streams. For
7133 example,
7135 @smallexample
7136 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
7137      -fdump-tree-pre=stderr file.c
7138 @end smallexample
7140 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
7141 output on to @file{stderr}. If two conflicting dump filenames are
7142 given for the same pass, then the latter option overrides the earlier
7143 one.
7145 @item all
7146 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
7147 and @option{lineno}.
7149 @item optall
7150 Turn on all optimization options, i.e., @option{optimized},
7151 @option{missed}, and @option{note}.
7152 @end table
7154 The following tree dumps are possible:
7155 @table @samp
7157 @item original
7158 @opindex fdump-tree-original
7159 Dump before any tree based optimization, to @file{@var{file}.original}.
7161 @item optimized
7162 @opindex fdump-tree-optimized
7163 Dump after all tree based optimization, to @file{@var{file}.optimized}.
7165 @item gimple
7166 @opindex fdump-tree-gimple
7167 Dump each function before and after the gimplification pass to a file.  The
7168 file name is made by appending @file{.gimple} to the source file name.
7170 @item cfg
7171 @opindex fdump-tree-cfg
7172 Dump the control flow graph of each function to a file.  The file name is
7173 made by appending @file{.cfg} to the source file name.
7175 @item ch
7176 @opindex fdump-tree-ch
7177 Dump each function after copying loop headers.  The file name is made by
7178 appending @file{.ch} to the source file name.
7180 @item ssa
7181 @opindex fdump-tree-ssa
7182 Dump SSA related information to a file.  The file name is made by appending
7183 @file{.ssa} to the source file name.
7185 @item alias
7186 @opindex fdump-tree-alias
7187 Dump aliasing information for each function.  The file name is made by
7188 appending @file{.alias} to the source file name.
7190 @item ccp
7191 @opindex fdump-tree-ccp
7192 Dump each function after CCP@.  The file name is made by appending
7193 @file{.ccp} to the source file name.
7195 @item storeccp
7196 @opindex fdump-tree-storeccp
7197 Dump each function after STORE-CCP@.  The file name is made by appending
7198 @file{.storeccp} to the source file name.
7200 @item pre
7201 @opindex fdump-tree-pre
7202 Dump trees after partial redundancy elimination.  The file name is made
7203 by appending @file{.pre} to the source file name.
7205 @item fre
7206 @opindex fdump-tree-fre
7207 Dump trees after full redundancy elimination.  The file name is made
7208 by appending @file{.fre} to the source file name.
7210 @item copyprop
7211 @opindex fdump-tree-copyprop
7212 Dump trees after copy propagation.  The file name is made
7213 by appending @file{.copyprop} to the source file name.
7215 @item store_copyprop
7216 @opindex fdump-tree-store_copyprop
7217 Dump trees after store copy-propagation.  The file name is made
7218 by appending @file{.store_copyprop} to the source file name.
7220 @item dce
7221 @opindex fdump-tree-dce
7222 Dump each function after dead code elimination.  The file name is made by
7223 appending @file{.dce} to the source file name.
7225 @item sra
7226 @opindex fdump-tree-sra
7227 Dump each function after performing scalar replacement of aggregates.  The
7228 file name is made by appending @file{.sra} to the source file name.
7230 @item sink
7231 @opindex fdump-tree-sink
7232 Dump each function after performing code sinking.  The file name is made
7233 by appending @file{.sink} to the source file name.
7235 @item dom
7236 @opindex fdump-tree-dom
7237 Dump each function after applying dominator tree optimizations.  The file
7238 name is made by appending @file{.dom} to the source file name.
7240 @item dse
7241 @opindex fdump-tree-dse
7242 Dump each function after applying dead store elimination.  The file
7243 name is made by appending @file{.dse} to the source file name.
7245 @item phiopt
7246 @opindex fdump-tree-phiopt
7247 Dump each function after optimizing PHI nodes into straightline code.  The file
7248 name is made by appending @file{.phiopt} to the source file name.
7250 @item backprop
7251 @opindex fdump-tree-backprop
7252 Dump each function after back-propagating use information up the definition
7253 chain.  The file name is made by appending @file{.backprop} to the
7254 source file name.
7256 @item forwprop
7257 @opindex fdump-tree-forwprop
7258 Dump each function after forward propagating single use variables.  The file
7259 name is made by appending @file{.forwprop} to the source file name.
7261 @item nrv
7262 @opindex fdump-tree-nrv
7263 Dump each function after applying the named return value optimization on
7264 generic trees.  The file name is made by appending @file{.nrv} to the source
7265 file name.
7267 @item vect
7268 @opindex fdump-tree-vect
7269 Dump each function after applying vectorization of loops.  The file name is
7270 made by appending @file{.vect} to the source file name.
7272 @item slp
7273 @opindex fdump-tree-slp
7274 Dump each function after applying vectorization of basic blocks.  The file name
7275 is made by appending @file{.slp} to the source file name.
7277 @item vrp
7278 @opindex fdump-tree-vrp
7279 Dump each function after Value Range Propagation (VRP).  The file name
7280 is made by appending @file{.vrp} to the source file name.
7282 @item oaccdevlow
7283 @opindex fdump-tree-oaccdevlow
7284 Dump each function after applying device-specific OpenACC transformations.
7285 The file name is made by appending @file{.oaccdevlow} to the source file name.
7287 @item all
7288 @opindex fdump-tree-all
7289 Enable all the available tree dumps with the flags provided in this option.
7290 @end table
7292 @item -fopt-info
7293 @itemx -fopt-info-@var{options}
7294 @itemx -fopt-info-@var{options}=@var{filename}
7295 @opindex fopt-info
7296 Controls optimization dumps from various optimization passes. If the
7297 @samp{-@var{options}} form is used, @var{options} is a list of
7298 @samp{-} separated option keywords to select the dump details and
7299 optimizations.  
7301 The @var{options} can be divided into two groups: options describing the
7302 verbosity of the dump, and options describing which optimizations
7303 should be included. The options from both the groups can be freely
7304 mixed as they are non-overlapping. However, in case of any conflicts,
7305 the later options override the earlier options on the command
7306 line. 
7308 The following options control the dump verbosity:
7310 @table @samp
7311 @item optimized
7312 Print information when an optimization is successfully applied. It is
7313 up to a pass to decide which information is relevant. For example, the
7314 vectorizer passes print the source location of loops which are
7315 successfully vectorized.
7316 @item missed
7317 Print information about missed optimizations. Individual passes
7318 control which information to include in the output. 
7319 @item note
7320 Print verbose information about optimizations, such as certain
7321 transformations, more detailed messages about decisions etc.
7322 @item all
7323 Print detailed optimization information. This includes
7324 @samp{optimized}, @samp{missed}, and @samp{note}.
7325 @end table
7327 One or more of the following option keywords can be used to describe a
7328 group of optimizations:
7330 @table @samp
7331 @item ipa
7332 Enable dumps from all interprocedural optimizations.
7333 @item loop
7334 Enable dumps from all loop optimizations.
7335 @item inline
7336 Enable dumps from all inlining optimizations.
7337 @item vec
7338 Enable dumps from all vectorization optimizations.
7339 @item optall
7340 Enable dumps from all optimizations. This is a superset of
7341 the optimization groups listed above.
7342 @end table
7344 If @var{options} is
7345 omitted, it defaults to @samp{optimized-optall}, which means to dump all
7346 info about successful optimizations from all the passes.  
7348 If the @var{filename} is provided, then the dumps from all the
7349 applicable optimizations are concatenated into the @var{filename}.
7350 Otherwise the dump is output onto @file{stderr}. Though multiple
7351 @option{-fopt-info} options are accepted, only one of them can include
7352 a @var{filename}. If other filenames are provided then all but the
7353 first such option are ignored.
7355 Note that the output @var{filename} is overwritten
7356 in case of multiple translation units. If a combined output from
7357 multiple translation units is desired, @file{stderr} should be used
7358 instead.
7360 In the following example, the optimization info is output to
7361 @file{stderr}:
7363 @smallexample
7364 gcc -O3 -fopt-info
7365 @end smallexample
7367 This example:
7368 @smallexample
7369 gcc -O3 -fopt-info-missed=missed.all
7370 @end smallexample
7372 @noindent
7373 outputs missed optimization report from all the passes into
7374 @file{missed.all}, and this one:
7376 @smallexample
7377 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
7378 @end smallexample
7380 @noindent
7381 prints information about missed optimization opportunities from
7382 vectorization passes on @file{stderr}.  
7383 Note that @option{-fopt-info-vec-missed} is equivalent to 
7384 @option{-fopt-info-missed-vec}.
7386 As another example,
7387 @smallexample
7388 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
7389 @end smallexample
7391 @noindent
7392 outputs information about missed optimizations as well as
7393 optimized locations from all the inlining passes into
7394 @file{inline.txt}.
7396 Finally, consider:
7398 @smallexample
7399 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
7400 @end smallexample
7402 @noindent
7403 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
7404 in conflict since only one output file is allowed. In this case, only
7405 the first option takes effect and the subsequent options are
7406 ignored. Thus only @file{vec.miss} is produced which contains
7407 dumps from the vectorizer about missed opportunities.
7409 @item -frandom-seed=@var{number}
7410 @opindex frandom-seed
7411 This option provides a seed that GCC uses in place of
7412 random numbers in generating certain symbol names
7413 that have to be different in every compiled file.  It is also used to
7414 place unique stamps in coverage data files and the object files that
7415 produce them.  You can use the @option{-frandom-seed} option to produce
7416 reproducibly identical object files.
7418 The @var{number} should be different for every file you compile.
7420 @item -fsched-verbose=@var{n}
7421 @opindex fsched-verbose
7422 On targets that use instruction scheduling, this option controls the
7423 amount of debugging output the scheduler prints.  This information is
7424 written to standard error, unless @option{-fdump-rtl-sched1} or
7425 @option{-fdump-rtl-sched2} is specified, in which case it is output
7426 to the usual dump listing file, @file{.sched1} or @file{.sched2}
7427 respectively.  However for @var{n} greater than nine, the output is
7428 always printed to standard error.
7430 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
7431 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
7432 For @var{n} greater than one, it also output basic block probabilities,
7433 detailed ready list information and unit/insn info.  For @var{n} greater
7434 than two, it includes RTL at abort point, control-flow and regions info.
7435 And for @var{n} over four, @option{-fsched-verbose} also includes
7436 dependence info.
7438 @item -save-temps
7439 @itemx -save-temps=cwd
7440 @opindex save-temps
7441 Store the usual ``temporary'' intermediate files permanently; place them
7442 in the current directory and name them based on the source file.  Thus,
7443 compiling @file{foo.c} with @option{-c -save-temps} produces files
7444 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
7445 preprocessed @file{foo.i} output file even though the compiler now
7446 normally uses an integrated preprocessor.
7448 When used in combination with the @option{-x} command-line option,
7449 @option{-save-temps} is sensible enough to avoid over writing an
7450 input source file with the same extension as an intermediate file.
7451 The corresponding intermediate file may be obtained by renaming the
7452 source file before using @option{-save-temps}.
7454 If you invoke GCC in parallel, compiling several different source
7455 files that share a common base name in different subdirectories or the
7456 same source file compiled for multiple output destinations, it is
7457 likely that the different parallel compilers will interfere with each
7458 other, and overwrite the temporary files.  For instance:
7460 @smallexample
7461 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
7462 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
7463 @end smallexample
7465 may result in @file{foo.i} and @file{foo.o} being written to
7466 simultaneously by both compilers.
7468 @item -save-temps=obj
7469 @opindex save-temps=obj
7470 Store the usual ``temporary'' intermediate files permanently.  If the
7471 @option{-o} option is used, the temporary files are based on the
7472 object file.  If the @option{-o} option is not used, the
7473 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
7475 For example:
7477 @smallexample
7478 gcc -save-temps=obj -c foo.c
7479 gcc -save-temps=obj -c bar.c -o dir/xbar.o
7480 gcc -save-temps=obj foobar.c -o dir2/yfoobar
7481 @end smallexample
7483 @noindent
7484 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
7485 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
7486 @file{dir2/yfoobar.o}.
7488 @item -time@r{[}=@var{file}@r{]}
7489 @opindex time
7490 Report the CPU time taken by each subprocess in the compilation
7491 sequence.  For C source files, this is the compiler proper and assembler
7492 (plus the linker if linking is done).
7494 Without the specification of an output file, the output looks like this:
7496 @smallexample
7497 # cc1 0.12 0.01
7498 # as 0.00 0.01
7499 @end smallexample
7501 The first number on each line is the ``user time'', that is time spent
7502 executing the program itself.  The second number is ``system time'',
7503 time spent executing operating system routines on behalf of the program.
7504 Both numbers are in seconds.
7506 With the specification of an output file, the output is appended to the
7507 named file, and it looks like this:
7509 @smallexample
7510 0.12 0.01 cc1 @var{options}
7511 0.00 0.01 as @var{options}
7512 @end smallexample
7514 The ``user time'' and the ``system time'' are moved before the program
7515 name, and the options passed to the program are displayed, so that one
7516 can later tell what file was being compiled, and with which options.
7518 @item -fvar-tracking
7519 @opindex fvar-tracking
7520 Run variable tracking pass.  It computes where variables are stored at each
7521 position in code.  Better debugging information is then generated
7522 (if the debugging information format supports this information).
7524 It is enabled by default when compiling with optimization (@option{-Os},
7525 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7526 the debug info format supports it.
7528 @item -fvar-tracking-assignments
7529 @opindex fvar-tracking-assignments
7530 @opindex fno-var-tracking-assignments
7531 Annotate assignments to user variables early in the compilation and
7532 attempt to carry the annotations over throughout the compilation all the
7533 way to the end, in an attempt to improve debug information while
7534 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7536 It can be enabled even if var-tracking is disabled, in which case
7537 annotations are created and maintained, but discarded at the end.
7538 By default, this flag is enabled together with @option{-fvar-tracking},
7539 except when selective scheduling is enabled.
7541 @item -fvar-tracking-assignments-toggle
7542 @opindex fvar-tracking-assignments-toggle
7543 @opindex fno-var-tracking-assignments-toggle
7544 Toggle @option{-fvar-tracking-assignments}, in the same way that
7545 @option{-gtoggle} toggles @option{-g}.
7547 @item -print-file-name=@var{library}
7548 @opindex print-file-name
7549 Print the full absolute name of the library file @var{library} that
7550 would be used when linking---and don't do anything else.  With this
7551 option, GCC does not compile or link anything; it just prints the
7552 file name.
7554 @item -print-multi-directory
7555 @opindex print-multi-directory
7556 Print the directory name corresponding to the multilib selected by any
7557 other switches present in the command line.  This directory is supposed
7558 to exist in @env{GCC_EXEC_PREFIX}.
7560 @item -print-multi-lib
7561 @opindex print-multi-lib
7562 Print the mapping from multilib directory names to compiler switches
7563 that enable them.  The directory name is separated from the switches by
7564 @samp{;}, and each switch starts with an @samp{@@} instead of the
7565 @samp{-}, without spaces between multiple switches.  This is supposed to
7566 ease shell processing.
7568 @item -print-multi-os-directory
7569 @opindex print-multi-os-directory
7570 Print the path to OS libraries for the selected
7571 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7572 present in the @file{lib} subdirectory and no multilibs are used, this is
7573 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7574 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7575 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7576 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7578 @item -print-multiarch
7579 @opindex print-multiarch
7580 Print the path to OS libraries for the selected multiarch,
7581 relative to some @file{lib} subdirectory.
7583 @item -print-prog-name=@var{program}
7584 @opindex print-prog-name
7585 Like @option{-print-file-name}, but searches for a program such as @command{cpp}.
7587 @item -print-libgcc-file-name
7588 @opindex print-libgcc-file-name
7589 Same as @option{-print-file-name=libgcc.a}.
7591 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7592 but you do want to link with @file{libgcc.a}.  You can do:
7594 @smallexample
7595 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7596 @end smallexample
7598 @item -print-search-dirs
7599 @opindex print-search-dirs
7600 Print the name of the configured installation directory and a list of
7601 program and library directories @command{gcc} searches---and don't do anything else.
7603 This is useful when @command{gcc} prints the error message
7604 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7605 To resolve this you either need to put @file{cpp0} and the other compiler
7606 components where @command{gcc} expects to find them, or you can set the environment
7607 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7608 Don't forget the trailing @samp{/}.
7609 @xref{Environment Variables}.
7611 @item -print-sysroot
7612 @opindex print-sysroot
7613 Print the target sysroot directory that is used during
7614 compilation.  This is the target sysroot specified either at configure
7615 time or using the @option{--sysroot} option, possibly with an extra
7616 suffix that depends on compilation options.  If no target sysroot is
7617 specified, the option prints nothing.
7619 @item -print-sysroot-headers-suffix
7620 @opindex print-sysroot-headers-suffix
7621 Print the suffix added to the target sysroot when searching for
7622 headers, or give an error if the compiler is not configured with such
7623 a suffix---and don't do anything else.
7625 @item -dumpmachine
7626 @opindex dumpmachine
7627 Print the compiler's target machine (for example,
7628 @samp{i686-pc-linux-gnu})---and don't do anything else.
7630 @item -dumpversion
7631 @opindex dumpversion
7632 Print the compiler version (for example, @code{3.0})---and don't do
7633 anything else.
7635 @item -dumpspecs
7636 @opindex dumpspecs
7637 Print the compiler's built-in specs---and don't do anything else.  (This
7638 is used when GCC itself is being built.)  @xref{Spec Files}.
7640 @item -fno-eliminate-unused-debug-types
7641 @opindex feliminate-unused-debug-types
7642 @opindex fno-eliminate-unused-debug-types
7643 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7644 output for types that are nowhere used in the source file being compiled.
7645 Sometimes it is useful to have GCC emit debugging
7646 information for all types declared in a compilation
7647 unit, regardless of whether or not they are actually used
7648 in that compilation unit, for example 
7649 if, in the debugger, you want to cast a value to a type that is
7650 not actually used in your program (but is declared).  More often,
7651 however, this results in a significant amount of wasted space.
7652 @end table
7654 @node Optimize Options
7655 @section Options That Control Optimization
7656 @cindex optimize options
7657 @cindex options, optimization
7659 These options control various sorts of optimizations.
7661 Without any optimization option, the compiler's goal is to reduce the
7662 cost of compilation and to make debugging produce the expected
7663 results.  Statements are independent: if you stop the program with a
7664 breakpoint between statements, you can then assign a new value to any
7665 variable or change the program counter to any other statement in the
7666 function and get exactly the results you expect from the source
7667 code.
7669 Turning on optimization flags makes the compiler attempt to improve
7670 the performance and/or code size at the expense of compilation time
7671 and possibly the ability to debug the program.
7673 The compiler performs optimization based on the knowledge it has of the
7674 program.  Compiling multiple files at once to a single output file mode allows
7675 the compiler to use information gained from all of the files when compiling
7676 each of them.
7678 Not all optimizations are controlled directly by a flag.  Only
7679 optimizations that have a flag are listed in this section.
7681 Most optimizations are only enabled if an @option{-O} level is set on
7682 the command line.  Otherwise they are disabled, even if individual
7683 optimization flags are specified.
7685 Depending on the target and how GCC was configured, a slightly different
7686 set of optimizations may be enabled at each @option{-O} level than
7687 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7688 to find out the exact set of optimizations that are enabled at each level.
7689 @xref{Overall Options}, for examples.
7691 @table @gcctabopt
7692 @item -O
7693 @itemx -O1
7694 @opindex O
7695 @opindex O1
7696 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7697 more memory for a large function.
7699 With @option{-O}, the compiler tries to reduce code size and execution
7700 time, without performing any optimizations that take a great deal of
7701 compilation time.
7703 @option{-O} turns on the following optimization flags:
7704 @gccoptlist{
7705 -fauto-inc-dec @gol
7706 -fbranch-count-reg @gol
7707 -fcombine-stack-adjustments @gol
7708 -fcompare-elim @gol
7709 -fcprop-registers @gol
7710 -fdce @gol
7711 -fdefer-pop @gol
7712 -fdelayed-branch @gol
7713 -fdse @gol
7714 -fforward-propagate @gol
7715 -fguess-branch-probability @gol
7716 -fif-conversion2 @gol
7717 -fif-conversion @gol
7718 -finline-functions-called-once @gol
7719 -fipa-pure-const @gol
7720 -fipa-profile @gol
7721 -fipa-reference @gol
7722 -fmerge-constants @gol
7723 -fmove-loop-invariants @gol
7724 -freorder-blocks @gol
7725 -fshrink-wrap @gol
7726 -fsplit-wide-types @gol
7727 -fssa-backprop @gol
7728 -fssa-phiopt @gol
7729 -ftree-bit-ccp @gol
7730 -ftree-ccp @gol
7731 -ftree-ch @gol
7732 -ftree-coalesce-vars @gol
7733 -ftree-copy-prop @gol
7734 -ftree-dce @gol
7735 -ftree-dominator-opts @gol
7736 -ftree-dse @gol
7737 -ftree-forwprop @gol
7738 -ftree-fre @gol
7739 -ftree-phiprop @gol
7740 -ftree-sink @gol
7741 -ftree-slsr @gol
7742 -ftree-sra @gol
7743 -ftree-pta @gol
7744 -ftree-ter @gol
7745 -funit-at-a-time}
7747 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7748 where doing so does not interfere with debugging.
7750 @item -O2
7751 @opindex O2
7752 Optimize even more.  GCC performs nearly all supported optimizations
7753 that do not involve a space-speed tradeoff.
7754 As compared to @option{-O}, this option increases both compilation time
7755 and the performance of the generated code.
7757 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7758 also turns on the following optimization flags:
7759 @gccoptlist{-fthread-jumps @gol
7760 -falign-functions  -falign-jumps @gol
7761 -falign-loops  -falign-labels @gol
7762 -fcaller-saves @gol
7763 -fcrossjumping @gol
7764 -fcse-follow-jumps  -fcse-skip-blocks @gol
7765 -fdelete-null-pointer-checks @gol
7766 -fdevirtualize -fdevirtualize-speculatively @gol
7767 -fexpensive-optimizations @gol
7768 -fgcse  -fgcse-lm  @gol
7769 -fhoist-adjacent-loads @gol
7770 -finline-small-functions @gol
7771 -findirect-inlining @gol
7772 -fipa-cp @gol
7773 -fipa-cp-alignment @gol
7774 -fipa-sra @gol
7775 -fipa-icf @gol
7776 -fisolate-erroneous-paths-dereference @gol
7777 -flra-remat @gol
7778 -foptimize-sibling-calls @gol
7779 -foptimize-strlen @gol
7780 -fpartial-inlining @gol
7781 -fpeephole2 @gol
7782 -freorder-blocks-algorithm=stc @gol
7783 -freorder-blocks-and-partition -freorder-functions @gol
7784 -frerun-cse-after-loop  @gol
7785 -fsched-interblock  -fsched-spec @gol
7786 -fschedule-insns  -fschedule-insns2 @gol
7787 -fstrict-aliasing -fstrict-overflow @gol
7788 -ftree-builtin-call-dce @gol
7789 -ftree-switch-conversion -ftree-tail-merge @gol
7790 -ftree-pre @gol
7791 -ftree-vrp @gol
7792 -fipa-ra}
7794 Please note the warning under @option{-fgcse} about
7795 invoking @option{-O2} on programs that use computed gotos.
7797 @item -O3
7798 @opindex O3
7799 Optimize yet more.  @option{-O3} turns on all optimizations specified
7800 by @option{-O2} and also turns on the @option{-finline-functions},
7801 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7802 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7803 @option{-ftree-loop-distribute-patterns},
7804 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7805 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7807 @item -O0
7808 @opindex O0
7809 Reduce compilation time and make debugging produce the expected
7810 results.  This is the default.
7812 @item -Os
7813 @opindex Os
7814 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7815 do not typically increase code size.  It also performs further
7816 optimizations designed to reduce code size.
7818 @option{-Os} disables the following optimization flags:
7819 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7820 -falign-labels  -freorder-blocks  -freorder-blocks-algorithm=stc @gol
7821 -freorder-blocks-and-partition  -fprefetch-loop-arrays}
7823 @item -Ofast
7824 @opindex Ofast
7825 Disregard strict standards compliance.  @option{-Ofast} enables all
7826 @option{-O3} optimizations.  It also enables optimizations that are not
7827 valid for all standard-compliant programs.
7828 It turns on @option{-ffast-math} and the Fortran-specific
7829 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7831 @item -Og
7832 @opindex Og
7833 Optimize debugging experience.  @option{-Og} enables optimizations
7834 that do not interfere with debugging. It should be the optimization
7835 level of choice for the standard edit-compile-debug cycle, offering
7836 a reasonable level of optimization while maintaining fast compilation
7837 and a good debugging experience.
7839 If you use multiple @option{-O} options, with or without level numbers,
7840 the last such option is the one that is effective.
7841 @end table
7843 Options of the form @option{-f@var{flag}} specify machine-independent
7844 flags.  Most flags have both positive and negative forms; the negative
7845 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7846 below, only one of the forms is listed---the one you typically 
7847 use.  You can figure out the other form by either removing @samp{no-}
7848 or adding it.
7850 The following options control specific optimizations.  They are either
7851 activated by @option{-O} options or are related to ones that are.  You
7852 can use the following flags in the rare cases when ``fine-tuning'' of
7853 optimizations to be performed is desired.
7855 @table @gcctabopt
7856 @item -fno-defer-pop
7857 @opindex fno-defer-pop
7858 Always pop the arguments to each function call as soon as that function
7859 returns.  For machines that must pop arguments after a function call,
7860 the compiler normally lets arguments accumulate on the stack for several
7861 function calls and pops them all at once.
7863 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7865 @item -fforward-propagate
7866 @opindex fforward-propagate
7867 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7868 instructions and checks if the result can be simplified.  If loop unrolling
7869 is active, two passes are performed and the second is scheduled after
7870 loop unrolling.
7872 This option is enabled by default at optimization levels @option{-O},
7873 @option{-O2}, @option{-O3}, @option{-Os}.
7875 @item -ffp-contract=@var{style}
7876 @opindex ffp-contract
7877 @option{-ffp-contract=off} disables floating-point expression contraction.
7878 @option{-ffp-contract=fast} enables floating-point expression contraction
7879 such as forming of fused multiply-add operations if the target has
7880 native support for them.
7881 @option{-ffp-contract=on} enables floating-point expression contraction
7882 if allowed by the language standard.  This is currently not implemented
7883 and treated equal to @option{-ffp-contract=off}.
7885 The default is @option{-ffp-contract=fast}.
7887 @item -fomit-frame-pointer
7888 @opindex fomit-frame-pointer
7889 Don't keep the frame pointer in a register for functions that
7890 don't need one.  This avoids the instructions to save, set up and
7891 restore frame pointers; it also makes an extra register available
7892 in many functions.  @strong{It also makes debugging impossible on
7893 some machines.}
7895 On some machines, such as the VAX, this flag has no effect, because
7896 the standard calling sequence automatically handles the frame pointer
7897 and nothing is saved by pretending it doesn't exist.  The
7898 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7899 whether a target machine supports this flag.  @xref{Registers,,Register
7900 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7902 The default setting (when not optimizing for
7903 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets is
7904 @option{-fomit-frame-pointer}.  You can configure GCC with the
7905 @option{--enable-frame-pointer} configure option to change the default.
7907 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7909 @item -foptimize-sibling-calls
7910 @opindex foptimize-sibling-calls
7911 Optimize sibling and tail recursive calls.
7913 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7915 @item -foptimize-strlen
7916 @opindex foptimize-strlen
7917 Optimize various standard C string functions (e.g. @code{strlen},
7918 @code{strchr} or @code{strcpy}) and
7919 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7921 Enabled at levels @option{-O2}, @option{-O3}.
7923 @item -fno-inline
7924 @opindex fno-inline
7925 Do not expand any functions inline apart from those marked with
7926 the @code{always_inline} attribute.  This is the default when not
7927 optimizing.
7929 Single functions can be exempted from inlining by marking them
7930 with the @code{noinline} attribute.
7932 @item -finline-small-functions
7933 @opindex finline-small-functions
7934 Integrate functions into their callers when their body is smaller than expected
7935 function call code (so overall size of program gets smaller).  The compiler
7936 heuristically decides which functions are simple enough to be worth integrating
7937 in this way.  This inlining applies to all functions, even those not declared
7938 inline.
7940 Enabled at level @option{-O2}.
7942 @item -findirect-inlining
7943 @opindex findirect-inlining
7944 Inline also indirect calls that are discovered to be known at compile
7945 time thanks to previous inlining.  This option has any effect only
7946 when inlining itself is turned on by the @option{-finline-functions}
7947 or @option{-finline-small-functions} options.
7949 Enabled at level @option{-O2}.
7951 @item -finline-functions
7952 @opindex finline-functions
7953 Consider all functions for inlining, even if they are not declared inline.
7954 The compiler heuristically decides which functions are worth integrating
7955 in this way.
7957 If all calls to a given function are integrated, and the function is
7958 declared @code{static}, then the function is normally not output as
7959 assembler code in its own right.
7961 Enabled at level @option{-O3}.
7963 @item -finline-functions-called-once
7964 @opindex finline-functions-called-once
7965 Consider all @code{static} functions called once for inlining into their
7966 caller even if they are not marked @code{inline}.  If a call to a given
7967 function is integrated, then the function is not output as assembler code
7968 in its own right.
7970 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7972 @item -fearly-inlining
7973 @opindex fearly-inlining
7974 Inline functions marked by @code{always_inline} and functions whose body seems
7975 smaller than the function call overhead early before doing
7976 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7977 makes profiling significantly cheaper and usually inlining faster on programs
7978 having large chains of nested wrapper functions.
7980 Enabled by default.
7982 @item -fipa-sra
7983 @opindex fipa-sra
7984 Perform interprocedural scalar replacement of aggregates, removal of
7985 unused parameters and replacement of parameters passed by reference
7986 by parameters passed by value.
7988 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7990 @item -finline-limit=@var{n}
7991 @opindex finline-limit
7992 By default, GCC limits the size of functions that can be inlined.  This flag
7993 allows coarse control of this limit.  @var{n} is the size of functions that
7994 can be inlined in number of pseudo instructions.
7996 Inlining is actually controlled by a number of parameters, which may be
7997 specified individually by using @option{--param @var{name}=@var{value}}.
7998 The @option{-finline-limit=@var{n}} option sets some of these parameters
7999 as follows:
8001 @table @gcctabopt
8002 @item max-inline-insns-single
8003 is set to @var{n}/2.
8004 @item max-inline-insns-auto
8005 is set to @var{n}/2.
8006 @end table
8008 See below for a documentation of the individual
8009 parameters controlling inlining and for the defaults of these parameters.
8011 @emph{Note:} there may be no value to @option{-finline-limit} that results
8012 in default behavior.
8014 @emph{Note:} pseudo instruction represents, in this particular context, an
8015 abstract measurement of function's size.  In no way does it represent a count
8016 of assembly instructions and as such its exact meaning might change from one
8017 release to an another.
8019 @item -fno-keep-inline-dllexport
8020 @opindex fno-keep-inline-dllexport
8021 This is a more fine-grained version of @option{-fkeep-inline-functions},
8022 which applies only to functions that are declared using the @code{dllexport}
8023 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
8024 Functions}.)
8026 @item -fkeep-inline-functions
8027 @opindex fkeep-inline-functions
8028 In C, emit @code{static} functions that are declared @code{inline}
8029 into the object file, even if the function has been inlined into all
8030 of its callers.  This switch does not affect functions using the
8031 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
8032 inline functions into the object file.
8034 @item -fkeep-static-functions
8035 @opindex fkeep-static-functions
8036 Emit @code{static} functions into the object file, even if the function
8037 is never used.
8039 @item -fkeep-static-consts
8040 @opindex fkeep-static-consts
8041 Emit variables declared @code{static const} when optimization isn't turned
8042 on, even if the variables aren't referenced.
8044 GCC enables this option by default.  If you want to force the compiler to
8045 check if a variable is referenced, regardless of whether or not
8046 optimization is turned on, use the @option{-fno-keep-static-consts} option.
8048 @item -fmerge-constants
8049 @opindex fmerge-constants
8050 Attempt to merge identical constants (string constants and floating-point
8051 constants) across compilation units.
8053 This option is the default for optimized compilation if the assembler and
8054 linker support it.  Use @option{-fno-merge-constants} to inhibit this
8055 behavior.
8057 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8059 @item -fmerge-all-constants
8060 @opindex fmerge-all-constants
8061 Attempt to merge identical constants and identical variables.
8063 This option implies @option{-fmerge-constants}.  In addition to
8064 @option{-fmerge-constants} this considers e.g.@: even constant initialized
8065 arrays or initialized constant variables with integral or floating-point
8066 types.  Languages like C or C++ require each variable, including multiple
8067 instances of the same variable in recursive calls, to have distinct locations,
8068 so using this option results in non-conforming
8069 behavior.
8071 @item -fmodulo-sched
8072 @opindex fmodulo-sched
8073 Perform swing modulo scheduling immediately before the first scheduling
8074 pass.  This pass looks at innermost loops and reorders their
8075 instructions by overlapping different iterations.
8077 @item -fmodulo-sched-allow-regmoves
8078 @opindex fmodulo-sched-allow-regmoves
8079 Perform more aggressive SMS-based modulo scheduling with register moves
8080 allowed.  By setting this flag certain anti-dependences edges are
8081 deleted, which triggers the generation of reg-moves based on the
8082 life-range analysis.  This option is effective only with
8083 @option{-fmodulo-sched} enabled.
8085 @item -fno-branch-count-reg
8086 @opindex fno-branch-count-reg
8087 Do not use ``decrement and branch'' instructions on a count register,
8088 but instead generate a sequence of instructions that decrement a
8089 register, compare it against zero, then branch based upon the result.
8090 This option is only meaningful on architectures that support such
8091 instructions, which include x86, PowerPC, IA-64 and S/390.
8093 Enabled by default at @option{-O1} and higher.
8095 The default is @option{-fbranch-count-reg}.
8097 @item -fno-function-cse
8098 @opindex fno-function-cse
8099 Do not put function addresses in registers; make each instruction that
8100 calls a constant function contain the function's address explicitly.
8102 This option results in less efficient code, but some strange hacks
8103 that alter the assembler output may be confused by the optimizations
8104 performed when this option is not used.
8106 The default is @option{-ffunction-cse}
8108 @item -fno-zero-initialized-in-bss
8109 @opindex fno-zero-initialized-in-bss
8110 If the target supports a BSS section, GCC by default puts variables that
8111 are initialized to zero into BSS@.  This can save space in the resulting
8112 code.
8114 This option turns off this behavior because some programs explicitly
8115 rely on variables going to the data section---e.g., so that the
8116 resulting executable can find the beginning of that section and/or make
8117 assumptions based on that.
8119 The default is @option{-fzero-initialized-in-bss}.
8121 @item -fthread-jumps
8122 @opindex fthread-jumps
8123 Perform optimizations that check to see if a jump branches to a
8124 location where another comparison subsumed by the first is found.  If
8125 so, the first branch is redirected to either the destination of the
8126 second branch or a point immediately following it, depending on whether
8127 the condition is known to be true or false.
8129 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8131 @item -fsplit-wide-types
8132 @opindex fsplit-wide-types
8133 When using a type that occupies multiple registers, such as @code{long
8134 long} on a 32-bit system, split the registers apart and allocate them
8135 independently.  This normally generates better code for those types,
8136 but may make debugging more difficult.
8138 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
8139 @option{-Os}.
8141 @item -fcse-follow-jumps
8142 @opindex fcse-follow-jumps
8143 In common subexpression elimination (CSE), scan through jump instructions
8144 when the target of the jump is not reached by any other path.  For
8145 example, when CSE encounters an @code{if} statement with an
8146 @code{else} clause, CSE follows the jump when the condition
8147 tested is false.
8149 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8151 @item -fcse-skip-blocks
8152 @opindex fcse-skip-blocks
8153 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
8154 follow jumps that conditionally skip over blocks.  When CSE
8155 encounters a simple @code{if} statement with no else clause,
8156 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
8157 body of the @code{if}.
8159 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8161 @item -frerun-cse-after-loop
8162 @opindex frerun-cse-after-loop
8163 Re-run common subexpression elimination after loop optimizations are
8164 performed.
8166 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8168 @item -fgcse
8169 @opindex fgcse
8170 Perform a global common subexpression elimination pass.
8171 This pass also performs global constant and copy propagation.
8173 @emph{Note:} When compiling a program using computed gotos, a GCC
8174 extension, you may get better run-time performance if you disable
8175 the global common subexpression elimination pass by adding
8176 @option{-fno-gcse} to the command line.
8178 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8180 @item -fgcse-lm
8181 @opindex fgcse-lm
8182 When @option{-fgcse-lm} is enabled, global common subexpression elimination
8183 attempts to move loads that are only killed by stores into themselves.  This
8184 allows a loop containing a load/store sequence to be changed to a load outside
8185 the loop, and a copy/store within the loop.
8187 Enabled by default when @option{-fgcse} is enabled.
8189 @item -fgcse-sm
8190 @opindex fgcse-sm
8191 When @option{-fgcse-sm} is enabled, a store motion pass is run after
8192 global common subexpression elimination.  This pass attempts to move
8193 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
8194 loops containing a load/store sequence can be changed to a load before
8195 the loop and a store after the loop.
8197 Not enabled at any optimization level.
8199 @item -fgcse-las
8200 @opindex fgcse-las
8201 When @option{-fgcse-las} is enabled, the global common subexpression
8202 elimination pass eliminates redundant loads that come after stores to the
8203 same memory location (both partial and full redundancies).
8205 Not enabled at any optimization level.
8207 @item -fgcse-after-reload
8208 @opindex fgcse-after-reload
8209 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
8210 pass is performed after reload.  The purpose of this pass is to clean up
8211 redundant spilling.
8213 @item -faggressive-loop-optimizations
8214 @opindex faggressive-loop-optimizations
8215 This option tells the loop optimizer to use language constraints to
8216 derive bounds for the number of iterations of a loop.  This assumes that
8217 loop code does not invoke undefined behavior by for example causing signed
8218 integer overflows or out-of-bound array accesses.  The bounds for the
8219 number of iterations of a loop are used to guide loop unrolling and peeling
8220 and loop exit test optimizations.
8221 This option is enabled by default.
8223 @item -funsafe-loop-optimizations
8224 @opindex funsafe-loop-optimizations
8225 This option tells the loop optimizer to assume that loop indices do not
8226 overflow, and that loops with nontrivial exit condition are not
8227 infinite.  This enables a wider range of loop optimizations even if
8228 the loop optimizer itself cannot prove that these assumptions are valid.
8229 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
8230 if it finds this kind of loop.
8232 @item -fcrossjumping
8233 @opindex fcrossjumping
8234 Perform cross-jumping transformation.
8235 This transformation unifies equivalent code and saves code size.  The
8236 resulting code may or may not perform better than without cross-jumping.
8238 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8240 @item -fauto-inc-dec
8241 @opindex fauto-inc-dec
8242 Combine increments or decrements of addresses with memory accesses.
8243 This pass is always skipped on architectures that do not have
8244 instructions to support this.  Enabled by default at @option{-O} and
8245 higher on architectures that support this.
8247 @item -fdce
8248 @opindex fdce
8249 Perform dead code elimination (DCE) on RTL@.
8250 Enabled by default at @option{-O} and higher.
8252 @item -fdse
8253 @opindex fdse
8254 Perform dead store elimination (DSE) on RTL@.
8255 Enabled by default at @option{-O} and higher.
8257 @item -fif-conversion
8258 @opindex fif-conversion
8259 Attempt to transform conditional jumps into branch-less equivalents.  This
8260 includes use of conditional moves, min, max, set flags and abs instructions, and
8261 some tricks doable by standard arithmetics.  The use of conditional execution
8262 on chips where it is available is controlled by @option{-fif-conversion2}.
8264 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8266 @item -fif-conversion2
8267 @opindex fif-conversion2
8268 Use conditional execution (where available) to transform conditional jumps into
8269 branch-less equivalents.
8271 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8273 @item -fdeclone-ctor-dtor
8274 @opindex fdeclone-ctor-dtor
8275 The C++ ABI requires multiple entry points for constructors and
8276 destructors: one for a base subobject, one for a complete object, and
8277 one for a virtual destructor that calls operator delete afterwards.
8278 For a hierarchy with virtual bases, the base and complete variants are
8279 clones, which means two copies of the function.  With this option, the
8280 base and complete variants are changed to be thunks that call a common
8281 implementation.
8283 Enabled by @option{-Os}.
8285 @item -fdelete-null-pointer-checks
8286 @opindex fdelete-null-pointer-checks
8287 Assume that programs cannot safely dereference null pointers, and that
8288 no code or data element resides at address zero.
8289 This option enables simple constant
8290 folding optimizations at all optimization levels.  In addition, other
8291 optimization passes in GCC use this flag to control global dataflow
8292 analyses that eliminate useless checks for null pointers; these assume
8293 that a memory access to address zero always results in a trap, so
8294 that if a pointer is checked after it has already been dereferenced,
8295 it cannot be null.
8297 Note however that in some environments this assumption is not true.
8298 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
8299 for programs that depend on that behavior.
8301 This option is enabled by default on most targets.  On Nios II ELF, it
8302 defaults to off.  On AVR and CR16, this option is completely disabled.  
8304 Passes that use the dataflow information
8305 are enabled independently at different optimization levels.
8307 @item -fdevirtualize
8308 @opindex fdevirtualize
8309 Attempt to convert calls to virtual functions to direct calls.  This
8310 is done both within a procedure and interprocedurally as part of
8311 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
8312 propagation (@option{-fipa-cp}).
8313 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8315 @item -fdevirtualize-speculatively
8316 @opindex fdevirtualize-speculatively
8317 Attempt to convert calls to virtual functions to speculative direct calls.
8318 Based on the analysis of the type inheritance graph, determine for a given call
8319 the set of likely targets. If the set is small, preferably of size 1, change
8320 the call into a conditional deciding between direct and indirect calls.  The
8321 speculative calls enable more optimizations, such as inlining.  When they seem
8322 useless after further optimization, they are converted back into original form.
8324 @item -fdevirtualize-at-ltrans
8325 @opindex fdevirtualize-at-ltrans
8326 Stream extra information needed for aggressive devirtualization when running
8327 the link-time optimizer in local transformation mode.  
8328 This option enables more devirtualization but
8329 significantly increases the size of streamed data. For this reason it is
8330 disabled by default.
8332 @item -fexpensive-optimizations
8333 @opindex fexpensive-optimizations
8334 Perform a number of minor optimizations that are relatively expensive.
8336 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8338 @item -free
8339 @opindex free
8340 Attempt to remove redundant extension instructions.  This is especially
8341 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
8342 registers after writing to their lower 32-bit half.
8344 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
8345 @option{-O3}, @option{-Os}.
8347 @item -fno-lifetime-dse
8348 @opindex fno-lifetime-dse
8349 In C++ the value of an object is only affected by changes within its
8350 lifetime: when the constructor begins, the object has an indeterminate
8351 value, and any changes during the lifetime of the object are dead when
8352 the object is destroyed.  Normally dead store elimination will take
8353 advantage of this; if your code relies on the value of the object
8354 storage persisting beyond the lifetime of the object, you can use this
8355 flag to disable this optimization.
8357 @item -flive-range-shrinkage
8358 @opindex flive-range-shrinkage
8359 Attempt to decrease register pressure through register live range
8360 shrinkage.  This is helpful for fast processors with small or moderate
8361 size register sets.
8363 @item -fira-algorithm=@var{algorithm}
8364 @opindex fira-algorithm
8365 Use the specified coloring algorithm for the integrated register
8366 allocator.  The @var{algorithm} argument can be @samp{priority}, which
8367 specifies Chow's priority coloring, or @samp{CB}, which specifies
8368 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
8369 for all architectures, but for those targets that do support it, it is
8370 the default because it generates better code.
8372 @item -fira-region=@var{region}
8373 @opindex fira-region
8374 Use specified regions for the integrated register allocator.  The
8375 @var{region} argument should be one of the following:
8377 @table @samp
8379 @item all
8380 Use all loops as register allocation regions.
8381 This can give the best results for machines with a small and/or
8382 irregular register set.
8384 @item mixed
8385 Use all loops except for loops with small register pressure 
8386 as the regions.  This value usually gives
8387 the best results in most cases and for most architectures,
8388 and is enabled by default when compiling with optimization for speed
8389 (@option{-O}, @option{-O2}, @dots{}).
8391 @item one
8392 Use all functions as a single region.  
8393 This typically results in the smallest code size, and is enabled by default for
8394 @option{-Os} or @option{-O0}.
8396 @end table
8398 @item -fira-hoist-pressure
8399 @opindex fira-hoist-pressure
8400 Use IRA to evaluate register pressure in the code hoisting pass for
8401 decisions to hoist expressions.  This option usually results in smaller
8402 code, but it can slow the compiler down.
8404 This option is enabled at level @option{-Os} for all targets.
8406 @item -fira-loop-pressure
8407 @opindex fira-loop-pressure
8408 Use IRA to evaluate register pressure in loops for decisions to move
8409 loop invariants.  This option usually results in generation
8410 of faster and smaller code on machines with large register files (>= 32
8411 registers), but it can slow the compiler down.
8413 This option is enabled at level @option{-O3} for some targets.
8415 @item -fno-ira-share-save-slots
8416 @opindex fno-ira-share-save-slots
8417 Disable sharing of stack slots used for saving call-used hard
8418 registers living through a call.  Each hard register gets a
8419 separate stack slot, and as a result function stack frames are
8420 larger.
8422 @item -fno-ira-share-spill-slots
8423 @opindex fno-ira-share-spill-slots
8424 Disable sharing of stack slots allocated for pseudo-registers.  Each
8425 pseudo-register that does not get a hard register gets a separate
8426 stack slot, and as a result function stack frames are larger.
8428 @item -fira-verbose=@var{n}
8429 @opindex fira-verbose
8430 Control the verbosity of the dump file for the integrated register allocator.
8431 The default value is 5.  If the value @var{n} is greater or equal to 10,
8432 the dump output is sent to stderr using the same format as @var{n} minus 10.
8434 @item -flra-remat
8435 @opindex flra-remat
8436 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
8437 values of spilled pseudos, LRA tries to rematerialize (recalculate)
8438 values if it is profitable.
8440 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8442 @item -fdelayed-branch
8443 @opindex fdelayed-branch
8444 If supported for the target machine, attempt to reorder instructions
8445 to exploit instruction slots available after delayed branch
8446 instructions.
8448 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8450 @item -fschedule-insns
8451 @opindex fschedule-insns
8452 If supported for the target machine, attempt to reorder instructions to
8453 eliminate execution stalls due to required data being unavailable.  This
8454 helps machines that have slow floating point or memory load instructions
8455 by allowing other instructions to be issued until the result of the load
8456 or floating-point instruction is required.
8458 Enabled at levels @option{-O2}, @option{-O3}.
8460 @item -fschedule-insns2
8461 @opindex fschedule-insns2
8462 Similar to @option{-fschedule-insns}, but requests an additional pass of
8463 instruction scheduling after register allocation has been done.  This is
8464 especially useful on machines with a relatively small number of
8465 registers and where memory load instructions take more than one cycle.
8467 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8469 @item -fno-sched-interblock
8470 @opindex fno-sched-interblock
8471 Don't schedule instructions across basic blocks.  This is normally
8472 enabled by default when scheduling before register allocation, i.e.@:
8473 with @option{-fschedule-insns} or at @option{-O2} or higher.
8475 @item -fno-sched-spec
8476 @opindex fno-sched-spec
8477 Don't allow speculative motion of non-load instructions.  This is normally
8478 enabled by default when scheduling before register allocation, i.e.@:
8479 with @option{-fschedule-insns} or at @option{-O2} or higher.
8481 @item -fsched-pressure
8482 @opindex fsched-pressure
8483 Enable register pressure sensitive insn scheduling before register
8484 allocation.  This only makes sense when scheduling before register
8485 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
8486 @option{-O2} or higher.  Usage of this option can improve the
8487 generated code and decrease its size by preventing register pressure
8488 increase above the number of available hard registers and subsequent
8489 spills in register allocation.
8491 @item -fsched-spec-load
8492 @opindex fsched-spec-load
8493 Allow speculative motion of some load instructions.  This only makes
8494 sense when scheduling before register allocation, i.e.@: with
8495 @option{-fschedule-insns} or at @option{-O2} or higher.
8497 @item -fsched-spec-load-dangerous
8498 @opindex fsched-spec-load-dangerous
8499 Allow speculative motion of more load instructions.  This only makes
8500 sense when scheduling before register allocation, i.e.@: with
8501 @option{-fschedule-insns} or at @option{-O2} or higher.
8503 @item -fsched-stalled-insns
8504 @itemx -fsched-stalled-insns=@var{n}
8505 @opindex fsched-stalled-insns
8506 Define how many insns (if any) can be moved prematurely from the queue
8507 of stalled insns into the ready list during the second scheduling pass.
8508 @option{-fno-sched-stalled-insns} means that no insns are moved
8509 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
8510 on how many queued insns can be moved prematurely.
8511 @option{-fsched-stalled-insns} without a value is equivalent to
8512 @option{-fsched-stalled-insns=1}.
8514 @item -fsched-stalled-insns-dep
8515 @itemx -fsched-stalled-insns-dep=@var{n}
8516 @opindex fsched-stalled-insns-dep
8517 Define how many insn groups (cycles) are examined for a dependency
8518 on a stalled insn that is a candidate for premature removal from the queue
8519 of stalled insns.  This has an effect only during the second scheduling pass,
8520 and only if @option{-fsched-stalled-insns} is used.
8521 @option{-fno-sched-stalled-insns-dep} is equivalent to
8522 @option{-fsched-stalled-insns-dep=0}.
8523 @option{-fsched-stalled-insns-dep} without a value is equivalent to
8524 @option{-fsched-stalled-insns-dep=1}.
8526 @item -fsched2-use-superblocks
8527 @opindex fsched2-use-superblocks
8528 When scheduling after register allocation, use superblock scheduling.
8529 This allows motion across basic block boundaries,
8530 resulting in faster schedules.  This option is experimental, as not all machine
8531 descriptions used by GCC model the CPU closely enough to avoid unreliable
8532 results from the algorithm.
8534 This only makes sense when scheduling after register allocation, i.e.@: with
8535 @option{-fschedule-insns2} or at @option{-O2} or higher.
8537 @item -fsched-group-heuristic
8538 @opindex fsched-group-heuristic
8539 Enable the group heuristic in the scheduler.  This heuristic favors
8540 the instruction that belongs to a schedule group.  This is enabled
8541 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8542 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8544 @item -fsched-critical-path-heuristic
8545 @opindex fsched-critical-path-heuristic
8546 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8547 instructions on the critical path.  This is enabled by default when
8548 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8549 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8551 @item -fsched-spec-insn-heuristic
8552 @opindex fsched-spec-insn-heuristic
8553 Enable the speculative instruction heuristic in the scheduler.  This
8554 heuristic favors speculative instructions with greater dependency weakness.
8555 This is enabled by default when scheduling is enabled, i.e.@:
8556 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8557 or at @option{-O2} or higher.
8559 @item -fsched-rank-heuristic
8560 @opindex fsched-rank-heuristic
8561 Enable the rank heuristic in the scheduler.  This heuristic favors
8562 the instruction belonging to a basic block with greater size or frequency.
8563 This is enabled by default when scheduling is enabled, i.e.@:
8564 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8565 at @option{-O2} or higher.
8567 @item -fsched-last-insn-heuristic
8568 @opindex fsched-last-insn-heuristic
8569 Enable the last-instruction heuristic in the scheduler.  This heuristic
8570 favors the instruction that is less dependent on the last instruction
8571 scheduled.  This is enabled by default when scheduling is enabled,
8572 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8573 at @option{-O2} or higher.
8575 @item -fsched-dep-count-heuristic
8576 @opindex fsched-dep-count-heuristic
8577 Enable the dependent-count heuristic in the scheduler.  This heuristic
8578 favors the instruction that has more instructions depending on it.
8579 This is enabled by default when scheduling is enabled, i.e.@:
8580 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8581 at @option{-O2} or higher.
8583 @item -freschedule-modulo-scheduled-loops
8584 @opindex freschedule-modulo-scheduled-loops
8585 Modulo scheduling is performed before traditional scheduling.  If a loop
8586 is modulo scheduled, later scheduling passes may change its schedule.  
8587 Use this option to control that behavior.
8589 @item -fselective-scheduling
8590 @opindex fselective-scheduling
8591 Schedule instructions using selective scheduling algorithm.  Selective
8592 scheduling runs instead of the first scheduler pass.
8594 @item -fselective-scheduling2
8595 @opindex fselective-scheduling2
8596 Schedule instructions using selective scheduling algorithm.  Selective
8597 scheduling runs instead of the second scheduler pass.
8599 @item -fsel-sched-pipelining
8600 @opindex fsel-sched-pipelining
8601 Enable software pipelining of innermost loops during selective scheduling.
8602 This option has no effect unless one of @option{-fselective-scheduling} or
8603 @option{-fselective-scheduling2} is turned on.
8605 @item -fsel-sched-pipelining-outer-loops
8606 @opindex fsel-sched-pipelining-outer-loops
8607 When pipelining loops during selective scheduling, also pipeline outer loops.
8608 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8610 @item -fsemantic-interposition
8611 @opindex fsemantic-interposition
8612 Some object formats, like ELF, allow interposing of symbols by the 
8613 dynamic linker.
8614 This means that for symbols exported from the DSO, the compiler cannot perform
8615 interprocedural propagation, inlining and other optimizations in anticipation
8616 that the function or variable in question may change. While this feature is
8617 useful, for example, to rewrite memory allocation functions by a debugging
8618 implementation, it is expensive in the terms of code quality.
8619 With @option{-fno-semantic-interposition} the compiler assumes that 
8620 if interposition happens for functions the overwriting function will have 
8621 precisely the same semantics (and side effects). 
8622 Similarly if interposition happens
8623 for variables, the constructor of the variable will be the same. The flag
8624 has no effect for functions explicitly declared inline 
8625 (where it is never allowed for interposition to change semantics) 
8626 and for symbols explicitly declared weak.
8628 @item -fshrink-wrap
8629 @opindex fshrink-wrap
8630 Emit function prologues only before parts of the function that need it,
8631 rather than at the top of the function.  This flag is enabled by default at
8632 @option{-O} and higher.
8634 @item -fcaller-saves
8635 @opindex fcaller-saves
8636 Enable allocation of values to registers that are clobbered by
8637 function calls, by emitting extra instructions to save and restore the
8638 registers around such calls.  Such allocation is done only when it
8639 seems to result in better code.
8641 This option is always enabled by default on certain machines, usually
8642 those which have no call-preserved registers to use instead.
8644 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8646 @item -fcombine-stack-adjustments
8647 @opindex fcombine-stack-adjustments
8648 Tracks stack adjustments (pushes and pops) and stack memory references
8649 and then tries to find ways to combine them.
8651 Enabled by default at @option{-O1} and higher.
8653 @item -fipa-ra
8654 @opindex fipa-ra
8655 Use caller save registers for allocation if those registers are not used by
8656 any called function.  In that case it is not necessary to save and restore
8657 them around calls.  This is only possible if called functions are part of
8658 same compilation unit as current function and they are compiled before it.
8660 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8662 @item -fconserve-stack
8663 @opindex fconserve-stack
8664 Attempt to minimize stack usage.  The compiler attempts to use less
8665 stack space, even if that makes the program slower.  This option
8666 implies setting the @option{large-stack-frame} parameter to 100
8667 and the @option{large-stack-frame-growth} parameter to 400.
8669 @item -ftree-reassoc
8670 @opindex ftree-reassoc
8671 Perform reassociation on trees.  This flag is enabled by default
8672 at @option{-O} and higher.
8674 @item -ftree-pre
8675 @opindex ftree-pre
8676 Perform partial redundancy elimination (PRE) on trees.  This flag is
8677 enabled by default at @option{-O2} and @option{-O3}.
8679 @item -ftree-partial-pre
8680 @opindex ftree-partial-pre
8681 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8682 enabled by default at @option{-O3}.
8684 @item -ftree-forwprop
8685 @opindex ftree-forwprop
8686 Perform forward propagation on trees.  This flag is enabled by default
8687 at @option{-O} and higher.
8689 @item -ftree-fre
8690 @opindex ftree-fre
8691 Perform full redundancy elimination (FRE) on trees.  The difference
8692 between FRE and PRE is that FRE only considers expressions
8693 that are computed on all paths leading to the redundant computation.
8694 This analysis is faster than PRE, though it exposes fewer redundancies.
8695 This flag is enabled by default at @option{-O} and higher.
8697 @item -ftree-phiprop
8698 @opindex ftree-phiprop
8699 Perform hoisting of loads from conditional pointers on trees.  This
8700 pass is enabled by default at @option{-O} and higher.
8702 @item -fhoist-adjacent-loads
8703 @opindex fhoist-adjacent-loads
8704 Speculatively hoist loads from both branches of an if-then-else if the
8705 loads are from adjacent locations in the same structure and the target
8706 architecture has a conditional move instruction.  This flag is enabled
8707 by default at @option{-O2} and higher.
8709 @item -ftree-copy-prop
8710 @opindex ftree-copy-prop
8711 Perform copy propagation on trees.  This pass eliminates unnecessary
8712 copy operations.  This flag is enabled by default at @option{-O} and
8713 higher.
8715 @item -fipa-pure-const
8716 @opindex fipa-pure-const
8717 Discover which functions are pure or constant.
8718 Enabled by default at @option{-O} and higher.
8720 @item -fipa-reference
8721 @opindex fipa-reference
8722 Discover which static variables do not escape the
8723 compilation unit.
8724 Enabled by default at @option{-O} and higher.
8726 @item -fipa-pta
8727 @opindex fipa-pta
8728 Perform interprocedural pointer analysis and interprocedural modification
8729 and reference analysis.  This option can cause excessive memory and
8730 compile-time usage on large compilation units.  It is not enabled by
8731 default at any optimization level.
8733 @item -fipa-profile
8734 @opindex fipa-profile
8735 Perform interprocedural profile propagation.  The functions called only from
8736 cold functions are marked as cold. Also functions executed once (such as
8737 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8738 functions and loop less parts of functions executed once are then optimized for
8739 size.
8740 Enabled by default at @option{-O} and higher.
8742 @item -fipa-cp
8743 @opindex fipa-cp
8744 Perform interprocedural constant propagation.
8745 This optimization analyzes the program to determine when values passed
8746 to functions are constants and then optimizes accordingly.
8747 This optimization can substantially increase performance
8748 if the application has constants passed to functions.
8749 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8751 @item -fipa-cp-clone
8752 @opindex fipa-cp-clone
8753 Perform function cloning to make interprocedural constant propagation stronger.
8754 When enabled, interprocedural constant propagation performs function cloning
8755 when externally visible function can be called with constant arguments.
8756 Because this optimization can create multiple copies of functions,
8757 it may significantly increase code size
8758 (see @option{--param ipcp-unit-growth=@var{value}}).
8759 This flag is enabled by default at @option{-O3}.
8761 @item -fipa-cp-alignment
8762 @opindex -fipa-cp-alignment
8763 When enabled, this optimization propagates alignment of function
8764 parameters to support better vectorization and string operations.
8766 This flag is enabled by default at @option{-O2} and @option{-Os}.  It
8767 requires that @option{-fipa-cp} is enabled.
8769 @item -fipa-icf
8770 @opindex fipa-icf
8771 Perform Identical Code Folding for functions and read-only variables.
8772 The optimization reduces code size and may disturb unwind stacks by replacing
8773 a function by equivalent one with a different name. The optimization works
8774 more effectively with link time optimization enabled.
8776 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8777 works on different levels and thus the optimizations are not same - there are
8778 equivalences that are found only by GCC and equivalences found only by Gold.
8780 This flag is enabled by default at @option{-O2} and @option{-Os}.
8782 @item -fisolate-erroneous-paths-dereference
8783 @opindex fisolate-erroneous-paths-dereference
8784 Detect paths that trigger erroneous or undefined behavior due to
8785 dereferencing a null pointer.  Isolate those paths from the main control
8786 flow and turn the statement with erroneous or undefined behavior into a trap.
8787 This flag is enabled by default at @option{-O2} and higher and depends on
8788 @option{-fdelete-null-pointer-checks} also being enabled.
8790 @item -fisolate-erroneous-paths-attribute
8791 @opindex fisolate-erroneous-paths-attribute
8792 Detect paths that trigger erroneous or undefined behavior due a null value
8793 being used in a way forbidden by a @code{returns_nonnull} or @code{nonnull}
8794 attribute.  Isolate those paths from the main control flow and turn the
8795 statement with erroneous or undefined behavior into a trap.  This is not
8796 currently enabled, but may be enabled by @option{-O2} in the future.
8798 @item -ftree-sink
8799 @opindex ftree-sink
8800 Perform forward store motion  on trees.  This flag is
8801 enabled by default at @option{-O} and higher.
8803 @item -ftree-bit-ccp
8804 @opindex ftree-bit-ccp
8805 Perform sparse conditional bit constant propagation on trees and propagate
8806 pointer alignment information.
8807 This pass only operates on local scalar variables and is enabled by default
8808 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8810 @item -ftree-ccp
8811 @opindex ftree-ccp
8812 Perform sparse conditional constant propagation (CCP) on trees.  This
8813 pass only operates on local scalar variables and is enabled by default
8814 at @option{-O} and higher.
8816 @item -fssa-backprop
8817 @opindex fssa-backprop
8818 Propagate information about uses of a value up the definition chain
8819 in order to simplify the definitions.  For example, this pass strips
8820 sign operations if the sign of a value never matters.  The flag is
8821 enabled by default at @option{-O} and higher.
8823 @item -fssa-phiopt
8824 @opindex fssa-phiopt
8825 Perform pattern matching on SSA PHI nodes to optimize conditional
8826 code.  This pass is enabled by default at @option{-O} and higher.
8828 @item -ftree-switch-conversion
8829 @opindex ftree-switch-conversion
8830 Perform conversion of simple initializations in a switch to
8831 initializations from a scalar array.  This flag is enabled by default
8832 at @option{-O2} and higher.
8834 @item -ftree-tail-merge
8835 @opindex ftree-tail-merge
8836 Look for identical code sequences.  When found, replace one with a jump to the
8837 other.  This optimization is known as tail merging or cross jumping.  This flag
8838 is enabled by default at @option{-O2} and higher.  The compilation time
8839 in this pass can
8840 be limited using @option{max-tail-merge-comparisons} parameter and
8841 @option{max-tail-merge-iterations} parameter.
8843 @item -ftree-dce
8844 @opindex ftree-dce
8845 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8846 default at @option{-O} and higher.
8848 @item -ftree-builtin-call-dce
8849 @opindex ftree-builtin-call-dce
8850 Perform conditional dead code elimination (DCE) for calls to built-in functions
8851 that may set @code{errno} but are otherwise side-effect free.  This flag is
8852 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8853 specified.
8855 @item -ftree-dominator-opts
8856 @opindex ftree-dominator-opts
8857 Perform a variety of simple scalar cleanups (constant/copy
8858 propagation, redundancy elimination, range propagation and expression
8859 simplification) based on a dominator tree traversal.  This also
8860 performs jump threading (to reduce jumps to jumps). This flag is
8861 enabled by default at @option{-O} and higher.
8863 @item -ftree-dse
8864 @opindex ftree-dse
8865 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8866 a memory location that is later overwritten by another store without
8867 any intervening loads.  In this case the earlier store can be deleted.  This
8868 flag is enabled by default at @option{-O} and higher.
8870 @item -ftree-ch
8871 @opindex ftree-ch
8872 Perform loop header copying on trees.  This is beneficial since it increases
8873 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8874 is enabled by default at @option{-O} and higher.  It is not enabled
8875 for @option{-Os}, since it usually increases code size.
8877 @item -ftree-loop-optimize
8878 @opindex ftree-loop-optimize
8879 Perform loop optimizations on trees.  This flag is enabled by default
8880 at @option{-O} and higher.
8882 @item -ftree-loop-linear
8883 @itemx -floop-interchange
8884 @itemx -floop-strip-mine
8885 @itemx -floop-block
8886 @itemx -floop-unroll-and-jam
8887 @opindex ftree-loop-linear
8888 @opindex floop-interchange
8889 @opindex floop-strip-mine
8890 @opindex floop-block
8891 @opindex floop-unroll-and-jam
8892 Perform loop nest optimizations.  Same as
8893 @option{-floop-nest-optimize}.  To use this code transformation, GCC has
8894 to be configured with @option{--with-isl} to enable the Graphite loop
8895 transformation infrastructure.
8897 @item -fgraphite-identity
8898 @opindex fgraphite-identity
8899 Enable the identity transformation for graphite.  For every SCoP we generate
8900 the polyhedral representation and transform it back to gimple.  Using
8901 @option{-fgraphite-identity} we can check the costs or benefits of the
8902 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8903 are also performed by the code generator ISL, like index splitting and
8904 dead code elimination in loops.
8906 @item -floop-nest-optimize
8907 @opindex floop-nest-optimize
8908 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8909 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8910 structure optimized for data-locality and parallelism.  This option
8911 is experimental.
8913 @item -floop-parallelize-all
8914 @opindex floop-parallelize-all
8915 Use the Graphite data dependence analysis to identify loops that can
8916 be parallelized.  Parallelize all the loops that can be analyzed to
8917 not contain loop carried dependences without checking that it is
8918 profitable to parallelize the loops.
8920 @item -ftree-coalesce-vars
8921 @opindex ftree-coalesce-vars
8922 While transforming the program out of the SSA representation, attempt to
8923 reduce copying by coalescing versions of different user-defined
8924 variables, instead of just compiler temporaries.  This may severely
8925 limit the ability to debug an optimized program compiled with
8926 @option{-fno-var-tracking-assignments}.  In the negated form, this flag
8927 prevents SSA coalescing of user variables.  This option is enabled by
8928 default if optimization is enabled, and it does very little otherwise.
8930 @item -ftree-loop-if-convert
8931 @opindex ftree-loop-if-convert
8932 Attempt to transform conditional jumps in the innermost loops to
8933 branch-less equivalents.  The intent is to remove control-flow from
8934 the innermost loops in order to improve the ability of the
8935 vectorization pass to handle these loops.  This is enabled by default
8936 if vectorization is enabled.
8938 @item -ftree-loop-if-convert-stores
8939 @opindex ftree-loop-if-convert-stores
8940 Attempt to also if-convert conditional jumps containing memory writes.
8941 This transformation can be unsafe for multi-threaded programs as it
8942 transforms conditional memory writes into unconditional memory writes.
8943 For example,
8944 @smallexample
8945 for (i = 0; i < N; i++)
8946   if (cond)
8947     A[i] = expr;
8948 @end smallexample
8949 is transformed to
8950 @smallexample
8951 for (i = 0; i < N; i++)
8952   A[i] = cond ? expr : A[i];
8953 @end smallexample
8954 potentially producing data races.
8956 @item -ftree-loop-distribution
8957 @opindex ftree-loop-distribution
8958 Perform loop distribution.  This flag can improve cache performance on
8959 big loop bodies and allow further loop optimizations, like
8960 parallelization or vectorization, to take place.  For example, the loop
8961 @smallexample
8962 DO I = 1, N
8963   A(I) = B(I) + C
8964   D(I) = E(I) * F
8965 ENDDO
8966 @end smallexample
8967 is transformed to
8968 @smallexample
8969 DO I = 1, N
8970    A(I) = B(I) + C
8971 ENDDO
8972 DO I = 1, N
8973    D(I) = E(I) * F
8974 ENDDO
8975 @end smallexample
8977 @item -ftree-loop-distribute-patterns
8978 @opindex ftree-loop-distribute-patterns
8979 Perform loop distribution of patterns that can be code generated with
8980 calls to a library.  This flag is enabled by default at @option{-O3}.
8982 This pass distributes the initialization loops and generates a call to
8983 memset zero.  For example, the loop
8984 @smallexample
8985 DO I = 1, N
8986   A(I) = 0
8987   B(I) = A(I) + I
8988 ENDDO
8989 @end smallexample
8990 is transformed to
8991 @smallexample
8992 DO I = 1, N
8993    A(I) = 0
8994 ENDDO
8995 DO I = 1, N
8996    B(I) = A(I) + I
8997 ENDDO
8998 @end smallexample
8999 and the initialization loop is transformed into a call to memset zero.
9001 @item -ftree-loop-im
9002 @opindex ftree-loop-im
9003 Perform loop invariant motion on trees.  This pass moves only invariants that
9004 are hard to handle at RTL level (function calls, operations that expand to
9005 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
9006 operands of conditions that are invariant out of the loop, so that we can use
9007 just trivial invariantness analysis in loop unswitching.  The pass also includes
9008 store motion.
9010 @item -ftree-loop-ivcanon
9011 @opindex ftree-loop-ivcanon
9012 Create a canonical counter for number of iterations in loops for which
9013 determining number of iterations requires complicated analysis.  Later
9014 optimizations then may determine the number easily.  Useful especially
9015 in connection with unrolling.
9017 @item -fivopts
9018 @opindex fivopts
9019 Perform induction variable optimizations (strength reduction, induction
9020 variable merging and induction variable elimination) on trees.
9022 @item -ftree-parallelize-loops=n
9023 @opindex ftree-parallelize-loops
9024 Parallelize loops, i.e., split their iteration space to run in n threads.
9025 This is only possible for loops whose iterations are independent
9026 and can be arbitrarily reordered.  The optimization is only
9027 profitable on multiprocessor machines, for loops that are CPU-intensive,
9028 rather than constrained e.g.@: by memory bandwidth.  This option
9029 implies @option{-pthread}, and thus is only supported on targets
9030 that have support for @option{-pthread}.
9032 @item -ftree-pta
9033 @opindex ftree-pta
9034 Perform function-local points-to analysis on trees.  This flag is
9035 enabled by default at @option{-O} and higher.
9037 @item -ftree-sra
9038 @opindex ftree-sra
9039 Perform scalar replacement of aggregates.  This pass replaces structure
9040 references with scalars to prevent committing structures to memory too
9041 early.  This flag is enabled by default at @option{-O} and higher.
9043 @item -ftree-ter
9044 @opindex ftree-ter
9045 Perform temporary expression replacement during the SSA->normal phase.  Single
9046 use/single def temporaries are replaced at their use location with their
9047 defining expression.  This results in non-GIMPLE code, but gives the expanders
9048 much more complex trees to work on resulting in better RTL generation.  This is
9049 enabled by default at @option{-O} and higher.
9051 @item -ftree-slsr
9052 @opindex ftree-slsr
9053 Perform straight-line strength reduction on trees.  This recognizes related
9054 expressions involving multiplications and replaces them by less expensive
9055 calculations when possible.  This is enabled by default at @option{-O} and
9056 higher.
9058 @item -ftree-vectorize
9059 @opindex ftree-vectorize
9060 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
9061 and @option{-ftree-slp-vectorize} if not explicitly specified.
9063 @item -ftree-loop-vectorize
9064 @opindex ftree-loop-vectorize
9065 Perform loop vectorization on trees. This flag is enabled by default at
9066 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9068 @item -ftree-slp-vectorize
9069 @opindex ftree-slp-vectorize
9070 Perform basic block vectorization on trees. This flag is enabled by default at
9071 @option{-O3} and when @option{-ftree-vectorize} is enabled.
9073 @item -fvect-cost-model=@var{model}
9074 @opindex fvect-cost-model
9075 Alter the cost model used for vectorization.  The @var{model} argument
9076 should be one of @samp{unlimited}, @samp{dynamic} or @samp{cheap}.
9077 With the @samp{unlimited} model the vectorized code-path is assumed
9078 to be profitable while with the @samp{dynamic} model a runtime check
9079 guards the vectorized code-path to enable it only for iteration
9080 counts that will likely execute faster than when executing the original
9081 scalar loop.  The @samp{cheap} model disables vectorization of
9082 loops where doing so would be cost prohibitive for example due to
9083 required runtime checks for data dependence or alignment but otherwise
9084 is equal to the @samp{dynamic} model.
9085 The default cost model depends on other optimization flags and is
9086 either @samp{dynamic} or @samp{cheap}.
9088 @item -fsimd-cost-model=@var{model}
9089 @opindex fsimd-cost-model
9090 Alter the cost model used for vectorization of loops marked with the OpenMP
9091 or Cilk Plus simd directive.  The @var{model} argument should be one of
9092 @samp{unlimited}, @samp{dynamic}, @samp{cheap}.  All values of @var{model}
9093 have the same meaning as described in @option{-fvect-cost-model} and by
9094 default a cost model defined with @option{-fvect-cost-model} is used.
9096 @item -ftree-vrp
9097 @opindex ftree-vrp
9098 Perform Value Range Propagation on trees.  This is similar to the
9099 constant propagation pass, but instead of values, ranges of values are
9100 propagated.  This allows the optimizers to remove unnecessary range
9101 checks like array bound checks and null pointer checks.  This is
9102 enabled by default at @option{-O2} and higher.  Null pointer check
9103 elimination is only done if @option{-fdelete-null-pointer-checks} is
9104 enabled.
9106 @item -fsplit-ivs-in-unroller
9107 @opindex fsplit-ivs-in-unroller
9108 Enables expression of values of induction variables in later iterations
9109 of the unrolled loop using the value in the first iteration.  This breaks
9110 long dependency chains, thus improving efficiency of the scheduling passes.
9112 A combination of @option{-fweb} and CSE is often sufficient to obtain the
9113 same effect.  However, that is not reliable in cases where the loop body
9114 is more complicated than a single basic block.  It also does not work at all
9115 on some architectures due to restrictions in the CSE pass.
9117 This optimization is enabled by default.
9119 @item -fvariable-expansion-in-unroller
9120 @opindex fvariable-expansion-in-unroller
9121 With this option, the compiler creates multiple copies of some
9122 local variables when unrolling a loop, which can result in superior code.
9124 @item -fpartial-inlining
9125 @opindex fpartial-inlining
9126 Inline parts of functions.  This option has any effect only
9127 when inlining itself is turned on by the @option{-finline-functions}
9128 or @option{-finline-small-functions} options.
9130 Enabled at level @option{-O2}.
9132 @item -fpredictive-commoning
9133 @opindex fpredictive-commoning
9134 Perform predictive commoning optimization, i.e., reusing computations
9135 (especially memory loads and stores) performed in previous
9136 iterations of loops.
9138 This option is enabled at level @option{-O3}.
9140 @item -fprefetch-loop-arrays
9141 @opindex fprefetch-loop-arrays
9142 If supported by the target machine, generate instructions to prefetch
9143 memory to improve the performance of loops that access large arrays.
9145 This option may generate better or worse code; results are highly
9146 dependent on the structure of loops within the source code.
9148 Disabled at level @option{-Os}.
9150 @item -fno-peephole
9151 @itemx -fno-peephole2
9152 @opindex fno-peephole
9153 @opindex fno-peephole2
9154 Disable any machine-specific peephole optimizations.  The difference
9155 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
9156 are implemented in the compiler; some targets use one, some use the
9157 other, a few use both.
9159 @option{-fpeephole} is enabled by default.
9160 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9162 @item -fno-guess-branch-probability
9163 @opindex fno-guess-branch-probability
9164 Do not guess branch probabilities using heuristics.
9166 GCC uses heuristics to guess branch probabilities if they are
9167 not provided by profiling feedback (@option{-fprofile-arcs}).  These
9168 heuristics are based on the control flow graph.  If some branch probabilities
9169 are specified by @code{__builtin_expect}, then the heuristics are
9170 used to guess branch probabilities for the rest of the control flow graph,
9171 taking the @code{__builtin_expect} info into account.  The interactions
9172 between the heuristics and @code{__builtin_expect} can be complex, and in
9173 some cases, it may be useful to disable the heuristics so that the effects
9174 of @code{__builtin_expect} are easier to understand.
9176 The default is @option{-fguess-branch-probability} at levels
9177 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9179 @item -freorder-blocks
9180 @opindex freorder-blocks
9181 Reorder basic blocks in the compiled function in order to reduce number of
9182 taken branches and improve code locality.
9184 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9186 @item -freorder-blocks-algorithm=@var{algorithm}
9187 @opindex freorder-blocks-algorithm
9188 Use the specified algorithm for basic block reordering.  The
9189 @var{algorithm} argument can be @samp{simple}, which does not increase
9190 code size (except sometimes due to secondary effects like alignment),
9191 or @samp{stc}, the ``software trace cache'' algorithm, which tries to
9192 put all often executed code together, minimizing the number of branches
9193 executed by making extra copies of code.
9195 The default is @samp{simple} at levels @option{-O}, @option{-Os}, and
9196 @samp{stc} at levels @option{-O2}, @option{-O3}.
9198 @item -freorder-blocks-and-partition
9199 @opindex freorder-blocks-and-partition
9200 In addition to reordering basic blocks in the compiled function, in order
9201 to reduce number of taken branches, partitions hot and cold basic blocks
9202 into separate sections of the assembly and .o files, to improve
9203 paging and cache locality performance.
9205 This optimization is automatically turned off in the presence of
9206 exception handling, for linkonce sections, for functions with a user-defined
9207 section attribute and on any architecture that does not support named
9208 sections.
9210 Enabled for x86 at levels @option{-O2}, @option{-O3}.
9212 @item -freorder-functions
9213 @opindex freorder-functions
9214 Reorder functions in the object file in order to
9215 improve code locality.  This is implemented by using special
9216 subsections @code{.text.hot} for most frequently executed functions and
9217 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
9218 the linker so object file format must support named sections and linker must
9219 place them in a reasonable way.
9221 Also profile feedback must be available to make this option effective.  See
9222 @option{-fprofile-arcs} for details.
9224 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9226 @item -fstrict-aliasing
9227 @opindex fstrict-aliasing
9228 Allow the compiler to assume the strictest aliasing rules applicable to
9229 the language being compiled.  For C (and C++), this activates
9230 optimizations based on the type of expressions.  In particular, an
9231 object of one type is assumed never to reside at the same address as an
9232 object of a different type, unless the types are almost the same.  For
9233 example, an @code{unsigned int} can alias an @code{int}, but not a
9234 @code{void*} or a @code{double}.  A character type may alias any other
9235 type.
9237 @anchor{Type-punning}Pay special attention to code like this:
9238 @smallexample
9239 union a_union @{
9240   int i;
9241   double d;
9244 int f() @{
9245   union a_union t;
9246   t.d = 3.0;
9247   return t.i;
9249 @end smallexample
9250 The practice of reading from a different union member than the one most
9251 recently written to (called ``type-punning'') is common.  Even with
9252 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
9253 is accessed through the union type.  So, the code above works as
9254 expected.  @xref{Structures unions enumerations and bit-fields
9255 implementation}.  However, this code might not:
9256 @smallexample
9257 int f() @{
9258   union a_union t;
9259   int* ip;
9260   t.d = 3.0;
9261   ip = &t.i;
9262   return *ip;
9264 @end smallexample
9266 Similarly, access by taking the address, casting the resulting pointer
9267 and dereferencing the result has undefined behavior, even if the cast
9268 uses a union type, e.g.:
9269 @smallexample
9270 int f() @{
9271   double d = 3.0;
9272   return ((union a_union *) &d)->i;
9274 @end smallexample
9276 The @option{-fstrict-aliasing} option is enabled at levels
9277 @option{-O2}, @option{-O3}, @option{-Os}.
9279 @item -fstrict-overflow
9280 @opindex fstrict-overflow
9281 Allow the compiler to assume strict signed overflow rules, depending
9282 on the language being compiled.  For C (and C++) this means that
9283 overflow when doing arithmetic with signed numbers is undefined, which
9284 means that the compiler may assume that it does not happen.  This
9285 permits various optimizations.  For example, the compiler assumes
9286 that an expression like @code{i + 10 > i} is always true for
9287 signed @code{i}.  This assumption is only valid if signed overflow is
9288 undefined, as the expression is false if @code{i + 10} overflows when
9289 using twos complement arithmetic.  When this option is in effect any
9290 attempt to determine whether an operation on signed numbers 
9291 overflows must be written carefully to not actually involve overflow.
9293 This option also allows the compiler to assume strict pointer
9294 semantics: given a pointer to an object, if adding an offset to that
9295 pointer does not produce a pointer to the same object, the addition is
9296 undefined.  This permits the compiler to conclude that @code{p + u >
9297 p} is always true for a pointer @code{p} and unsigned integer
9298 @code{u}.  This assumption is only valid because pointer wraparound is
9299 undefined, as the expression is false if @code{p + u} overflows using
9300 twos complement arithmetic.
9302 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
9303 that integer signed overflow is fully defined: it wraps.  When
9304 @option{-fwrapv} is used, there is no difference between
9305 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
9306 integers.  With @option{-fwrapv} certain types of overflow are
9307 permitted.  For example, if the compiler gets an overflow when doing
9308 arithmetic on constants, the overflowed value can still be used with
9309 @option{-fwrapv}, but not otherwise.
9311 The @option{-fstrict-overflow} option is enabled at levels
9312 @option{-O2}, @option{-O3}, @option{-Os}.
9314 @item -falign-functions
9315 @itemx -falign-functions=@var{n}
9316 @opindex falign-functions
9317 Align the start of functions to the next power-of-two greater than
9318 @var{n}, skipping up to @var{n} bytes.  For instance,
9319 @option{-falign-functions=32} aligns functions to the next 32-byte
9320 boundary, but @option{-falign-functions=24} aligns to the next
9321 32-byte boundary only if this can be done by skipping 23 bytes or less.
9323 @option{-fno-align-functions} and @option{-falign-functions=1} are
9324 equivalent and mean that functions are not aligned.
9326 Some assemblers only support this flag when @var{n} is a power of two;
9327 in that case, it is rounded up.
9329 If @var{n} is not specified or is zero, use a machine-dependent default.
9331 Enabled at levels @option{-O2}, @option{-O3}.
9333 @item -falign-labels
9334 @itemx -falign-labels=@var{n}
9335 @opindex falign-labels
9336 Align all branch targets to a power-of-two boundary, skipping up to
9337 @var{n} bytes like @option{-falign-functions}.  This option can easily
9338 make code slower, because it must insert dummy operations for when the
9339 branch target is reached in the usual flow of the code.
9341 @option{-fno-align-labels} and @option{-falign-labels=1} are
9342 equivalent and mean that labels are not aligned.
9344 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
9345 are greater than this value, then their values are used instead.
9347 If @var{n} is not specified or is zero, use a machine-dependent default
9348 which is very likely to be @samp{1}, meaning no alignment.
9350 Enabled at levels @option{-O2}, @option{-O3}.
9352 @item -falign-loops
9353 @itemx -falign-loops=@var{n}
9354 @opindex falign-loops
9355 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
9356 like @option{-falign-functions}.  If the loops are
9357 executed many times, this makes up for any execution of the dummy
9358 operations.
9360 @option{-fno-align-loops} and @option{-falign-loops=1} are
9361 equivalent and mean that loops are not aligned.
9363 If @var{n} is not specified or is zero, use a machine-dependent default.
9365 Enabled at levels @option{-O2}, @option{-O3}.
9367 @item -falign-jumps
9368 @itemx -falign-jumps=@var{n}
9369 @opindex falign-jumps
9370 Align branch targets to a power-of-two boundary, for branch targets
9371 where the targets can only be reached by jumping, skipping up to @var{n}
9372 bytes like @option{-falign-functions}.  In this case, no dummy operations
9373 need be executed.
9375 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
9376 equivalent and mean that loops are not aligned.
9378 If @var{n} is not specified or is zero, use a machine-dependent default.
9380 Enabled at levels @option{-O2}, @option{-O3}.
9382 @item -funit-at-a-time
9383 @opindex funit-at-a-time
9384 This option is left for compatibility reasons. @option{-funit-at-a-time}
9385 has no effect, while @option{-fno-unit-at-a-time} implies
9386 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
9388 Enabled by default.
9390 @item -fno-toplevel-reorder
9391 @opindex fno-toplevel-reorder
9392 Do not reorder top-level functions, variables, and @code{asm}
9393 statements.  Output them in the same order that they appear in the
9394 input file.  When this option is used, unreferenced static variables
9395 are not removed.  This option is intended to support existing code
9396 that relies on a particular ordering.  For new code, it is better to
9397 use attributes when possible.
9399 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
9400 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
9401 targets.
9403 @item -fweb
9404 @opindex fweb
9405 Constructs webs as commonly used for register allocation purposes and assign
9406 each web individual pseudo register.  This allows the register allocation pass
9407 to operate on pseudos directly, but also strengthens several other optimization
9408 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
9409 however, make debugging impossible, since variables no longer stay in a
9410 ``home register''.
9412 Enabled by default with @option{-funroll-loops}.
9414 @item -fwhole-program
9415 @opindex fwhole-program
9416 Assume that the current compilation unit represents the whole program being
9417 compiled.  All public functions and variables with the exception of @code{main}
9418 and those merged by attribute @code{externally_visible} become static functions
9419 and in effect are optimized more aggressively by interprocedural optimizers.
9421 This option should not be used in combination with @option{-flto}.
9422 Instead relying on a linker plugin should provide safer and more precise
9423 information.
9425 @item -flto[=@var{n}]
9426 @opindex flto
9427 This option runs the standard link-time optimizer.  When invoked
9428 with source code, it generates GIMPLE (one of GCC's internal
9429 representations) and writes it to special ELF sections in the object
9430 file.  When the object files are linked together, all the function
9431 bodies are read from these ELF sections and instantiated as if they
9432 had been part of the same translation unit.
9434 To use the link-time optimizer, @option{-flto} and optimization
9435 options should be specified at compile time and during the final link.
9436 For example:
9438 @smallexample
9439 gcc -c -O2 -flto foo.c
9440 gcc -c -O2 -flto bar.c
9441 gcc -o myprog -flto -O2 foo.o bar.o
9442 @end smallexample
9444 The first two invocations to GCC save a bytecode representation
9445 of GIMPLE into special ELF sections inside @file{foo.o} and
9446 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9447 @file{foo.o} and @file{bar.o}, merges the two files into a single
9448 internal image, and compiles the result as usual.  Since both
9449 @file{foo.o} and @file{bar.o} are merged into a single image, this
9450 causes all the interprocedural analyses and optimizations in GCC to
9451 work across the two files as if they were a single one.  This means,
9452 for example, that the inliner is able to inline functions in
9453 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9455 Another (simpler) way to enable link-time optimization is:
9457 @smallexample
9458 gcc -o myprog -flto -O2 foo.c bar.c
9459 @end smallexample
9461 The above generates bytecode for @file{foo.c} and @file{bar.c},
9462 merges them together into a single GIMPLE representation and optimizes
9463 them as usual to produce @file{myprog}.
9465 The only important thing to keep in mind is that to enable link-time
9466 optimizations you need to use the GCC driver to perform the link-step.
9467 GCC then automatically performs link-time optimization if any of the
9468 objects involved were compiled with the @option{-flto} command-line option.  
9469 You generally
9470 should specify the optimization options to be used for link-time
9471 optimization though GCC tries to be clever at guessing an
9472 optimization level to use from the options used at compile-time
9473 if you fail to specify one at link-time.  You can always override
9474 the automatic decision to do link-time optimization at link-time
9475 by passing @option{-fno-lto} to the link command.
9477 To make whole program optimization effective, it is necessary to make
9478 certain whole program assumptions.  The compiler needs to know
9479 what functions and variables can be accessed by libraries and runtime
9480 outside of the link-time optimized unit.  When supported by the linker,
9481 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9482 to the compiler about used and externally visible symbols.  When
9483 the linker plugin is not available, @option{-fwhole-program} should be
9484 used to allow the compiler to make these assumptions, which leads
9485 to more aggressive optimization decisions.
9487 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9488 compiled with @option{-flto}, the generated object file is larger than
9489 a regular object file because it contains GIMPLE bytecodes and the usual
9490 final code (see @option{-ffat-lto-objects}.  This means that
9491 object files with LTO information can be linked as normal object
9492 files; if @option{-fno-lto} is passed to the linker, no
9493 interprocedural optimizations are applied.  Note that when
9494 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9495 but you cannot perform a regular, non-LTO link on them.
9497 Additionally, the optimization flags used to compile individual files
9498 are not necessarily related to those used at link time.  For instance,
9500 @smallexample
9501 gcc -c -O0 -ffat-lto-objects -flto foo.c
9502 gcc -c -O0 -ffat-lto-objects -flto bar.c
9503 gcc -o myprog -O3 foo.o bar.o
9504 @end smallexample
9506 This produces individual object files with unoptimized assembler
9507 code, but the resulting binary @file{myprog} is optimized at
9508 @option{-O3}.  If, instead, the final binary is generated with
9509 @option{-fno-lto}, then @file{myprog} is not optimized.
9511 When producing the final binary, GCC only
9512 applies link-time optimizations to those files that contain bytecode.
9513 Therefore, you can mix and match object files and libraries with
9514 GIMPLE bytecodes and final object code.  GCC automatically selects
9515 which files to optimize in LTO mode and which files to link without
9516 further processing.
9518 There are some code generation flags preserved by GCC when
9519 generating bytecodes, as they need to be used during the final link
9520 stage.  Generally options specified at link-time override those
9521 specified at compile-time.
9523 If you do not specify an optimization level option @option{-O} at
9524 link-time then GCC computes one based on the optimization levels
9525 used when compiling the object files.  The highest optimization
9526 level wins here.
9528 Currently, the following options and their setting are take from
9529 the first object file that explicitely specified it: 
9530 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9531 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9532 and all the @option{-m} target flags.
9534 Certain ABI changing flags are required to match in all compilation-units
9535 and trying to override this at link-time with a conflicting value
9536 is ignored.  This includes options such as @option{-freg-struct-return}
9537 and @option{-fpcc-struct-return}. 
9539 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9540 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9541 are passed through to the link stage and merged conservatively for
9542 conflicting translation units.  Specifically
9543 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9544 precedence and for example @option{-ffp-contract=off} takes precedence
9545 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9547 It is recommended that you compile all the files participating in the
9548 same link with the same options and also specify those options at
9549 link time.
9551 If LTO encounters objects with C linkage declared with incompatible
9552 types in separate translation units to be linked together (undefined
9553 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9554 issued.  The behavior is still undefined at run time.  Similar
9555 diagnostics may be raised for other languages.
9557 Another feature of LTO is that it is possible to apply interprocedural
9558 optimizations on files written in different languages:
9560 @smallexample
9561 gcc -c -flto foo.c
9562 g++ -c -flto bar.cc
9563 gfortran -c -flto baz.f90
9564 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9565 @end smallexample
9567 Notice that the final link is done with @command{g++} to get the C++
9568 runtime libraries and @option{-lgfortran} is added to get the Fortran
9569 runtime libraries.  In general, when mixing languages in LTO mode, you
9570 should use the same link command options as when mixing languages in a
9571 regular (non-LTO) compilation.
9573 If object files containing GIMPLE bytecode are stored in a library archive, say
9574 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9575 are using a linker with plugin support.  To create static libraries suitable
9576 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9577 and @command{ranlib}; 
9578 to show the symbols of object files with GIMPLE bytecode, use
9579 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9580 and @command{nm} have been compiled with plugin support.  At link time, use the the
9581 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9582 the LTO optimization process:
9584 @smallexample
9585 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9586 @end smallexample
9588 With the linker plugin enabled, the linker extracts the needed
9589 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9590 to make them part of the aggregated GIMPLE image to be optimized.
9592 If you are not using a linker with plugin support and/or do not
9593 enable the linker plugin, then the objects inside @file{libfoo.a}
9594 are extracted and linked as usual, but they do not participate
9595 in the LTO optimization process.  In order to make a static library suitable
9596 for both LTO optimization and usual linkage, compile its object files with
9597 @option{-flto} @option{-ffat-lto-objects}.
9599 Link-time optimizations do not require the presence of the whole program to
9600 operate.  If the program does not require any symbols to be exported, it is
9601 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9602 the interprocedural optimizers to use more aggressive assumptions which may
9603 lead to improved optimization opportunities.
9604 Use of @option{-fwhole-program} is not needed when linker plugin is
9605 active (see @option{-fuse-linker-plugin}).
9607 The current implementation of LTO makes no
9608 attempt to generate bytecode that is portable between different
9609 types of hosts.  The bytecode files are versioned and there is a
9610 strict version check, so bytecode files generated in one version of
9611 GCC do not work with an older or newer version of GCC.
9613 Link-time optimization does not work well with generation of debugging
9614 information.  Combining @option{-flto} with
9615 @option{-g} is currently experimental and expected to produce unexpected
9616 results.
9618 If you specify the optional @var{n}, the optimization and code
9619 generation done at link time is executed in parallel using @var{n}
9620 parallel jobs by utilizing an installed @command{make} program.  The
9621 environment variable @env{MAKE} may be used to override the program
9622 used.  The default value for @var{n} is 1.
9624 You can also specify @option{-flto=jobserver} to use GNU make's
9625 job server mode to determine the number of parallel jobs. This
9626 is useful when the Makefile calling GCC is already executing in parallel.
9627 You must prepend a @samp{+} to the command recipe in the parent Makefile
9628 for this to work.  This option likely only works if @env{MAKE} is
9629 GNU make.
9631 @item -flto-partition=@var{alg}
9632 @opindex flto-partition
9633 Specify the partitioning algorithm used by the link-time optimizer.
9634 The value is either @samp{1to1} to specify a partitioning mirroring
9635 the original source files or @samp{balanced} to specify partitioning
9636 into equally sized chunks (whenever possible) or @samp{max} to create
9637 new partition for every symbol where possible.  Specifying @samp{none}
9638 as an algorithm disables partitioning and streaming completely. 
9639 The default value is @samp{balanced}. While @samp{1to1} can be used
9640 as an workaround for various code ordering issues, the @samp{max}
9641 partitioning is intended for internal testing only.
9642 The value @samp{one} specifies that exactly one partition should be
9643 used while the value @samp{none} bypasses partitioning and executes
9644 the link-time optimization step directly from the WPA phase.
9646 @item -flto-odr-type-merging
9647 @opindex flto-odr-type-merging
9648 Enable streaming of mangled types names of C++ types and their unification
9649 at linktime.  This increases size of LTO object files, but enable
9650 diagnostics about One Definition Rule violations.
9652 @item -flto-compression-level=@var{n}
9653 @opindex flto-compression-level
9654 This option specifies the level of compression used for intermediate
9655 language written to LTO object files, and is only meaningful in
9656 conjunction with LTO mode (@option{-flto}).  Valid
9657 values are 0 (no compression) to 9 (maximum compression).  Values
9658 outside this range are clamped to either 0 or 9.  If the option is not
9659 given, a default balanced compression setting is used.
9661 @item -flto-report
9662 @opindex flto-report
9663 Prints a report with internal details on the workings of the link-time
9664 optimizer.  The contents of this report vary from version to version.
9665 It is meant to be useful to GCC developers when processing object
9666 files in LTO mode (via @option{-flto}).
9668 Disabled by default.
9670 @item -flto-report-wpa
9671 @opindex flto-report-wpa
9672 Like @option{-flto-report}, but only print for the WPA phase of Link
9673 Time Optimization.
9675 @item -fuse-linker-plugin
9676 @opindex fuse-linker-plugin
9677 Enables the use of a linker plugin during link-time optimization.  This
9678 option relies on plugin support in the linker, which is available in gold
9679 or in GNU ld 2.21 or newer.
9681 This option enables the extraction of object files with GIMPLE bytecode out
9682 of library archives. This improves the quality of optimization by exposing
9683 more code to the link-time optimizer.  This information specifies what
9684 symbols can be accessed externally (by non-LTO object or during dynamic
9685 linking).  Resulting code quality improvements on binaries (and shared
9686 libraries that use hidden visibility) are similar to @option{-fwhole-program}.
9687 See @option{-flto} for a description of the effect of this flag and how to
9688 use it.
9690 This option is enabled by default when LTO support in GCC is enabled
9691 and GCC was configured for use with
9692 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9694 @item -ffat-lto-objects
9695 @opindex ffat-lto-objects
9696 Fat LTO objects are object files that contain both the intermediate language
9697 and the object code. This makes them usable for both LTO linking and normal
9698 linking. This option is effective only when compiling with @option{-flto}
9699 and is ignored at link time.
9701 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9702 requires the complete toolchain to be aware of LTO. It requires a linker with
9703 linker plugin support for basic functionality.  Additionally,
9704 @command{nm}, @command{ar} and @command{ranlib}
9705 need to support linker plugins to allow a full-featured build environment
9706 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9707 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9708 to these tools. With non fat LTO makefiles need to be modified to use them.
9710 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9711 support.
9713 @item -fcompare-elim
9714 @opindex fcompare-elim
9715 After register allocation and post-register allocation instruction splitting,
9716 identify arithmetic instructions that compute processor flags similar to a
9717 comparison operation based on that arithmetic.  If possible, eliminate the
9718 explicit comparison operation.
9720 This pass only applies to certain targets that cannot explicitly represent
9721 the comparison operation before register allocation is complete.
9723 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9725 @item -fcprop-registers
9726 @opindex fcprop-registers
9727 After register allocation and post-register allocation instruction splitting,
9728 perform a copy-propagation pass to try to reduce scheduling dependencies
9729 and occasionally eliminate the copy.
9731 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9733 @item -fprofile-correction
9734 @opindex fprofile-correction
9735 Profiles collected using an instrumented binary for multi-threaded programs may
9736 be inconsistent due to missed counter updates. When this option is specified,
9737 GCC uses heuristics to correct or smooth out such inconsistencies. By
9738 default, GCC emits an error message when an inconsistent profile is detected.
9740 @item -fprofile-dir=@var{path}
9741 @opindex fprofile-dir
9743 Set the directory to search for the profile data files in to @var{path}.
9744 This option affects only the profile data generated by
9745 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9746 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9747 and its related options.  Both absolute and relative paths can be used.
9748 By default, GCC uses the current directory as @var{path}, thus the
9749 profile data file appears in the same directory as the object file.
9751 @item -fprofile-generate
9752 @itemx -fprofile-generate=@var{path}
9753 @opindex fprofile-generate
9755 Enable options usually used for instrumenting application to produce
9756 profile useful for later recompilation with profile feedback based
9757 optimization.  You must use @option{-fprofile-generate} both when
9758 compiling and when linking your program.
9760 The following options are enabled: @option{-fprofile-arcs}, @option{-fprofile-values}, @option{-fvpt}.
9762 If @var{path} is specified, GCC looks at the @var{path} to find
9763 the profile feedback data files. See @option{-fprofile-dir}.
9765 @item -fprofile-use
9766 @itemx -fprofile-use=@var{path}
9767 @opindex fprofile-use
9768 Enable profile feedback-directed optimizations, 
9769 and the following optimizations
9770 which are generally profitable only with profile feedback available:
9771 @option{-fbranch-probabilities}, @option{-fvpt},
9772 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9773 @option{-ftree-vectorize}, and @option{ftree-loop-distribute-patterns}.
9775 By default, GCC emits an error message if the feedback profiles do not
9776 match the source code.  This error can be turned into a warning by using
9777 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9778 code.
9780 If @var{path} is specified, GCC looks at the @var{path} to find
9781 the profile feedback data files. See @option{-fprofile-dir}.
9783 @item -fauto-profile
9784 @itemx -fauto-profile=@var{path}
9785 @opindex fauto-profile
9786 Enable sampling-based feedback-directed optimizations, 
9787 and the following optimizations
9788 which are generally profitable only with profile feedback available:
9789 @option{-fbranch-probabilities}, @option{-fvpt},
9790 @option{-funroll-loops}, @option{-fpeel-loops}, @option{-ftracer}, 
9791 @option{-ftree-vectorize},
9792 @option{-finline-functions}, @option{-fipa-cp}, @option{-fipa-cp-clone},
9793 @option{-fpredictive-commoning}, @option{-funswitch-loops},
9794 @option{-fgcse-after-reload}, and @option{-ftree-loop-distribute-patterns}.
9796 @var{path} is the name of a file containing AutoFDO profile information.
9797 If omitted, it defaults to @file{fbdata.afdo} in the current directory.
9799 Producing an AutoFDO profile data file requires running your program
9800 with the @command{perf} utility on a supported GNU/Linux target system.
9801 For more information, see @uref{https://perf.wiki.kernel.org/}.
9803 E.g.
9804 @smallexample
9805 perf record -e br_inst_retired:near_taken -b -o perf.data \
9806     -- your_program
9807 @end smallexample
9809 Then use the @command{create_gcov} tool to convert the raw profile data
9810 to a format that can be used by GCC.@  You must also supply the 
9811 unstripped binary for your program to this tool.  
9812 See @uref{https://github.com/google/autofdo}.
9814 E.g.
9815 @smallexample
9816 create_gcov --binary=your_program.unstripped --profile=perf.data \
9817     --gcov=profile.afdo
9818 @end smallexample
9819 @end table
9821 The following options control compiler behavior regarding floating-point 
9822 arithmetic.  These options trade off between speed and
9823 correctness.  All must be specifically enabled.
9825 @table @gcctabopt
9826 @item -ffloat-store
9827 @opindex ffloat-store
9828 Do not store floating-point variables in registers, and inhibit other
9829 options that might change whether a floating-point value is taken from a
9830 register or memory.
9832 @cindex floating-point precision
9833 This option prevents undesirable excess precision on machines such as
9834 the 68000 where the floating registers (of the 68881) keep more
9835 precision than a @code{double} is supposed to have.  Similarly for the
9836 x86 architecture.  For most programs, the excess precision does only
9837 good, but a few programs rely on the precise definition of IEEE floating
9838 point.  Use @option{-ffloat-store} for such programs, after modifying
9839 them to store all pertinent intermediate computations into variables.
9841 @item -fexcess-precision=@var{style}
9842 @opindex fexcess-precision
9843 This option allows further control over excess precision on machines
9844 where floating-point registers have more precision than the IEEE
9845 @code{float} and @code{double} types and the processor does not
9846 support operations rounding to those types.  By default,
9847 @option{-fexcess-precision=fast} is in effect; this means that
9848 operations are carried out in the precision of the registers and that
9849 it is unpredictable when rounding to the types specified in the source
9850 code takes place.  When compiling C, if
9851 @option{-fexcess-precision=standard} is specified then excess
9852 precision follows the rules specified in ISO C99; in particular,
9853 both casts and assignments cause values to be rounded to their
9854 semantic types (whereas @option{-ffloat-store} only affects
9855 assignments).  This option is enabled by default for C if a strict
9856 conformance option such as @option{-std=c99} is used.
9858 @opindex mfpmath
9859 @option{-fexcess-precision=standard} is not implemented for languages
9860 other than C, and has no effect if
9861 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9862 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9863 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9864 semantics apply without excess precision, and in the latter, rounding
9865 is unpredictable.
9867 @item -ffast-math
9868 @opindex ffast-math
9869 Sets the options @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9870 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9871 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9873 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9875 This option is not turned on by any @option{-O} option besides
9876 @option{-Ofast} since it can result in incorrect output for programs
9877 that depend on an exact implementation of IEEE or ISO rules/specifications
9878 for math functions. It may, however, yield faster code for programs
9879 that do not require the guarantees of these specifications.
9881 @item -fno-math-errno
9882 @opindex fno-math-errno
9883 Do not set @code{errno} after calling math functions that are executed
9884 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9885 IEEE exceptions for math error handling may want to use this flag
9886 for speed while maintaining IEEE arithmetic compatibility.
9888 This option is not turned on by any @option{-O} option since
9889 it can result in incorrect output for programs that depend on
9890 an exact implementation of IEEE or ISO rules/specifications for
9891 math functions. It may, however, yield faster code for programs
9892 that do not require the guarantees of these specifications.
9894 The default is @option{-fmath-errno}.
9896 On Darwin systems, the math library never sets @code{errno}.  There is
9897 therefore no reason for the compiler to consider the possibility that
9898 it might, and @option{-fno-math-errno} is the default.
9900 @item -funsafe-math-optimizations
9901 @opindex funsafe-math-optimizations
9903 Allow optimizations for floating-point arithmetic that (a) assume
9904 that arguments and results are valid and (b) may violate IEEE or
9905 ANSI standards.  When used at link-time, it may include libraries
9906 or startup files that change the default FPU control word or other
9907 similar optimizations.
9909 This option is not turned on by any @option{-O} option since
9910 it can result in incorrect output for programs that depend on
9911 an exact implementation of IEEE or ISO rules/specifications for
9912 math functions. It may, however, yield faster code for programs
9913 that do not require the guarantees of these specifications.
9914 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9915 @option{-fassociative-math} and @option{-freciprocal-math}.
9917 The default is @option{-fno-unsafe-math-optimizations}.
9919 @item -fassociative-math
9920 @opindex fassociative-math
9922 Allow re-association of operands in series of floating-point operations.
9923 This violates the ISO C and C++ language standard by possibly changing
9924 computation result.  NOTE: re-ordering may change the sign of zero as
9925 well as ignore NaNs and inhibit or create underflow or overflow (and
9926 thus cannot be used on code that relies on rounding behavior like
9927 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9928 and thus may not be used when ordered comparisons are required.
9929 This option requires that both @option{-fno-signed-zeros} and
9930 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9931 much sense with @option{-frounding-math}. For Fortran the option
9932 is automatically enabled when both @option{-fno-signed-zeros} and
9933 @option{-fno-trapping-math} are in effect.
9935 The default is @option{-fno-associative-math}.
9937 @item -freciprocal-math
9938 @opindex freciprocal-math
9940 Allow the reciprocal of a value to be used instead of dividing by
9941 the value if this enables optimizations.  For example @code{x / y}
9942 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9943 is subject to common subexpression elimination.  Note that this loses
9944 precision and increases the number of flops operating on the value.
9946 The default is @option{-fno-reciprocal-math}.
9948 @item -ffinite-math-only
9949 @opindex ffinite-math-only
9950 Allow optimizations for floating-point arithmetic that assume
9951 that arguments and results are not NaNs or +-Infs.
9953 This option is not turned on by any @option{-O} option since
9954 it can result in incorrect output for programs that depend on
9955 an exact implementation of IEEE or ISO rules/specifications for
9956 math functions. It may, however, yield faster code for programs
9957 that do not require the guarantees of these specifications.
9959 The default is @option{-fno-finite-math-only}.
9961 @item -fno-signed-zeros
9962 @opindex fno-signed-zeros
9963 Allow optimizations for floating-point arithmetic that ignore the
9964 signedness of zero.  IEEE arithmetic specifies the behavior of
9965 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9966 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9967 This option implies that the sign of a zero result isn't significant.
9969 The default is @option{-fsigned-zeros}.
9971 @item -fno-trapping-math
9972 @opindex fno-trapping-math
9973 Compile code assuming that floating-point operations cannot generate
9974 user-visible traps.  These traps include division by zero, overflow,
9975 underflow, inexact result and invalid operation.  This option requires
9976 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9977 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9979 This option should never be turned on by any @option{-O} option since
9980 it can result in incorrect output for programs that depend on
9981 an exact implementation of IEEE or ISO rules/specifications for
9982 math functions.
9984 The default is @option{-ftrapping-math}.
9986 @item -frounding-math
9987 @opindex frounding-math
9988 Disable transformations and optimizations that assume default floating-point
9989 rounding behavior.  This is round-to-zero for all floating point
9990 to integer conversions, and round-to-nearest for all other arithmetic
9991 truncations.  This option should be specified for programs that change
9992 the FP rounding mode dynamically, or that may be executed with a
9993 non-default rounding mode.  This option disables constant folding of
9994 floating-point expressions at compile time (which may be affected by
9995 rounding mode) and arithmetic transformations that are unsafe in the
9996 presence of sign-dependent rounding modes.
9998 The default is @option{-fno-rounding-math}.
10000 This option is experimental and does not currently guarantee to
10001 disable all GCC optimizations that are affected by rounding mode.
10002 Future versions of GCC may provide finer control of this setting
10003 using C99's @code{FENV_ACCESS} pragma.  This command-line option
10004 will be used to specify the default state for @code{FENV_ACCESS}.
10006 @item -fsignaling-nans
10007 @opindex fsignaling-nans
10008 Compile code assuming that IEEE signaling NaNs may generate user-visible
10009 traps during floating-point operations.  Setting this option disables
10010 optimizations that may change the number of exceptions visible with
10011 signaling NaNs.  This option implies @option{-ftrapping-math}.
10013 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
10014 be defined.
10016 The default is @option{-fno-signaling-nans}.
10018 This option is experimental and does not currently guarantee to
10019 disable all GCC optimizations that affect signaling NaN behavior.
10021 @item -fsingle-precision-constant
10022 @opindex fsingle-precision-constant
10023 Treat floating-point constants as single precision instead of
10024 implicitly converting them to double-precision constants.
10026 @item -fcx-limited-range
10027 @opindex fcx-limited-range
10028 When enabled, this option states that a range reduction step is not
10029 needed when performing complex division.  Also, there is no checking
10030 whether the result of a complex multiplication or division is @code{NaN
10031 + I*NaN}, with an attempt to rescue the situation in that case.  The
10032 default is @option{-fno-cx-limited-range}, but is enabled by
10033 @option{-ffast-math}.
10035 This option controls the default setting of the ISO C99
10036 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
10037 all languages.
10039 @item -fcx-fortran-rules
10040 @opindex fcx-fortran-rules
10041 Complex multiplication and division follow Fortran rules.  Range
10042 reduction is done as part of complex division, but there is no checking
10043 whether the result of a complex multiplication or division is @code{NaN
10044 + I*NaN}, with an attempt to rescue the situation in that case.
10046 The default is @option{-fno-cx-fortran-rules}.
10048 @end table
10050 The following options control optimizations that may improve
10051 performance, but are not enabled by any @option{-O} options.  This
10052 section includes experimental options that may produce broken code.
10054 @table @gcctabopt
10055 @item -fbranch-probabilities
10056 @opindex fbranch-probabilities
10057 After running a program compiled with @option{-fprofile-arcs}
10058 (@pxref{Debugging Options,, Options for Debugging Your Program or
10059 @command{gcc}}), you can compile it a second time using
10060 @option{-fbranch-probabilities}, to improve optimizations based on
10061 the number of times each branch was taken.  When a program
10062 compiled with @option{-fprofile-arcs} exits, it saves arc execution
10063 counts to a file called @file{@var{sourcename}.gcda} for each source
10064 file.  The information in this data file is very dependent on the
10065 structure of the generated code, so you must use the same source code
10066 and the same optimization options for both compilations.
10068 With @option{-fbranch-probabilities}, GCC puts a
10069 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
10070 These can be used to improve optimization.  Currently, they are only
10071 used in one place: in @file{reorg.c}, instead of guessing which path a
10072 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
10073 exactly determine which path is taken more often.
10075 @item -fprofile-values
10076 @opindex fprofile-values
10077 If combined with @option{-fprofile-arcs}, it adds code so that some
10078 data about values of expressions in the program is gathered.
10080 With @option{-fbranch-probabilities}, it reads back the data gathered
10081 from profiling values of expressions for usage in optimizations.
10083 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
10085 @item -fprofile-reorder-functions
10086 @opindex fprofile-reorder-functions
10087 Function reordering based on profile instrumentation collects
10088 first time of execution of a function and orders these functions
10089 in ascending order.
10091 Enabled with @option{-fprofile-use}.
10093 @item -fvpt
10094 @opindex fvpt
10095 If combined with @option{-fprofile-arcs}, this option instructs the compiler
10096 to add code to gather information about values of expressions.
10098 With @option{-fbranch-probabilities}, it reads back the data gathered
10099 and actually performs the optimizations based on them.
10100 Currently the optimizations include specialization of division operations
10101 using the knowledge about the value of the denominator.
10103 @item -frename-registers
10104 @opindex frename-registers
10105 Attempt to avoid false dependencies in scheduled code by making use
10106 of registers left over after register allocation.  This optimization
10107 most benefits processors with lots of registers.  Depending on the
10108 debug information format adopted by the target, however, it can
10109 make debugging impossible, since variables no longer stay in
10110 a ``home register''.
10112 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
10114 @item -fschedule-fusion
10115 @opindex fschedule-fusion
10116 Performs a target dependent pass over the instruction stream to schedule
10117 instructions of same type together because target machine can execute them
10118 more efficiently if they are adjacent to each other in the instruction flow.
10120 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
10122 @item -ftracer
10123 @opindex ftracer
10124 Perform tail duplication to enlarge superblock size.  This transformation
10125 simplifies the control flow of the function allowing other optimizations to do
10126 a better job.
10128 Enabled with @option{-fprofile-use}.
10130 @item -funroll-loops
10131 @opindex funroll-loops
10132 Unroll loops whose number of iterations can be determined at compile time or
10133 upon entry to the loop.  @option{-funroll-loops} implies
10134 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
10135 It also turns on complete loop peeling (i.e.@: complete removal of loops with
10136 a small constant number of iterations).  This option makes code larger, and may
10137 or may not make it run faster.
10139 Enabled with @option{-fprofile-use}.
10141 @item -funroll-all-loops
10142 @opindex funroll-all-loops
10143 Unroll all loops, even if their number of iterations is uncertain when
10144 the loop is entered.  This usually makes programs run more slowly.
10145 @option{-funroll-all-loops} implies the same options as
10146 @option{-funroll-loops}.
10148 @item -fpeel-loops
10149 @opindex fpeel-loops
10150 Peels loops for which there is enough information that they do not
10151 roll much (from profile feedback).  It also turns on complete loop peeling
10152 (i.e.@: complete removal of loops with small constant number of iterations).
10154 Enabled with @option{-fprofile-use}.
10156 @item -fmove-loop-invariants
10157 @opindex fmove-loop-invariants
10158 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
10159 at level @option{-O1}
10161 @item -funswitch-loops
10162 @opindex funswitch-loops
10163 Move branches with loop invariant conditions out of the loop, with duplicates
10164 of the loop on both branches (modified according to result of the condition).
10166 @item -ffunction-sections
10167 @itemx -fdata-sections
10168 @opindex ffunction-sections
10169 @opindex fdata-sections
10170 Place each function or data item into its own section in the output
10171 file if the target supports arbitrary sections.  The name of the
10172 function or the name of the data item determines the section's name
10173 in the output file.
10175 Use these options on systems where the linker can perform optimizations
10176 to improve locality of reference in the instruction space.  Most systems
10177 using the ELF object format and SPARC processors running Solaris 2 have
10178 linkers with such optimizations.  AIX may have these optimizations in
10179 the future.
10181 Only use these options when there are significant benefits from doing
10182 so.  When you specify these options, the assembler and linker
10183 create larger object and executable files and are also slower.
10184 You cannot use @command{gprof} on all systems if you
10185 specify this option, and you may have problems with debugging if
10186 you specify both this option and @option{-g}.
10188 @item -fbranch-target-load-optimize
10189 @opindex fbranch-target-load-optimize
10190 Perform branch target register load optimization before prologue / epilogue
10191 threading.
10192 The use of target registers can typically be exposed only during reload,
10193 thus hoisting loads out of loops and doing inter-block scheduling needs
10194 a separate optimization pass.
10196 @item -fbranch-target-load-optimize2
10197 @opindex fbranch-target-load-optimize2
10198 Perform branch target register load optimization after prologue / epilogue
10199 threading.
10201 @item -fbtr-bb-exclusive
10202 @opindex fbtr-bb-exclusive
10203 When performing branch target register load optimization, don't reuse
10204 branch target registers within any basic block.
10206 @item -fstack-protector
10207 @opindex fstack-protector
10208 Emit extra code to check for buffer overflows, such as stack smashing
10209 attacks.  This is done by adding a guard variable to functions with
10210 vulnerable objects.  This includes functions that call @code{alloca}, and
10211 functions with buffers larger than 8 bytes.  The guards are initialized
10212 when a function is entered and then checked when the function exits.
10213 If a guard check fails, an error message is printed and the program exits.
10215 @item -fstack-protector-all
10216 @opindex fstack-protector-all
10217 Like @option{-fstack-protector} except that all functions are protected.
10219 @item -fstack-protector-strong
10220 @opindex fstack-protector-strong
10221 Like @option{-fstack-protector} but includes additional functions to
10222 be protected --- those that have local array definitions, or have
10223 references to local frame addresses.
10225 @item -fstack-protector-explicit
10226 @opindex fstack-protector-explicit
10227 Like @option{-fstack-protector} but only protects those functions which
10228 have the @code{stack_protect} attribute
10230 @item -fstdarg-opt
10231 @opindex fstdarg-opt
10232 Optimize the prologue of variadic argument functions with respect to usage of
10233 those arguments.
10235 @item -fsection-anchors
10236 @opindex fsection-anchors
10237 Try to reduce the number of symbolic address calculations by using
10238 shared ``anchor'' symbols to address nearby objects.  This transformation
10239 can help to reduce the number of GOT entries and GOT accesses on some
10240 targets.
10242 For example, the implementation of the following function @code{foo}:
10244 @smallexample
10245 static int a, b, c;
10246 int foo (void) @{ return a + b + c; @}
10247 @end smallexample
10249 @noindent
10250 usually calculates the addresses of all three variables, but if you
10251 compile it with @option{-fsection-anchors}, it accesses the variables
10252 from a common anchor point instead.  The effect is similar to the
10253 following pseudocode (which isn't valid C):
10255 @smallexample
10256 int foo (void)
10258   register int *xr = &x;
10259   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
10261 @end smallexample
10263 Not all targets support this option.
10265 @item --param @var{name}=@var{value}
10266 @opindex param
10267 In some places, GCC uses various constants to control the amount of
10268 optimization that is done.  For example, GCC does not inline functions
10269 that contain more than a certain number of instructions.  You can
10270 control some of these constants on the command line using the
10271 @option{--param} option.
10273 The names of specific parameters, and the meaning of the values, are
10274 tied to the internals of the compiler, and are subject to change
10275 without notice in future releases.
10277 In each case, the @var{value} is an integer.  The allowable choices for
10278 @var{name} are:
10280 @table @gcctabopt
10281 @item predictable-branch-outcome
10282 When branch is predicted to be taken with probability lower than this threshold
10283 (in percent), then it is considered well predictable. The default is 10.
10285 @item max-crossjump-edges
10286 The maximum number of incoming edges to consider for cross-jumping.
10287 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
10288 the number of edges incoming to each block.  Increasing values mean
10289 more aggressive optimization, making the compilation time increase with
10290 probably small improvement in executable size.
10292 @item min-crossjump-insns
10293 The minimum number of instructions that must be matched at the end
10294 of two blocks before cross-jumping is performed on them.  This
10295 value is ignored in the case where all instructions in the block being
10296 cross-jumped from are matched.  The default value is 5.
10298 @item max-grow-copy-bb-insns
10299 The maximum code size expansion factor when copying basic blocks
10300 instead of jumping.  The expansion is relative to a jump instruction.
10301 The default value is 8.
10303 @item max-goto-duplication-insns
10304 The maximum number of instructions to duplicate to a block that jumps
10305 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
10306 passes, GCC factors computed gotos early in the compilation process,
10307 and unfactors them as late as possible.  Only computed jumps at the
10308 end of a basic blocks with no more than max-goto-duplication-insns are
10309 unfactored.  The default value is 8.
10311 @item max-delay-slot-insn-search
10312 The maximum number of instructions to consider when looking for an
10313 instruction to fill a delay slot.  If more than this arbitrary number of
10314 instructions are searched, the time savings from filling the delay slot
10315 are minimal, so stop searching.  Increasing values mean more
10316 aggressive optimization, making the compilation time increase with probably
10317 small improvement in execution time.
10319 @item max-delay-slot-live-search
10320 When trying to fill delay slots, the maximum number of instructions to
10321 consider when searching for a block with valid live register
10322 information.  Increasing this arbitrarily chosen value means more
10323 aggressive optimization, increasing the compilation time.  This parameter
10324 should be removed when the delay slot code is rewritten to maintain the
10325 control-flow graph.
10327 @item max-gcse-memory
10328 The approximate maximum amount of memory that can be allocated in
10329 order to perform the global common subexpression elimination
10330 optimization.  If more memory than specified is required, the
10331 optimization is not done.
10333 @item max-gcse-insertion-ratio
10334 If the ratio of expression insertions to deletions is larger than this value
10335 for any expression, then RTL PRE inserts or removes the expression and thus
10336 leaves partially redundant computations in the instruction stream.  The default value is 20.
10338 @item max-pending-list-length
10339 The maximum number of pending dependencies scheduling allows
10340 before flushing the current state and starting over.  Large functions
10341 with few branches or calls can create excessively large lists which
10342 needlessly consume memory and resources.
10344 @item max-modulo-backtrack-attempts
10345 The maximum number of backtrack attempts the scheduler should make
10346 when modulo scheduling a loop.  Larger values can exponentially increase
10347 compilation time.
10349 @item max-inline-insns-single
10350 Several parameters control the tree inliner used in GCC@.
10351 This number sets the maximum number of instructions (counted in GCC's
10352 internal representation) in a single function that the tree inliner
10353 considers for inlining.  This only affects functions declared
10354 inline and methods implemented in a class declaration (C++).
10355 The default value is 400.
10357 @item max-inline-insns-auto
10358 When you use @option{-finline-functions} (included in @option{-O3}),
10359 a lot of functions that would otherwise not be considered for inlining
10360 by the compiler are investigated.  To those functions, a different
10361 (more restrictive) limit compared to functions declared inline can
10362 be applied.
10363 The default value is 40.
10365 @item inline-min-speedup
10366 When estimated performance improvement of caller + callee runtime exceeds this
10367 threshold (in precent), the function can be inlined regardless the limit on
10368 @option{--param max-inline-insns-single} and @option{--param
10369 max-inline-insns-auto}.
10371 @item large-function-insns
10372 The limit specifying really large functions.  For functions larger than this
10373 limit after inlining, inlining is constrained by
10374 @option{--param large-function-growth}.  This parameter is useful primarily
10375 to avoid extreme compilation time caused by non-linear algorithms used by the
10376 back end.
10377 The default value is 2700.
10379 @item large-function-growth
10380 Specifies maximal growth of large function caused by inlining in percents.
10381 The default value is 100 which limits large function growth to 2.0 times
10382 the original size.
10384 @item large-unit-insns
10385 The limit specifying large translation unit.  Growth caused by inlining of
10386 units larger than this limit is limited by @option{--param inline-unit-growth}.
10387 For small units this might be too tight.
10388 For example, consider a unit consisting of function A
10389 that is inline and B that just calls A three times.  If B is small relative to
10390 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
10391 large units consisting of small inlineable functions, however, the overall unit
10392 growth limit is needed to avoid exponential explosion of code size.  Thus for
10393 smaller units, the size is increased to @option{--param large-unit-insns}
10394 before applying @option{--param inline-unit-growth}.  The default is 10000.
10396 @item inline-unit-growth
10397 Specifies maximal overall growth of the compilation unit caused by inlining.
10398 The default value is 20 which limits unit growth to 1.2 times the original
10399 size. Cold functions (either marked cold via an attribute or by profile
10400 feedback) are not accounted into the unit size.
10402 @item ipcp-unit-growth
10403 Specifies maximal overall growth of the compilation unit caused by
10404 interprocedural constant propagation.  The default value is 10 which limits
10405 unit growth to 1.1 times the original size.
10407 @item large-stack-frame
10408 The limit specifying large stack frames.  While inlining the algorithm is trying
10409 to not grow past this limit too much.  The default value is 256 bytes.
10411 @item large-stack-frame-growth
10412 Specifies maximal growth of large stack frames caused by inlining in percents.
10413 The default value is 1000 which limits large stack frame growth to 11 times
10414 the original size.
10416 @item max-inline-insns-recursive
10417 @itemx max-inline-insns-recursive-auto
10418 Specifies the maximum number of instructions an out-of-line copy of a
10419 self-recursive inline
10420 function can grow into by performing recursive inlining.
10422 @option{--param max-inline-insns-recursive} applies to functions
10423 declared inline.
10424 For functions not declared inline, recursive inlining
10425 happens only when @option{-finline-functions} (included in @option{-O3}) is
10426 enabled; @option{--param max-inline-insns-recursive-auto} applies instead.  The
10427 default value is 450.
10429 @item max-inline-recursive-depth
10430 @itemx max-inline-recursive-depth-auto
10431 Specifies the maximum recursion depth used for recursive inlining.
10433 @option{--param max-inline-recursive-depth} applies to functions
10434 declared inline.  For functions not declared inline, recursive inlining
10435 happens only when @option{-finline-functions} (included in @option{-O3}) is
10436 enabled; @option{--param max-inline-recursive-depth-auto} applies instead.  The
10437 default value is 8.
10439 @item min-inline-recursive-probability
10440 Recursive inlining is profitable only for function having deep recursion
10441 in average and can hurt for function having little recursion depth by
10442 increasing the prologue size or complexity of function body to other
10443 optimizers.
10445 When profile feedback is available (see @option{-fprofile-generate}) the actual
10446 recursion depth can be guessed from probability that function recurses via a
10447 given call expression.  This parameter limits inlining only to call expressions
10448 whose probability exceeds the given threshold (in percents).
10449 The default value is 10.
10451 @item early-inlining-insns
10452 Specify growth that the early inliner can make.  In effect it increases
10453 the amount of inlining for code having a large abstraction penalty.
10454 The default value is 14.
10456 @item max-early-inliner-iterations
10457 Limit of iterations of the early inliner.  This basically bounds
10458 the number of nested indirect calls the early inliner can resolve.
10459 Deeper chains are still handled by late inlining.
10461 @item comdat-sharing-probability
10462 Probability (in percent) that C++ inline function with comdat visibility
10463 are shared across multiple compilation units.  The default value is 20.
10465 @item profile-func-internal-id
10466 A parameter to control whether to use function internal id in profile
10467 database lookup. If the value is 0, the compiler uses an id that
10468 is based on function assembler name and filename, which makes old profile
10469 data more tolerant to source changes such as function reordering etc.
10470 The default value is 0.
10472 @item min-vect-loop-bound
10473 The minimum number of iterations under which loops are not vectorized
10474 when @option{-ftree-vectorize} is used.  The number of iterations after
10475 vectorization needs to be greater than the value specified by this option
10476 to allow vectorization.  The default value is 0.
10478 @item gcse-cost-distance-ratio
10479 Scaling factor in calculation of maximum distance an expression
10480 can be moved by GCSE optimizations.  This is currently supported only in the
10481 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10482 is with simple expressions, i.e., the expressions that have cost
10483 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10484 hoisting of simple expressions.  The default value is 10.
10486 @item gcse-unrestricted-cost
10487 Cost, roughly measured as the cost of a single typical machine
10488 instruction, at which GCSE optimizations do not constrain
10489 the distance an expression can travel.  This is currently
10490 supported only in the code hoisting pass.  The lesser the cost,
10491 the more aggressive code hoisting is.  Specifying 0 
10492 allows all expressions to travel unrestricted distances.
10493 The default value is 3.
10495 @item max-hoist-depth
10496 The depth of search in the dominator tree for expressions to hoist.
10497 This is used to avoid quadratic behavior in hoisting algorithm.
10498 The value of 0 does not limit on the search, but may slow down compilation
10499 of huge functions.  The default value is 30.
10501 @item max-tail-merge-comparisons
10502 The maximum amount of similar bbs to compare a bb with.  This is used to
10503 avoid quadratic behavior in tree tail merging.  The default value is 10.
10505 @item max-tail-merge-iterations
10506 The maximum amount of iterations of the pass over the function.  This is used to
10507 limit compilation time in tree tail merging.  The default value is 2.
10509 @item max-unrolled-insns
10510 The maximum number of instructions that a loop may have to be unrolled.
10511 If a loop is unrolled, this parameter also determines how many times
10512 the loop code is unrolled.
10514 @item max-average-unrolled-insns
10515 The maximum number of instructions biased by probabilities of their execution
10516 that a loop may have to be unrolled.  If a loop is unrolled,
10517 this parameter also determines how many times the loop code is unrolled.
10519 @item max-unroll-times
10520 The maximum number of unrollings of a single loop.
10522 @item max-peeled-insns
10523 The maximum number of instructions that a loop may have to be peeled.
10524 If a loop is peeled, this parameter also determines how many times
10525 the loop code is peeled.
10527 @item max-peel-times
10528 The maximum number of peelings of a single loop.
10530 @item max-peel-branches
10531 The maximum number of branches on the hot path through the peeled sequence.
10533 @item max-completely-peeled-insns
10534 The maximum number of insns of a completely peeled loop.
10536 @item max-completely-peel-times
10537 The maximum number of iterations of a loop to be suitable for complete peeling.
10539 @item max-completely-peel-loop-nest-depth
10540 The maximum depth of a loop nest suitable for complete peeling.
10542 @item max-unswitch-insns
10543 The maximum number of insns of an unswitched loop.
10545 @item max-unswitch-level
10546 The maximum number of branches unswitched in a single loop.
10548 @item lim-expensive
10549 The minimum cost of an expensive expression in the loop invariant motion.
10551 @item iv-consider-all-candidates-bound
10552 Bound on number of candidates for induction variables, below which
10553 all candidates are considered for each use in induction variable
10554 optimizations.  If there are more candidates than this,
10555 only the most relevant ones are considered to avoid quadratic time complexity.
10557 @item iv-max-considered-uses
10558 The induction variable optimizations give up on loops that contain more
10559 induction variable uses.
10561 @item iv-always-prune-cand-set-bound
10562 If the number of candidates in the set is smaller than this value,
10563 always try to remove unnecessary ivs from the set
10564 when adding a new one.
10566 @item scev-max-expr-size
10567 Bound on size of expressions used in the scalar evolutions analyzer.
10568 Large expressions slow the analyzer.
10570 @item scev-max-expr-complexity
10571 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10572 Complex expressions slow the analyzer.
10574 @item vect-max-version-for-alignment-checks
10575 The maximum number of run-time checks that can be performed when
10576 doing loop versioning for alignment in the vectorizer.
10578 @item vect-max-version-for-alias-checks
10579 The maximum number of run-time checks that can be performed when
10580 doing loop versioning for alias in the vectorizer.
10582 @item vect-max-peeling-for-alignment
10583 The maximum number of loop peels to enhance access alignment
10584 for vectorizer. Value -1 means 'no limit'.
10586 @item max-iterations-to-track
10587 The maximum number of iterations of a loop the brute-force algorithm
10588 for analysis of the number of iterations of the loop tries to evaluate.
10590 @item hot-bb-count-ws-permille
10591 A basic block profile count is considered hot if it contributes to 
10592 the given permillage (i.e. 0...1000) of the entire profiled execution.
10594 @item hot-bb-frequency-fraction
10595 Select fraction of the entry block frequency of executions of basic block in
10596 function given basic block needs to have to be considered hot.
10598 @item max-predicted-iterations
10599 The maximum number of loop iterations we predict statically.  This is useful
10600 in cases where a function contains a single loop with known bound and
10601 another loop with unknown bound.
10602 The known number of iterations is predicted correctly, while
10603 the unknown number of iterations average to roughly 10.  This means that the
10604 loop without bounds appears artificially cold relative to the other one.
10606 @item builtin-expect-probability
10607 Control the probability of the expression having the specified value. This
10608 parameter takes a percentage (i.e. 0 ... 100) as input.
10609 The default probability of 90 is obtained empirically.
10611 @item align-threshold
10613 Select fraction of the maximal frequency of executions of a basic block in
10614 a function to align the basic block.
10616 @item align-loop-iterations
10618 A loop expected to iterate at least the selected number of iterations is
10619 aligned.
10621 @item tracer-dynamic-coverage
10622 @itemx tracer-dynamic-coverage-feedback
10624 This value is used to limit superblock formation once the given percentage of
10625 executed instructions is covered.  This limits unnecessary code size
10626 expansion.
10628 The @option{tracer-dynamic-coverage-feedback} parameter
10629 is used only when profile
10630 feedback is available.  The real profiles (as opposed to statically estimated
10631 ones) are much less balanced allowing the threshold to be larger value.
10633 @item tracer-max-code-growth
10634 Stop tail duplication once code growth has reached given percentage.  This is
10635 a rather artificial limit, as most of the duplicates are eliminated later in
10636 cross jumping, so it may be set to much higher values than is the desired code
10637 growth.
10639 @item tracer-min-branch-ratio
10641 Stop reverse growth when the reverse probability of best edge is less than this
10642 threshold (in percent).
10644 @item tracer-min-branch-ratio
10645 @itemx tracer-min-branch-ratio-feedback
10647 Stop forward growth if the best edge has probability lower than this
10648 threshold.
10650 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10651 compilation for profile feedback and one for compilation without.  The value
10652 for compilation with profile feedback needs to be more conservative (higher) in
10653 order to make tracer effective.
10655 @item max-cse-path-length
10657 The maximum number of basic blocks on path that CSE considers.
10658 The default is 10.
10660 @item max-cse-insns
10661 The maximum number of instructions CSE processes before flushing.
10662 The default is 1000.
10664 @item ggc-min-expand
10666 GCC uses a garbage collector to manage its own memory allocation.  This
10667 parameter specifies the minimum percentage by which the garbage
10668 collector's heap should be allowed to expand between collections.
10669 Tuning this may improve compilation speed; it has no effect on code
10670 generation.
10672 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10673 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10674 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10675 GCC is not able to calculate RAM on a particular platform, the lower
10676 bound of 30% is used.  Setting this parameter and
10677 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10678 every opportunity.  This is extremely slow, but can be useful for
10679 debugging.
10681 @item ggc-min-heapsize
10683 Minimum size of the garbage collector's heap before it begins bothering
10684 to collect garbage.  The first collection occurs after the heap expands
10685 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10686 tuning this may improve compilation speed, and has no effect on code
10687 generation.
10689 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10690 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10691 with a lower bound of 4096 (four megabytes) and an upper bound of
10692 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10693 particular platform, the lower bound is used.  Setting this parameter
10694 very large effectively disables garbage collection.  Setting this
10695 parameter and @option{ggc-min-expand} to zero causes a full collection
10696 to occur at every opportunity.
10698 @item max-reload-search-insns
10699 The maximum number of instruction reload should look backward for equivalent
10700 register.  Increasing values mean more aggressive optimization, making the
10701 compilation time increase with probably slightly better performance.
10702 The default value is 100.
10704 @item max-cselib-memory-locations
10705 The maximum number of memory locations cselib should take into account.
10706 Increasing values mean more aggressive optimization, making the compilation time
10707 increase with probably slightly better performance.  The default value is 500.
10709 @item reorder-blocks-duplicate
10710 @itemx reorder-blocks-duplicate-feedback
10712 Used by the basic block reordering pass to decide whether to use unconditional
10713 branch or duplicate the code on its destination.  Code is duplicated when its
10714 estimated size is smaller than this value multiplied by the estimated size of
10715 unconditional jump in the hot spots of the program.
10717 The @option{reorder-block-duplicate-feedback} parameter
10718 is used only when profile
10719 feedback is available.  It may be set to higher values than
10720 @option{reorder-block-duplicate} since information about the hot spots is more
10721 accurate.
10723 @item max-sched-ready-insns
10724 The maximum number of instructions ready to be issued the scheduler should
10725 consider at any given time during the first scheduling pass.  Increasing
10726 values mean more thorough searches, making the compilation time increase
10727 with probably little benefit.  The default value is 100.
10729 @item max-sched-region-blocks
10730 The maximum number of blocks in a region to be considered for
10731 interblock scheduling.  The default value is 10.
10733 @item max-pipeline-region-blocks
10734 The maximum number of blocks in a region to be considered for
10735 pipelining in the selective scheduler.  The default value is 15.
10737 @item max-sched-region-insns
10738 The maximum number of insns in a region to be considered for
10739 interblock scheduling.  The default value is 100.
10741 @item max-pipeline-region-insns
10742 The maximum number of insns in a region to be considered for
10743 pipelining in the selective scheduler.  The default value is 200.
10745 @item min-spec-prob
10746 The minimum probability (in percents) of reaching a source block
10747 for interblock speculative scheduling.  The default value is 40.
10749 @item max-sched-extend-regions-iters
10750 The maximum number of iterations through CFG to extend regions.
10751 A value of 0 (the default) disables region extensions.
10753 @item max-sched-insn-conflict-delay
10754 The maximum conflict delay for an insn to be considered for speculative motion.
10755 The default value is 3.
10757 @item sched-spec-prob-cutoff
10758 The minimal probability of speculation success (in percents), so that
10759 speculative insns are scheduled.
10760 The default value is 40.
10762 @item sched-spec-state-edge-prob-cutoff
10763 The minimum probability an edge must have for the scheduler to save its
10764 state across it.
10765 The default value is 10.
10767 @item sched-mem-true-dep-cost
10768 Minimal distance (in CPU cycles) between store and load targeting same
10769 memory locations.  The default value is 1.
10771 @item selsched-max-lookahead
10772 The maximum size of the lookahead window of selective scheduling.  It is a
10773 depth of search for available instructions.
10774 The default value is 50.
10776 @item selsched-max-sched-times
10777 The maximum number of times that an instruction is scheduled during
10778 selective scheduling.  This is the limit on the number of iterations
10779 through which the instruction may be pipelined.  The default value is 2.
10781 @item selsched-max-insns-to-rename
10782 The maximum number of best instructions in the ready list that are considered
10783 for renaming in the selective scheduler.  The default value is 2.
10785 @item sms-min-sc
10786 The minimum value of stage count that swing modulo scheduler
10787 generates.  The default value is 2.
10789 @item max-last-value-rtl
10790 The maximum size measured as number of RTLs that can be recorded in an expression
10791 in combiner for a pseudo register as last known value of that register.  The default
10792 is 10000.
10794 @item max-combine-insns
10795 The maximum number of instructions the RTL combiner tries to combine.
10796 The default value is 2 at @option{-Og} and 4 otherwise.
10798 @item integer-share-limit
10799 Small integer constants can use a shared data structure, reducing the
10800 compiler's memory usage and increasing its speed.  This sets the maximum
10801 value of a shared integer constant.  The default value is 256.
10803 @item ssp-buffer-size
10804 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10805 protection when @option{-fstack-protection} is used.
10807 @item min-size-for-stack-sharing
10808 The minimum size of variables taking part in stack slot sharing when not
10809 optimizing. The default value is 32.
10811 @item max-jump-thread-duplication-stmts
10812 Maximum number of statements allowed in a block that needs to be
10813 duplicated when threading jumps.
10815 @item max-fields-for-field-sensitive
10816 Maximum number of fields in a structure treated in
10817 a field sensitive manner during pointer analysis.  The default is zero
10818 for @option{-O0} and @option{-O1},
10819 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10821 @item prefetch-latency
10822 Estimate on average number of instructions that are executed before
10823 prefetch finishes.  The distance prefetched ahead is proportional
10824 to this constant.  Increasing this number may also lead to less
10825 streams being prefetched (see @option{simultaneous-prefetches}).
10827 @item simultaneous-prefetches
10828 Maximum number of prefetches that can run at the same time.
10830 @item l1-cache-line-size
10831 The size of cache line in L1 cache, in bytes.
10833 @item l1-cache-size
10834 The size of L1 cache, in kilobytes.
10836 @item l2-cache-size
10837 The size of L2 cache, in kilobytes.
10839 @item min-insn-to-prefetch-ratio
10840 The minimum ratio between the number of instructions and the
10841 number of prefetches to enable prefetching in a loop.
10843 @item prefetch-min-insn-to-mem-ratio
10844 The minimum ratio between the number of instructions and the
10845 number of memory references to enable prefetching in a loop.
10847 @item use-canonical-types
10848 Whether the compiler should use the ``canonical'' type system.  By
10849 default, this should always be 1, which uses a more efficient internal
10850 mechanism for comparing types in C++ and Objective-C++.  However, if
10851 bugs in the canonical type system are causing compilation failures,
10852 set this value to 0 to disable canonical types.
10854 @item switch-conversion-max-branch-ratio
10855 Switch initialization conversion refuses to create arrays that are
10856 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10857 branches in the switch.
10859 @item max-partial-antic-length
10860 Maximum length of the partial antic set computed during the tree
10861 partial redundancy elimination optimization (@option{-ftree-pre}) when
10862 optimizing at @option{-O3} and above.  For some sorts of source code
10863 the enhanced partial redundancy elimination optimization can run away,
10864 consuming all of the memory available on the host machine.  This
10865 parameter sets a limit on the length of the sets that are computed,
10866 which prevents the runaway behavior.  Setting a value of 0 for
10867 this parameter allows an unlimited set length.
10869 @item sccvn-max-scc-size
10870 Maximum size of a strongly connected component (SCC) during SCCVN
10871 processing.  If this limit is hit, SCCVN processing for the whole
10872 function is not done and optimizations depending on it are
10873 disabled.  The default maximum SCC size is 10000.
10875 @item sccvn-max-alias-queries-per-access
10876 Maximum number of alias-oracle queries we perform when looking for
10877 redundancies for loads and stores.  If this limit is hit the search
10878 is aborted and the load or store is not considered redundant.  The
10879 number of queries is algorithmically limited to the number of
10880 stores on all paths from the load to the function entry.
10881 The default maxmimum number of queries is 1000.
10883 @item ira-max-loops-num
10884 IRA uses regional register allocation by default.  If a function
10885 contains more loops than the number given by this parameter, only at most
10886 the given number of the most frequently-executed loops form regions
10887 for regional register allocation.  The default value of the
10888 parameter is 100.
10890 @item ira-max-conflict-table-size 
10891 Although IRA uses a sophisticated algorithm to compress the conflict
10892 table, the table can still require excessive amounts of memory for
10893 huge functions.  If the conflict table for a function could be more
10894 than the size in MB given by this parameter, the register allocator
10895 instead uses a faster, simpler, and lower-quality
10896 algorithm that does not require building a pseudo-register conflict table.  
10897 The default value of the parameter is 2000.
10899 @item ira-loop-reserved-regs
10900 IRA can be used to evaluate more accurate register pressure in loops
10901 for decisions to move loop invariants (see @option{-O3}).  The number
10902 of available registers reserved for some other purposes is given
10903 by this parameter.  The default value of the parameter is 2, which is
10904 the minimal number of registers needed by typical instructions.
10905 This value is the best found from numerous experiments.
10907 @item lra-inheritance-ebb-probability-cutoff
10908 LRA tries to reuse values reloaded in registers in subsequent insns.
10909 This optimization is called inheritance.  EBB is used as a region to
10910 do this optimization.  The parameter defines a minimal fall-through
10911 edge probability in percentage used to add BB to inheritance EBB in
10912 LRA.  The default value of the parameter is 40.  The value was chosen
10913 from numerous runs of SPEC2000 on x86-64.
10915 @item loop-invariant-max-bbs-in-loop
10916 Loop invariant motion can be very expensive, both in compilation time and
10917 in amount of needed compile-time memory, with very large loops.  Loops
10918 with more basic blocks than this parameter won't have loop invariant
10919 motion optimization performed on them.  The default value of the
10920 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10922 @item loop-max-datarefs-for-datadeps
10923 Building data dapendencies is expensive for very large loops.  This
10924 parameter limits the number of data references in loops that are
10925 considered for data dependence analysis.  These large loops are no
10926 handled by the optimizations using loop data dependencies.
10927 The default value is 1000.
10929 @item max-vartrack-size
10930 Sets a maximum number of hash table slots to use during variable
10931 tracking dataflow analysis of any function.  If this limit is exceeded
10932 with variable tracking at assignments enabled, analysis for that
10933 function is retried without it, after removing all debug insns from
10934 the function.  If the limit is exceeded even without debug insns, var
10935 tracking analysis is completely disabled for the function.  Setting
10936 the parameter to zero makes it unlimited.
10938 @item max-vartrack-expr-depth
10939 Sets a maximum number of recursion levels when attempting to map
10940 variable names or debug temporaries to value expressions.  This trades
10941 compilation time for more complete debug information.  If this is set too
10942 low, value expressions that are available and could be represented in
10943 debug information may end up not being used; setting this higher may
10944 enable the compiler to find more complex debug expressions, but compile
10945 time and memory use may grow.  The default is 12.
10947 @item min-nondebug-insn-uid
10948 Use uids starting at this parameter for nondebug insns.  The range below
10949 the parameter is reserved exclusively for debug insns created by
10950 @option{-fvar-tracking-assignments}, but debug insns may get
10951 (non-overlapping) uids above it if the reserved range is exhausted.
10953 @item ipa-sra-ptr-growth-factor
10954 IPA-SRA replaces a pointer to an aggregate with one or more new
10955 parameters only when their cumulative size is less or equal to
10956 @option{ipa-sra-ptr-growth-factor} times the size of the original
10957 pointer parameter.
10959 @item sra-max-scalarization-size-Ospeed
10960 @item sra-max-scalarization-size-Osize
10961 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10962 replace scalar parts of aggregates with uses of independent scalar
10963 variables.  These parameters control the maximum size, in storage units,
10964 of aggregate which is considered for replacement when compiling for
10965 speed
10966 (@option{sra-max-scalarization-size-Ospeed}) or size
10967 (@option{sra-max-scalarization-size-Osize}) respectively.
10969 @item tm-max-aggregate-size
10970 When making copies of thread-local variables in a transaction, this
10971 parameter specifies the size in bytes after which variables are
10972 saved with the logging functions as opposed to save/restore code
10973 sequence pairs.  This option only applies when using
10974 @option{-fgnu-tm}.
10976 @item graphite-max-nb-scop-params
10977 To avoid exponential effects in the Graphite loop transforms, the
10978 number of parameters in a Static Control Part (SCoP) is bounded.  The
10979 default value is 10 parameters.  A variable whose value is unknown at
10980 compilation time and defined outside a SCoP is a parameter of the SCoP.
10982 @item graphite-max-bbs-per-function
10983 To avoid exponential effects in the detection of SCoPs, the size of
10984 the functions analyzed by Graphite is bounded.  The default value is
10985 100 basic blocks.
10987 @item loop-block-tile-size
10988 Loop blocking or strip mining transforms, enabled with
10989 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10990 loop in the loop nest by a given number of iterations.  The strip
10991 length can be changed using the @option{loop-block-tile-size}
10992 parameter.  The default value is 51 iterations.
10994 @item loop-unroll-jam-size
10995 Specify the unroll factor for the @option{-floop-unroll-and-jam} option.  The 
10996 default value is 4.
10998 @item loop-unroll-jam-depth
10999 Specify the dimension to be unrolled (counting from the most inner loop)
11000 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
11002 @item ipa-cp-value-list-size
11003 IPA-CP attempts to track all possible values and types passed to a function's
11004 parameter in order to propagate them and perform devirtualization.
11005 @option{ipa-cp-value-list-size} is the maximum number of values and types it
11006 stores per one formal parameter of a function.
11008 @item ipa-cp-eval-threshold
11009 IPA-CP calculates its own score of cloning profitability heuristics
11010 and performs those cloning opportunities with scores that exceed
11011 @option{ipa-cp-eval-threshold}.
11013 @item ipa-cp-recursion-penalty
11014 Percentage penalty the recursive functions will receive when they
11015 are evaluated for cloning.
11017 @item ipa-cp-single-call-penalty
11018 Percentage penalty functions containg a single call to another
11019 function will receive when they are evaluated for cloning.
11022 @item ipa-max-agg-items
11023 IPA-CP is also capable to propagate a number of scalar values passed
11024 in an aggregate. @option{ipa-max-agg-items} controls the maximum
11025 number of such values per one parameter.
11027 @item ipa-cp-loop-hint-bonus
11028 When IPA-CP determines that a cloning candidate would make the number
11029 of iterations of a loop known, it adds a bonus of
11030 @option{ipa-cp-loop-hint-bonus} to the profitability score of
11031 the candidate.
11033 @item ipa-cp-array-index-hint-bonus
11034 When IPA-CP determines that a cloning candidate would make the index of
11035 an array access known, it adds a bonus of
11036 @option{ipa-cp-array-index-hint-bonus} to the profitability
11037 score of the candidate.
11039 @item ipa-max-aa-steps
11040 During its analysis of function bodies, IPA-CP employs alias analysis
11041 in order to track values pointed to by function parameters.  In order
11042 not spend too much time analyzing huge functions, it gives up and
11043 consider all memory clobbered after examining
11044 @option{ipa-max-aa-steps} statements modifying memory.
11046 @item lto-partitions
11047 Specify desired number of partitions produced during WHOPR compilation.
11048 The number of partitions should exceed the number of CPUs used for compilation.
11049 The default value is 32.
11051 @item lto-minpartition
11052 Size of minimal partition for WHOPR (in estimated instructions).
11053 This prevents expenses of splitting very small programs into too many
11054 partitions.
11056 @item cxx-max-namespaces-for-diagnostic-help
11057 The maximum number of namespaces to consult for suggestions when C++
11058 name lookup fails for an identifier.  The default is 1000.
11060 @item sink-frequency-threshold
11061 The maximum relative execution frequency (in percents) of the target block
11062 relative to a statement's original block to allow statement sinking of a
11063 statement.  Larger numbers result in more aggressive statement sinking.
11064 The default value is 75.  A small positive adjustment is applied for
11065 statements with memory operands as those are even more profitable so sink.
11067 @item max-stores-to-sink
11068 The maximum number of conditional stores paires that can be sunk.  Set to 0
11069 if either vectorization (@option{-ftree-vectorize}) or if-conversion
11070 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
11072 @item allow-store-data-races
11073 Allow optimizers to introduce new data races on stores.
11074 Set to 1 to allow, otherwise to 0.  This option is enabled by default
11075 at optimization level @option{-Ofast}.
11077 @item case-values-threshold
11078 The smallest number of different values for which it is best to use a
11079 jump-table instead of a tree of conditional branches.  If the value is
11080 0, use the default for the machine.  The default is 0.
11082 @item tree-reassoc-width
11083 Set the maximum number of instructions executed in parallel in
11084 reassociated tree. This parameter overrides target dependent
11085 heuristics used by default if has non zero value.
11087 @item sched-pressure-algorithm
11088 Choose between the two available implementations of
11089 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
11090 and is the more likely to prevent instructions from being reordered.
11091 Algorithm 2 was designed to be a compromise between the relatively
11092 conservative approach taken by algorithm 1 and the rather aggressive
11093 approach taken by the default scheduler.  It relies more heavily on
11094 having a regular register file and accurate register pressure classes.
11095 See @file{haifa-sched.c} in the GCC sources for more details.
11097 The default choice depends on the target.
11099 @item max-slsr-cand-scan
11100 Set the maximum number of existing candidates that are considered when
11101 seeking a basis for a new straight-line strength reduction candidate.
11103 @item asan-globals
11104 Enable buffer overflow detection for global objects.  This kind
11105 of protection is enabled by default if you are using
11106 @option{-fsanitize=address} option.
11107 To disable global objects protection use @option{--param asan-globals=0}.
11109 @item asan-stack
11110 Enable buffer overflow detection for stack objects.  This kind of
11111 protection is enabled by default when using @option{-fsanitize=address}.
11112 To disable stack protection use @option{--param asan-stack=0} option.
11114 @item asan-instrument-reads
11115 Enable buffer overflow detection for memory reads.  This kind of
11116 protection is enabled by default when using @option{-fsanitize=address}.
11117 To disable memory reads protection use
11118 @option{--param asan-instrument-reads=0}.
11120 @item asan-instrument-writes
11121 Enable buffer overflow detection for memory writes.  This kind of
11122 protection is enabled by default when using @option{-fsanitize=address}.
11123 To disable memory writes protection use
11124 @option{--param asan-instrument-writes=0} option.
11126 @item asan-memintrin
11127 Enable detection for built-in functions.  This kind of protection
11128 is enabled by default when using @option{-fsanitize=address}.
11129 To disable built-in functions protection use
11130 @option{--param asan-memintrin=0}.
11132 @item asan-use-after-return
11133 Enable detection of use-after-return.  This kind of protection
11134 is enabled by default when using @option{-fsanitize=address} option.
11135 To disable use-after-return detection use 
11136 @option{--param asan-use-after-return=0}.
11138 @item asan-instrumentation-with-call-threshold
11139 If number of memory accesses in function being instrumented
11140 is greater or equal to this number, use callbacks instead of inline checks.
11141 E.g. to disable inline code use
11142 @option{--param asan-instrumentation-with-call-threshold=0}.
11144 @item chkp-max-ctor-size
11145 Static constructors generated by Pointer Bounds Checker may become very
11146 large and significantly increase compile time at optimization level
11147 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
11148 in a single generated constructor.  Default value is 5000.
11150 @item max-fsm-thread-path-insns
11151 Maximum number of instructions to copy when duplicating blocks on a
11152 finite state automaton jump thread path.  The default is 100.
11154 @item max-fsm-thread-length
11155 Maximum number of basic blocks on a finite state automaton jump thread
11156 path.  The default is 10.
11158 @item max-fsm-thread-paths
11159 Maximum number of new jump thread paths to create for a finite state
11160 automaton.  The default is 50.
11162 @item parloops-chunk-size
11163 Chunk size of omp schedule for loops parallelized by parloops.  The default
11164 is 0.
11166 @item parloops-schedule
11167 Schedule type of omp schedule for loops parallelized by parloops (static,
11168 dynamic, guided, auto, runtime).  The default is static.
11170 @item max-ssa-name-query-depth
11171 Maximum depth of recursion when querying properties of SSA names in things
11172 like fold routines.  One level of recursion corresponds to following a
11173 use-def chain.
11174 @end table
11175 @end table
11177 @node Preprocessor Options
11178 @section Options Controlling the Preprocessor
11179 @cindex preprocessor options
11180 @cindex options, preprocessor
11182 These options control the C preprocessor, which is run on each C source
11183 file before actual compilation.
11185 If you use the @option{-E} option, nothing is done except preprocessing.
11186 Some of these options make sense only together with @option{-E} because
11187 they cause the preprocessor output to be unsuitable for actual
11188 compilation.
11190 @table @gcctabopt
11191 @item -Wp,@var{option}
11192 @opindex Wp
11193 You can use @option{-Wp,@var{option}} to bypass the compiler driver
11194 and pass @var{option} directly through to the preprocessor.  If
11195 @var{option} contains commas, it is split into multiple options at the
11196 commas.  However, many options are modified, translated or interpreted
11197 by the compiler driver before being passed to the preprocessor, and
11198 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
11199 interface is undocumented and subject to change, so whenever possible
11200 you should avoid using @option{-Wp} and let the driver handle the
11201 options instead.
11203 @item -Xpreprocessor @var{option}
11204 @opindex Xpreprocessor
11205 Pass @var{option} as an option to the preprocessor.  You can use this to
11206 supply system-specific preprocessor options that GCC does not 
11207 recognize.
11209 If you want to pass an option that takes an argument, you must use
11210 @option{-Xpreprocessor} twice, once for the option and once for the argument.
11212 @item -no-integrated-cpp
11213 @opindex no-integrated-cpp
11214 Perform preprocessing as a separate pass before compilation.
11215 By default, GCC performs preprocessing as an integrated part of
11216 input tokenization and parsing.
11217 If this option is provided, the appropriate language front end
11218 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
11219 and Objective-C, respectively) is instead invoked twice,
11220 once for preprocessing only and once for actual compilation
11221 of the preprocessed input.
11222 This option may be useful in conjunction with the @option{-B} or
11223 @option{-wrapper} options to specify an alternate preprocessor or
11224 perform additional processing of the program source between
11225 normal preprocessing and compilation.
11226 @end table
11228 @include cppopts.texi
11230 @node Assembler Options
11231 @section Passing Options to the Assembler
11233 @c prevent bad page break with this line
11234 You can pass options to the assembler.
11236 @table @gcctabopt
11237 @item -Wa,@var{option}
11238 @opindex Wa
11239 Pass @var{option} as an option to the assembler.  If @var{option}
11240 contains commas, it is split into multiple options at the commas.
11242 @item -Xassembler @var{option}
11243 @opindex Xassembler
11244 Pass @var{option} as an option to the assembler.  You can use this to
11245 supply system-specific assembler options that GCC does not
11246 recognize.
11248 If you want to pass an option that takes an argument, you must use
11249 @option{-Xassembler} twice, once for the option and once for the argument.
11251 @end table
11253 @node Link Options
11254 @section Options for Linking
11255 @cindex link options
11256 @cindex options, linking
11258 These options come into play when the compiler links object files into
11259 an executable output file.  They are meaningless if the compiler is
11260 not doing a link step.
11262 @table @gcctabopt
11263 @cindex file names
11264 @item @var{object-file-name}
11265 A file name that does not end in a special recognized suffix is
11266 considered to name an object file or library.  (Object files are
11267 distinguished from libraries by the linker according to the file
11268 contents.)  If linking is done, these object files are used as input
11269 to the linker.
11271 @item -c
11272 @itemx -S
11273 @itemx -E
11274 @opindex c
11275 @opindex S
11276 @opindex E
11277 If any of these options is used, then the linker is not run, and
11278 object file names should not be used as arguments.  @xref{Overall
11279 Options}.
11281 @item -fuse-ld=bfd
11282 @opindex fuse-ld=bfd
11283 Use the @command{bfd} linker instead of the default linker.
11285 @item -fuse-ld=gold
11286 @opindex fuse-ld=gold
11287 Use the @command{gold} linker instead of the default linker.
11289 @cindex Libraries
11290 @item -l@var{library}
11291 @itemx -l @var{library}
11292 @opindex l
11293 Search the library named @var{library} when linking.  (The second
11294 alternative with the library as a separate argument is only for
11295 POSIX compliance and is not recommended.)
11297 It makes a difference where in the command you write this option; the
11298 linker searches and processes libraries and object files in the order they
11299 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
11300 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
11301 to functions in @samp{z}, those functions may not be loaded.
11303 The linker searches a standard list of directories for the library,
11304 which is actually a file named @file{lib@var{library}.a}.  The linker
11305 then uses this file as if it had been specified precisely by name.
11307 The directories searched include several standard system directories
11308 plus any that you specify with @option{-L}.
11310 Normally the files found this way are library files---archive files
11311 whose members are object files.  The linker handles an archive file by
11312 scanning through it for members which define symbols that have so far
11313 been referenced but not defined.  But if the file that is found is an
11314 ordinary object file, it is linked in the usual fashion.  The only
11315 difference between using an @option{-l} option and specifying a file name
11316 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
11317 and searches several directories.
11319 @item -lobjc
11320 @opindex lobjc
11321 You need this special case of the @option{-l} option in order to
11322 link an Objective-C or Objective-C++ program.
11324 @item -nostartfiles
11325 @opindex nostartfiles
11326 Do not use the standard system startup files when linking.
11327 The standard system libraries are used normally, unless @option{-nostdlib}
11328 or @option{-nodefaultlibs} is used.
11330 @item -nodefaultlibs
11331 @opindex nodefaultlibs
11332 Do not use the standard system libraries when linking.
11333 Only the libraries you specify are passed to the linker, and options
11334 specifying linkage of the system libraries, such as @option{-static-libgcc}
11335 or @option{-shared-libgcc}, are ignored.  
11336 The standard startup files are used normally, unless @option{-nostartfiles}
11337 is used.  
11339 The compiler may generate calls to @code{memcmp},
11340 @code{memset}, @code{memcpy} and @code{memmove}.
11341 These entries are usually resolved by entries in
11342 libc.  These entry points should be supplied through some other
11343 mechanism when this option is specified.
11345 @item -nostdlib
11346 @opindex nostdlib
11347 Do not use the standard system startup files or libraries when linking.
11348 No startup files and only the libraries you specify are passed to
11349 the linker, and options specifying linkage of the system libraries, such as
11350 @option{-static-libgcc} or @option{-shared-libgcc}, are ignored.
11352 The compiler may generate calls to @code{memcmp}, @code{memset},
11353 @code{memcpy} and @code{memmove}.
11354 These entries are usually resolved by entries in
11355 libc.  These entry points should be supplied through some other
11356 mechanism when this option is specified.
11358 @cindex @option{-lgcc}, use with @option{-nostdlib}
11359 @cindex @option{-nostdlib} and unresolved references
11360 @cindex unresolved references and @option{-nostdlib}
11361 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
11362 @cindex @option{-nodefaultlibs} and unresolved references
11363 @cindex unresolved references and @option{-nodefaultlibs}
11364 One of the standard libraries bypassed by @option{-nostdlib} and
11365 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
11366 which GCC uses to overcome shortcomings of particular machines, or special
11367 needs for some languages.
11368 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
11369 Collection (GCC) Internals},
11370 for more discussion of @file{libgcc.a}.)
11371 In most cases, you need @file{libgcc.a} even when you want to avoid
11372 other standard libraries.  In other words, when you specify @option{-nostdlib}
11373 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
11374 This ensures that you have no unresolved references to internal GCC
11375 library subroutines.
11376 (An example of such an internal subroutine is @code{__main}, used to ensure C++
11377 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
11378 GNU Compiler Collection (GCC) Internals}.)
11380 @item -pie
11381 @opindex pie
11382 Produce a position independent executable on targets that support it.
11383 For predictable results, you must also specify the same set of options
11384 used for compilation (@option{-fpie}, @option{-fPIE},
11385 or model suboptions) when you specify this linker option.
11387 @item -no-pie
11388 @opindex no-pie
11389 Don't produce a position independent executable.
11391 @item -rdynamic
11392 @opindex rdynamic
11393 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
11394 that support it. This instructs the linker to add all symbols, not
11395 only used ones, to the dynamic symbol table. This option is needed
11396 for some uses of @code{dlopen} or to allow obtaining backtraces
11397 from within a program.
11399 @item -s
11400 @opindex s
11401 Remove all symbol table and relocation information from the executable.
11403 @item -static
11404 @opindex static
11405 On systems that support dynamic linking, this prevents linking with the shared
11406 libraries.  On other systems, this option has no effect.
11408 @item -shared
11409 @opindex shared
11410 Produce a shared object which can then be linked with other objects to
11411 form an executable.  Not all systems support this option.  For predictable
11412 results, you must also specify the same set of options used for compilation
11413 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
11414 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
11415 needs to build supplementary stub code for constructors to work.  On
11416 multi-libbed systems, @samp{gcc -shared} must select the correct support
11417 libraries to link against.  Failing to supply the correct flags may lead
11418 to subtle defects.  Supplying them in cases where they are not necessary
11419 is innocuous.}
11421 @item -shared-libgcc
11422 @itemx -static-libgcc
11423 @opindex shared-libgcc
11424 @opindex static-libgcc
11425 On systems that provide @file{libgcc} as a shared library, these options
11426 force the use of either the shared or static version, respectively.
11427 If no shared version of @file{libgcc} was built when the compiler was
11428 configured, these options have no effect.
11430 There are several situations in which an application should use the
11431 shared @file{libgcc} instead of the static version.  The most common
11432 of these is when the application wishes to throw and catch exceptions
11433 across different shared libraries.  In that case, each of the libraries
11434 as well as the application itself should use the shared @file{libgcc}.
11436 Therefore, the G++ and GCJ drivers automatically add
11437 @option{-shared-libgcc} whenever you build a shared library or a main
11438 executable, because C++ and Java programs typically use exceptions, so
11439 this is the right thing to do.
11441 If, instead, you use the GCC driver to create shared libraries, you may
11442 find that they are not always linked with the shared @file{libgcc}.
11443 If GCC finds, at its configuration time, that you have a non-GNU linker
11444 or a GNU linker that does not support option @option{--eh-frame-hdr},
11445 it links the shared version of @file{libgcc} into shared libraries
11446 by default.  Otherwise, it takes advantage of the linker and optimizes
11447 away the linking with the shared version of @file{libgcc}, linking with
11448 the static version of libgcc by default.  This allows exceptions to
11449 propagate through such shared libraries, without incurring relocation
11450 costs at library load time.
11452 However, if a library or main executable is supposed to throw or catch
11453 exceptions, you must link it using the G++ or GCJ driver, as appropriate
11454 for the languages used in the program, or using the option
11455 @option{-shared-libgcc}, such that it is linked with the shared
11456 @file{libgcc}.
11458 @item -static-libasan
11459 @opindex static-libasan
11460 When the @option{-fsanitize=address} option is used to link a program,
11461 the GCC driver automatically links against @option{libasan}.  If
11462 @file{libasan} is available as a shared library, and the @option{-static}
11463 option is not used, then this links against the shared version of
11464 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11465 driver to link @file{libasan} statically, without necessarily linking
11466 other libraries statically.
11468 @item -static-libtsan
11469 @opindex static-libtsan
11470 When the @option{-fsanitize=thread} option is used to link a program,
11471 the GCC driver automatically links against @option{libtsan}.  If
11472 @file{libtsan} is available as a shared library, and the @option{-static}
11473 option is not used, then this links against the shared version of
11474 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11475 driver to link @file{libtsan} statically, without necessarily linking
11476 other libraries statically.
11478 @item -static-liblsan
11479 @opindex static-liblsan
11480 When the @option{-fsanitize=leak} option is used to link a program,
11481 the GCC driver automatically links against @option{liblsan}.  If
11482 @file{liblsan} is available as a shared library, and the @option{-static}
11483 option is not used, then this links against the shared version of
11484 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11485 driver to link @file{liblsan} statically, without necessarily linking
11486 other libraries statically.
11488 @item -static-libubsan
11489 @opindex static-libubsan
11490 When the @option{-fsanitize=undefined} option is used to link a program,
11491 the GCC driver automatically links against @option{libubsan}.  If
11492 @file{libubsan} is available as a shared library, and the @option{-static}
11493 option is not used, then this links against the shared version of
11494 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11495 driver to link @file{libubsan} statically, without necessarily linking
11496 other libraries statically.
11498 @item -static-libmpx
11499 @opindex static-libmpx
11500 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are
11501 used to link a program, the GCC driver automatically links against
11502 @file{libmpx}.  If @file{libmpx} is available as a shared library,
11503 and the @option{-static} option is not used, then this links against
11504 the shared version of @file{libmpx}.  The @option{-static-libmpx}
11505 option directs the GCC driver to link @file{libmpx} statically,
11506 without necessarily linking other libraries statically.
11508 @item -static-libmpxwrappers
11509 @opindex static-libmpxwrappers
11510 When the @option{-fcheck-pointer bounds} and @option{-mmpx} options are used
11511 to link a program without also using @option{-fno-chkp-use-wrappers}, the
11512 GCC driver automatically links against @file{libmpxwrappers}.  If
11513 @file{libmpxwrappers} is available as a shared library, and the
11514 @option{-static} option is not used, then this links against the shared
11515 version of @file{libmpxwrappers}.  The @option{-static-libmpxwrappers}
11516 option directs the GCC driver to link @file{libmpxwrappers} statically,
11517 without necessarily linking other libraries statically.
11519 @item -static-libstdc++
11520 @opindex static-libstdc++
11521 When the @command{g++} program is used to link a C++ program, it
11522 normally automatically links against @option{libstdc++}.  If
11523 @file{libstdc++} is available as a shared library, and the
11524 @option{-static} option is not used, then this links against the
11525 shared version of @file{libstdc++}.  That is normally fine.  However, it
11526 is sometimes useful to freeze the version of @file{libstdc++} used by
11527 the program without going all the way to a fully static link.  The
11528 @option{-static-libstdc++} option directs the @command{g++} driver to
11529 link @file{libstdc++} statically, without necessarily linking other
11530 libraries statically.
11532 @item -symbolic
11533 @opindex symbolic
11534 Bind references to global symbols when building a shared object.  Warn
11535 about any unresolved references (unless overridden by the link editor
11536 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11537 this option.
11539 @item -T @var{script}
11540 @opindex T
11541 @cindex linker script
11542 Use @var{script} as the linker script.  This option is supported by most
11543 systems using the GNU linker.  On some targets, such as bare-board
11544 targets without an operating system, the @option{-T} option may be required
11545 when linking to avoid references to undefined symbols.
11547 @item -Xlinker @var{option}
11548 @opindex Xlinker
11549 Pass @var{option} as an option to the linker.  You can use this to
11550 supply system-specific linker options that GCC does not recognize.
11552 If you want to pass an option that takes a separate argument, you must use
11553 @option{-Xlinker} twice, once for the option and once for the argument.
11554 For example, to pass @option{-assert definitions}, you must write
11555 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11556 @option{-Xlinker "-assert definitions"}, because this passes the entire
11557 string as a single argument, which is not what the linker expects.
11559 When using the GNU linker, it is usually more convenient to pass
11560 arguments to linker options using the @option{@var{option}=@var{value}}
11561 syntax than as separate arguments.  For example, you can specify
11562 @option{-Xlinker -Map=output.map} rather than
11563 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11564 this syntax for command-line options.
11566 @item -Wl,@var{option}
11567 @opindex Wl
11568 Pass @var{option} as an option to the linker.  If @var{option} contains
11569 commas, it is split into multiple options at the commas.  You can use this
11570 syntax to pass an argument to the option.
11571 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11572 linker.  When using the GNU linker, you can also get the same effect with
11573 @option{-Wl,-Map=output.map}.
11575 @item -u @var{symbol}
11576 @opindex u
11577 Pretend the symbol @var{symbol} is undefined, to force linking of
11578 library modules to define it.  You can use @option{-u} multiple times with
11579 different symbols to force loading of additional library modules.
11581 @item -z @var{keyword}
11582 @opindex z
11583 @option{-z} is passed directly on to the linker along with the keyword
11584 @var{keyword}. See the section in the documentation of your linker for
11585 permitted values and their meanings.
11586 @end table
11588 @node Directory Options
11589 @section Options for Directory Search
11590 @cindex directory options
11591 @cindex options, directory search
11592 @cindex search path
11594 These options specify directories to search for header files, for
11595 libraries and for parts of the compiler:
11597 @table @gcctabopt
11598 @item -I@var{dir}
11599 @opindex I
11600 Add the directory @var{dir} to the head of the list of directories to be
11601 searched for header files.  This can be used to override a system header
11602 file, substituting your own version, since these directories are
11603 searched before the system header file directories.  However, you should
11604 not use this option to add directories that contain vendor-supplied
11605 system header files (use @option{-isystem} for that).  If you use more than
11606 one @option{-I} option, the directories are scanned in left-to-right
11607 order; the standard system directories come after.
11609 If a standard system include directory, or a directory specified with
11610 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11611 option is ignored.  The directory is still searched but as a
11612 system directory at its normal position in the system include chain.
11613 This is to ensure that GCC's procedure to fix buggy system headers and
11614 the ordering for the @code{include_next} directive are not inadvertently changed.
11615 If you really need to change the search order for system directories,
11616 use the @option{-nostdinc} and/or @option{-isystem} options.
11618 @item -iplugindir=@var{dir}
11619 @opindex iplugindir=
11620 Set the directory to search for plugins that are passed
11621 by @option{-fplugin=@var{name}} instead of
11622 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11623 to be used by the user, but only passed by the driver.
11625 @item -iquote@var{dir}
11626 @opindex iquote
11627 Add the directory @var{dir} to the head of the list of directories to
11628 be searched for header files only for the case of @code{#include
11629 "@var{file}"}; they are not searched for @code{#include <@var{file}>},
11630 otherwise just like @option{-I}.
11632 @item -L@var{dir}
11633 @opindex L
11634 Add directory @var{dir} to the list of directories to be searched
11635 for @option{-l}.
11637 @item -B@var{prefix}
11638 @opindex B
11639 This option specifies where to find the executables, libraries,
11640 include files, and data files of the compiler itself.
11642 The compiler driver program runs one or more of the subprograms
11643 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11644 @var{prefix} as a prefix for each program it tries to run, both with and
11645 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11647 For each subprogram to be run, the compiler driver first tries the
11648 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11649 is not specified, the driver tries two standard prefixes, 
11650 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11651 those results in a file name that is found, the unmodified program
11652 name is searched for using the directories specified in your
11653 @env{PATH} environment variable.
11655 The compiler checks to see if the path provided by @option{-B}
11656 refers to a directory, and if necessary it adds a directory
11657 separator character at the end of the path.
11659 @option{-B} prefixes that effectively specify directory names also apply
11660 to libraries in the linker, because the compiler translates these
11661 options into @option{-L} options for the linker.  They also apply to
11662 include files in the preprocessor, because the compiler translates these
11663 options into @option{-isystem} options for the preprocessor.  In this case,
11664 the compiler appends @samp{include} to the prefix.
11666 The runtime support file @file{libgcc.a} can also be searched for using
11667 the @option{-B} prefix, if needed.  If it is not found there, the two
11668 standard prefixes above are tried, and that is all.  The file is left
11669 out of the link if it is not found by those means.
11671 Another way to specify a prefix much like the @option{-B} prefix is to use
11672 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11673 Variables}.
11675 As a special kludge, if the path provided by @option{-B} is
11676 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11677 9, then it is replaced by @file{[dir/]include}.  This is to help
11678 with boot-strapping the compiler.
11680 @item -specs=@var{file}
11681 @opindex specs
11682 Process @var{file} after the compiler reads in the standard @file{specs}
11683 file, in order to override the defaults which the @command{gcc} driver
11684 program uses when determining what switches to pass to @command{cc1},
11685 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11686 @option{-specs=@var{file}} can be specified on the command line, and they
11687 are processed in order, from left to right.
11689 @item --sysroot=@var{dir}
11690 @opindex sysroot
11691 Use @var{dir} as the logical root directory for headers and libraries.
11692 For example, if the compiler normally searches for headers in
11693 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11694 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11696 If you use both this option and the @option{-isysroot} option, then
11697 the @option{--sysroot} option applies to libraries, but the
11698 @option{-isysroot} option applies to header files.
11700 The GNU linker (beginning with version 2.16) has the necessary support
11701 for this option.  If your linker does not support this option, the
11702 header file aspect of @option{--sysroot} still works, but the
11703 library aspect does not.
11705 @item --no-sysroot-suffix
11706 @opindex no-sysroot-suffix
11707 For some targets, a suffix is added to the root directory specified
11708 with @option{--sysroot}, depending on the other options used, so that
11709 headers may for example be found in
11710 @file{@var{dir}/@var{suffix}/usr/include} instead of
11711 @file{@var{dir}/usr/include}.  This option disables the addition of
11712 such a suffix.
11714 @item -I-
11715 @opindex I-
11716 This option has been deprecated.  Please use @option{-iquote} instead for
11717 @option{-I} directories before the @option{-I-} and remove the @option{-I-}
11718 option.
11719 Any directories you specify with @option{-I} options before the @option{-I-}
11720 option are searched only for the case of @code{#include "@var{file}"};
11721 they are not searched for @code{#include <@var{file}>}.
11723 If additional directories are specified with @option{-I} options after
11724 the @option{-I-} option, these directories are searched for all @code{#include}
11725 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11726 this way.)
11728 In addition, the @option{-I-} option inhibits the use of the current
11729 directory (where the current input file came from) as the first search
11730 directory for @code{#include "@var{file}"}.  There is no way to
11731 override this effect of @option{-I-}.  With @option{-I.} you can specify
11732 searching the directory that is current when the compiler is
11733 invoked.  That is not exactly the same as what the preprocessor does
11734 by default, but it is often satisfactory.
11736 @option{-I-} does not inhibit the use of the standard system directories
11737 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11738 independent.
11739 @end table
11741 @c man end
11743 @node Spec Files
11744 @section Specifying Subprocesses and the Switches to Pass to Them
11745 @cindex Spec Files
11747 @command{gcc} is a driver program.  It performs its job by invoking a
11748 sequence of other programs to do the work of compiling, assembling and
11749 linking.  GCC interprets its command-line parameters and uses these to
11750 deduce which programs it should invoke, and which command-line options
11751 it ought to place on their command lines.  This behavior is controlled
11752 by @dfn{spec strings}.  In most cases there is one spec string for each
11753 program that GCC can invoke, but a few programs have multiple spec
11754 strings to control their behavior.  The spec strings built into GCC can
11755 be overridden by using the @option{-specs=} command-line switch to specify
11756 a spec file.
11758 @dfn{Spec files} are plaintext files that are used to construct spec
11759 strings.  They consist of a sequence of directives separated by blank
11760 lines.  The type of directive is determined by the first non-whitespace
11761 character on the line, which can be one of the following:
11763 @table @code
11764 @item %@var{command}
11765 Issues a @var{command} to the spec file processor.  The commands that can
11766 appear here are:
11768 @table @code
11769 @item %include <@var{file}>
11770 @cindex @code{%include}
11771 Search for @var{file} and insert its text at the current point in the
11772 specs file.
11774 @item %include_noerr <@var{file}>
11775 @cindex @code{%include_noerr}
11776 Just like @samp{%include}, but do not generate an error message if the include
11777 file cannot be found.
11779 @item %rename @var{old_name} @var{new_name}
11780 @cindex @code{%rename}
11781 Rename the spec string @var{old_name} to @var{new_name}.
11783 @end table
11785 @item *[@var{spec_name}]:
11786 This tells the compiler to create, override or delete the named spec
11787 string.  All lines after this directive up to the next directive or
11788 blank line are considered to be the text for the spec string.  If this
11789 results in an empty string then the spec is deleted.  (Or, if the
11790 spec did not exist, then nothing happens.)  Otherwise, if the spec
11791 does not currently exist a new spec is created.  If the spec does
11792 exist then its contents are overridden by the text of this
11793 directive, unless the first character of that text is the @samp{+}
11794 character, in which case the text is appended to the spec.
11796 @item [@var{suffix}]:
11797 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11798 and up to the next directive or blank line are considered to make up the
11799 spec string for the indicated suffix.  When the compiler encounters an
11800 input file with the named suffix, it processes the spec string in
11801 order to work out how to compile that file.  For example:
11803 @smallexample
11804 .ZZ:
11805 z-compile -input %i
11806 @end smallexample
11808 This says that any input file whose name ends in @samp{.ZZ} should be
11809 passed to the program @samp{z-compile}, which should be invoked with the
11810 command-line switch @option{-input} and with the result of performing the
11811 @samp{%i} substitution.  (See below.)
11813 As an alternative to providing a spec string, the text following a
11814 suffix directive can be one of the following:
11816 @table @code
11817 @item @@@var{language}
11818 This says that the suffix is an alias for a known @var{language}.  This is
11819 similar to using the @option{-x} command-line switch to GCC to specify a
11820 language explicitly.  For example:
11822 @smallexample
11823 .ZZ:
11824 @@c++
11825 @end smallexample
11827 Says that .ZZ files are, in fact, C++ source files.
11829 @item #@var{name}
11830 This causes an error messages saying:
11832 @smallexample
11833 @var{name} compiler not installed on this system.
11834 @end smallexample
11835 @end table
11837 GCC already has an extensive list of suffixes built into it.
11838 This directive adds an entry to the end of the list of suffixes, but
11839 since the list is searched from the end backwards, it is effectively
11840 possible to override earlier entries using this technique.
11842 @end table
11844 GCC has the following spec strings built into it.  Spec files can
11845 override these strings or create their own.  Note that individual
11846 targets can also add their own spec strings to this list.
11848 @smallexample
11849 asm          Options to pass to the assembler
11850 asm_final    Options to pass to the assembler post-processor
11851 cpp          Options to pass to the C preprocessor
11852 cc1          Options to pass to the C compiler
11853 cc1plus      Options to pass to the C++ compiler
11854 endfile      Object files to include at the end of the link
11855 link         Options to pass to the linker
11856 lib          Libraries to include on the command line to the linker
11857 libgcc       Decides which GCC support library to pass to the linker
11858 linker       Sets the name of the linker
11859 predefines   Defines to be passed to the C preprocessor
11860 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11861              by default
11862 startfile    Object files to include at the start of the link
11863 @end smallexample
11865 Here is a small example of a spec file:
11867 @smallexample
11868 %rename lib                 old_lib
11870 *lib:
11871 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11872 @end smallexample
11874 This example renames the spec called @samp{lib} to @samp{old_lib} and
11875 then overrides the previous definition of @samp{lib} with a new one.
11876 The new definition adds in some extra command-line options before
11877 including the text of the old definition.
11879 @dfn{Spec strings} are a list of command-line options to be passed to their
11880 corresponding program.  In addition, the spec strings can contain
11881 @samp{%}-prefixed sequences to substitute variable text or to
11882 conditionally insert text into the command line.  Using these constructs
11883 it is possible to generate quite complex command lines.
11885 Here is a table of all defined @samp{%}-sequences for spec
11886 strings.  Note that spaces are not generated automatically around the
11887 results of expanding these sequences.  Therefore you can concatenate them
11888 together or combine them with constant text in a single argument.
11890 @table @code
11891 @item %%
11892 Substitute one @samp{%} into the program name or argument.
11894 @item %i
11895 Substitute the name of the input file being processed.
11897 @item %b
11898 Substitute the basename of the input file being processed.
11899 This is the substring up to (and not including) the last period
11900 and not including the directory.
11902 @item %B
11903 This is the same as @samp{%b}, but include the file suffix (text after
11904 the last period).
11906 @item %d
11907 Marks the argument containing or following the @samp{%d} as a
11908 temporary file name, so that that file is deleted if GCC exits
11909 successfully.  Unlike @samp{%g}, this contributes no text to the
11910 argument.
11912 @item %g@var{suffix}
11913 Substitute a file name that has suffix @var{suffix} and is chosen
11914 once per compilation, and mark the argument in the same way as
11915 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11916 name is now chosen in a way that is hard to predict even when previously
11917 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11918 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11919 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11920 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11921 was simply substituted with a file name chosen once per compilation,
11922 without regard to any appended suffix (which was therefore treated
11923 just like ordinary text), making such attacks more likely to succeed.
11925 @item %u@var{suffix}
11926 Like @samp{%g}, but generates a new temporary file name
11927 each time it appears instead of once per compilation.
11929 @item %U@var{suffix}
11930 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11931 new one if there is no such last file name.  In the absence of any
11932 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11933 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11934 involves the generation of two distinct file names, one
11935 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11936 simply substituted with a file name chosen for the previous @samp{%u},
11937 without regard to any appended suffix.
11939 @item %j@var{suffix}
11940 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11941 writable, and if @option{-save-temps} is not used; 
11942 otherwise, substitute the name
11943 of a temporary file, just like @samp{%u}.  This temporary file is not
11944 meant for communication between processes, but rather as a junk
11945 disposal mechanism.
11947 @item %|@var{suffix}
11948 @itemx %m@var{suffix}
11949 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11950 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11951 all.  These are the two most common ways to instruct a program that it
11952 should read from standard input or write to standard output.  If you
11953 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11954 construct: see for example @file{f/lang-specs.h}.
11956 @item %.@var{SUFFIX}
11957 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11958 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11959 terminated by the next space or %.
11961 @item %w
11962 Marks the argument containing or following the @samp{%w} as the
11963 designated output file of this compilation.  This puts the argument
11964 into the sequence of arguments that @samp{%o} substitutes.
11966 @item %o
11967 Substitutes the names of all the output files, with spaces
11968 automatically placed around them.  You should write spaces
11969 around the @samp{%o} as well or the results are undefined.
11970 @samp{%o} is for use in the specs for running the linker.
11971 Input files whose names have no recognized suffix are not compiled
11972 at all, but they are included among the output files, so they are
11973 linked.
11975 @item %O
11976 Substitutes the suffix for object files.  Note that this is
11977 handled specially when it immediately follows @samp{%g, %u, or %U},
11978 because of the need for those to form complete file names.  The
11979 handling is such that @samp{%O} is treated exactly as if it had already
11980 been substituted, except that @samp{%g, %u, and %U} do not currently
11981 support additional @var{suffix} characters following @samp{%O} as they do
11982 following, for example, @samp{.o}.
11984 @item %p
11985 Substitutes the standard macro predefinitions for the
11986 current target machine.  Use this when running @command{cpp}.
11988 @item %P
11989 Like @samp{%p}, but puts @samp{__} before and after the name of each
11990 predefined macro, except for macros that start with @samp{__} or with
11991 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11994 @item %I
11995 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11996 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11997 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11998 and @option{-imultilib} as necessary.
12000 @item %s
12001 Current argument is the name of a library or startup file of some sort.
12002 Search for that file in a standard list of directories and substitute
12003 the full name found.  The current working directory is included in the
12004 list of directories scanned.
12006 @item %T
12007 Current argument is the name of a linker script.  Search for that file
12008 in the current list of directories to scan for libraries. If the file
12009 is located insert a @option{--script} option into the command line
12010 followed by the full path name found.  If the file is not found then
12011 generate an error message.  Note: the current working directory is not
12012 searched.
12014 @item %e@var{str}
12015 Print @var{str} as an error message.  @var{str} is terminated by a newline.
12016 Use this when inconsistent options are detected.
12018 @item %(@var{name})
12019 Substitute the contents of spec string @var{name} at this point.
12021 @item %x@{@var{option}@}
12022 Accumulate an option for @samp{%X}.
12024 @item %X
12025 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
12026 spec string.
12028 @item %Y
12029 Output the accumulated assembler options specified by @option{-Wa}.
12031 @item %Z
12032 Output the accumulated preprocessor options specified by @option{-Wp}.
12034 @item %a
12035 Process the @code{asm} spec.  This is used to compute the
12036 switches to be passed to the assembler.
12038 @item %A
12039 Process the @code{asm_final} spec.  This is a spec string for
12040 passing switches to an assembler post-processor, if such a program is
12041 needed.
12043 @item %l
12044 Process the @code{link} spec.  This is the spec for computing the
12045 command line passed to the linker.  Typically it makes use of the
12046 @samp{%L %G %S %D and %E} sequences.
12048 @item %D
12049 Dump out a @option{-L} option for each directory that GCC believes might
12050 contain startup files.  If the target supports multilibs then the
12051 current multilib directory is prepended to each of these paths.
12053 @item %L
12054 Process the @code{lib} spec.  This is a spec string for deciding which
12055 libraries are included on the command line to the linker.
12057 @item %G
12058 Process the @code{libgcc} spec.  This is a spec string for deciding
12059 which GCC support library is included on the command line to the linker.
12061 @item %S
12062 Process the @code{startfile} spec.  This is a spec for deciding which
12063 object files are the first ones passed to the linker.  Typically
12064 this might be a file named @file{crt0.o}.
12066 @item %E
12067 Process the @code{endfile} spec.  This is a spec string that specifies
12068 the last object files that are passed to the linker.
12070 @item %C
12071 Process the @code{cpp} spec.  This is used to construct the arguments
12072 to be passed to the C preprocessor.
12074 @item %1
12075 Process the @code{cc1} spec.  This is used to construct the options to be
12076 passed to the actual C compiler (@command{cc1}).
12078 @item %2
12079 Process the @code{cc1plus} spec.  This is used to construct the options to be
12080 passed to the actual C++ compiler (@command{cc1plus}).
12082 @item %*
12083 Substitute the variable part of a matched option.  See below.
12084 Note that each comma in the substituted string is replaced by
12085 a single space.
12087 @item %<@code{S}
12088 Remove all occurrences of @code{-S} from the command line.  Note---this
12089 command is position dependent.  @samp{%} commands in the spec string
12090 before this one see @code{-S}, @samp{%} commands in the spec string
12091 after this one do not.
12093 @item %:@var{function}(@var{args})
12094 Call the named function @var{function}, passing it @var{args}.
12095 @var{args} is first processed as a nested spec string, then split
12096 into an argument vector in the usual fashion.  The function returns
12097 a string which is processed as if it had appeared literally as part
12098 of the current spec.
12100 The following built-in spec functions are provided:
12102 @table @code
12103 @item @code{getenv}
12104 The @code{getenv} spec function takes two arguments: an environment
12105 variable name and a string.  If the environment variable is not
12106 defined, a fatal error is issued.  Otherwise, the return value is the
12107 value of the environment variable concatenated with the string.  For
12108 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
12110 @smallexample
12111 %:getenv(TOPDIR /include)
12112 @end smallexample
12114 expands to @file{/path/to/top/include}.
12116 @item @code{if-exists}
12117 The @code{if-exists} spec function takes one argument, an absolute
12118 pathname to a file.  If the file exists, @code{if-exists} returns the
12119 pathname.  Here is a small example of its usage:
12121 @smallexample
12122 *startfile:
12123 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
12124 @end smallexample
12126 @item @code{if-exists-else}
12127 The @code{if-exists-else} spec function is similar to the @code{if-exists}
12128 spec function, except that it takes two arguments.  The first argument is
12129 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
12130 returns the pathname.  If it does not exist, it returns the second argument.
12131 This way, @code{if-exists-else} can be used to select one file or another,
12132 based on the existence of the first.  Here is a small example of its usage:
12134 @smallexample
12135 *startfile:
12136 crt0%O%s %:if-exists(crti%O%s) \
12137 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
12138 @end smallexample
12140 @item @code{replace-outfile}
12141 The @code{replace-outfile} spec function takes two arguments.  It looks for the
12142 first argument in the outfiles array and replaces it with the second argument.  Here
12143 is a small example of its usage:
12145 @smallexample
12146 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
12147 @end smallexample
12149 @item @code{remove-outfile}
12150 The @code{remove-outfile} spec function takes one argument.  It looks for the
12151 first argument in the outfiles array and removes it.  Here is a small example
12152 its usage:
12154 @smallexample
12155 %:remove-outfile(-lm)
12156 @end smallexample
12158 @item @code{pass-through-libs}
12159 The @code{pass-through-libs} spec function takes any number of arguments.  It
12160 finds any @option{-l} options and any non-options ending in @file{.a} (which it
12161 assumes are the names of linker input library archive files) and returns a
12162 result containing all the found arguments each prepended by
12163 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
12164 intended to be passed to the LTO linker plugin.
12166 @smallexample
12167 %:pass-through-libs(%G %L %G)
12168 @end smallexample
12170 @item @code{print-asm-header}
12171 The @code{print-asm-header} function takes no arguments and simply
12172 prints a banner like:
12174 @smallexample
12175 Assembler options
12176 =================
12178 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
12179 @end smallexample
12181 It is used to separate compiler options from assembler options
12182 in the @option{--target-help} output.
12183 @end table
12185 @item %@{@code{S}@}
12186 Substitutes the @code{-S} switch, if that switch is given to GCC@.
12187 If that switch is not specified, this substitutes nothing.  Note that
12188 the leading dash is omitted when specifying this option, and it is
12189 automatically inserted if the substitution is performed.  Thus the spec
12190 string @samp{%@{foo@}} matches the command-line option @option{-foo}
12191 and outputs the command-line option @option{-foo}.
12193 @item %W@{@code{S}@}
12194 Like %@{@code{S}@} but mark last argument supplied within as a file to be
12195 deleted on failure.
12197 @item %@{@code{S}*@}
12198 Substitutes all the switches specified to GCC whose names start
12199 with @code{-S}, but which also take an argument.  This is used for
12200 switches like @option{-o}, @option{-D}, @option{-I}, etc.
12201 GCC considers @option{-o foo} as being
12202 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
12203 text, including the space.  Thus two arguments are generated.
12205 @item %@{@code{S}*&@code{T}*@}
12206 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
12207 (the order of @code{S} and @code{T} in the spec is not significant).
12208 There can be any number of ampersand-separated variables; for each the
12209 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
12211 @item %@{@code{S}:@code{X}@}
12212 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
12214 @item %@{!@code{S}:@code{X}@}
12215 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
12217 @item %@{@code{S}*:@code{X}@}
12218 Substitutes @code{X} if one or more switches whose names start with
12219 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
12220 once, no matter how many such switches appeared.  However, if @code{%*}
12221 appears somewhere in @code{X}, then @code{X} is substituted once
12222 for each matching switch, with the @code{%*} replaced by the part of
12223 that switch matching the @code{*}.
12225 If @code{%*} appears as the last part of a spec sequence then a space
12226 is added after the end of the last substitution.  If there is more
12227 text in the sequence, however, then a space is not generated.  This
12228 allows the @code{%*} substitution to be used as part of a larger
12229 string.  For example, a spec string like this:
12231 @smallexample
12232 %@{mcu=*:--script=%*/memory.ld@}
12233 @end smallexample
12235 @noindent
12236 when matching an option like @option{-mcu=newchip} produces:
12238 @smallexample
12239 --script=newchip/memory.ld
12240 @end smallexample
12242 @item %@{.@code{S}:@code{X}@}
12243 Substitutes @code{X}, if processing a file with suffix @code{S}.
12245 @item %@{!.@code{S}:@code{X}@}
12246 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
12248 @item %@{,@code{S}:@code{X}@}
12249 Substitutes @code{X}, if processing a file for language @code{S}.
12251 @item %@{!,@code{S}:@code{X}@}
12252 Substitutes @code{X}, if not processing a file for language @code{S}.
12254 @item %@{@code{S}|@code{P}:@code{X}@}
12255 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
12256 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
12257 @code{*} sequences as well, although they have a stronger binding than
12258 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
12259 alternatives must be starred, and only the first matching alternative
12260 is substituted.
12262 For example, a spec string like this:
12264 @smallexample
12265 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
12266 @end smallexample
12268 @noindent
12269 outputs the following command-line options from the following input
12270 command-line options:
12272 @smallexample
12273 fred.c        -foo -baz
12274 jim.d         -bar -boggle
12275 -d fred.c     -foo -baz -boggle
12276 -d jim.d      -bar -baz -boggle
12277 @end smallexample
12279 @item %@{S:X; T:Y; :D@}
12281 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
12282 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
12283 be as many clauses as you need.  This may be combined with @code{.},
12284 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
12287 @end table
12289 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
12290 construct may contain other nested @samp{%} constructs or spaces, or
12291 even newlines.  They are processed as usual, as described above.
12292 Trailing white space in @code{X} is ignored.  White space may also
12293 appear anywhere on the left side of the colon in these constructs,
12294 except between @code{.} or @code{*} and the corresponding word.
12296 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
12297 handled specifically in these constructs.  If another value of
12298 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
12299 @option{-W} switch is found later in the command line, the earlier
12300 switch value is ignored, except with @{@code{S}*@} where @code{S} is
12301 just one letter, which passes all matching options.
12303 The character @samp{|} at the beginning of the predicate text is used to
12304 indicate that a command should be piped to the following command, but
12305 only if @option{-pipe} is specified.
12307 It is built into GCC which switches take arguments and which do not.
12308 (You might think it would be useful to generalize this to allow each
12309 compiler's spec to say which switches take arguments.  But this cannot
12310 be done in a consistent fashion.  GCC cannot even decide which input
12311 files have been specified without knowing which switches take arguments,
12312 and it must know which input files to compile in order to tell which
12313 compilers to run).
12315 GCC also knows implicitly that arguments starting in @option{-l} are to be
12316 treated as compiler output files, and passed to the linker in their
12317 proper position among the other output files.
12319 @c man begin OPTIONS
12321 @node Target Options
12322 @section Specifying Target Machine and Compiler Version
12323 @cindex target options
12324 @cindex cross compiling
12325 @cindex specifying machine version
12326 @cindex specifying compiler version and target machine
12327 @cindex compiler version, specifying
12328 @cindex target machine, specifying
12330 The usual way to run GCC is to run the executable called @command{gcc}, or
12331 @command{@var{machine}-gcc} when cross-compiling, or
12332 @command{@var{machine}-gcc-@var{version}} to run a version other than the
12333 one that was installed last.
12335 @node Submodel Options
12336 @section Hardware Models and Configurations
12337 @cindex submodel options
12338 @cindex specifying hardware config
12339 @cindex hardware models and configurations, specifying
12340 @cindex machine dependent options
12342 Each target machine types can have its own
12343 special options, starting with @samp{-m}, to choose among various
12344 hardware models or configurations---for example, 68010 vs 68020,
12345 floating coprocessor or none.  A single installed version of the
12346 compiler can compile for any model or configuration, according to the
12347 options specified.
12349 Some configurations of the compiler also support additional special
12350 options, usually for compatibility with other compilers on the same
12351 platform.
12353 @c This list is ordered alphanumerically by subsection name.
12354 @c It should be the same order and spelling as these options are listed
12355 @c in Machine Dependent Options
12357 @menu
12358 * AArch64 Options::
12359 * Adapteva Epiphany Options::
12360 * ARC Options::
12361 * ARM Options::
12362 * AVR Options::
12363 * Blackfin Options::
12364 * C6X Options::
12365 * CRIS Options::
12366 * CR16 Options::
12367 * Darwin Options::
12368 * DEC Alpha Options::
12369 * FR30 Options::
12370 * FT32 Options::
12371 * FRV Options::
12372 * GNU/Linux Options::
12373 * H8/300 Options::
12374 * HPPA Options::
12375 * IA-64 Options::
12376 * LM32 Options::
12377 * M32C Options::
12378 * M32R/D Options::
12379 * M680x0 Options::
12380 * MCore Options::
12381 * MeP Options::
12382 * MicroBlaze Options::
12383 * MIPS Options::
12384 * MMIX Options::
12385 * MN10300 Options::
12386 * Moxie Options::
12387 * MSP430 Options::
12388 * NDS32 Options::
12389 * Nios II Options::
12390 * Nvidia PTX Options::
12391 * PDP-11 Options::
12392 * picoChip Options::
12393 * PowerPC Options::
12394 * RL78 Options::
12395 * RS/6000 and PowerPC Options::
12396 * RX Options::
12397 * S/390 and zSeries Options::
12398 * Score Options::
12399 * SH Options::
12400 * Solaris 2 Options::
12401 * SPARC Options::
12402 * SPU Options::
12403 * System V Options::
12404 * TILE-Gx Options::
12405 * TILEPro Options::
12406 * V850 Options::
12407 * VAX Options::
12408 * Visium Options::
12409 * VMS Options::
12410 * VxWorks Options::
12411 * x86 Options::
12412 * x86 Windows Options::
12413 * Xstormy16 Options::
12414 * Xtensa Options::
12415 * zSeries Options::
12416 @end menu
12418 @node AArch64 Options
12419 @subsection AArch64 Options
12420 @cindex AArch64 Options
12422 These options are defined for AArch64 implementations:
12424 @table @gcctabopt
12426 @item -mabi=@var{name}
12427 @opindex mabi
12428 Generate code for the specified data model.  Permissible values
12429 are @samp{ilp32} for SysV-like data model where int, long int and pointer
12430 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
12431 but long int and pointer are 64-bit.
12433 The default depends on the specific target configuration.  Note that
12434 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
12435 entire program with the same ABI, and link with a compatible set of libraries.
12437 @item -mbig-endian
12438 @opindex mbig-endian
12439 Generate big-endian code.  This is the default when GCC is configured for an
12440 @samp{aarch64_be-*-*} target.
12442 @item -mgeneral-regs-only
12443 @opindex mgeneral-regs-only
12444 Generate code which uses only the general-purpose registers.  This is equivalent
12445 to feature modifier @option{nofp} of @option{-march} or @option{-mcpu}, except
12446 that @option{-mgeneral-regs-only} takes precedence over any conflicting feature
12447 modifier regardless of sequence.
12449 @item -mlittle-endian
12450 @opindex mlittle-endian
12451 Generate little-endian code.  This is the default when GCC is configured for an
12452 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
12454 @item -mcmodel=tiny
12455 @opindex mcmodel=tiny
12456 Generate code for the tiny code model.  The program and its statically defined
12457 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
12458 be statically or dynamically linked.  This model is not fully implemented and
12459 mostly treated as @samp{small}.
12461 @item -mcmodel=small
12462 @opindex mcmodel=small
12463 Generate code for the small code model.  The program and its statically defined
12464 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
12465 be statically or dynamically linked.  This is the default code model.
12467 @item -mcmodel=large
12468 @opindex mcmodel=large
12469 Generate code for the large code model.  This makes no assumptions about
12470 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
12471 statically linked only.
12473 @item -mstrict-align
12474 @opindex mstrict-align
12475 Do not assume that unaligned memory references are handled by the system.
12477 @item -momit-leaf-frame-pointer
12478 @itemx -mno-omit-leaf-frame-pointer
12479 @opindex momit-leaf-frame-pointer
12480 @opindex mno-omit-leaf-frame-pointer
12481 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
12482 default.
12484 @item -mtls-dialect=desc
12485 @opindex mtls-dialect=desc
12486 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12487 of TLS variables.  This is the default.
12489 @item -mtls-dialect=traditional
12490 @opindex mtls-dialect=traditional
12491 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12492 of TLS variables.
12494 @item -mtls-size=@var{size}
12495 @opindex mtls-size
12496 Specify bit size of immediate TLS offsets.  Valid values are 12, 24, 32, 48.
12497 This option depends on binutils higher than 2.25.
12499 @item -mfix-cortex-a53-835769
12500 @itemx -mno-fix-cortex-a53-835769
12501 @opindex mfix-cortex-a53-835769
12502 @opindex mno-fix-cortex-a53-835769
12503 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12504 This involves inserting a NOP instruction between memory instructions and
12505 64-bit integer multiply-accumulate instructions.
12507 @item -mfix-cortex-a53-843419
12508 @itemx -mno-fix-cortex-a53-843419
12509 @opindex mfix-cortex-a53-843419
12510 @opindex mno-fix-cortex-a53-843419
12511 Enable or disable the workaround for the ARM Cortex-A53 erratum number 843419.
12512 This erratum workaround is made at link time and this will only pass the
12513 corresponding flag to the linker.
12515 @item -march=@var{name}
12516 @opindex march
12517 Specify the name of the target architecture, optionally suffixed by one or
12518 more feature modifiers.  This option has the form
12519 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}.
12521 The permissible values for @var{arch} are @samp{armv8-a} or
12522 @samp{armv8.1-a}.
12524 For the permissible values for @var{feature}, see the sub-section on
12525 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12526 Feature Modifiers}.  Where conflicting feature modifiers are
12527 specified, the right-most feature is used.
12529 Additionally on native AArch64 GNU/Linux systems the value
12530 @samp{native} is available.  This option causes the compiler to pick the
12531 architecture of the host system.  If the compiler is unable to recognize the
12532 architecture of the host system this option has no effect.
12534 GCC uses @var{name} to determine what kind of instructions it can emit
12535 when generating assembly code.  If @option{-march} is specified
12536 without either of @option{-mtune} or @option{-mcpu} also being
12537 specified, the code is tuned to perform well across a range of target
12538 processors implementing the target architecture.
12540 @item -mtune=@var{name}
12541 @opindex mtune
12542 Specify the name of the target processor for which GCC should tune the
12543 performance of the code.  Permissible values for this option are:
12544 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
12545 @samp{exynos-m1}, @samp{thunderx}, @samp{xgene1}.
12547 Additionally, this option can specify that GCC should tune the performance
12548 of the code for a big.LITTLE system.  Permissible values for this
12549 option are: @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
12551 Additionally on native AArch64 GNU/Linux systems the value
12552 @samp{native} is available.  This option causes the compiler to pick
12553 the architecture of and tune the performance of the code for the
12554 processor of the host system.  If the compiler is unable to recognize
12555 the processor of the host system this option has no effect.
12557 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12558 are specified, the code is tuned to perform well across a range
12559 of target processors.
12561 This option cannot be suffixed by feature modifiers.
12563 @item -mcpu=@var{name}
12564 @opindex mcpu
12565 Specify the name of the target processor, optionally suffixed by one
12566 or more feature modifiers.  This option has the form
12567 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where
12568 the permissible values for @var{cpu} are the same as those available
12569 for @option{-mtune}.  The permissible values for @var{feature} are
12570 documented in the sub-section on
12571 @ref{aarch64-feature-modifiers,,@option{-march} and @option{-mcpu}
12572 Feature Modifiers}.  Where conflicting feature modifiers are
12573 specified, the right-most feature is used.
12575 Additionally on native AArch64 GNU/Linux systems the value
12576 @samp{native} is available.  This option causes the compiler to tune
12577 the performance of the code for the processor of the host system.  If
12578 the compiler is unable to recognize the processor of the host system
12579 this option has no effect.
12581 GCC uses @var{name} to determine what kind of instructions it can emit when
12582 generating assembly code (as if by @option{-march}) and to determine
12583 the target processor for which to tune for performance (as if
12584 by @option{-mtune}).  Where this option is used in conjunction
12585 with @option{-march} or @option{-mtune}, those options take precedence
12586 over the appropriate part of this option.
12588 @item -moverride=@var{string}
12589 @opindex moverride
12590 Override tuning decisions made by the back-end in response to a
12591 @option{-mtune=} switch.  The syntax, semantics, and accepted values
12592 for @var{string} in this option are not guaranteed to be consistent
12593 across releases.
12595 This option is only intended to be useful when developing GCC.
12597 @item -mpc-relative-literal-loads
12598 @opindex mpcrelativeliteralloads
12599 Enable PC relative literal loads. If this option is used, literal
12600 pools are assumed to have a range of up to 1MiB and an appropriate
12601 instruction sequence is used. This option has no impact when used
12602 with @option{-mcmodel=tiny}.
12604 @end table
12606 @subsubsection @option{-march} and @option{-mcpu} Feature Modifiers
12607 @anchor{aarch64-feature-modifiers}
12608 @cindex @option{-march} feature modifiers
12609 @cindex @option{-mcpu} feature modifiers
12610 Feature modifiers used with @option{-march} and @option{-mcpu} can be any of
12611 the following and their inverses @option{no@var{feature}}:
12613 @table @samp
12614 @item crc
12615 Enable CRC extension.
12616 @item crypto
12617 Enable Crypto extension.  This also enables Advanced SIMD and floating-point
12618 instructions.
12619 @item fp
12620 Enable floating-point instructions.  This is on by default for all possible
12621 values for options @option{-march} and @option{-mcpu}.
12622 @item simd
12623 Enable Advanced SIMD instructions.  This also enables floating-point
12624 instructions.  This is on by default for all possible values for options
12625 @option{-march} and @option{-mcpu}.
12626 @item lse
12627 Enable Large System Extension instructions.
12628 @item pan
12629 Enable Privileged Access Never support.
12630 @item lor
12631 Enable Limited Ordering Regions support.
12632 @item rdma
12633 Enable ARMv8.1 Advanced SIMD instructions.  This implies Advanced SIMD
12634 is enabled.
12636 @end table
12638 That is, @option{crypto} implies @option{simd} implies @option{fp}.
12639 Conversely, @option{nofp} (or equivalently, @option{-mgeneral-regs-only})
12640 implies @option{nosimd} implies @option{nocrypto}.
12642 @node Adapteva Epiphany Options
12643 @subsection Adapteva Epiphany Options
12645 These @samp{-m} options are defined for Adapteva Epiphany:
12647 @table @gcctabopt
12648 @item -mhalf-reg-file
12649 @opindex mhalf-reg-file
12650 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12651 That allows code to run on hardware variants that lack these registers.
12653 @item -mprefer-short-insn-regs
12654 @opindex mprefer-short-insn-regs
12655 Preferrentially allocate registers that allow short instruction generation.
12656 This can result in increased instruction count, so this may either reduce or
12657 increase overall code size.
12659 @item -mbranch-cost=@var{num}
12660 @opindex mbranch-cost
12661 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12662 This cost is only a heuristic and is not guaranteed to produce
12663 consistent results across releases.
12665 @item -mcmove
12666 @opindex mcmove
12667 Enable the generation of conditional moves.
12669 @item -mnops=@var{num}
12670 @opindex mnops
12671 Emit @var{num} NOPs before every other generated instruction.
12673 @item -mno-soft-cmpsf
12674 @opindex mno-soft-cmpsf
12675 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12676 and test the flags.  This is faster than a software comparison, but can
12677 get incorrect results in the presence of NaNs, or when two different small
12678 numbers are compared such that their difference is calculated as zero.
12679 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12680 software comparisons.
12682 @item -mstack-offset=@var{num}
12683 @opindex mstack-offset
12684 Set the offset between the top of the stack and the stack pointer.
12685 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12686 can be used by leaf functions without stack allocation.
12687 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12688 Note also that this option changes the ABI; compiling a program with a
12689 different stack offset than the libraries have been compiled with
12690 generally does not work.
12691 This option can be useful if you want to evaluate if a different stack
12692 offset would give you better code, but to actually use a different stack
12693 offset to build working programs, it is recommended to configure the
12694 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12696 @item -mno-round-nearest
12697 @opindex mno-round-nearest
12698 Make the scheduler assume that the rounding mode has been set to
12699 truncating.  The default is @option{-mround-nearest}.
12701 @item -mlong-calls
12702 @opindex mlong-calls
12703 If not otherwise specified by an attribute, assume all calls might be beyond
12704 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12705 function address into a register before performing a (otherwise direct) call.
12706 This is the default.
12708 @item -mshort-calls
12709 @opindex short-calls
12710 If not otherwise specified by an attribute, assume all direct calls are
12711 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12712 for direct calls.  The default is @option{-mlong-calls}.
12714 @item -msmall16
12715 @opindex msmall16
12716 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12717 apply to function addresses for which @option{-mlong-calls} semantics
12718 are in effect.
12720 @item -mfp-mode=@var{mode}
12721 @opindex mfp-mode
12722 Set the prevailing mode of the floating-point unit.
12723 This determines the floating-point mode that is provided and expected
12724 at function call and return time.  Making this mode match the mode you
12725 predominantly need at function start can make your programs smaller and
12726 faster by avoiding unnecessary mode switches.
12728 @var{mode} can be set to one the following values:
12730 @table @samp
12731 @item caller
12732 Any mode at function entry is valid, and retained or restored when
12733 the function returns, and when it calls other functions.
12734 This mode is useful for compiling libraries or other compilation units
12735 you might want to incorporate into different programs with different
12736 prevailing FPU modes, and the convenience of being able to use a single
12737 object file outweighs the size and speed overhead for any extra
12738 mode switching that might be needed, compared with what would be needed
12739 with a more specific choice of prevailing FPU mode.
12741 @item truncate
12742 This is the mode used for floating-point calculations with
12743 truncating (i.e.@: round towards zero) rounding mode.  That includes
12744 conversion from floating point to integer.
12746 @item round-nearest
12747 This is the mode used for floating-point calculations with
12748 round-to-nearest-or-even rounding mode.
12750 @item int
12751 This is the mode used to perform integer calculations in the FPU, e.g.@:
12752 integer multiply, or integer multiply-and-accumulate.
12753 @end table
12755 The default is @option{-mfp-mode=caller}
12757 @item -mnosplit-lohi
12758 @itemx -mno-postinc
12759 @itemx -mno-postmodify
12760 @opindex mnosplit-lohi
12761 @opindex mno-postinc
12762 @opindex mno-postmodify
12763 Code generation tweaks that disable, respectively, splitting of 32-bit
12764 loads, generation of post-increment addresses, and generation of
12765 post-modify addresses.  The defaults are @option{msplit-lohi},
12766 @option{-mpost-inc}, and @option{-mpost-modify}.
12768 @item -mnovect-double
12769 @opindex mno-vect-double
12770 Change the preferred SIMD mode to SImode.  The default is
12771 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12773 @item -max-vect-align=@var{num}
12774 @opindex max-vect-align
12775 The maximum alignment for SIMD vector mode types.
12776 @var{num} may be 4 or 8.  The default is 8.
12777 Note that this is an ABI change, even though many library function
12778 interfaces are unaffected if they don't use SIMD vector modes
12779 in places that affect size and/or alignment of relevant types.
12781 @item -msplit-vecmove-early
12782 @opindex msplit-vecmove-early
12783 Split vector moves into single word moves before reload.  In theory this
12784 can give better register allocation, but so far the reverse seems to be
12785 generally the case.
12787 @item -m1reg-@var{reg}
12788 @opindex m1reg-
12789 Specify a register to hold the constant @minus{}1, which makes loading small negative
12790 constants and certain bitmasks faster.
12791 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12792 which specify use of that register as a fixed register,
12793 and @samp{none}, which means that no register is used for this
12794 purpose.  The default is @option{-m1reg-none}.
12796 @end table
12798 @node ARC Options
12799 @subsection ARC Options
12800 @cindex ARC options
12802 The following options control the architecture variant for which code
12803 is being compiled:
12805 @c architecture variants
12806 @table @gcctabopt
12808 @item -mbarrel-shifter
12809 @opindex mbarrel-shifter
12810 Generate instructions supported by barrel shifter.  This is the default
12811 unless @option{-mcpu=ARC601} is in effect.
12813 @item -mcpu=@var{cpu}
12814 @opindex mcpu
12815 Set architecture type, register usage, and instruction scheduling
12816 parameters for @var{cpu}.  There are also shortcut alias options
12817 available for backward compatibility and convenience.  Supported
12818 values for @var{cpu} are
12820 @table @samp
12821 @opindex mA6
12822 @opindex mARC600
12823 @item ARC600
12824 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12826 @item ARC601
12827 @opindex mARC601
12828 Compile for ARC601.  Alias: @option{-mARC601}.
12830 @item ARC700
12831 @opindex mA7
12832 @opindex mARC700
12833 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12834 This is the default when configured with @option{--with-cpu=arc700}@.
12835 @end table
12837 @item -mdpfp
12838 @opindex mdpfp
12839 @itemx -mdpfp-compact
12840 @opindex mdpfp-compact
12841 FPX: Generate Double Precision FPX instructions, tuned for the compact
12842 implementation.
12844 @item -mdpfp-fast
12845 @opindex mdpfp-fast
12846 FPX: Generate Double Precision FPX instructions, tuned for the fast
12847 implementation.
12849 @item -mno-dpfp-lrsr
12850 @opindex mno-dpfp-lrsr
12851 Disable LR and SR instructions from using FPX extension aux registers.
12853 @item -mea
12854 @opindex mea
12855 Generate Extended arithmetic instructions.  Currently only
12856 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12857 supported.  This is always enabled for @option{-mcpu=ARC700}.
12859 @item -mno-mpy
12860 @opindex mno-mpy
12861 Do not generate mpy instructions for ARC700.
12863 @item -mmul32x16
12864 @opindex mmul32x16
12865 Generate 32x16 bit multiply and mac instructions.
12867 @item -mmul64
12868 @opindex mmul64
12869 Generate mul64 and mulu64 instructions.  Only valid for @option{-mcpu=ARC600}.
12871 @item -mnorm
12872 @opindex mnorm
12873 Generate norm instruction.  This is the default if @option{-mcpu=ARC700}
12874 is in effect.
12876 @item -mspfp
12877 @opindex mspfp
12878 @itemx -mspfp-compact
12879 @opindex mspfp-compact
12880 FPX: Generate Single Precision FPX instructions, tuned for the compact
12881 implementation.
12883 @item -mspfp-fast
12884 @opindex mspfp-fast
12885 FPX: Generate Single Precision FPX instructions, tuned for the fast
12886 implementation.
12888 @item -msimd
12889 @opindex msimd
12890 Enable generation of ARC SIMD instructions via target-specific
12891 builtins.  Only valid for @option{-mcpu=ARC700}.
12893 @item -msoft-float
12894 @opindex msoft-float
12895 This option ignored; it is provided for compatibility purposes only.
12896 Software floating point code is emitted by default, and this default
12897 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12898 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12899 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12901 @item -mswap
12902 @opindex mswap
12903 Generate swap instructions.
12905 @end table
12907 The following options are passed through to the assembler, and also
12908 define preprocessor macro symbols.
12910 @c Flags used by the assembler, but for which we define preprocessor
12911 @c macro symbols as well.
12912 @table @gcctabopt
12913 @item -mdsp-packa
12914 @opindex mdsp-packa
12915 Passed down to the assembler to enable the DSP Pack A extensions.
12916 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12918 @item -mdvbf
12919 @opindex mdvbf
12920 Passed down to the assembler to enable the dual viterbi butterfly
12921 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12923 @c ARC700 4.10 extension instruction
12924 @item -mlock
12925 @opindex mlock
12926 Passed down to the assembler to enable the Locked Load/Store
12927 Conditional extension.  Also sets the preprocessor symbol
12928 @code{__Xlock}.
12930 @item -mmac-d16
12931 @opindex mmac-d16
12932 Passed down to the assembler.  Also sets the preprocessor symbol
12933 @code{__Xxmac_d16}.
12935 @item -mmac-24
12936 @opindex mmac-24
12937 Passed down to the assembler.  Also sets the preprocessor symbol
12938 @code{__Xxmac_24}.
12940 @c ARC700 4.10 extension instruction
12941 @item -mrtsc
12942 @opindex mrtsc
12943 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12944 extension instruction.  Also sets the preprocessor symbol
12945 @code{__Xrtsc}.
12947 @c ARC700 4.10 extension instruction
12948 @item -mswape
12949 @opindex mswape
12950 Passed down to the assembler to enable the swap byte ordering
12951 extension instruction.  Also sets the preprocessor symbol
12952 @code{__Xswape}.
12954 @item -mtelephony
12955 @opindex mtelephony
12956 Passed down to the assembler to enable dual and single operand
12957 instructions for telephony.  Also sets the preprocessor symbol
12958 @code{__Xtelephony}.
12960 @item -mxy
12961 @opindex mxy
12962 Passed down to the assembler to enable the XY Memory extension.  Also
12963 sets the preprocessor symbol @code{__Xxy}.
12965 @end table
12967 The following options control how the assembly code is annotated:
12969 @c Assembly annotation options
12970 @table @gcctabopt
12971 @item -misize
12972 @opindex misize
12973 Annotate assembler instructions with estimated addresses.
12975 @item -mannotate-align
12976 @opindex mannotate-align
12977 Explain what alignment considerations lead to the decision to make an
12978 instruction short or long.
12980 @end table
12982 The following options are passed through to the linker:
12984 @c options passed through to the linker
12985 @table @gcctabopt
12986 @item -marclinux
12987 @opindex marclinux
12988 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12989 This option is enabled by default in tool chains built for
12990 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12991 when profiling is not requested.
12993 @item -marclinux_prof
12994 @opindex marclinux_prof
12995 Passed through to the linker, to specify use of the
12996 @code{arclinux_prof} emulation.  This option is enabled by default in
12997 tool chains built for @w{@code{arc-linux-uclibc}} and
12998 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
13000 @end table
13002 The following options control the semantics of generated code:
13004 @c semantically relevant code generation options
13005 @table @gcctabopt
13006 @item -mepilogue-cfi
13007 @opindex mepilogue-cfi
13008 Enable generation of call frame information for epilogues.
13010 @item -mno-epilogue-cfi
13011 @opindex mno-epilogue-cfi
13012 Disable generation of call frame information for epilogues.
13014 @item -mlong-calls
13015 @opindex mlong-calls
13016 Generate call insns as register indirect calls, thus providing access
13017 to the full 32-bit address range.
13019 @item -mmedium-calls
13020 @opindex mmedium-calls
13021 Don't use less than 25 bit addressing range for calls, which is the
13022 offset available for an unconditional branch-and-link
13023 instruction.  Conditional execution of function calls is suppressed, to
13024 allow use of the 25-bit range, rather than the 21-bit range with
13025 conditional branch-and-link.  This is the default for tool chains built
13026 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
13028 @item -mno-sdata
13029 @opindex mno-sdata
13030 Do not generate sdata references.  This is the default for tool chains
13031 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
13032 targets.
13034 @item -mucb-mcount
13035 @opindex mucb-mcount
13036 Instrument with mcount calls as used in UCB code.  I.e. do the
13037 counting in the callee, not the caller.  By default ARC instrumentation
13038 counts in the caller.
13040 @item -mvolatile-cache
13041 @opindex mvolatile-cache
13042 Use ordinarily cached memory accesses for volatile references.  This is the
13043 default.
13045 @item -mno-volatile-cache
13046 @opindex mno-volatile-cache
13047 Enable cache bypass for volatile references.
13049 @end table
13051 The following options fine tune code generation:
13052 @c code generation tuning options
13053 @table @gcctabopt
13054 @item -malign-call
13055 @opindex malign-call
13056 Do alignment optimizations for call instructions.
13058 @item -mauto-modify-reg
13059 @opindex mauto-modify-reg
13060 Enable the use of pre/post modify with register displacement.
13062 @item -mbbit-peephole
13063 @opindex mbbit-peephole
13064 Enable bbit peephole2.
13066 @item -mno-brcc
13067 @opindex mno-brcc
13068 This option disables a target-specific pass in @file{arc_reorg} to
13069 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
13070 generation driven by the combiner pass.
13072 @item -mcase-vector-pcrel
13073 @opindex mcase-vector-pcrel
13074 Use pc-relative switch case tables - this enables case table shortening.
13075 This is the default for @option{-Os}.
13077 @item -mcompact-casesi
13078 @opindex mcompact-casesi
13079 Enable compact casesi pattern.
13080 This is the default for @option{-Os}.
13082 @item -mno-cond-exec
13083 @opindex mno-cond-exec
13084 Disable ARCompact specific pass to generate conditional execution instructions.
13085 Due to delay slot scheduling and interactions between operand numbers,
13086 literal sizes, instruction lengths, and the support for conditional execution,
13087 the target-independent pass to generate conditional execution is often lacking,
13088 so the ARC port has kept a special pass around that tries to find more
13089 conditional execution generating opportunities after register allocation,
13090 branch shortening, and delay slot scheduling have been done.  This pass
13091 generally, but not always, improves performance and code size, at the cost of
13092 extra compilation time, which is why there is an option to switch it off.
13093 If you have a problem with call instructions exceeding their allowable
13094 offset range because they are conditionalized, you should consider using
13095 @option{-mmedium-calls} instead.
13097 @item -mearly-cbranchsi
13098 @opindex mearly-cbranchsi
13099 Enable pre-reload use of the cbranchsi pattern.
13101 @item -mexpand-adddi
13102 @opindex mexpand-adddi
13103 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
13104 @code{add.f}, @code{adc} etc.
13106 @item -mindexed-loads
13107 @opindex mindexed-loads
13108 Enable the use of indexed loads.  This can be problematic because some
13109 optimizers then assume that indexed stores exist, which is not
13110 the case.
13112 @item -mlra
13113 @opindex mlra
13114 Enable Local Register Allocation.  This is still experimental for ARC,
13115 so by default the compiler uses standard reload
13116 (i.e. @option{-mno-lra}).
13118 @item -mlra-priority-none
13119 @opindex mlra-priority-none
13120 Don't indicate any priority for target registers.
13122 @item -mlra-priority-compact
13123 @opindex mlra-priority-compact
13124 Indicate target register priority for r0..r3 / r12..r15.
13126 @item -mlra-priority-noncompact
13127 @opindex mlra-priority-noncompact
13128 Reduce target regsiter priority for r0..r3 / r12..r15.
13130 @item -mno-millicode
13131 @opindex mno-millicode
13132 When optimizing for size (using @option{-Os}), prologues and epilogues
13133 that have to save or restore a large number of registers are often
13134 shortened by using call to a special function in libgcc; this is
13135 referred to as a @emph{millicode} call.  As these calls can pose
13136 performance issues, and/or cause linking issues when linking in a
13137 nonstandard way, this option is provided to turn off millicode call
13138 generation.
13140 @item -mmixed-code
13141 @opindex mmixed-code
13142 Tweak register allocation to help 16-bit instruction generation.
13143 This generally has the effect of decreasing the average instruction size
13144 while increasing the instruction count.
13146 @item -mq-class
13147 @opindex mq-class
13148 Enable 'q' instruction alternatives.
13149 This is the default for @option{-Os}.
13151 @item -mRcq
13152 @opindex mRcq
13153 Enable Rcq constraint handling - most short code generation depends on this.
13154 This is the default.
13156 @item -mRcw
13157 @opindex mRcw
13158 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
13159 This is the default.
13161 @item -msize-level=@var{level}
13162 @opindex msize-level
13163 Fine-tune size optimization with regards to instruction lengths and alignment.
13164 The recognized values for @var{level} are:
13165 @table @samp
13166 @item 0
13167 No size optimization.  This level is deprecated and treated like @samp{1}.
13169 @item 1
13170 Short instructions are used opportunistically.
13172 @item 2
13173 In addition, alignment of loops and of code after barriers are dropped.
13175 @item 3
13176 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
13178 @end table
13180 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
13181 the behavior when this is not set is equivalent to level @samp{1}.
13183 @item -mtune=@var{cpu}
13184 @opindex mtune
13185 Set instruction scheduling parameters for @var{cpu}, overriding any implied
13186 by @option{-mcpu=}.
13188 Supported values for @var{cpu} are
13190 @table @samp
13191 @item ARC600
13192 Tune for ARC600 cpu.
13194 @item ARC601
13195 Tune for ARC601 cpu.
13197 @item ARC700
13198 Tune for ARC700 cpu with standard multiplier block.
13200 @item ARC700-xmac
13201 Tune for ARC700 cpu with XMAC block.
13203 @item ARC725D
13204 Tune for ARC725D cpu.
13206 @item ARC750D
13207 Tune for ARC750D cpu.
13209 @end table
13211 @item -mmultcost=@var{num}
13212 @opindex mmultcost
13213 Cost to assume for a multiply instruction, with @samp{4} being equal to a
13214 normal instruction.
13216 @item -munalign-prob-threshold=@var{probability}
13217 @opindex munalign-prob-threshold
13218 Set probability threshold for unaligning branches.
13219 When tuning for @samp{ARC700} and optimizing for speed, branches without
13220 filled delay slot are preferably emitted unaligned and long, unless
13221 profiling indicates that the probability for the branch to be taken
13222 is below @var{probability}.  @xref{Cross-profiling}.
13223 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
13225 @end table
13227 The following options are maintained for backward compatibility, but
13228 are now deprecated and will be removed in a future release:
13230 @c Deprecated options
13231 @table @gcctabopt
13233 @item -margonaut
13234 @opindex margonaut
13235 Obsolete FPX.
13237 @item -mbig-endian
13238 @opindex mbig-endian
13239 @itemx -EB
13240 @opindex EB
13241 Compile code for big endian targets.  Use of these options is now
13242 deprecated.  Users wanting big-endian code, should use the
13243 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
13244 building the tool chain, for which big-endian is the default.
13246 @item -mlittle-endian
13247 @opindex mlittle-endian
13248 @itemx -EL
13249 @opindex EL
13250 Compile code for little endian targets.  Use of these options is now
13251 deprecated.  Users wanting little-endian code should use the
13252 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
13253 building the tool chain, for which little-endian is the default.
13255 @item -mbarrel_shifter
13256 @opindex mbarrel_shifter
13257 Replaced by @option{-mbarrel-shifter}.
13259 @item -mdpfp_compact
13260 @opindex mdpfp_compact
13261 Replaced by @option{-mdpfp-compact}.
13263 @item -mdpfp_fast
13264 @opindex mdpfp_fast
13265 Replaced by @option{-mdpfp-fast}.
13267 @item -mdsp_packa
13268 @opindex mdsp_packa
13269 Replaced by @option{-mdsp-packa}.
13271 @item -mEA
13272 @opindex mEA
13273 Replaced by @option{-mea}.
13275 @item -mmac_24
13276 @opindex mmac_24
13277 Replaced by @option{-mmac-24}.
13279 @item -mmac_d16
13280 @opindex mmac_d16
13281 Replaced by @option{-mmac-d16}.
13283 @item -mspfp_compact
13284 @opindex mspfp_compact
13285 Replaced by @option{-mspfp-compact}.
13287 @item -mspfp_fast
13288 @opindex mspfp_fast
13289 Replaced by @option{-mspfp-fast}.
13291 @item -mtune=@var{cpu}
13292 @opindex mtune
13293 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
13294 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
13295 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
13297 @item -multcost=@var{num}
13298 @opindex multcost
13299 Replaced by @option{-mmultcost}.
13301 @end table
13303 @node ARM Options
13304 @subsection ARM Options
13305 @cindex ARM options
13307 These @samp{-m} options are defined for the ARM port:
13309 @table @gcctabopt
13310 @item -mabi=@var{name}
13311 @opindex mabi
13312 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
13313 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
13315 @item -mapcs-frame
13316 @opindex mapcs-frame
13317 Generate a stack frame that is compliant with the ARM Procedure Call
13318 Standard for all functions, even if this is not strictly necessary for
13319 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
13320 with this option causes the stack frames not to be generated for
13321 leaf functions.  The default is @option{-mno-apcs-frame}.
13322 This option is deprecated.
13324 @item -mapcs
13325 @opindex mapcs
13326 This is a synonym for @option{-mapcs-frame} and is deprecated.
13328 @ignore
13329 @c not currently implemented
13330 @item -mapcs-stack-check
13331 @opindex mapcs-stack-check
13332 Generate code to check the amount of stack space available upon entry to
13333 every function (that actually uses some stack space).  If there is
13334 insufficient space available then either the function
13335 @code{__rt_stkovf_split_small} or @code{__rt_stkovf_split_big} is
13336 called, depending upon the amount of stack space required.  The runtime
13337 system is required to provide these functions.  The default is
13338 @option{-mno-apcs-stack-check}, since this produces smaller code.
13340 @c not currently implemented
13341 @item -mapcs-float
13342 @opindex mapcs-float
13343 Pass floating-point arguments using the floating-point registers.  This is
13344 one of the variants of the APCS@.  This option is recommended if the
13345 target hardware has a floating-point unit or if a lot of floating-point
13346 arithmetic is going to be performed by the code.  The default is
13347 @option{-mno-apcs-float}, since the size of integer-only code is 
13348 slightly increased if @option{-mapcs-float} is used.
13350 @c not currently implemented
13351 @item -mapcs-reentrant
13352 @opindex mapcs-reentrant
13353 Generate reentrant, position-independent code.  The default is
13354 @option{-mno-apcs-reentrant}.
13355 @end ignore
13357 @item -mthumb-interwork
13358 @opindex mthumb-interwork
13359 Generate code that supports calling between the ARM and Thumb
13360 instruction sets.  Without this option, on pre-v5 architectures, the
13361 two instruction sets cannot be reliably used inside one program.  The
13362 default is @option{-mno-thumb-interwork}, since slightly larger code
13363 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
13364 configurations this option is meaningless.
13366 @item -mno-sched-prolog
13367 @opindex mno-sched-prolog
13368 Prevent the reordering of instructions in the function prologue, or the
13369 merging of those instruction with the instructions in the function's
13370 body.  This means that all functions start with a recognizable set
13371 of instructions (or in fact one of a choice from a small set of
13372 different function prologues), and this information can be used to
13373 locate the start of functions inside an executable piece of code.  The
13374 default is @option{-msched-prolog}.
13376 @item -mfloat-abi=@var{name}
13377 @opindex mfloat-abi
13378 Specifies which floating-point ABI to use.  Permissible values
13379 are: @samp{soft}, @samp{softfp} and @samp{hard}.
13381 Specifying @samp{soft} causes GCC to generate output containing
13382 library calls for floating-point operations.
13383 @samp{softfp} allows the generation of code using hardware floating-point
13384 instructions, but still uses the soft-float calling conventions.
13385 @samp{hard} allows generation of floating-point instructions
13386 and uses FPU-specific calling conventions.
13388 The default depends on the specific target configuration.  Note that
13389 the hard-float and soft-float ABIs are not link-compatible; you must
13390 compile your entire program with the same ABI, and link with a
13391 compatible set of libraries.
13393 @item -mlittle-endian
13394 @opindex mlittle-endian
13395 Generate code for a processor running in little-endian mode.  This is
13396 the default for all standard configurations.
13398 @item -mbig-endian
13399 @opindex mbig-endian
13400 Generate code for a processor running in big-endian mode; the default is
13401 to compile code for a little-endian processor.
13403 @item -march=@var{name}
13404 @opindex march
13405 This specifies the name of the target ARM architecture.  GCC uses this
13406 name to determine what kind of instructions it can emit when generating
13407 assembly code.  This option can be used in conjunction with or instead
13408 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
13409 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
13410 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
13411 @samp{armv6}, @samp{armv6j},
13412 @samp{armv6t2}, @samp{armv6z}, @samp{armv6kz}, @samp{armv6-m},
13413 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
13414 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
13415 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
13417 @option{-march=armv7ve} is the armv7-a architecture with virtualization
13418 extensions.
13420 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
13421 architecture together with the optional CRC32 extensions.
13423 @option{-march=native} causes the compiler to auto-detect the architecture
13424 of the build computer.  At present, this feature is only supported on
13425 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13426 is unsuccessful the option has no effect.
13428 @item -mtune=@var{name}
13429 @opindex mtune
13430 This option specifies the name of the target ARM processor for
13431 which GCC should tune the performance of the code.
13432 For some ARM implementations better performance can be obtained by using
13433 this option.
13434 Permissible names are: @samp{arm2}, @samp{arm250},
13435 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
13436 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
13437 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
13438 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
13439 @samp{arm720},
13440 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
13441 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
13442 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
13443 @samp{strongarm1110},
13444 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
13445 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
13446 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
13447 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
13448 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
13449 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
13450 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
13451 @samp{generic-armv7-a}, @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8},
13452 @samp{cortex-a9}, @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a17},
13453 @samp{cortex-a53}, @samp{cortex-a57}, @samp{cortex-a72},
13454 @samp{cortex-r4},
13455 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
13456 @samp{cortex-m4},
13457 @samp{cortex-m3},
13458 @samp{cortex-m1},
13459 @samp{cortex-m0},
13460 @samp{cortex-m0plus},
13461 @samp{cortex-m1.small-multiply},
13462 @samp{cortex-m0.small-multiply},
13463 @samp{cortex-m0plus.small-multiply},
13464 @samp{exynos-m1},
13465 @samp{marvell-pj4},
13466 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
13467 @samp{fa526}, @samp{fa626},
13468 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te},
13469 @samp{xgene1}.
13471 Additionally, this option can specify that GCC should tune the performance
13472 of the code for a big.LITTLE system.  Permissible names are:
13473 @samp{cortex-a15.cortex-a7}, @samp{cortex-a17.cortex-a7},
13474 @samp{cortex-a57.cortex-a53}, @samp{cortex-a72.cortex-a53}.
13476 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
13477 performance for a blend of processors within architecture @var{arch}.
13478 The aim is to generate code that run well on the current most popular
13479 processors, balancing between optimizations that benefit some CPUs in the
13480 range, and avoiding performance pitfalls of other CPUs.  The effects of
13481 this option may change in future GCC versions as CPU models come and go.
13483 @option{-mtune=native} causes the compiler to auto-detect the CPU
13484 of the build computer.  At present, this feature is only supported on
13485 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
13486 unsuccessful the option has no effect.
13488 @item -mcpu=@var{name}
13489 @opindex mcpu
13490 This specifies the name of the target ARM processor.  GCC uses this name
13491 to derive the name of the target ARM architecture (as if specified
13492 by @option{-march}) and the ARM processor type for which to tune for
13493 performance (as if specified by @option{-mtune}).  Where this option
13494 is used in conjunction with @option{-march} or @option{-mtune},
13495 those options take precedence over the appropriate part of this option.
13497 Permissible names for this option are the same as those for
13498 @option{-mtune}.
13500 @option{-mcpu=generic-@var{arch}} is also permissible, and is
13501 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
13502 See @option{-mtune} for more information.
13504 @option{-mcpu=native} causes the compiler to auto-detect the CPU
13505 of the build computer.  At present, this feature is only supported on
13506 GNU/Linux, and not all architectures are recognized.  If the auto-detect
13507 is unsuccessful the option has no effect.
13509 @item -mfpu=@var{name}
13510 @opindex mfpu
13511 This specifies what floating-point hardware (or hardware emulation) is
13512 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
13513 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
13514 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
13515 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
13516 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
13517 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
13519 If @option{-msoft-float} is specified this specifies the format of
13520 floating-point values.
13522 If the selected floating-point hardware includes the NEON extension
13523 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
13524 operations are not generated by GCC's auto-vectorization pass unless
13525 @option{-funsafe-math-optimizations} is also specified.  This is
13526 because NEON hardware does not fully implement the IEEE 754 standard for
13527 floating-point arithmetic (in particular denormal values are treated as
13528 zero), so the use of NEON instructions may lead to a loss of precision.
13530 @item -mfp16-format=@var{name}
13531 @opindex mfp16-format
13532 Specify the format of the @code{__fp16} half-precision floating-point type.
13533 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
13534 the default is @samp{none}, in which case the @code{__fp16} type is not
13535 defined.  @xref{Half-Precision}, for more information.
13537 @item -mstructure-size-boundary=@var{n}
13538 @opindex mstructure-size-boundary
13539 The sizes of all structures and unions are rounded up to a multiple
13540 of the number of bits set by this option.  Permissible values are 8, 32
13541 and 64.  The default value varies for different toolchains.  For the COFF
13542 targeted toolchain the default value is 8.  A value of 64 is only allowed
13543 if the underlying ABI supports it.
13545 Specifying a larger number can produce faster, more efficient code, but
13546 can also increase the size of the program.  Different values are potentially
13547 incompatible.  Code compiled with one value cannot necessarily expect to
13548 work with code or libraries compiled with another value, if they exchange
13549 information using structures or unions.
13551 @item -mabort-on-noreturn
13552 @opindex mabort-on-noreturn
13553 Generate a call to the function @code{abort} at the end of a
13554 @code{noreturn} function.  It is executed if the function tries to
13555 return.
13557 @item -mlong-calls
13558 @itemx -mno-long-calls
13559 @opindex mlong-calls
13560 @opindex mno-long-calls
13561 Tells the compiler to perform function calls by first loading the
13562 address of the function into a register and then performing a subroutine
13563 call on this register.  This switch is needed if the target function
13564 lies outside of the 64-megabyte addressing range of the offset-based
13565 version of subroutine call instruction.
13567 Even if this switch is enabled, not all function calls are turned
13568 into long calls.  The heuristic is that static functions, functions
13569 that have the @code{short_call} attribute, functions that are inside
13570 the scope of a @code{#pragma no_long_calls} directive, and functions whose
13571 definitions have already been compiled within the current compilation
13572 unit are not turned into long calls.  The exceptions to this rule are
13573 that weak function definitions, functions with the @code{long_call}
13574 attribute or the @code{section} attribute, and functions that are within
13575 the scope of a @code{#pragma long_calls} directive are always
13576 turned into long calls.
13578 This feature is not enabled by default.  Specifying
13579 @option{-mno-long-calls} restores the default behavior, as does
13580 placing the function calls within the scope of a @code{#pragma
13581 long_calls_off} directive.  Note these switches have no effect on how
13582 the compiler generates code to handle function calls via function
13583 pointers.
13585 @item -msingle-pic-base
13586 @opindex msingle-pic-base
13587 Treat the register used for PIC addressing as read-only, rather than
13588 loading it in the prologue for each function.  The runtime system is
13589 responsible for initializing this register with an appropriate value
13590 before execution begins.
13592 @item -mpic-register=@var{reg}
13593 @opindex mpic-register
13594 Specify the register to be used for PIC addressing.
13595 For standard PIC base case, the default is any suitable register
13596 determined by compiler.  For single PIC base case, the default is
13597 @samp{R9} if target is EABI based or stack-checking is enabled,
13598 otherwise the default is @samp{R10}.
13600 @item -mpic-data-is-text-relative
13601 @opindex mpic-data-is-text-relative
13602 Assume that each data segments are relative to text segment at load time.
13603 Therefore, it permits addressing data using PC-relative operations.
13604 This option is on by default for targets other than VxWorks RTP.
13606 @item -mpoke-function-name
13607 @opindex mpoke-function-name
13608 Write the name of each function into the text section, directly
13609 preceding the function prologue.  The generated code is similar to this:
13611 @smallexample
13612      t0
13613          .ascii "arm_poke_function_name", 0
13614          .align
13615      t1
13616          .word 0xff000000 + (t1 - t0)
13617      arm_poke_function_name
13618          mov     ip, sp
13619          stmfd   sp!, @{fp, ip, lr, pc@}
13620          sub     fp, ip, #4
13621 @end smallexample
13623 When performing a stack backtrace, code can inspect the value of
13624 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13625 location @code{pc - 12} and the top 8 bits are set, then we know that
13626 there is a function name embedded immediately preceding this location
13627 and has length @code{((pc[-3]) & 0xff000000)}.
13629 @item -mthumb
13630 @itemx -marm
13631 @opindex marm
13632 @opindex mthumb
13634 Select between generating code that executes in ARM and Thumb
13635 states.  The default for most configurations is to generate code
13636 that executes in ARM state, but the default can be changed by
13637 configuring GCC with the @option{--with-mode=}@var{state}
13638 configure option.
13640 You can also override the ARM and Thumb mode for each function
13641 by using the @code{target("thumb")} and @code{target("arm")} function attributes
13642 (@pxref{ARM Function Attributes}) or pragmas (@pxref{Function Specific Option Pragmas}).
13644 @item -mtpcs-frame
13645 @opindex mtpcs-frame
13646 Generate a stack frame that is compliant with the Thumb Procedure Call
13647 Standard for all non-leaf functions.  (A leaf function is one that does
13648 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13650 @item -mtpcs-leaf-frame
13651 @opindex mtpcs-leaf-frame
13652 Generate a stack frame that is compliant with the Thumb Procedure Call
13653 Standard for all leaf functions.  (A leaf function is one that does
13654 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13656 @item -mcallee-super-interworking
13657 @opindex mcallee-super-interworking
13658 Gives all externally visible functions in the file being compiled an ARM
13659 instruction set header which switches to Thumb mode before executing the
13660 rest of the function.  This allows these functions to be called from
13661 non-interworking code.  This option is not valid in AAPCS configurations
13662 because interworking is enabled by default.
13664 @item -mcaller-super-interworking
13665 @opindex mcaller-super-interworking
13666 Allows calls via function pointers (including virtual functions) to
13667 execute correctly regardless of whether the target code has been
13668 compiled for interworking or not.  There is a small overhead in the cost
13669 of executing a function pointer if this option is enabled.  This option
13670 is not valid in AAPCS configurations because interworking is enabled
13671 by default.
13673 @item -mtp=@var{name}
13674 @opindex mtp
13675 Specify the access model for the thread local storage pointer.  The valid
13676 models are @samp{soft}, which generates calls to @code{__aeabi_read_tp},
13677 @samp{cp15}, which fetches the thread pointer from @code{cp15} directly
13678 (supported in the arm6k architecture), and @samp{auto}, which uses the
13679 best available method for the selected processor.  The default setting is
13680 @samp{auto}.
13682 @item -mtls-dialect=@var{dialect}
13683 @opindex mtls-dialect
13684 Specify the dialect to use for accessing thread local storage.  Two
13685 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13686 @samp{gnu} dialect selects the original GNU scheme for supporting
13687 local and global dynamic TLS models.  The @samp{gnu2} dialect
13688 selects the GNU descriptor scheme, which provides better performance
13689 for shared libraries.  The GNU descriptor scheme is compatible with
13690 the original scheme, but does require new assembler, linker and
13691 library support.  Initial and local exec TLS models are unaffected by
13692 this option and always use the original scheme.
13694 @item -mword-relocations
13695 @opindex mword-relocations
13696 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13697 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13698 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13699 is specified.
13701 @item -mfix-cortex-m3-ldrd
13702 @opindex mfix-cortex-m3-ldrd
13703 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13704 with overlapping destination and base registers are used.  This option avoids
13705 generating these instructions.  This option is enabled by default when
13706 @option{-mcpu=cortex-m3} is specified.
13708 @item -munaligned-access
13709 @itemx -mno-unaligned-access
13710 @opindex munaligned-access
13711 @opindex mno-unaligned-access
13712 Enables (or disables) reading and writing of 16- and 32- bit values
13713 from addresses that are not 16- or 32- bit aligned.  By default
13714 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13715 architectures, and enabled for all other architectures.  If unaligned
13716 access is not enabled then words in packed data structures are
13717 accessed a byte at a time.
13719 The ARM attribute @code{Tag_CPU_unaligned_access} is set in the
13720 generated object file to either true or false, depending upon the
13721 setting of this option.  If unaligned access is enabled then the
13722 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} is also
13723 defined.
13725 @item -mneon-for-64bits
13726 @opindex mneon-for-64bits
13727 Enables using Neon to handle scalar 64-bits operations. This is
13728 disabled by default since the cost of moving data from core registers
13729 to Neon is high.
13731 @item -mslow-flash-data
13732 @opindex mslow-flash-data
13733 Assume loading data from flash is slower than fetching instruction.
13734 Therefore literal load is minimized for better performance.
13735 This option is only supported when compiling for ARMv7 M-profile and
13736 off by default.
13738 @item -masm-syntax-unified
13739 @opindex masm-syntax-unified
13740 Assume inline assembler is using unified asm syntax.  The default is
13741 currently off which implies divided syntax.  Currently this option is
13742 available only for Thumb1 and has no effect on ARM state and Thumb2.
13743 However, this may change in future releases of GCC.  Divided syntax
13744 should be considered deprecated.
13746 @item -mrestrict-it
13747 @opindex mrestrict-it
13748 Restricts generation of IT blocks to conform to the rules of ARMv8.
13749 IT blocks can only contain a single 16-bit instruction from a select
13750 set of instructions. This option is on by default for ARMv8 Thumb mode.
13752 @item -mprint-tune-info
13753 @opindex mprint-tune-info
13754 Print CPU tuning information as comment in assembler file.  This is
13755 an option used only for regression testing of the compiler and not
13756 intended for ordinary use in compiling code.  This option is disabled
13757 by default.
13758 @end table
13760 @node AVR Options
13761 @subsection AVR Options
13762 @cindex AVR Options
13764 These options are defined for AVR implementations:
13766 @table @gcctabopt
13767 @item -mmcu=@var{mcu}
13768 @opindex mmcu
13769 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13771 The default for this option is@tie{}@samp{avr2}.
13773 GCC supports the following AVR devices and ISAs:
13775 @include avr-mmcu.texi
13777 @item -maccumulate-args
13778 @opindex maccumulate-args
13779 Accumulate outgoing function arguments and acquire/release the needed
13780 stack space for outgoing function arguments once in function
13781 prologue/epilogue.  Without this option, outgoing arguments are pushed
13782 before calling a function and popped afterwards.
13784 Popping the arguments after the function call can be expensive on
13785 AVR so that accumulating the stack space might lead to smaller
13786 executables because arguments need not to be removed from the
13787 stack after such a function call.
13789 This option can lead to reduced code size for functions that perform
13790 several calls to functions that get their arguments on the stack like
13791 calls to printf-like functions.
13793 @item -mbranch-cost=@var{cost}
13794 @opindex mbranch-cost
13795 Set the branch costs for conditional branch instructions to
13796 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13797 integers. The default branch cost is 0.
13799 @item -mcall-prologues
13800 @opindex mcall-prologues
13801 Functions prologues/epilogues are expanded as calls to appropriate
13802 subroutines.  Code size is smaller.
13804 @item -mint8
13805 @opindex mint8
13806 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13807 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13808 and @code{long long} is 4 bytes.  Please note that this option does not
13809 conform to the C standards, but it results in smaller code
13810 size.
13812 @item -mn-flash=@var{num}
13813 @opindex mn-flash
13814 Assume that the flash memory has a size of 
13815 @var{num} times 64@tie{}KiB.
13817 @item -mno-interrupts
13818 @opindex mno-interrupts
13819 Generated code is not compatible with hardware interrupts.
13820 Code size is smaller.
13822 @item -mrelax
13823 @opindex mrelax
13824 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13825 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13826 Setting @option{-mrelax} just adds the @option{--mlink-relax} option to
13827 the assembler's command line and the @option{--relax} option to the
13828 linker's command line.
13830 Jump relaxing is performed by the linker because jump offsets are not
13831 known before code is located. Therefore, the assembler code generated by the
13832 compiler is the same, but the instructions in the executable may
13833 differ from instructions in the assembler code.
13835 Relaxing must be turned on if linker stubs are needed, see the
13836 section on @code{EIND} and linker stubs below.
13838 @item -mrmw
13839 @opindex mrmw
13840 Assume that the device supports the Read-Modify-Write
13841 instructions @code{XCH}, @code{LAC}, @code{LAS} and @code{LAT}.
13843 @item -msp8
13844 @opindex msp8
13845 Treat the stack pointer register as an 8-bit register,
13846 i.e.@: assume the high byte of the stack pointer is zero.
13847 In general, you don't need to set this option by hand.
13849 This option is used internally by the compiler to select and
13850 build multilibs for architectures @code{avr2} and @code{avr25}.
13851 These architectures mix devices with and without @code{SPH}.
13852 For any setting other than @option{-mmcu=avr2} or @option{-mmcu=avr25}
13853 the compiler driver adds or removes this option from the compiler
13854 proper's command line, because the compiler then knows if the device
13855 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13856 register or not.
13858 @item -mstrict-X
13859 @opindex mstrict-X
13860 Use address register @code{X} in a way proposed by the hardware.  This means
13861 that @code{X} is only used in indirect, post-increment or
13862 pre-decrement addressing.
13864 Without this option, the @code{X} register may be used in the same way
13865 as @code{Y} or @code{Z} which then is emulated by additional
13866 instructions.  
13867 For example, loading a value with @code{X+const} addressing with a
13868 small non-negative @code{const < 64} to a register @var{Rn} is
13869 performed as
13871 @example
13872 adiw r26, const   ; X += const
13873 ld   @var{Rn}, X        ; @var{Rn} = *X
13874 sbiw r26, const   ; X -= const
13875 @end example
13877 @item -mtiny-stack
13878 @opindex mtiny-stack
13879 Only change the lower 8@tie{}bits of the stack pointer.
13881 @item -nodevicelib
13882 @opindex nodevicelib
13883 Don't link against AVR-LibC's device specific library @code{libdev.a}.
13885 @item -Waddr-space-convert
13886 @opindex Waddr-space-convert
13887 Warn about conversions between address spaces in the case where the
13888 resulting address space is not contained in the incoming address space.
13889 @end table
13891 @subsubsection @code{EIND} and Devices with More Than 128 Ki Bytes of Flash
13892 @cindex @code{EIND}
13893 Pointers in the implementation are 16@tie{}bits wide.
13894 The address of a function or label is represented as word address so
13895 that indirect jumps and calls can target any code address in the
13896 range of 64@tie{}Ki words.
13898 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13899 bytes of program memory space, there is a special function register called
13900 @code{EIND} that serves as most significant part of the target address
13901 when @code{EICALL} or @code{EIJMP} instructions are used.
13903 Indirect jumps and calls on these devices are handled as follows by
13904 the compiler and are subject to some limitations:
13906 @itemize @bullet
13908 @item
13909 The compiler never sets @code{EIND}.
13911 @item
13912 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13913 instructions or might read @code{EIND} directly in order to emulate an
13914 indirect call/jump by means of a @code{RET} instruction.
13916 @item
13917 The compiler assumes that @code{EIND} never changes during the startup
13918 code or during the application. In particular, @code{EIND} is not
13919 saved/restored in function or interrupt service routine
13920 prologue/epilogue.
13922 @item
13923 For indirect calls to functions and computed goto, the linker
13924 generates @emph{stubs}. Stubs are jump pads sometimes also called
13925 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13926 The stub contains a direct jump to the desired address.
13928 @item
13929 Linker relaxation must be turned on so that the linker generates
13930 the stubs correctly in all situations. See the compiler option
13931 @option{-mrelax} and the linker option @option{--relax}.
13932 There are corner cases where the linker is supposed to generate stubs
13933 but aborts without relaxation and without a helpful error message.
13935 @item
13936 The default linker script is arranged for code with @code{EIND = 0}.
13937 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13938 linker script has to be used in order to place the sections whose
13939 name start with @code{.trampolines} into the segment where @code{EIND}
13940 points to.
13942 @item
13943 The startup code from libgcc never sets @code{EIND}.
13944 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13945 For the impact of AVR-LibC on @code{EIND}, see the
13946 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13948 @item
13949 It is legitimate for user-specific startup code to set up @code{EIND}
13950 early, for example by means of initialization code located in
13951 section @code{.init3}. Such code runs prior to general startup code
13952 that initializes RAM and calls constructors, but after the bit
13953 of startup code from AVR-LibC that sets @code{EIND} to the segment
13954 where the vector table is located.
13955 @example
13956 #include <avr/io.h>
13958 static void
13959 __attribute__((section(".init3"),naked,used,no_instrument_function))
13960 init3_set_eind (void)
13962   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13963                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13965 @end example
13967 @noindent
13968 The @code{__trampolines_start} symbol is defined in the linker script.
13970 @item
13971 Stubs are generated automatically by the linker if
13972 the following two conditions are met:
13973 @itemize @minus
13975 @item The address of a label is taken by means of the @code{gs} modifier
13976 (short for @emph{generate stubs}) like so:
13977 @example
13978 LDI r24, lo8(gs(@var{func}))
13979 LDI r25, hi8(gs(@var{func}))
13980 @end example
13981 @item The final location of that label is in a code segment
13982 @emph{outside} the segment where the stubs are located.
13983 @end itemize
13985 @item
13986 The compiler emits such @code{gs} modifiers for code labels in the
13987 following situations:
13988 @itemize @minus
13989 @item Taking address of a function or code label.
13990 @item Computed goto.
13991 @item If prologue-save function is used, see @option{-mcall-prologues}
13992 command-line option.
13993 @item Switch/case dispatch tables. If you do not want such dispatch
13994 tables you can specify the @option{-fno-jump-tables} command-line option.
13995 @item C and C++ constructors/destructors called during startup/shutdown.
13996 @item If the tools hit a @code{gs()} modifier explained above.
13997 @end itemize
13999 @item
14000 Jumping to non-symbolic addresses like so is @emph{not} supported:
14002 @example
14003 int main (void)
14005     /* Call function at word address 0x2 */
14006     return ((int(*)(void)) 0x2)();
14008 @end example
14010 Instead, a stub has to be set up, i.e.@: the function has to be called
14011 through a symbol (@code{func_4} in the example):
14013 @example
14014 int main (void)
14016     extern int func_4 (void);
14018     /* Call function at byte address 0x4 */
14019     return func_4();
14021 @end example
14023 and the application be linked with @option{-Wl,--defsym,func_4=0x4}.
14024 Alternatively, @code{func_4} can be defined in the linker script.
14025 @end itemize
14027 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
14028 @cindex @code{RAMPD}
14029 @cindex @code{RAMPX}
14030 @cindex @code{RAMPY}
14031 @cindex @code{RAMPZ}
14032 Some AVR devices support memories larger than the 64@tie{}KiB range
14033 that can be accessed with 16-bit pointers.  To access memory locations
14034 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
14035 register is used as high part of the address:
14036 The @code{X}, @code{Y}, @code{Z} address register is concatenated
14037 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
14038 register, respectively, to get a wide address. Similarly,
14039 @code{RAMPD} is used together with direct addressing.
14041 @itemize
14042 @item
14043 The startup code initializes the @code{RAMP} special function
14044 registers with zero.
14046 @item
14047 If a @ref{AVR Named Address Spaces,named address space} other than
14048 generic or @code{__flash} is used, then @code{RAMPZ} is set
14049 as needed before the operation.
14051 @item
14052 If the device supports RAM larger than 64@tie{}KiB and the compiler
14053 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
14054 is reset to zero after the operation.
14056 @item
14057 If the device comes with a specific @code{RAMP} register, the ISR
14058 prologue/epilogue saves/restores that SFR and initializes it with
14059 zero in case the ISR code might (implicitly) use it.
14061 @item
14062 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
14063 If you use inline assembler to read from locations outside the
14064 16-bit address range and change one of the @code{RAMP} registers,
14065 you must reset it to zero after the access.
14067 @end itemize
14069 @subsubsection AVR Built-in Macros
14071 GCC defines several built-in macros so that the user code can test
14072 for the presence or absence of features.  Almost any of the following
14073 built-in macros are deduced from device capabilities and thus
14074 triggered by the @option{-mmcu=} command-line option.
14076 For even more AVR-specific built-in macros see
14077 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
14079 @table @code
14081 @item __AVR_ARCH__
14082 Build-in macro that resolves to a decimal number that identifies the
14083 architecture and depends on the @option{-mmcu=@var{mcu}} option.
14084 Possible values are:
14086 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
14087 @code{4}, @code{5}, @code{51}, @code{6}
14089 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3}, @code{avr31},
14090 @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51}, @code{avr6},
14092 respectively and
14094 @code{100}, @code{102}, @code{104},
14095 @code{105}, @code{106}, @code{107}
14097 for @var{mcu}=@code{avrtiny}, @code{avrxmega2}, @code{avrxmega4},
14098 @code{avrxmega5}, @code{avrxmega6}, @code{avrxmega7}, respectively.
14099 If @var{mcu} specifies a device, this built-in macro is set
14100 accordingly. For example, with @option{-mmcu=atmega8} the macro is
14101 defined to @code{4}.
14103 @item __AVR_@var{Device}__
14104 Setting @option{-mmcu=@var{device}} defines this built-in macro which reflects
14105 the device's name. For example, @option{-mmcu=atmega8} defines the
14106 built-in macro @code{__AVR_ATmega8__}, @option{-mmcu=attiny261a} defines
14107 @code{__AVR_ATtiny261A__}, etc.
14109 The built-in macros' names follow
14110 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
14111 the device name as from the AVR user manual. The difference between
14112 @var{Device} in the built-in macro and @var{device} in
14113 @option{-mmcu=@var{device}} is that the latter is always lowercase.
14115 If @var{device} is not a device but only a core architecture like
14116 @samp{avr51}, this macro is not defined.
14118 @item __AVR_DEVICE_NAME__
14119 Setting @option{-mmcu=@var{device}} defines this built-in macro to
14120 the device's name. For example, with @option{-mmcu=atmega8} the macro
14121 is defined to @code{atmega8}.
14123 If @var{device} is not a device but only a core architecture like
14124 @samp{avr51}, this macro is not defined.
14126 @item __AVR_XMEGA__
14127 The device / architecture belongs to the XMEGA family of devices.
14129 @item __AVR_HAVE_ELPM__
14130 The device has the @code{ELPM} instruction.
14132 @item __AVR_HAVE_ELPMX__
14133 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
14134 R@var{n},Z+} instructions.
14136 @item __AVR_HAVE_MOVW__
14137 The device has the @code{MOVW} instruction to perform 16-bit
14138 register-register moves.
14140 @item __AVR_HAVE_LPMX__
14141 The device has the @code{LPM R@var{n},Z} and
14142 @code{LPM R@var{n},Z+} instructions.
14144 @item __AVR_HAVE_MUL__
14145 The device has a hardware multiplier. 
14147 @item __AVR_HAVE_JMP_CALL__
14148 The device has the @code{JMP} and @code{CALL} instructions.
14149 This is the case for devices with at least 16@tie{}KiB of program
14150 memory.
14152 @item __AVR_HAVE_EIJMP_EICALL__
14153 @itemx __AVR_3_BYTE_PC__
14154 The device has the @code{EIJMP} and @code{EICALL} instructions.
14155 This is the case for devices with more than 128@tie{}KiB of program memory.
14156 This also means that the program counter
14157 (PC) is 3@tie{}bytes wide.
14159 @item __AVR_2_BYTE_PC__
14160 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
14161 with up to 128@tie{}KiB of program memory.
14163 @item __AVR_HAVE_8BIT_SP__
14164 @itemx __AVR_HAVE_16BIT_SP__
14165 The stack pointer (SP) register is treated as 8-bit respectively
14166 16-bit register by the compiler.
14167 The definition of these macros is affected by @option{-mtiny-stack}.
14169 @item __AVR_HAVE_SPH__
14170 @itemx __AVR_SP8__
14171 The device has the SPH (high part of stack pointer) special function
14172 register or has an 8-bit stack pointer, respectively.
14173 The definition of these macros is affected by @option{-mmcu=} and
14174 in the cases of @option{-mmcu=avr2} and @option{-mmcu=avr25} also
14175 by @option{-msp8}.
14177 @item __AVR_HAVE_RAMPD__
14178 @itemx __AVR_HAVE_RAMPX__
14179 @itemx __AVR_HAVE_RAMPY__
14180 @itemx __AVR_HAVE_RAMPZ__
14181 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
14182 @code{RAMPZ} special function register, respectively.
14184 @item __NO_INTERRUPTS__
14185 This macro reflects the @option{-mno-interrupts} command-line option.
14187 @item __AVR_ERRATA_SKIP__
14188 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
14189 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
14190 instructions because of a hardware erratum.  Skip instructions are
14191 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
14192 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
14193 set.
14195 @item __AVR_ISA_RMW__
14196 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
14198 @item __AVR_SFR_OFFSET__=@var{offset}
14199 Instructions that can address I/O special function registers directly
14200 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
14201 address as if addressed by an instruction to access RAM like @code{LD}
14202 or @code{STS}. This offset depends on the device architecture and has
14203 to be subtracted from the RAM address in order to get the
14204 respective I/O@tie{}address.
14206 @item __WITH_AVRLIBC__
14207 The compiler is configured to be used together with AVR-Libc.
14208 See the @option{--with-avrlibc} configure option.
14210 @end table
14212 @node Blackfin Options
14213 @subsection Blackfin Options
14214 @cindex Blackfin Options
14216 @table @gcctabopt
14217 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
14218 @opindex mcpu=
14219 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
14220 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
14221 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
14222 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
14223 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
14224 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
14225 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
14226 @samp{bf561}, @samp{bf592}.
14228 The optional @var{sirevision} specifies the silicon revision of the target
14229 Blackfin processor.  Any workarounds available for the targeted silicon revision
14230 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
14231 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
14232 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
14233 hexadecimal digits representing the major and minor numbers in the silicon
14234 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
14235 is not defined.  If @var{sirevision} is @samp{any}, the
14236 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
14237 If this optional @var{sirevision} is not used, GCC assumes the latest known
14238 silicon revision of the targeted Blackfin processor.
14240 GCC defines a preprocessor macro for the specified @var{cpu}.
14241 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
14242 provided by libgloss to be linked in if @option{-msim} is not given.
14244 Without this option, @samp{bf532} is used as the processor by default.
14246 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
14247 only the preprocessor macro is defined.
14249 @item -msim
14250 @opindex msim
14251 Specifies that the program will be run on the simulator.  This causes
14252 the simulator BSP provided by libgloss to be linked in.  This option
14253 has effect only for @samp{bfin-elf} toolchain.
14254 Certain other options, such as @option{-mid-shared-library} and
14255 @option{-mfdpic}, imply @option{-msim}.
14257 @item -momit-leaf-frame-pointer
14258 @opindex momit-leaf-frame-pointer
14259 Don't keep the frame pointer in a register for leaf functions.  This
14260 avoids the instructions to save, set up and restore frame pointers and
14261 makes an extra register available in leaf functions.  The option
14262 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
14263 which might make debugging harder.
14265 @item -mspecld-anomaly
14266 @opindex mspecld-anomaly
14267 When enabled, the compiler ensures that the generated code does not
14268 contain speculative loads after jump instructions. If this option is used,
14269 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
14271 @item -mno-specld-anomaly
14272 @opindex mno-specld-anomaly
14273 Don't generate extra code to prevent speculative loads from occurring.
14275 @item -mcsync-anomaly
14276 @opindex mcsync-anomaly
14277 When enabled, the compiler ensures that the generated code does not
14278 contain CSYNC or SSYNC instructions too soon after conditional branches.
14279 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
14281 @item -mno-csync-anomaly
14282 @opindex mno-csync-anomaly
14283 Don't generate extra code to prevent CSYNC or SSYNC instructions from
14284 occurring too soon after a conditional branch.
14286 @item -mlow-64k
14287 @opindex mlow-64k
14288 When enabled, the compiler is free to take advantage of the knowledge that
14289 the entire program fits into the low 64k of memory.
14291 @item -mno-low-64k
14292 @opindex mno-low-64k
14293 Assume that the program is arbitrarily large.  This is the default.
14295 @item -mstack-check-l1
14296 @opindex mstack-check-l1
14297 Do stack checking using information placed into L1 scratchpad memory by the
14298 uClinux kernel.
14300 @item -mid-shared-library
14301 @opindex mid-shared-library
14302 Generate code that supports shared libraries via the library ID method.
14303 This allows for execute in place and shared libraries in an environment
14304 without virtual memory management.  This option implies @option{-fPIC}.
14305 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14307 @item -mno-id-shared-library
14308 @opindex mno-id-shared-library
14309 Generate code that doesn't assume ID-based shared libraries are being used.
14310 This is the default.
14312 @item -mleaf-id-shared-library
14313 @opindex mleaf-id-shared-library
14314 Generate code that supports shared libraries via the library ID method,
14315 but assumes that this library or executable won't link against any other
14316 ID shared libraries.  That allows the compiler to use faster code for jumps
14317 and calls.
14319 @item -mno-leaf-id-shared-library
14320 @opindex mno-leaf-id-shared-library
14321 Do not assume that the code being compiled won't link against any ID shared
14322 libraries.  Slower code is generated for jump and call insns.
14324 @item -mshared-library-id=n
14325 @opindex mshared-library-id
14326 Specifies the identification number of the ID-based shared library being
14327 compiled.  Specifying a value of 0 generates more compact code; specifying
14328 other values forces the allocation of that number to the current
14329 library but is no more space- or time-efficient than omitting this option.
14331 @item -msep-data
14332 @opindex msep-data
14333 Generate code that allows the data segment to be located in a different
14334 area of memory from the text segment.  This allows for execute in place in
14335 an environment without virtual memory management by eliminating relocations
14336 against the text section.
14338 @item -mno-sep-data
14339 @opindex mno-sep-data
14340 Generate code that assumes that the data segment follows the text segment.
14341 This is the default.
14343 @item -mlong-calls
14344 @itemx -mno-long-calls
14345 @opindex mlong-calls
14346 @opindex mno-long-calls
14347 Tells the compiler to perform function calls by first loading the
14348 address of the function into a register and then performing a subroutine
14349 call on this register.  This switch is needed if the target function
14350 lies outside of the 24-bit addressing range of the offset-based
14351 version of subroutine call instruction.
14353 This feature is not enabled by default.  Specifying
14354 @option{-mno-long-calls} restores the default behavior.  Note these
14355 switches have no effect on how the compiler generates code to handle
14356 function calls via function pointers.
14358 @item -mfast-fp
14359 @opindex mfast-fp
14360 Link with the fast floating-point library. This library relaxes some of
14361 the IEEE floating-point standard's rules for checking inputs against
14362 Not-a-Number (NAN), in the interest of performance.
14364 @item -minline-plt
14365 @opindex minline-plt
14366 Enable inlining of PLT entries in function calls to functions that are
14367 not known to bind locally.  It has no effect without @option{-mfdpic}.
14369 @item -mmulticore
14370 @opindex mmulticore
14371 Build a standalone application for multicore Blackfin processors. 
14372 This option causes proper start files and link scripts supporting 
14373 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
14374 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
14376 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
14377 selects the one-application-per-core programming model.  Without
14378 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
14379 programming model is used. In this model, the main function of Core B
14380 should be named as @code{coreb_main}.
14382 If this option is not used, the single-core application programming
14383 model is used.
14385 @item -mcorea
14386 @opindex mcorea
14387 Build a standalone application for Core A of BF561 when using
14388 the one-application-per-core programming model. Proper start files
14389 and link scripts are used to support Core A, and the macro
14390 @code{__BFIN_COREA} is defined.
14391 This option can only be used in conjunction with @option{-mmulticore}.
14393 @item -mcoreb
14394 @opindex mcoreb
14395 Build a standalone application for Core B of BF561 when using
14396 the one-application-per-core programming model. Proper start files
14397 and link scripts are used to support Core B, and the macro
14398 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
14399 should be used instead of @code{main}. 
14400 This option can only be used in conjunction with @option{-mmulticore}.
14402 @item -msdram
14403 @opindex msdram
14404 Build a standalone application for SDRAM. Proper start files and
14405 link scripts are used to put the application into SDRAM, and the macro
14406 @code{__BFIN_SDRAM} is defined.
14407 The loader should initialize SDRAM before loading the application.
14409 @item -micplb
14410 @opindex micplb
14411 Assume that ICPLBs are enabled at run time.  This has an effect on certain
14412 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
14413 are enabled; for standalone applications the default is off.
14414 @end table
14416 @node C6X Options
14417 @subsection C6X Options
14418 @cindex C6X Options
14420 @table @gcctabopt
14421 @item -march=@var{name}
14422 @opindex march
14423 This specifies the name of the target architecture.  GCC uses this
14424 name to determine what kind of instructions it can emit when generating
14425 assembly code.  Permissible names are: @samp{c62x},
14426 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
14428 @item -mbig-endian
14429 @opindex mbig-endian
14430 Generate code for a big-endian target.
14432 @item -mlittle-endian
14433 @opindex mlittle-endian
14434 Generate code for a little-endian target.  This is the default.
14436 @item -msim
14437 @opindex msim
14438 Choose startup files and linker script suitable for the simulator.
14440 @item -msdata=default
14441 @opindex msdata=default
14442 Put small global and static data in the @code{.neardata} section,
14443 which is pointed to by register @code{B14}.  Put small uninitialized
14444 global and static data in the @code{.bss} section, which is adjacent
14445 to the @code{.neardata} section.  Put small read-only data into the
14446 @code{.rodata} section.  The corresponding sections used for large
14447 pieces of data are @code{.fardata}, @code{.far} and @code{.const}.
14449 @item -msdata=all
14450 @opindex msdata=all
14451 Put all data, not just small objects, into the sections reserved for
14452 small data, and use addressing relative to the @code{B14} register to
14453 access them.
14455 @item -msdata=none
14456 @opindex msdata=none
14457 Make no use of the sections reserved for small data, and use absolute
14458 addresses to access all data.  Put all initialized global and static
14459 data in the @code{.fardata} section, and all uninitialized data in the
14460 @code{.far} section.  Put all constant data into the @code{.const}
14461 section.
14462 @end table
14464 @node CRIS Options
14465 @subsection CRIS Options
14466 @cindex CRIS Options
14468 These options are defined specifically for the CRIS ports.
14470 @table @gcctabopt
14471 @item -march=@var{architecture-type}
14472 @itemx -mcpu=@var{architecture-type}
14473 @opindex march
14474 @opindex mcpu
14475 Generate code for the specified architecture.  The choices for
14476 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
14477 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
14478 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
14479 @samp{v10}.
14481 @item -mtune=@var{architecture-type}
14482 @opindex mtune
14483 Tune to @var{architecture-type} everything applicable about the generated
14484 code, except for the ABI and the set of available instructions.  The
14485 choices for @var{architecture-type} are the same as for
14486 @option{-march=@var{architecture-type}}.
14488 @item -mmax-stack-frame=@var{n}
14489 @opindex mmax-stack-frame
14490 Warn when the stack frame of a function exceeds @var{n} bytes.
14492 @item -metrax4
14493 @itemx -metrax100
14494 @opindex metrax4
14495 @opindex metrax100
14496 The options @option{-metrax4} and @option{-metrax100} are synonyms for
14497 @option{-march=v3} and @option{-march=v8} respectively.
14499 @item -mmul-bug-workaround
14500 @itemx -mno-mul-bug-workaround
14501 @opindex mmul-bug-workaround
14502 @opindex mno-mul-bug-workaround
14503 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
14504 models where it applies.  This option is active by default.
14506 @item -mpdebug
14507 @opindex mpdebug
14508 Enable CRIS-specific verbose debug-related information in the assembly
14509 code.  This option also has the effect of turning off the @samp{#NO_APP}
14510 formatted-code indicator to the assembler at the beginning of the
14511 assembly file.
14513 @item -mcc-init
14514 @opindex mcc-init
14515 Do not use condition-code results from previous instruction; always emit
14516 compare and test instructions before use of condition codes.
14518 @item -mno-side-effects
14519 @opindex mno-side-effects
14520 Do not emit instructions with side effects in addressing modes other than
14521 post-increment.
14523 @item -mstack-align
14524 @itemx -mno-stack-align
14525 @itemx -mdata-align
14526 @itemx -mno-data-align
14527 @itemx -mconst-align
14528 @itemx -mno-const-align
14529 @opindex mstack-align
14530 @opindex mno-stack-align
14531 @opindex mdata-align
14532 @opindex mno-data-align
14533 @opindex mconst-align
14534 @opindex mno-const-align
14535 These options (@samp{no-} options) arrange (eliminate arrangements) for the
14536 stack frame, individual data and constants to be aligned for the maximum
14537 single data access size for the chosen CPU model.  The default is to
14538 arrange for 32-bit alignment.  ABI details such as structure layout are
14539 not affected by these options.
14541 @item -m32-bit
14542 @itemx -m16-bit
14543 @itemx -m8-bit
14544 @opindex m32-bit
14545 @opindex m16-bit
14546 @opindex m8-bit
14547 Similar to the stack- data- and const-align options above, these options
14548 arrange for stack frame, writable data and constants to all be 32-bit,
14549 16-bit or 8-bit aligned.  The default is 32-bit alignment.
14551 @item -mno-prologue-epilogue
14552 @itemx -mprologue-epilogue
14553 @opindex mno-prologue-epilogue
14554 @opindex mprologue-epilogue
14555 With @option{-mno-prologue-epilogue}, the normal function prologue and
14556 epilogue which set up the stack frame are omitted and no return
14557 instructions or return sequences are generated in the code.  Use this
14558 option only together with visual inspection of the compiled code: no
14559 warnings or errors are generated when call-saved registers must be saved,
14560 or storage for local variables needs to be allocated.
14562 @item -mno-gotplt
14563 @itemx -mgotplt
14564 @opindex mno-gotplt
14565 @opindex mgotplt
14566 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
14567 instruction sequences that load addresses for functions from the PLT part
14568 of the GOT rather than (traditional on other architectures) calls to the
14569 PLT@.  The default is @option{-mgotplt}.
14571 @item -melf
14572 @opindex melf
14573 Legacy no-op option only recognized with the cris-axis-elf and
14574 cris-axis-linux-gnu targets.
14576 @item -mlinux
14577 @opindex mlinux
14578 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
14580 @item -sim
14581 @opindex sim
14582 This option, recognized for the cris-axis-elf, arranges
14583 to link with input-output functions from a simulator library.  Code,
14584 initialized data and zero-initialized data are allocated consecutively.
14586 @item -sim2
14587 @opindex sim2
14588 Like @option{-sim}, but pass linker options to locate initialized data at
14589 0x40000000 and zero-initialized data at 0x80000000.
14590 @end table
14592 @node CR16 Options
14593 @subsection CR16 Options
14594 @cindex CR16 Options
14596 These options are defined specifically for the CR16 ports.
14598 @table @gcctabopt
14600 @item -mmac
14601 @opindex mmac
14602 Enable the use of multiply-accumulate instructions. Disabled by default.
14604 @item -mcr16cplus
14605 @itemx -mcr16c
14606 @opindex mcr16cplus
14607 @opindex mcr16c
14608 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14609 is default.
14611 @item -msim
14612 @opindex msim
14613 Links the library libsim.a which is in compatible with simulator. Applicable
14614 to ELF compiler only.
14616 @item -mint32
14617 @opindex mint32
14618 Choose integer type as 32-bit wide.
14620 @item -mbit-ops
14621 @opindex mbit-ops
14622 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14624 @item -mdata-model=@var{model}
14625 @opindex mdata-model
14626 Choose a data model. The choices for @var{model} are @samp{near},
14627 @samp{far} or @samp{medium}. @samp{medium} is default.
14628 However, @samp{far} is not valid with @option{-mcr16c}, as the
14629 CR16C architecture does not support the far data model.
14630 @end table
14632 @node Darwin Options
14633 @subsection Darwin Options
14634 @cindex Darwin options
14636 These options are defined for all architectures running the Darwin operating
14637 system.
14639 FSF GCC on Darwin does not create ``fat'' object files; it creates
14640 an object file for the single architecture that GCC was built to
14641 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14642 @option{-arch} options are used; it does so by running the compiler or
14643 linker multiple times and joining the results together with
14644 @file{lipo}.
14646 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14647 @samp{i686}) is determined by the flags that specify the ISA
14648 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14649 @option{-force_cpusubtype_ALL} option can be used to override this.
14651 The Darwin tools vary in their behavior when presented with an ISA
14652 mismatch.  The assembler, @file{as}, only permits instructions to
14653 be used that are valid for the subtype of the file it is generating,
14654 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14655 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14656 and prints an error if asked to create a shared library with a less
14657 restrictive subtype than its input files (for instance, trying to put
14658 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14659 for executables, @command{ld}, quietly gives the executable the most
14660 restrictive subtype of any of its input files.
14662 @table @gcctabopt
14663 @item -F@var{dir}
14664 @opindex F
14665 Add the framework directory @var{dir} to the head of the list of
14666 directories to be searched for header files.  These directories are
14667 interleaved with those specified by @option{-I} options and are
14668 scanned in a left-to-right order.
14670 A framework directory is a directory with frameworks in it.  A
14671 framework is a directory with a @file{Headers} and/or
14672 @file{PrivateHeaders} directory contained directly in it that ends
14673 in @file{.framework}.  The name of a framework is the name of this
14674 directory excluding the @file{.framework}.  Headers associated with
14675 the framework are found in one of those two directories, with
14676 @file{Headers} being searched first.  A subframework is a framework
14677 directory that is in a framework's @file{Frameworks} directory.
14678 Includes of subframework headers can only appear in a header of a
14679 framework that contains the subframework, or in a sibling subframework
14680 header.  Two subframeworks are siblings if they occur in the same
14681 framework.  A subframework should not have the same name as a
14682 framework; a warning is issued if this is violated.  Currently a
14683 subframework cannot have subframeworks; in the future, the mechanism
14684 may be extended to support this.  The standard frameworks can be found
14685 in @file{/System/Library/Frameworks} and
14686 @file{/Library/Frameworks}.  An example include looks like
14687 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14688 the name of the framework and @file{header.h} is found in the
14689 @file{PrivateHeaders} or @file{Headers} directory.
14691 @item -iframework@var{dir}
14692 @opindex iframework
14693 Like @option{-F} except the directory is a treated as a system
14694 directory.  The main difference between this @option{-iframework} and
14695 @option{-F} is that with @option{-iframework} the compiler does not
14696 warn about constructs contained within header files found via
14697 @var{dir}.  This option is valid only for the C family of languages.
14699 @item -gused
14700 @opindex gused
14701 Emit debugging information for symbols that are used.  For stabs
14702 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14703 This is by default ON@.
14705 @item -gfull
14706 @opindex gfull
14707 Emit debugging information for all symbols and types.
14709 @item -mmacosx-version-min=@var{version}
14710 The earliest version of MacOS X that this executable will run on
14711 is @var{version}.  Typical values of @var{version} include @code{10.1},
14712 @code{10.2}, and @code{10.3.9}.
14714 If the compiler was built to use the system's headers by default,
14715 then the default for this option is the system version on which the
14716 compiler is running, otherwise the default is to make choices that
14717 are compatible with as many systems and code bases as possible.
14719 @item -mkernel
14720 @opindex mkernel
14721 Enable kernel development mode.  The @option{-mkernel} option sets
14722 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14723 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14724 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14725 applicable.  This mode also sets @option{-mno-altivec},
14726 @option{-msoft-float}, @option{-fno-builtin} and
14727 @option{-mlong-branch} for PowerPC targets.
14729 @item -mone-byte-bool
14730 @opindex mone-byte-bool
14731 Override the defaults for @code{bool} so that @code{sizeof(bool)==1}.
14732 By default @code{sizeof(bool)} is @code{4} when compiling for
14733 Darwin/PowerPC and @code{1} when compiling for Darwin/x86, so this
14734 option has no effect on x86.
14736 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14737 to generate code that is not binary compatible with code generated
14738 without that switch.  Using this switch may require recompiling all
14739 other modules in a program, including system libraries.  Use this
14740 switch to conform to a non-default data model.
14742 @item -mfix-and-continue
14743 @itemx -ffix-and-continue
14744 @itemx -findirect-data
14745 @opindex mfix-and-continue
14746 @opindex ffix-and-continue
14747 @opindex findirect-data
14748 Generate code suitable for fast turnaround development, such as to
14749 allow GDB to dynamically load @file{.o} files into already-running
14750 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14751 are provided for backwards compatibility.
14753 @item -all_load
14754 @opindex all_load
14755 Loads all members of static archive libraries.
14756 See man ld(1) for more information.
14758 @item -arch_errors_fatal
14759 @opindex arch_errors_fatal
14760 Cause the errors having to do with files that have the wrong architecture
14761 to be fatal.
14763 @item -bind_at_load
14764 @opindex bind_at_load
14765 Causes the output file to be marked such that the dynamic linker will
14766 bind all undefined references when the file is loaded or launched.
14768 @item -bundle
14769 @opindex bundle
14770 Produce a Mach-o bundle format file.
14771 See man ld(1) for more information.
14773 @item -bundle_loader @var{executable}
14774 @opindex bundle_loader
14775 This option specifies the @var{executable} that will load the build
14776 output file being linked.  See man ld(1) for more information.
14778 @item -dynamiclib
14779 @opindex dynamiclib
14780 When passed this option, GCC produces a dynamic library instead of
14781 an executable when linking, using the Darwin @file{libtool} command.
14783 @item -force_cpusubtype_ALL
14784 @opindex force_cpusubtype_ALL
14785 This causes GCC's output file to have the @samp{ALL} subtype, instead of
14786 one controlled by the @option{-mcpu} or @option{-march} option.
14788 @item -allowable_client  @var{client_name}
14789 @itemx -client_name
14790 @itemx -compatibility_version
14791 @itemx -current_version
14792 @itemx -dead_strip
14793 @itemx -dependency-file
14794 @itemx -dylib_file
14795 @itemx -dylinker_install_name
14796 @itemx -dynamic
14797 @itemx -exported_symbols_list
14798 @itemx -filelist
14799 @need 800
14800 @itemx -flat_namespace
14801 @itemx -force_flat_namespace
14802 @itemx -headerpad_max_install_names
14803 @itemx -image_base
14804 @itemx -init
14805 @itemx -install_name
14806 @itemx -keep_private_externs
14807 @itemx -multi_module
14808 @itemx -multiply_defined
14809 @itemx -multiply_defined_unused
14810 @need 800
14811 @itemx -noall_load
14812 @itemx -no_dead_strip_inits_and_terms
14813 @itemx -nofixprebinding
14814 @itemx -nomultidefs
14815 @itemx -noprebind
14816 @itemx -noseglinkedit
14817 @itemx -pagezero_size
14818 @itemx -prebind
14819 @itemx -prebind_all_twolevel_modules
14820 @itemx -private_bundle
14821 @need 800
14822 @itemx -read_only_relocs
14823 @itemx -sectalign
14824 @itemx -sectobjectsymbols
14825 @itemx -whyload
14826 @itemx -seg1addr
14827 @itemx -sectcreate
14828 @itemx -sectobjectsymbols
14829 @itemx -sectorder
14830 @itemx -segaddr
14831 @itemx -segs_read_only_addr
14832 @need 800
14833 @itemx -segs_read_write_addr
14834 @itemx -seg_addr_table
14835 @itemx -seg_addr_table_filename
14836 @itemx -seglinkedit
14837 @itemx -segprot
14838 @itemx -segs_read_only_addr
14839 @itemx -segs_read_write_addr
14840 @itemx -single_module
14841 @itemx -static
14842 @itemx -sub_library
14843 @need 800
14844 @itemx -sub_umbrella
14845 @itemx -twolevel_namespace
14846 @itemx -umbrella
14847 @itemx -undefined
14848 @itemx -unexported_symbols_list
14849 @itemx -weak_reference_mismatches
14850 @itemx -whatsloaded
14851 @opindex allowable_client
14852 @opindex client_name
14853 @opindex compatibility_version
14854 @opindex current_version
14855 @opindex dead_strip
14856 @opindex dependency-file
14857 @opindex dylib_file
14858 @opindex dylinker_install_name
14859 @opindex dynamic
14860 @opindex exported_symbols_list
14861 @opindex filelist
14862 @opindex flat_namespace
14863 @opindex force_flat_namespace
14864 @opindex headerpad_max_install_names
14865 @opindex image_base
14866 @opindex init
14867 @opindex install_name
14868 @opindex keep_private_externs
14869 @opindex multi_module
14870 @opindex multiply_defined
14871 @opindex multiply_defined_unused
14872 @opindex noall_load
14873 @opindex no_dead_strip_inits_and_terms
14874 @opindex nofixprebinding
14875 @opindex nomultidefs
14876 @opindex noprebind
14877 @opindex noseglinkedit
14878 @opindex pagezero_size
14879 @opindex prebind
14880 @opindex prebind_all_twolevel_modules
14881 @opindex private_bundle
14882 @opindex read_only_relocs
14883 @opindex sectalign
14884 @opindex sectobjectsymbols
14885 @opindex whyload
14886 @opindex seg1addr
14887 @opindex sectcreate
14888 @opindex sectobjectsymbols
14889 @opindex sectorder
14890 @opindex segaddr
14891 @opindex segs_read_only_addr
14892 @opindex segs_read_write_addr
14893 @opindex seg_addr_table
14894 @opindex seg_addr_table_filename
14895 @opindex seglinkedit
14896 @opindex segprot
14897 @opindex segs_read_only_addr
14898 @opindex segs_read_write_addr
14899 @opindex single_module
14900 @opindex static
14901 @opindex sub_library
14902 @opindex sub_umbrella
14903 @opindex twolevel_namespace
14904 @opindex umbrella
14905 @opindex undefined
14906 @opindex unexported_symbols_list
14907 @opindex weak_reference_mismatches
14908 @opindex whatsloaded
14909 These options are passed to the Darwin linker.  The Darwin linker man page
14910 describes them in detail.
14911 @end table
14913 @node DEC Alpha Options
14914 @subsection DEC Alpha Options
14916 These @samp{-m} options are defined for the DEC Alpha implementations:
14918 @table @gcctabopt
14919 @item -mno-soft-float
14920 @itemx -msoft-float
14921 @opindex mno-soft-float
14922 @opindex msoft-float
14923 Use (do not use) the hardware floating-point instructions for
14924 floating-point operations.  When @option{-msoft-float} is specified,
14925 functions in @file{libgcc.a} are used to perform floating-point
14926 operations.  Unless they are replaced by routines that emulate the
14927 floating-point operations, or compiled in such a way as to call such
14928 emulations routines, these routines issue floating-point
14929 operations.   If you are compiling for an Alpha without floating-point
14930 operations, you must ensure that the library is built so as not to call
14931 them.
14933 Note that Alpha implementations without floating-point operations are
14934 required to have floating-point registers.
14936 @item -mfp-reg
14937 @itemx -mno-fp-regs
14938 @opindex mfp-reg
14939 @opindex mno-fp-regs
14940 Generate code that uses (does not use) the floating-point register set.
14941 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14942 register set is not used, floating-point operands are passed in integer
14943 registers as if they were integers and floating-point results are passed
14944 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14945 so any function with a floating-point argument or return value called by code
14946 compiled with @option{-mno-fp-regs} must also be compiled with that
14947 option.
14949 A typical use of this option is building a kernel that does not use,
14950 and hence need not save and restore, any floating-point registers.
14952 @item -mieee
14953 @opindex mieee
14954 The Alpha architecture implements floating-point hardware optimized for
14955 maximum performance.  It is mostly compliant with the IEEE floating-point
14956 standard.  However, for full compliance, software assistance is
14957 required.  This option generates code fully IEEE-compliant code
14958 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14959 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14960 defined during compilation.  The resulting code is less efficient but is
14961 able to correctly support denormalized numbers and exceptional IEEE
14962 values such as not-a-number and plus/minus infinity.  Other Alpha
14963 compilers call this option @option{-ieee_with_no_inexact}.
14965 @item -mieee-with-inexact
14966 @opindex mieee-with-inexact
14967 This is like @option{-mieee} except the generated code also maintains
14968 the IEEE @var{inexact-flag}.  Turning on this option causes the
14969 generated code to implement fully-compliant IEEE math.  In addition to
14970 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14971 macro.  On some Alpha implementations the resulting code may execute
14972 significantly slower than the code generated by default.  Since there is
14973 very little code that depends on the @var{inexact-flag}, you should
14974 normally not specify this option.  Other Alpha compilers call this
14975 option @option{-ieee_with_inexact}.
14977 @item -mfp-trap-mode=@var{trap-mode}
14978 @opindex mfp-trap-mode
14979 This option controls what floating-point related traps are enabled.
14980 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14981 The trap mode can be set to one of four values:
14983 @table @samp
14984 @item n
14985 This is the default (normal) setting.  The only traps that are enabled
14986 are the ones that cannot be disabled in software (e.g., division by zero
14987 trap).
14989 @item u
14990 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14991 as well.
14993 @item su
14994 Like @samp{u}, but the instructions are marked to be safe for software
14995 completion (see Alpha architecture manual for details).
14997 @item sui
14998 Like @samp{su}, but inexact traps are enabled as well.
14999 @end table
15001 @item -mfp-rounding-mode=@var{rounding-mode}
15002 @opindex mfp-rounding-mode
15003 Selects the IEEE rounding mode.  Other Alpha compilers call this option
15004 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
15007 @table @samp
15008 @item n
15009 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
15010 the nearest machine number or towards the even machine number in case
15011 of a tie.
15013 @item m
15014 Round towards minus infinity.
15016 @item c
15017 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
15019 @item d
15020 Dynamic rounding mode.  A field in the floating-point control register
15021 (@var{fpcr}, see Alpha architecture reference manual) controls the
15022 rounding mode in effect.  The C library initializes this register for
15023 rounding towards plus infinity.  Thus, unless your program modifies the
15024 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
15025 @end table
15027 @item -mtrap-precision=@var{trap-precision}
15028 @opindex mtrap-precision
15029 In the Alpha architecture, floating-point traps are imprecise.  This
15030 means without software assistance it is impossible to recover from a
15031 floating trap and program execution normally needs to be terminated.
15032 GCC can generate code that can assist operating system trap handlers
15033 in determining the exact location that caused a floating-point trap.
15034 Depending on the requirements of an application, different levels of
15035 precisions can be selected:
15037 @table @samp
15038 @item p
15039 Program precision.  This option is the default and means a trap handler
15040 can only identify which program caused a floating-point exception.
15042 @item f
15043 Function precision.  The trap handler can determine the function that
15044 caused a floating-point exception.
15046 @item i
15047 Instruction precision.  The trap handler can determine the exact
15048 instruction that caused a floating-point exception.
15049 @end table
15051 Other Alpha compilers provide the equivalent options called
15052 @option{-scope_safe} and @option{-resumption_safe}.
15054 @item -mieee-conformant
15055 @opindex mieee-conformant
15056 This option marks the generated code as IEEE conformant.  You must not
15057 use this option unless you also specify @option{-mtrap-precision=i} and either
15058 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
15059 is to emit the line @samp{.eflag 48} in the function prologue of the
15060 generated assembly file.
15062 @item -mbuild-constants
15063 @opindex mbuild-constants
15064 Normally GCC examines a 32- or 64-bit integer constant to
15065 see if it can construct it from smaller constants in two or three
15066 instructions.  If it cannot, it outputs the constant as a literal and
15067 generates code to load it from the data segment at run time.
15069 Use this option to require GCC to construct @emph{all} integer constants
15070 using code, even if it takes more instructions (the maximum is six).
15072 You typically use this option to build a shared library dynamic
15073 loader.  Itself a shared library, it must relocate itself in memory
15074 before it can find the variables and constants in its own data segment.
15076 @item -mbwx
15077 @itemx -mno-bwx
15078 @itemx -mcix
15079 @itemx -mno-cix
15080 @itemx -mfix
15081 @itemx -mno-fix
15082 @itemx -mmax
15083 @itemx -mno-max
15084 @opindex mbwx
15085 @opindex mno-bwx
15086 @opindex mcix
15087 @opindex mno-cix
15088 @opindex mfix
15089 @opindex mno-fix
15090 @opindex mmax
15091 @opindex mno-max
15092 Indicate whether GCC should generate code to use the optional BWX,
15093 CIX, FIX and MAX instruction sets.  The default is to use the instruction
15094 sets supported by the CPU type specified via @option{-mcpu=} option or that
15095 of the CPU on which GCC was built if none is specified.
15097 @item -mfloat-vax
15098 @itemx -mfloat-ieee
15099 @opindex mfloat-vax
15100 @opindex mfloat-ieee
15101 Generate code that uses (does not use) VAX F and G floating-point
15102 arithmetic instead of IEEE single and double precision.
15104 @item -mexplicit-relocs
15105 @itemx -mno-explicit-relocs
15106 @opindex mexplicit-relocs
15107 @opindex mno-explicit-relocs
15108 Older Alpha assemblers provided no way to generate symbol relocations
15109 except via assembler macros.  Use of these macros does not allow
15110 optimal instruction scheduling.  GNU binutils as of version 2.12
15111 supports a new syntax that allows the compiler to explicitly mark
15112 which relocations should apply to which instructions.  This option
15113 is mostly useful for debugging, as GCC detects the capabilities of
15114 the assembler when it is built and sets the default accordingly.
15116 @item -msmall-data
15117 @itemx -mlarge-data
15118 @opindex msmall-data
15119 @opindex mlarge-data
15120 When @option{-mexplicit-relocs} is in effect, static data is
15121 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
15122 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
15123 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
15124 16-bit relocations off of the @code{$gp} register.  This limits the
15125 size of the small data area to 64KB, but allows the variables to be
15126 directly accessed via a single instruction.
15128 The default is @option{-mlarge-data}.  With this option the data area
15129 is limited to just below 2GB@.  Programs that require more than 2GB of
15130 data must use @code{malloc} or @code{mmap} to allocate the data in the
15131 heap instead of in the program's data segment.
15133 When generating code for shared libraries, @option{-fpic} implies
15134 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
15136 @item -msmall-text
15137 @itemx -mlarge-text
15138 @opindex msmall-text
15139 @opindex mlarge-text
15140 When @option{-msmall-text} is used, the compiler assumes that the
15141 code of the entire program (or shared library) fits in 4MB, and is
15142 thus reachable with a branch instruction.  When @option{-msmall-data}
15143 is used, the compiler can assume that all local symbols share the
15144 same @code{$gp} value, and thus reduce the number of instructions
15145 required for a function call from 4 to 1.
15147 The default is @option{-mlarge-text}.
15149 @item -mcpu=@var{cpu_type}
15150 @opindex mcpu
15151 Set the instruction set and instruction scheduling parameters for
15152 machine type @var{cpu_type}.  You can specify either the @samp{EV}
15153 style name or the corresponding chip number.  GCC supports scheduling
15154 parameters for the EV4, EV5 and EV6 family of processors and
15155 chooses the default values for the instruction set from the processor
15156 you specify.  If you do not specify a processor type, GCC defaults
15157 to the processor on which the compiler was built.
15159 Supported values for @var{cpu_type} are
15161 @table @samp
15162 @item ev4
15163 @itemx ev45
15164 @itemx 21064
15165 Schedules as an EV4 and has no instruction set extensions.
15167 @item ev5
15168 @itemx 21164
15169 Schedules as an EV5 and has no instruction set extensions.
15171 @item ev56
15172 @itemx 21164a
15173 Schedules as an EV5 and supports the BWX extension.
15175 @item pca56
15176 @itemx 21164pc
15177 @itemx 21164PC
15178 Schedules as an EV5 and supports the BWX and MAX extensions.
15180 @item ev6
15181 @itemx 21264
15182 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
15184 @item ev67
15185 @itemx 21264a
15186 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
15187 @end table
15189 Native toolchains also support the value @samp{native},
15190 which selects the best architecture option for the host processor.
15191 @option{-mcpu=native} has no effect if GCC does not recognize
15192 the processor.
15194 @item -mtune=@var{cpu_type}
15195 @opindex mtune
15196 Set only the instruction scheduling parameters for machine type
15197 @var{cpu_type}.  The instruction set is not changed.
15199 Native toolchains also support the value @samp{native},
15200 which selects the best architecture option for the host processor.
15201 @option{-mtune=native} has no effect if GCC does not recognize
15202 the processor.
15204 @item -mmemory-latency=@var{time}
15205 @opindex mmemory-latency
15206 Sets the latency the scheduler should assume for typical memory
15207 references as seen by the application.  This number is highly
15208 dependent on the memory access patterns used by the application
15209 and the size of the external cache on the machine.
15211 Valid options for @var{time} are
15213 @table @samp
15214 @item @var{number}
15215 A decimal number representing clock cycles.
15217 @item L1
15218 @itemx L2
15219 @itemx L3
15220 @itemx main
15221 The compiler contains estimates of the number of clock cycles for
15222 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
15223 (also called Dcache, Scache, and Bcache), as well as to main memory.
15224 Note that L3 is only valid for EV5.
15226 @end table
15227 @end table
15229 @node FR30 Options
15230 @subsection FR30 Options
15231 @cindex FR30 Options
15233 These options are defined specifically for the FR30 port.
15235 @table @gcctabopt
15237 @item -msmall-model
15238 @opindex msmall-model
15239 Use the small address space model.  This can produce smaller code, but
15240 it does assume that all symbolic values and addresses fit into a
15241 20-bit range.
15243 @item -mno-lsim
15244 @opindex mno-lsim
15245 Assume that runtime support has been provided and so there is no need
15246 to include the simulator library (@file{libsim.a}) on the linker
15247 command line.
15249 @end table
15251 @node FT32 Options
15252 @subsection FT32 Options
15253 @cindex FT32 Options
15255 These options are defined specifically for the FT32 port.
15257 @table @gcctabopt
15259 @item -msim
15260 @opindex msim
15261 Specifies that the program will be run on the simulator.  This causes
15262 an alternate runtime startup and library to be linked.
15263 You must not use this option when generating programs that will run on
15264 real hardware; you must provide your own runtime library for whatever
15265 I/O functions are needed.
15267 @item -mlra
15268 @opindex mlra
15269 Enable Local Register Allocation.  This is still experimental for FT32,
15270 so by default the compiler uses standard reload.
15272 @end table
15274 @node FRV Options
15275 @subsection FRV Options
15276 @cindex FRV Options
15278 @table @gcctabopt
15279 @item -mgpr-32
15280 @opindex mgpr-32
15282 Only use the first 32 general-purpose registers.
15284 @item -mgpr-64
15285 @opindex mgpr-64
15287 Use all 64 general-purpose registers.
15289 @item -mfpr-32
15290 @opindex mfpr-32
15292 Use only the first 32 floating-point registers.
15294 @item -mfpr-64
15295 @opindex mfpr-64
15297 Use all 64 floating-point registers.
15299 @item -mhard-float
15300 @opindex mhard-float
15302 Use hardware instructions for floating-point operations.
15304 @item -msoft-float
15305 @opindex msoft-float
15307 Use library routines for floating-point operations.
15309 @item -malloc-cc
15310 @opindex malloc-cc
15312 Dynamically allocate condition code registers.
15314 @item -mfixed-cc
15315 @opindex mfixed-cc
15317 Do not try to dynamically allocate condition code registers, only
15318 use @code{icc0} and @code{fcc0}.
15320 @item -mdword
15321 @opindex mdword
15323 Change ABI to use double word insns.
15325 @item -mno-dword
15326 @opindex mno-dword
15328 Do not use double word instructions.
15330 @item -mdouble
15331 @opindex mdouble
15333 Use floating-point double instructions.
15335 @item -mno-double
15336 @opindex mno-double
15338 Do not use floating-point double instructions.
15340 @item -mmedia
15341 @opindex mmedia
15343 Use media instructions.
15345 @item -mno-media
15346 @opindex mno-media
15348 Do not use media instructions.
15350 @item -mmuladd
15351 @opindex mmuladd
15353 Use multiply and add/subtract instructions.
15355 @item -mno-muladd
15356 @opindex mno-muladd
15358 Do not use multiply and add/subtract instructions.
15360 @item -mfdpic
15361 @opindex mfdpic
15363 Select the FDPIC ABI, which uses function descriptors to represent
15364 pointers to functions.  Without any PIC/PIE-related options, it
15365 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
15366 assumes GOT entries and small data are within a 12-bit range from the
15367 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
15368 are computed with 32 bits.
15369 With a @samp{bfin-elf} target, this option implies @option{-msim}.
15371 @item -minline-plt
15372 @opindex minline-plt
15374 Enable inlining of PLT entries in function calls to functions that are
15375 not known to bind locally.  It has no effect without @option{-mfdpic}.
15376 It's enabled by default if optimizing for speed and compiling for
15377 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
15378 optimization option such as @option{-O3} or above is present in the
15379 command line.
15381 @item -mTLS
15382 @opindex mTLS
15384 Assume a large TLS segment when generating thread-local code.
15386 @item -mtls
15387 @opindex mtls
15389 Do not assume a large TLS segment when generating thread-local code.
15391 @item -mgprel-ro
15392 @opindex mgprel-ro
15394 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
15395 that is known to be in read-only sections.  It's enabled by default,
15396 except for @option{-fpic} or @option{-fpie}: even though it may help
15397 make the global offset table smaller, it trades 1 instruction for 4.
15398 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
15399 one of which may be shared by multiple symbols, and it avoids the need
15400 for a GOT entry for the referenced symbol, so it's more likely to be a
15401 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
15403 @item -multilib-library-pic
15404 @opindex multilib-library-pic
15406 Link with the (library, not FD) pic libraries.  It's implied by
15407 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
15408 @option{-fpic} without @option{-mfdpic}.  You should never have to use
15409 it explicitly.
15411 @item -mlinked-fp
15412 @opindex mlinked-fp
15414 Follow the EABI requirement of always creating a frame pointer whenever
15415 a stack frame is allocated.  This option is enabled by default and can
15416 be disabled with @option{-mno-linked-fp}.
15418 @item -mlong-calls
15419 @opindex mlong-calls
15421 Use indirect addressing to call functions outside the current
15422 compilation unit.  This allows the functions to be placed anywhere
15423 within the 32-bit address space.
15425 @item -malign-labels
15426 @opindex malign-labels
15428 Try to align labels to an 8-byte boundary by inserting NOPs into the
15429 previous packet.  This option only has an effect when VLIW packing
15430 is enabled.  It doesn't create new packets; it merely adds NOPs to
15431 existing ones.
15433 @item -mlibrary-pic
15434 @opindex mlibrary-pic
15436 Generate position-independent EABI code.
15438 @item -macc-4
15439 @opindex macc-4
15441 Use only the first four media accumulator registers.
15443 @item -macc-8
15444 @opindex macc-8
15446 Use all eight media accumulator registers.
15448 @item -mpack
15449 @opindex mpack
15451 Pack VLIW instructions.
15453 @item -mno-pack
15454 @opindex mno-pack
15456 Do not pack VLIW instructions.
15458 @item -mno-eflags
15459 @opindex mno-eflags
15461 Do not mark ABI switches in e_flags.
15463 @item -mcond-move
15464 @opindex mcond-move
15466 Enable the use of conditional-move instructions (default).
15468 This switch is mainly for debugging the compiler and will likely be removed
15469 in a future version.
15471 @item -mno-cond-move
15472 @opindex mno-cond-move
15474 Disable the use of conditional-move instructions.
15476 This switch is mainly for debugging the compiler and will likely be removed
15477 in a future version.
15479 @item -mscc
15480 @opindex mscc
15482 Enable the use of conditional set instructions (default).
15484 This switch is mainly for debugging the compiler and will likely be removed
15485 in a future version.
15487 @item -mno-scc
15488 @opindex mno-scc
15490 Disable the use of conditional set instructions.
15492 This switch is mainly for debugging the compiler and will likely be removed
15493 in a future version.
15495 @item -mcond-exec
15496 @opindex mcond-exec
15498 Enable the use of conditional execution (default).
15500 This switch is mainly for debugging the compiler and will likely be removed
15501 in a future version.
15503 @item -mno-cond-exec
15504 @opindex mno-cond-exec
15506 Disable the use of conditional execution.
15508 This switch is mainly for debugging the compiler and will likely be removed
15509 in a future version.
15511 @item -mvliw-branch
15512 @opindex mvliw-branch
15514 Run a pass to pack branches into VLIW instructions (default).
15516 This switch is mainly for debugging the compiler and will likely be removed
15517 in a future version.
15519 @item -mno-vliw-branch
15520 @opindex mno-vliw-branch
15522 Do not run a pass to pack branches into VLIW instructions.
15524 This switch is mainly for debugging the compiler and will likely be removed
15525 in a future version.
15527 @item -mmulti-cond-exec
15528 @opindex mmulti-cond-exec
15530 Enable optimization of @code{&&} and @code{||} in conditional execution
15531 (default).
15533 This switch is mainly for debugging the compiler and will likely be removed
15534 in a future version.
15536 @item -mno-multi-cond-exec
15537 @opindex mno-multi-cond-exec
15539 Disable optimization of @code{&&} and @code{||} in conditional execution.
15541 This switch is mainly for debugging the compiler and will likely be removed
15542 in a future version.
15544 @item -mnested-cond-exec
15545 @opindex mnested-cond-exec
15547 Enable nested conditional execution optimizations (default).
15549 This switch is mainly for debugging the compiler and will likely be removed
15550 in a future version.
15552 @item -mno-nested-cond-exec
15553 @opindex mno-nested-cond-exec
15555 Disable nested conditional execution optimizations.
15557 This switch is mainly for debugging the compiler and will likely be removed
15558 in a future version.
15560 @item -moptimize-membar
15561 @opindex moptimize-membar
15563 This switch removes redundant @code{membar} instructions from the
15564 compiler-generated code.  It is enabled by default.
15566 @item -mno-optimize-membar
15567 @opindex mno-optimize-membar
15569 This switch disables the automatic removal of redundant @code{membar}
15570 instructions from the generated code.
15572 @item -mtomcat-stats
15573 @opindex mtomcat-stats
15575 Cause gas to print out tomcat statistics.
15577 @item -mcpu=@var{cpu}
15578 @opindex mcpu
15580 Select the processor type for which to generate code.  Possible values are
15581 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
15582 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
15584 @end table
15586 @node GNU/Linux Options
15587 @subsection GNU/Linux Options
15589 These @samp{-m} options are defined for GNU/Linux targets:
15591 @table @gcctabopt
15592 @item -mglibc
15593 @opindex mglibc
15594 Use the GNU C library.  This is the default except
15595 on @samp{*-*-linux-*uclibc*}, @samp{*-*-linux-*musl*} and
15596 @samp{*-*-linux-*android*} targets.
15598 @item -muclibc
15599 @opindex muclibc
15600 Use uClibc C library.  This is the default on
15601 @samp{*-*-linux-*uclibc*} targets.
15603 @item -mmusl
15604 @opindex mmusl
15605 Use the musl C library.  This is the default on
15606 @samp{*-*-linux-*musl*} targets.
15608 @item -mbionic
15609 @opindex mbionic
15610 Use Bionic C library.  This is the default on
15611 @samp{*-*-linux-*android*} targets.
15613 @item -mandroid
15614 @opindex mandroid
15615 Compile code compatible with Android platform.  This is the default on
15616 @samp{*-*-linux-*android*} targets.
15618 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15619 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15620 this option makes the GCC driver pass Android-specific options to the linker.
15621 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15622 to be defined.
15624 @item -tno-android-cc
15625 @opindex tno-android-cc
15626 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15627 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15628 @option{-fno-rtti} by default.
15630 @item -tno-android-ld
15631 @opindex tno-android-ld
15632 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15633 linking options to the linker.
15635 @end table
15637 @node H8/300 Options
15638 @subsection H8/300 Options
15640 These @samp{-m} options are defined for the H8/300 implementations:
15642 @table @gcctabopt
15643 @item -mrelax
15644 @opindex mrelax
15645 Shorten some address references at link time, when possible; uses the
15646 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15647 ld, Using ld}, for a fuller description.
15649 @item -mh
15650 @opindex mh
15651 Generate code for the H8/300H@.
15653 @item -ms
15654 @opindex ms
15655 Generate code for the H8S@.
15657 @item -mn
15658 @opindex mn
15659 Generate code for the H8S and H8/300H in the normal mode.  This switch
15660 must be used either with @option{-mh} or @option{-ms}.
15662 @item -ms2600
15663 @opindex ms2600
15664 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15666 @item -mexr
15667 @opindex mexr
15668 Extended registers are stored on stack before execution of function
15669 with monitor attribute. Default option is @option{-mexr}.
15670 This option is valid only for H8S targets.
15672 @item -mno-exr
15673 @opindex mno-exr
15674 Extended registers are not stored on stack before execution of function 
15675 with monitor attribute. Default option is @option{-mno-exr}. 
15676 This option is valid only for H8S targets.
15678 @item -mint32
15679 @opindex mint32
15680 Make @code{int} data 32 bits by default.
15682 @item -malign-300
15683 @opindex malign-300
15684 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15685 The default for the H8/300H and H8S is to align longs and floats on
15686 4-byte boundaries.
15687 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15688 This option has no effect on the H8/300.
15689 @end table
15691 @node HPPA Options
15692 @subsection HPPA Options
15693 @cindex HPPA Options
15695 These @samp{-m} options are defined for the HPPA family of computers:
15697 @table @gcctabopt
15698 @item -march=@var{architecture-type}
15699 @opindex march
15700 Generate code for the specified architecture.  The choices for
15701 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15702 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15703 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15704 architecture option for your machine.  Code compiled for lower numbered
15705 architectures runs on higher numbered architectures, but not the
15706 other way around.
15708 @item -mpa-risc-1-0
15709 @itemx -mpa-risc-1-1
15710 @itemx -mpa-risc-2-0
15711 @opindex mpa-risc-1-0
15712 @opindex mpa-risc-1-1
15713 @opindex mpa-risc-2-0
15714 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15716 @item -mjump-in-delay
15717 @opindex mjump-in-delay
15718 This option is ignored and provided for compatibility purposes only.
15720 @item -mdisable-fpregs
15721 @opindex mdisable-fpregs
15722 Prevent floating-point registers from being used in any manner.  This is
15723 necessary for compiling kernels that perform lazy context switching of
15724 floating-point registers.  If you use this option and attempt to perform
15725 floating-point operations, the compiler aborts.
15727 @item -mdisable-indexing
15728 @opindex mdisable-indexing
15729 Prevent the compiler from using indexing address modes.  This avoids some
15730 rather obscure problems when compiling MIG generated code under MACH@.
15732 @item -mno-space-regs
15733 @opindex mno-space-regs
15734 Generate code that assumes the target has no space registers.  This allows
15735 GCC to generate faster indirect calls and use unscaled index address modes.
15737 Such code is suitable for level 0 PA systems and kernels.
15739 @item -mfast-indirect-calls
15740 @opindex mfast-indirect-calls
15741 Generate code that assumes calls never cross space boundaries.  This
15742 allows GCC to emit code that performs faster indirect calls.
15744 This option does not work in the presence of shared libraries or nested
15745 functions.
15747 @item -mfixed-range=@var{register-range}
15748 @opindex mfixed-range
15749 Generate code treating the given register range as fixed registers.
15750 A fixed register is one that the register allocator cannot use.  This is
15751 useful when compiling kernel code.  A register range is specified as
15752 two registers separated by a dash.  Multiple register ranges can be
15753 specified separated by a comma.
15755 @item -mlong-load-store
15756 @opindex mlong-load-store
15757 Generate 3-instruction load and store sequences as sometimes required by
15758 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15759 the HP compilers.
15761 @item -mportable-runtime
15762 @opindex mportable-runtime
15763 Use the portable calling conventions proposed by HP for ELF systems.
15765 @item -mgas
15766 @opindex mgas
15767 Enable the use of assembler directives only GAS understands.
15769 @item -mschedule=@var{cpu-type}
15770 @opindex mschedule
15771 Schedule code according to the constraints for the machine type
15772 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15773 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15774 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15775 proper scheduling option for your machine.  The default scheduling is
15776 @samp{8000}.
15778 @item -mlinker-opt
15779 @opindex mlinker-opt
15780 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15781 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15782 linkers in which they give bogus error messages when linking some programs.
15784 @item -msoft-float
15785 @opindex msoft-float
15786 Generate output containing library calls for floating point.
15787 @strong{Warning:} the requisite libraries are not available for all HPPA
15788 targets.  Normally the facilities of the machine's usual C compiler are
15789 used, but this cannot be done directly in cross-compilation.  You must make
15790 your own arrangements to provide suitable library functions for
15791 cross-compilation.
15793 @option{-msoft-float} changes the calling convention in the output file;
15794 therefore, it is only useful if you compile @emph{all} of a program with
15795 this option.  In particular, you need to compile @file{libgcc.a}, the
15796 library that comes with GCC, with @option{-msoft-float} in order for
15797 this to work.
15799 @item -msio
15800 @opindex msio
15801 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15802 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15803 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15804 options are available under HP-UX and HI-UX@.
15806 @item -mgnu-ld
15807 @opindex mgnu-ld
15808 Use options specific to GNU @command{ld}.
15809 This passes @option{-shared} to @command{ld} when
15810 building a shared library.  It is the default when GCC is configured,
15811 explicitly or implicitly, with the GNU linker.  This option does not
15812 affect which @command{ld} is called; it only changes what parameters
15813 are passed to that @command{ld}.
15814 The @command{ld} that is called is determined by the
15815 @option{--with-ld} configure option, GCC's program search path, and
15816 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15817 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15818 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15820 @item -mhp-ld
15821 @opindex mhp-ld
15822 Use options specific to HP @command{ld}.
15823 This passes @option{-b} to @command{ld} when building
15824 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15825 links.  It is the default when GCC is configured, explicitly or
15826 implicitly, with the HP linker.  This option does not affect
15827 which @command{ld} is called; it only changes what parameters are passed to that
15828 @command{ld}.
15829 The @command{ld} that is called is determined by the @option{--with-ld}
15830 configure option, GCC's program search path, and finally by the user's
15831 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15832 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15833 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15835 @item -mlong-calls
15836 @opindex mno-long-calls
15837 Generate code that uses long call sequences.  This ensures that a call
15838 is always able to reach linker generated stubs.  The default is to generate
15839 long calls only when the distance from the call site to the beginning
15840 of the function or translation unit, as the case may be, exceeds a
15841 predefined limit set by the branch type being used.  The limits for
15842 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15843 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15844 240,000 bytes.
15846 Distances are measured from the beginning of functions when using the
15847 @option{-ffunction-sections} option, or when using the @option{-mgas}
15848 and @option{-mno-portable-runtime} options together under HP-UX with
15849 the SOM linker.
15851 It is normally not desirable to use this option as it degrades
15852 performance.  However, it may be useful in large applications,
15853 particularly when partial linking is used to build the application.
15855 The types of long calls used depends on the capabilities of the
15856 assembler and linker, and the type of code being generated.  The
15857 impact on systems that support long absolute calls, and long pic
15858 symbol-difference or pc-relative calls should be relatively small.
15859 However, an indirect call is used on 32-bit ELF systems in pic code
15860 and it is quite long.
15862 @item -munix=@var{unix-std}
15863 @opindex march
15864 Generate compiler predefines and select a startfile for the specified
15865 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15866 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15867 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15868 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15869 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15870 and later.
15872 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15873 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15874 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15875 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15876 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15877 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15879 It is @emph{important} to note that this option changes the interfaces
15880 for various library routines.  It also affects the operational behavior
15881 of the C library.  Thus, @emph{extreme} care is needed in using this
15882 option.
15884 Library code that is intended to operate with more than one UNIX
15885 standard must test, set and restore the variable @code{__xpg4_extended_mask}
15886 as appropriate.  Most GNU software doesn't provide this capability.
15888 @item -nolibdld
15889 @opindex nolibdld
15890 Suppress the generation of link options to search libdld.sl when the
15891 @option{-static} option is specified on HP-UX 10 and later.
15893 @item -static
15894 @opindex static
15895 The HP-UX implementation of setlocale in libc has a dependency on
15896 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15897 when the @option{-static} option is specified, special link options
15898 are needed to resolve this dependency.
15900 On HP-UX 10 and later, the GCC driver adds the necessary options to
15901 link with libdld.sl when the @option{-static} option is specified.
15902 This causes the resulting binary to be dynamic.  On the 64-bit port,
15903 the linkers generate dynamic binaries by default in any case.  The
15904 @option{-nolibdld} option can be used to prevent the GCC driver from
15905 adding these link options.
15907 @item -threads
15908 @opindex threads
15909 Add support for multithreading with the @dfn{dce thread} library
15910 under HP-UX@.  This option sets flags for both the preprocessor and
15911 linker.
15912 @end table
15914 @node IA-64 Options
15915 @subsection IA-64 Options
15916 @cindex IA-64 Options
15918 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15920 @table @gcctabopt
15921 @item -mbig-endian
15922 @opindex mbig-endian
15923 Generate code for a big-endian target.  This is the default for HP-UX@.
15925 @item -mlittle-endian
15926 @opindex mlittle-endian
15927 Generate code for a little-endian target.  This is the default for AIX5
15928 and GNU/Linux.
15930 @item -mgnu-as
15931 @itemx -mno-gnu-as
15932 @opindex mgnu-as
15933 @opindex mno-gnu-as
15934 Generate (or don't) code for the GNU assembler.  This is the default.
15935 @c Also, this is the default if the configure option @option{--with-gnu-as}
15936 @c is used.
15938 @item -mgnu-ld
15939 @itemx -mno-gnu-ld
15940 @opindex mgnu-ld
15941 @opindex mno-gnu-ld
15942 Generate (or don't) code for the GNU linker.  This is the default.
15943 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15944 @c is used.
15946 @item -mno-pic
15947 @opindex mno-pic
15948 Generate code that does not use a global pointer register.  The result
15949 is not position independent code, and violates the IA-64 ABI@.
15951 @item -mvolatile-asm-stop
15952 @itemx -mno-volatile-asm-stop
15953 @opindex mvolatile-asm-stop
15954 @opindex mno-volatile-asm-stop
15955 Generate (or don't) a stop bit immediately before and after volatile asm
15956 statements.
15958 @item -mregister-names
15959 @itemx -mno-register-names
15960 @opindex mregister-names
15961 @opindex mno-register-names
15962 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15963 the stacked registers.  This may make assembler output more readable.
15965 @item -mno-sdata
15966 @itemx -msdata
15967 @opindex mno-sdata
15968 @opindex msdata
15969 Disable (or enable) optimizations that use the small data section.  This may
15970 be useful for working around optimizer bugs.
15972 @item -mconstant-gp
15973 @opindex mconstant-gp
15974 Generate code that uses a single constant global pointer value.  This is
15975 useful when compiling kernel code.
15977 @item -mauto-pic
15978 @opindex mauto-pic
15979 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15980 This is useful when compiling firmware code.
15982 @item -minline-float-divide-min-latency
15983 @opindex minline-float-divide-min-latency
15984 Generate code for inline divides of floating-point values
15985 using the minimum latency algorithm.
15987 @item -minline-float-divide-max-throughput
15988 @opindex minline-float-divide-max-throughput
15989 Generate code for inline divides of floating-point values
15990 using the maximum throughput algorithm.
15992 @item -mno-inline-float-divide
15993 @opindex mno-inline-float-divide
15994 Do not generate inline code for divides of floating-point values.
15996 @item -minline-int-divide-min-latency
15997 @opindex minline-int-divide-min-latency
15998 Generate code for inline divides of integer values
15999 using the minimum latency algorithm.
16001 @item -minline-int-divide-max-throughput
16002 @opindex minline-int-divide-max-throughput
16003 Generate code for inline divides of integer values
16004 using the maximum throughput algorithm.
16006 @item -mno-inline-int-divide
16007 @opindex mno-inline-int-divide
16008 Do not generate inline code for divides of integer values.
16010 @item -minline-sqrt-min-latency
16011 @opindex minline-sqrt-min-latency
16012 Generate code for inline square roots
16013 using the minimum latency algorithm.
16015 @item -minline-sqrt-max-throughput
16016 @opindex minline-sqrt-max-throughput
16017 Generate code for inline square roots
16018 using the maximum throughput algorithm.
16020 @item -mno-inline-sqrt
16021 @opindex mno-inline-sqrt
16022 Do not generate inline code for @code{sqrt}.
16024 @item -mfused-madd
16025 @itemx -mno-fused-madd
16026 @opindex mfused-madd
16027 @opindex mno-fused-madd
16028 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16029 instructions.  The default is to use these instructions.
16031 @item -mno-dwarf2-asm
16032 @itemx -mdwarf2-asm
16033 @opindex mno-dwarf2-asm
16034 @opindex mdwarf2-asm
16035 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16036 info.  This may be useful when not using the GNU assembler.
16038 @item -mearly-stop-bits
16039 @itemx -mno-early-stop-bits
16040 @opindex mearly-stop-bits
16041 @opindex mno-early-stop-bits
16042 Allow stop bits to be placed earlier than immediately preceding the
16043 instruction that triggered the stop bit.  This can improve instruction
16044 scheduling, but does not always do so.
16046 @item -mfixed-range=@var{register-range}
16047 @opindex mfixed-range
16048 Generate code treating the given register range as fixed registers.
16049 A fixed register is one that the register allocator cannot use.  This is
16050 useful when compiling kernel code.  A register range is specified as
16051 two registers separated by a dash.  Multiple register ranges can be
16052 specified separated by a comma.
16054 @item -mtls-size=@var{tls-size}
16055 @opindex mtls-size
16056 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16059 @item -mtune=@var{cpu-type}
16060 @opindex mtune
16061 Tune the instruction scheduling for a particular CPU, Valid values are
16062 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16063 and @samp{mckinley}.
16065 @item -milp32
16066 @itemx -mlp64
16067 @opindex milp32
16068 @opindex mlp64
16069 Generate code for a 32-bit or 64-bit environment.
16070 The 32-bit environment sets int, long and pointer to 32 bits.
16071 The 64-bit environment sets int to 32 bits and long and pointer
16072 to 64 bits.  These are HP-UX specific flags.
16074 @item -mno-sched-br-data-spec
16075 @itemx -msched-br-data-spec
16076 @opindex mno-sched-br-data-spec
16077 @opindex msched-br-data-spec
16078 (Dis/En)able data speculative scheduling before reload.
16079 This results in generation of @code{ld.a} instructions and
16080 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16081 The default is 'disable'.
16083 @item -msched-ar-data-spec
16084 @itemx -mno-sched-ar-data-spec
16085 @opindex msched-ar-data-spec
16086 @opindex mno-sched-ar-data-spec
16087 (En/Dis)able data speculative scheduling after reload.
16088 This results in generation of @code{ld.a} instructions and
16089 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16090 The default is 'enable'.
16092 @item -mno-sched-control-spec
16093 @itemx -msched-control-spec
16094 @opindex mno-sched-control-spec
16095 @opindex msched-control-spec
16096 (Dis/En)able control speculative scheduling.  This feature is
16097 available only during region scheduling (i.e.@: before reload).
16098 This results in generation of the @code{ld.s} instructions and
16099 the corresponding check instructions @code{chk.s}.
16100 The default is 'disable'.
16102 @item -msched-br-in-data-spec
16103 @itemx -mno-sched-br-in-data-spec
16104 @opindex msched-br-in-data-spec
16105 @opindex mno-sched-br-in-data-spec
16106 (En/Dis)able speculative scheduling of the instructions that
16107 are dependent on the data speculative loads before reload.
16108 This is effective only with @option{-msched-br-data-spec} enabled.
16109 The default is 'enable'.
16111 @item -msched-ar-in-data-spec
16112 @itemx -mno-sched-ar-in-data-spec
16113 @opindex msched-ar-in-data-spec
16114 @opindex mno-sched-ar-in-data-spec
16115 (En/Dis)able speculative scheduling of the instructions that
16116 are dependent on the data speculative loads after reload.
16117 This is effective only with @option{-msched-ar-data-spec} enabled.
16118 The default is 'enable'.
16120 @item -msched-in-control-spec
16121 @itemx -mno-sched-in-control-spec
16122 @opindex msched-in-control-spec
16123 @opindex mno-sched-in-control-spec
16124 (En/Dis)able speculative scheduling of the instructions that
16125 are dependent on the control speculative loads.
16126 This is effective only with @option{-msched-control-spec} enabled.
16127 The default is 'enable'.
16129 @item -mno-sched-prefer-non-data-spec-insns
16130 @itemx -msched-prefer-non-data-spec-insns
16131 @opindex mno-sched-prefer-non-data-spec-insns
16132 @opindex msched-prefer-non-data-spec-insns
16133 If enabled, data-speculative instructions are chosen for schedule
16134 only if there are no other choices at the moment.  This makes
16135 the use of the data speculation much more conservative.
16136 The default is 'disable'.
16138 @item -mno-sched-prefer-non-control-spec-insns
16139 @itemx -msched-prefer-non-control-spec-insns
16140 @opindex mno-sched-prefer-non-control-spec-insns
16141 @opindex msched-prefer-non-control-spec-insns
16142 If enabled, control-speculative instructions are chosen for schedule
16143 only if there are no other choices at the moment.  This makes
16144 the use of the control speculation much more conservative.
16145 The default is 'disable'.
16147 @item -mno-sched-count-spec-in-critical-path
16148 @itemx -msched-count-spec-in-critical-path
16149 @opindex mno-sched-count-spec-in-critical-path
16150 @opindex msched-count-spec-in-critical-path
16151 If enabled, speculative dependencies are considered during
16152 computation of the instructions priorities.  This makes the use of the
16153 speculation a bit more conservative.
16154 The default is 'disable'.
16156 @item -msched-spec-ldc
16157 @opindex msched-spec-ldc
16158 Use a simple data speculation check.  This option is on by default.
16160 @item -msched-control-spec-ldc
16161 @opindex msched-spec-ldc
16162 Use a simple check for control speculation.  This option is on by default.
16164 @item -msched-stop-bits-after-every-cycle
16165 @opindex msched-stop-bits-after-every-cycle
16166 Place a stop bit after every cycle when scheduling.  This option is on
16167 by default.
16169 @item -msched-fp-mem-deps-zero-cost
16170 @opindex msched-fp-mem-deps-zero-cost
16171 Assume that floating-point stores and loads are not likely to cause a conflict
16172 when placed into the same instruction group.  This option is disabled by
16173 default.
16175 @item -msel-sched-dont-check-control-spec
16176 @opindex msel-sched-dont-check-control-spec
16177 Generate checks for control speculation in selective scheduling.
16178 This flag is disabled by default.
16180 @item -msched-max-memory-insns=@var{max-insns}
16181 @opindex msched-max-memory-insns
16182 Limit on the number of memory insns per instruction group, giving lower
16183 priority to subsequent memory insns attempting to schedule in the same
16184 instruction group. Frequently useful to prevent cache bank conflicts.
16185 The default value is 1.
16187 @item -msched-max-memory-insns-hard-limit
16188 @opindex msched-max-memory-insns-hard-limit
16189 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16190 disallowing more than that number in an instruction group.
16191 Otherwise, the limit is ``soft'', meaning that non-memory operations
16192 are preferred when the limit is reached, but memory operations may still
16193 be scheduled.
16195 @end table
16197 @node LM32 Options
16198 @subsection LM32 Options
16199 @cindex LM32 options
16201 These @option{-m} options are defined for the LatticeMico32 architecture:
16203 @table @gcctabopt
16204 @item -mbarrel-shift-enabled
16205 @opindex mbarrel-shift-enabled
16206 Enable barrel-shift instructions.
16208 @item -mdivide-enabled
16209 @opindex mdivide-enabled
16210 Enable divide and modulus instructions.
16212 @item -mmultiply-enabled
16213 @opindex multiply-enabled
16214 Enable multiply instructions.
16216 @item -msign-extend-enabled
16217 @opindex msign-extend-enabled
16218 Enable sign extend instructions.
16220 @item -muser-enabled
16221 @opindex muser-enabled
16222 Enable user-defined instructions.
16224 @end table
16226 @node M32C Options
16227 @subsection M32C Options
16228 @cindex M32C options
16230 @table @gcctabopt
16231 @item -mcpu=@var{name}
16232 @opindex mcpu=
16233 Select the CPU for which code is generated.  @var{name} may be one of
16234 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16235 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16236 the M32C/80 series.
16238 @item -msim
16239 @opindex msim
16240 Specifies that the program will be run on the simulator.  This causes
16241 an alternate runtime library to be linked in which supports, for
16242 example, file I/O@.  You must not use this option when generating
16243 programs that will run on real hardware; you must provide your own
16244 runtime library for whatever I/O functions are needed.
16246 @item -memregs=@var{number}
16247 @opindex memregs=
16248 Specifies the number of memory-based pseudo-registers GCC uses
16249 during code generation.  These pseudo-registers are used like real
16250 registers, so there is a tradeoff between GCC's ability to fit the
16251 code into available registers, and the performance penalty of using
16252 memory instead of registers.  Note that all modules in a program must
16253 be compiled with the same value for this option.  Because of that, you
16254 must not use this option with GCC's default runtime libraries.
16256 @end table
16258 @node M32R/D Options
16259 @subsection M32R/D Options
16260 @cindex M32R/D options
16262 These @option{-m} options are defined for Renesas M32R/D architectures:
16264 @table @gcctabopt
16265 @item -m32r2
16266 @opindex m32r2
16267 Generate code for the M32R/2@.
16269 @item -m32rx
16270 @opindex m32rx
16271 Generate code for the M32R/X@.
16273 @item -m32r
16274 @opindex m32r
16275 Generate code for the M32R@.  This is the default.
16277 @item -mmodel=small
16278 @opindex mmodel=small
16279 Assume all objects live in the lower 16MB of memory (so that their addresses
16280 can be loaded with the @code{ld24} instruction), and assume all subroutines
16281 are reachable with the @code{bl} instruction.
16282 This is the default.
16284 The addressability of a particular object can be set with the
16285 @code{model} attribute.
16287 @item -mmodel=medium
16288 @opindex mmodel=medium
16289 Assume objects may be anywhere in the 32-bit address space (the compiler
16290 generates @code{seth/add3} instructions to load their addresses), and
16291 assume all subroutines are reachable with the @code{bl} instruction.
16293 @item -mmodel=large
16294 @opindex mmodel=large
16295 Assume objects may be anywhere in the 32-bit address space (the compiler
16296 generates @code{seth/add3} instructions to load their addresses), and
16297 assume subroutines may not be reachable with the @code{bl} instruction
16298 (the compiler generates the much slower @code{seth/add3/jl}
16299 instruction sequence).
16301 @item -msdata=none
16302 @opindex msdata=none
16303 Disable use of the small data area.  Variables are put into
16304 one of @code{.data}, @code{.bss}, or @code{.rodata} (unless the
16305 @code{section} attribute has been specified).
16306 This is the default.
16308 The small data area consists of sections @code{.sdata} and @code{.sbss}.
16309 Objects may be explicitly put in the small data area with the
16310 @code{section} attribute using one of these sections.
16312 @item -msdata=sdata
16313 @opindex msdata=sdata
16314 Put small global and static data in the small data area, but do not
16315 generate special code to reference them.
16317 @item -msdata=use
16318 @opindex msdata=use
16319 Put small global and static data in the small data area, and generate
16320 special instructions to reference them.
16322 @item -G @var{num}
16323 @opindex G
16324 @cindex smaller data references
16325 Put global and static objects less than or equal to @var{num} bytes
16326 into the small data or BSS sections instead of the normal data or BSS
16327 sections.  The default value of @var{num} is 8.
16328 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16329 for this option to have any effect.
16331 All modules should be compiled with the same @option{-G @var{num}} value.
16332 Compiling with different values of @var{num} may or may not work; if it
16333 doesn't the linker gives an error message---incorrect code is not
16334 generated.
16336 @item -mdebug
16337 @opindex mdebug
16338 Makes the M32R-specific code in the compiler display some statistics
16339 that might help in debugging programs.
16341 @item -malign-loops
16342 @opindex malign-loops
16343 Align all loops to a 32-byte boundary.
16345 @item -mno-align-loops
16346 @opindex mno-align-loops
16347 Do not enforce a 32-byte alignment for loops.  This is the default.
16349 @item -missue-rate=@var{number}
16350 @opindex missue-rate=@var{number}
16351 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16352 or 2.
16354 @item -mbranch-cost=@var{number}
16355 @opindex mbranch-cost=@var{number}
16356 @var{number} can only be 1 or 2.  If it is 1 then branches are
16357 preferred over conditional code, if it is 2, then the opposite applies.
16359 @item -mflush-trap=@var{number}
16360 @opindex mflush-trap=@var{number}
16361 Specifies the trap number to use to flush the cache.  The default is
16362 12.  Valid numbers are between 0 and 15 inclusive.
16364 @item -mno-flush-trap
16365 @opindex mno-flush-trap
16366 Specifies that the cache cannot be flushed by using a trap.
16368 @item -mflush-func=@var{name}
16369 @opindex mflush-func=@var{name}
16370 Specifies the name of the operating system function to call to flush
16371 the cache.  The default is @samp{_flush_cache}, but a function call
16372 is only used if a trap is not available.
16374 @item -mno-flush-func
16375 @opindex mno-flush-func
16376 Indicates that there is no OS function for flushing the cache.
16378 @end table
16380 @node M680x0 Options
16381 @subsection M680x0 Options
16382 @cindex M680x0 options
16384 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16385 The default settings depend on which architecture was selected when
16386 the compiler was configured; the defaults for the most common choices
16387 are given below.
16389 @table @gcctabopt
16390 @item -march=@var{arch}
16391 @opindex march
16392 Generate code for a specific M680x0 or ColdFire instruction set
16393 architecture.  Permissible values of @var{arch} for M680x0
16394 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16395 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16396 architectures are selected according to Freescale's ISA classification
16397 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16398 @samp{isab} and @samp{isac}.
16400 GCC defines a macro @code{__mcf@var{arch}__} whenever it is generating
16401 code for a ColdFire target.  The @var{arch} in this macro is one of the
16402 @option{-march} arguments given above.
16404 When used together, @option{-march} and @option{-mtune} select code
16405 that runs on a family of similar processors but that is optimized
16406 for a particular microarchitecture.
16408 @item -mcpu=@var{cpu}
16409 @opindex mcpu
16410 Generate code for a specific M680x0 or ColdFire processor.
16411 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16412 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16413 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16414 below, which also classifies the CPUs into families:
16416 @multitable @columnfractions 0.20 0.80
16417 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16418 @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}
16419 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16420 @item @samp{5206e} @tab @samp{5206e}
16421 @item @samp{5208} @tab @samp{5207} @samp{5208}
16422 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16423 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16424 @item @samp{5216} @tab @samp{5214} @samp{5216}
16425 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16426 @item @samp{5225} @tab @samp{5224} @samp{5225}
16427 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16428 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16429 @item @samp{5249} @tab @samp{5249}
16430 @item @samp{5250} @tab @samp{5250}
16431 @item @samp{5271} @tab @samp{5270} @samp{5271}
16432 @item @samp{5272} @tab @samp{5272}
16433 @item @samp{5275} @tab @samp{5274} @samp{5275}
16434 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16435 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16436 @item @samp{5307} @tab @samp{5307}
16437 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16438 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16439 @item @samp{5407} @tab @samp{5407}
16440 @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}
16441 @end multitable
16443 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16444 @var{arch} is compatible with @var{cpu}.  Other combinations of
16445 @option{-mcpu} and @option{-march} are rejected.
16447 GCC defines the macro @code{__mcf_cpu_@var{cpu}} when ColdFire target
16448 @var{cpu} is selected.  It also defines @code{__mcf_family_@var{family}},
16449 where the value of @var{family} is given by the table above.
16451 @item -mtune=@var{tune}
16452 @opindex mtune
16453 Tune the code for a particular microarchitecture within the
16454 constraints set by @option{-march} and @option{-mcpu}.
16455 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16456 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16457 and @samp{cpu32}.  The ColdFire microarchitectures
16458 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16460 You can also use @option{-mtune=68020-40} for code that needs
16461 to run relatively well on 68020, 68030 and 68040 targets.
16462 @option{-mtune=68020-60} is similar but includes 68060 targets
16463 as well.  These two options select the same tuning decisions as
16464 @option{-m68020-40} and @option{-m68020-60} respectively.
16466 GCC defines the macros @code{__mc@var{arch}} and @code{__mc@var{arch}__}
16467 when tuning for 680x0 architecture @var{arch}.  It also defines
16468 @code{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16469 option is used.  If GCC is tuning for a range of architectures,
16470 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16471 it defines the macros for every architecture in the range.
16473 GCC also defines the macro @code{__m@var{uarch}__} when tuning for
16474 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16475 of the arguments given above.
16477 @item -m68000
16478 @itemx -mc68000
16479 @opindex m68000
16480 @opindex mc68000
16481 Generate output for a 68000.  This is the default
16482 when the compiler is configured for 68000-based systems.
16483 It is equivalent to @option{-march=68000}.
16485 Use this option for microcontrollers with a 68000 or EC000 core,
16486 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16488 @item -m68010
16489 @opindex m68010
16490 Generate output for a 68010.  This is the default
16491 when the compiler is configured for 68010-based systems.
16492 It is equivalent to @option{-march=68010}.
16494 @item -m68020
16495 @itemx -mc68020
16496 @opindex m68020
16497 @opindex mc68020
16498 Generate output for a 68020.  This is the default
16499 when the compiler is configured for 68020-based systems.
16500 It is equivalent to @option{-march=68020}.
16502 @item -m68030
16503 @opindex m68030
16504 Generate output for a 68030.  This is the default when the compiler is
16505 configured for 68030-based systems.  It is equivalent to
16506 @option{-march=68030}.
16508 @item -m68040
16509 @opindex m68040
16510 Generate output for a 68040.  This is the default when the compiler is
16511 configured for 68040-based systems.  It is equivalent to
16512 @option{-march=68040}.
16514 This option inhibits the use of 68881/68882 instructions that have to be
16515 emulated by software on the 68040.  Use this option if your 68040 does not
16516 have code to emulate those instructions.
16518 @item -m68060
16519 @opindex m68060
16520 Generate output for a 68060.  This is the default when the compiler is
16521 configured for 68060-based systems.  It is equivalent to
16522 @option{-march=68060}.
16524 This option inhibits the use of 68020 and 68881/68882 instructions that
16525 have to be emulated by software on the 68060.  Use this option if your 68060
16526 does not have code to emulate those instructions.
16528 @item -mcpu32
16529 @opindex mcpu32
16530 Generate output for a CPU32.  This is the default
16531 when the compiler is configured for CPU32-based systems.
16532 It is equivalent to @option{-march=cpu32}.
16534 Use this option for microcontrollers with a
16535 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16536 68336, 68340, 68341, 68349 and 68360.
16538 @item -m5200
16539 @opindex m5200
16540 Generate output for a 520X ColdFire CPU@.  This is the default
16541 when the compiler is configured for 520X-based systems.
16542 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16543 in favor of that option.
16545 Use this option for microcontroller with a 5200 core, including
16546 the MCF5202, MCF5203, MCF5204 and MCF5206.
16548 @item -m5206e
16549 @opindex m5206e
16550 Generate output for a 5206e ColdFire CPU@.  The option is now
16551 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16553 @item -m528x
16554 @opindex m528x
16555 Generate output for a member of the ColdFire 528X family.
16556 The option is now deprecated in favor of the equivalent
16557 @option{-mcpu=528x}.
16559 @item -m5307
16560 @opindex m5307
16561 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16562 in favor of the equivalent @option{-mcpu=5307}.
16564 @item -m5407
16565 @opindex m5407
16566 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16567 in favor of the equivalent @option{-mcpu=5407}.
16569 @item -mcfv4e
16570 @opindex mcfv4e
16571 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16572 This includes use of hardware floating-point instructions.
16573 The option is equivalent to @option{-mcpu=547x}, and is now
16574 deprecated in favor of that option.
16576 @item -m68020-40
16577 @opindex m68020-40
16578 Generate output for a 68040, without using any of the new instructions.
16579 This results in code that can run relatively efficiently on either a
16580 68020/68881 or a 68030 or a 68040.  The generated code does use the
16581 68881 instructions that are emulated on the 68040.
16583 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16585 @item -m68020-60
16586 @opindex m68020-60
16587 Generate output for a 68060, without using any of the new instructions.
16588 This results in code that can run relatively efficiently on either a
16589 68020/68881 or a 68030 or a 68040.  The generated code does use the
16590 68881 instructions that are emulated on the 68060.
16592 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16594 @item -mhard-float
16595 @itemx -m68881
16596 @opindex mhard-float
16597 @opindex m68881
16598 Generate floating-point instructions.  This is the default for 68020
16599 and above, and for ColdFire devices that have an FPU@.  It defines the
16600 macro @code{__HAVE_68881__} on M680x0 targets and @code{__mcffpu__}
16601 on ColdFire targets.
16603 @item -msoft-float
16604 @opindex msoft-float
16605 Do not generate floating-point instructions; use library calls instead.
16606 This is the default for 68000, 68010, and 68832 targets.  It is also
16607 the default for ColdFire devices that have no FPU.
16609 @item -mdiv
16610 @itemx -mno-div
16611 @opindex mdiv
16612 @opindex mno-div
16613 Generate (do not generate) ColdFire hardware divide and remainder
16614 instructions.  If @option{-march} is used without @option{-mcpu},
16615 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16616 architectures.  Otherwise, the default is taken from the target CPU
16617 (either the default CPU, or the one specified by @option{-mcpu}).  For
16618 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16619 @option{-mcpu=5206e}.
16621 GCC defines the macro @code{__mcfhwdiv__} when this option is enabled.
16623 @item -mshort
16624 @opindex mshort
16625 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16626 Additionally, parameters passed on the stack are also aligned to a
16627 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16629 @item -mno-short
16630 @opindex mno-short
16631 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16633 @item -mnobitfield
16634 @itemx -mno-bitfield
16635 @opindex mnobitfield
16636 @opindex mno-bitfield
16637 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16638 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16640 @item -mbitfield
16641 @opindex mbitfield
16642 Do use the bit-field instructions.  The @option{-m68020} option implies
16643 @option{-mbitfield}.  This is the default if you use a configuration
16644 designed for a 68020.
16646 @item -mrtd
16647 @opindex mrtd
16648 Use a different function-calling convention, in which functions
16649 that take a fixed number of arguments return with the @code{rtd}
16650 instruction, which pops their arguments while returning.  This
16651 saves one instruction in the caller since there is no need to pop
16652 the arguments there.
16654 This calling convention is incompatible with the one normally
16655 used on Unix, so you cannot use it if you need to call libraries
16656 compiled with the Unix compiler.
16658 Also, you must provide function prototypes for all functions that
16659 take variable numbers of arguments (including @code{printf});
16660 otherwise incorrect code is generated for calls to those
16661 functions.
16663 In addition, seriously incorrect code results if you call a
16664 function with too many arguments.  (Normally, extra arguments are
16665 harmlessly ignored.)
16667 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16668 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16670 @item -mno-rtd
16671 @opindex mno-rtd
16672 Do not use the calling conventions selected by @option{-mrtd}.
16673 This is the default.
16675 @item -malign-int
16676 @itemx -mno-align-int
16677 @opindex malign-int
16678 @opindex mno-align-int
16679 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16680 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16681 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16682 Aligning variables on 32-bit boundaries produces code that runs somewhat
16683 faster on processors with 32-bit busses at the expense of more memory.
16685 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16686 aligns structures containing the above types differently than
16687 most published application binary interface specifications for the m68k.
16689 @item -mpcrel
16690 @opindex mpcrel
16691 Use the pc-relative addressing mode of the 68000 directly, instead of
16692 using a global offset table.  At present, this option implies @option{-fpic},
16693 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16694 not presently supported with @option{-mpcrel}, though this could be supported for
16695 68020 and higher processors.
16697 @item -mno-strict-align
16698 @itemx -mstrict-align
16699 @opindex mno-strict-align
16700 @opindex mstrict-align
16701 Do not (do) assume that unaligned memory references are handled by
16702 the system.
16704 @item -msep-data
16705 Generate code that allows the data segment to be located in a different
16706 area of memory from the text segment.  This allows for execute-in-place in
16707 an environment without virtual memory management.  This option implies
16708 @option{-fPIC}.
16710 @item -mno-sep-data
16711 Generate code that assumes that the data segment follows the text segment.
16712 This is the default.
16714 @item -mid-shared-library
16715 Generate code that supports shared libraries via the library ID method.
16716 This allows for execute-in-place and shared libraries in an environment
16717 without virtual memory management.  This option implies @option{-fPIC}.
16719 @item -mno-id-shared-library
16720 Generate code that doesn't assume ID-based shared libraries are being used.
16721 This is the default.
16723 @item -mshared-library-id=n
16724 Specifies the identification number of the ID-based shared library being
16725 compiled.  Specifying a value of 0 generates more compact code; specifying
16726 other values forces the allocation of that number to the current
16727 library, but is no more space- or time-efficient than omitting this option.
16729 @item -mxgot
16730 @itemx -mno-xgot
16731 @opindex mxgot
16732 @opindex mno-xgot
16733 When generating position-independent code for ColdFire, generate code
16734 that works if the GOT has more than 8192 entries.  This code is
16735 larger and slower than code generated without this option.  On M680x0
16736 processors, this option is not needed; @option{-fPIC} suffices.
16738 GCC normally uses a single instruction to load values from the GOT@.
16739 While this is relatively efficient, it only works if the GOT
16740 is smaller than about 64k.  Anything larger causes the linker
16741 to report an error such as:
16743 @cindex relocation truncated to fit (ColdFire)
16744 @smallexample
16745 relocation truncated to fit: R_68K_GOT16O foobar
16746 @end smallexample
16748 If this happens, you should recompile your code with @option{-mxgot}.
16749 It should then work with very large GOTs.  However, code generated with
16750 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16751 the value of a global symbol.
16753 Note that some linkers, including newer versions of the GNU linker,
16754 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16755 you should only need to use @option{-mxgot} when compiling a single
16756 object file that accesses more than 8192 GOT entries.  Very few do.
16758 These options have no effect unless GCC is generating
16759 position-independent code.
16761 @end table
16763 @node MCore Options
16764 @subsection MCore Options
16765 @cindex MCore options
16767 These are the @samp{-m} options defined for the Motorola M*Core
16768 processors.
16770 @table @gcctabopt
16772 @item -mhardlit
16773 @itemx -mno-hardlit
16774 @opindex mhardlit
16775 @opindex mno-hardlit
16776 Inline constants into the code stream if it can be done in two
16777 instructions or less.
16779 @item -mdiv
16780 @itemx -mno-div
16781 @opindex mdiv
16782 @opindex mno-div
16783 Use the divide instruction.  (Enabled by default).
16785 @item -mrelax-immediate
16786 @itemx -mno-relax-immediate
16787 @opindex mrelax-immediate
16788 @opindex mno-relax-immediate
16789 Allow arbitrary-sized immediates in bit operations.
16791 @item -mwide-bitfields
16792 @itemx -mno-wide-bitfields
16793 @opindex mwide-bitfields
16794 @opindex mno-wide-bitfields
16795 Always treat bit-fields as @code{int}-sized.
16797 @item -m4byte-functions
16798 @itemx -mno-4byte-functions
16799 @opindex m4byte-functions
16800 @opindex mno-4byte-functions
16801 Force all functions to be aligned to a 4-byte boundary.
16803 @item -mcallgraph-data
16804 @itemx -mno-callgraph-data
16805 @opindex mcallgraph-data
16806 @opindex mno-callgraph-data
16807 Emit callgraph information.
16809 @item -mslow-bytes
16810 @itemx -mno-slow-bytes
16811 @opindex mslow-bytes
16812 @opindex mno-slow-bytes
16813 Prefer word access when reading byte quantities.
16815 @item -mlittle-endian
16816 @itemx -mbig-endian
16817 @opindex mlittle-endian
16818 @opindex mbig-endian
16819 Generate code for a little-endian target.
16821 @item -m210
16822 @itemx -m340
16823 @opindex m210
16824 @opindex m340
16825 Generate code for the 210 processor.
16827 @item -mno-lsim
16828 @opindex mno-lsim
16829 Assume that runtime support has been provided and so omit the
16830 simulator library (@file{libsim.a)} from the linker command line.
16832 @item -mstack-increment=@var{size}
16833 @opindex mstack-increment
16834 Set the maximum amount for a single stack increment operation.  Large
16835 values can increase the speed of programs that contain functions
16836 that need a large amount of stack space, but they can also trigger a
16837 segmentation fault if the stack is extended too much.  The default
16838 value is 0x1000.
16840 @end table
16842 @node MeP Options
16843 @subsection MeP Options
16844 @cindex MeP options
16846 @table @gcctabopt
16848 @item -mabsdiff
16849 @opindex mabsdiff
16850 Enables the @code{abs} instruction, which is the absolute difference
16851 between two registers.
16853 @item -mall-opts
16854 @opindex mall-opts
16855 Enables all the optional instructions---average, multiply, divide, bit
16856 operations, leading zero, absolute difference, min/max, clip, and
16857 saturation.
16860 @item -maverage
16861 @opindex maverage
16862 Enables the @code{ave} instruction, which computes the average of two
16863 registers.
16865 @item -mbased=@var{n}
16866 @opindex mbased=
16867 Variables of size @var{n} bytes or smaller are placed in the
16868 @code{.based} section by default.  Based variables use the @code{$tp}
16869 register as a base register, and there is a 128-byte limit to the
16870 @code{.based} section.
16872 @item -mbitops
16873 @opindex mbitops
16874 Enables the bit operation instructions---bit test (@code{btstm}), set
16875 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16876 test-and-set (@code{tas}).
16878 @item -mc=@var{name}
16879 @opindex mc=
16880 Selects which section constant data is placed in.  @var{name} may
16881 be @samp{tiny}, @samp{near}, or @samp{far}.
16883 @item -mclip
16884 @opindex mclip
16885 Enables the @code{clip} instruction.  Note that @option{-mclip} is not
16886 useful unless you also provide @option{-mminmax}.
16888 @item -mconfig=@var{name}
16889 @opindex mconfig=
16890 Selects one of the built-in core configurations.  Each MeP chip has
16891 one or more modules in it; each module has a core CPU and a variety of
16892 coprocessors, optional instructions, and peripherals.  The
16893 @code{MeP-Integrator} tool, not part of GCC, provides these
16894 configurations through this option; using this option is the same as
16895 using all the corresponding command-line options.  The default
16896 configuration is @samp{default}.
16898 @item -mcop
16899 @opindex mcop
16900 Enables the coprocessor instructions.  By default, this is a 32-bit
16901 coprocessor.  Note that the coprocessor is normally enabled via the
16902 @option{-mconfig=} option.
16904 @item -mcop32
16905 @opindex mcop32
16906 Enables the 32-bit coprocessor's instructions.
16908 @item -mcop64
16909 @opindex mcop64
16910 Enables the 64-bit coprocessor's instructions.
16912 @item -mivc2
16913 @opindex mivc2
16914 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16916 @item -mdc
16917 @opindex mdc
16918 Causes constant variables to be placed in the @code{.near} section.
16920 @item -mdiv
16921 @opindex mdiv
16922 Enables the @code{div} and @code{divu} instructions.
16924 @item -meb
16925 @opindex meb
16926 Generate big-endian code.
16928 @item -mel
16929 @opindex mel
16930 Generate little-endian code.
16932 @item -mio-volatile
16933 @opindex mio-volatile
16934 Tells the compiler that any variable marked with the @code{io}
16935 attribute is to be considered volatile.
16937 @item -ml
16938 @opindex ml
16939 Causes variables to be assigned to the @code{.far} section by default.
16941 @item -mleadz
16942 @opindex mleadz
16943 Enables the @code{leadz} (leading zero) instruction.
16945 @item -mm
16946 @opindex mm
16947 Causes variables to be assigned to the @code{.near} section by default.
16949 @item -mminmax
16950 @opindex mminmax
16951 Enables the @code{min} and @code{max} instructions.
16953 @item -mmult
16954 @opindex mmult
16955 Enables the multiplication and multiply-accumulate instructions.
16957 @item -mno-opts
16958 @opindex mno-opts
16959 Disables all the optional instructions enabled by @option{-mall-opts}.
16961 @item -mrepeat
16962 @opindex mrepeat
16963 Enables the @code{repeat} and @code{erepeat} instructions, used for
16964 low-overhead looping.
16966 @item -ms
16967 @opindex ms
16968 Causes all variables to default to the @code{.tiny} section.  Note
16969 that there is a 65536-byte limit to this section.  Accesses to these
16970 variables use the @code{%gp} base register.
16972 @item -msatur
16973 @opindex msatur
16974 Enables the saturation instructions.  Note that the compiler does not
16975 currently generate these itself, but this option is included for
16976 compatibility with other tools, like @code{as}.
16978 @item -msdram
16979 @opindex msdram
16980 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16982 @item -msim
16983 @opindex msim
16984 Link the simulator run-time libraries.
16986 @item -msimnovec
16987 @opindex msimnovec
16988 Link the simulator runtime libraries, excluding built-in support
16989 for reset and exception vectors and tables.
16991 @item -mtf
16992 @opindex mtf
16993 Causes all functions to default to the @code{.far} section.  Without
16994 this option, functions default to the @code{.near} section.
16996 @item -mtiny=@var{n}
16997 @opindex mtiny=
16998 Variables that are @var{n} bytes or smaller are allocated to the
16999 @code{.tiny} section.  These variables use the @code{$gp} base
17000 register.  The default for this option is 4, but note that there's a
17001 65536-byte limit to the @code{.tiny} section.
17003 @end table
17005 @node MicroBlaze Options
17006 @subsection MicroBlaze Options
17007 @cindex MicroBlaze Options
17009 @table @gcctabopt
17011 @item -msoft-float
17012 @opindex msoft-float
17013 Use software emulation for floating point (default).
17015 @item -mhard-float
17016 @opindex mhard-float
17017 Use hardware floating-point instructions.
17019 @item -mmemcpy
17020 @opindex mmemcpy
17021 Do not optimize block moves, use @code{memcpy}.
17023 @item -mno-clearbss
17024 @opindex mno-clearbss
17025 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17027 @item -mcpu=@var{cpu-type}
17028 @opindex mcpu=
17029 Use features of, and schedule code for, the given CPU.
17030 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17031 where @var{X} is a major version, @var{YY} is the minor version, and
17032 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17033 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17035 @item -mxl-soft-mul
17036 @opindex mxl-soft-mul
17037 Use software multiply emulation (default).
17039 @item -mxl-soft-div
17040 @opindex mxl-soft-div
17041 Use software emulation for divides (default).
17043 @item -mxl-barrel-shift
17044 @opindex mxl-barrel-shift
17045 Use the hardware barrel shifter.
17047 @item -mxl-pattern-compare
17048 @opindex mxl-pattern-compare
17049 Use pattern compare instructions.
17051 @item -msmall-divides
17052 @opindex msmall-divides
17053 Use table lookup optimization for small signed integer divisions.
17055 @item -mxl-stack-check
17056 @opindex mxl-stack-check
17057 This option is deprecated.  Use @option{-fstack-check} instead.
17059 @item -mxl-gp-opt
17060 @opindex mxl-gp-opt
17061 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17063 @item -mxl-multiply-high
17064 @opindex mxl-multiply-high
17065 Use multiply high instructions for high part of 32x32 multiply.
17067 @item -mxl-float-convert
17068 @opindex mxl-float-convert
17069 Use hardware floating-point conversion instructions.
17071 @item -mxl-float-sqrt
17072 @opindex mxl-float-sqrt
17073 Use hardware floating-point square root instruction.
17075 @item -mbig-endian
17076 @opindex mbig-endian
17077 Generate code for a big-endian target.
17079 @item -mlittle-endian
17080 @opindex mlittle-endian
17081 Generate code for a little-endian target.
17083 @item -mxl-reorder
17084 @opindex mxl-reorder
17085 Use reorder instructions (swap and byte reversed load/store).
17087 @item -mxl-mode-@var{app-model}
17088 Select application model @var{app-model}.  Valid models are
17089 @table @samp
17090 @item executable
17091 normal executable (default), uses startup code @file{crt0.o}.
17093 @item xmdstub
17094 for use with Xilinx Microprocessor Debugger (XMD) based
17095 software intrusive debug agent called xmdstub. This uses startup file
17096 @file{crt1.o} and sets the start address of the program to 0x800.
17098 @item bootstrap
17099 for applications that are loaded using a bootloader.
17100 This model uses startup file @file{crt2.o} which does not contain a processor
17101 reset vector handler. This is suitable for transferring control on a
17102 processor reset to the bootloader rather than the application.
17104 @item novectors
17105 for applications that do not require any of the
17106 MicroBlaze vectors. This option may be useful for applications running
17107 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17108 @end table
17110 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17111 @option{-mxl-mode-@var{app-model}}.
17113 @end table
17115 @node MIPS Options
17116 @subsection MIPS Options
17117 @cindex MIPS options
17119 @table @gcctabopt
17121 @item -EB
17122 @opindex EB
17123 Generate big-endian code.
17125 @item -EL
17126 @opindex EL
17127 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17128 configurations.
17130 @item -march=@var{arch}
17131 @opindex march
17132 Generate code that runs on @var{arch}, which can be the name of a
17133 generic MIPS ISA, or the name of a particular processor.
17134 The ISA names are:
17135 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17136 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17137 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17138 @samp{mips64r5} and @samp{mips64r6}.
17139 The processor names are:
17140 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17141 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17142 @samp{5kc}, @samp{5kf},
17143 @samp{20kc},
17144 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17145 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17146 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17147 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17148 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17149 @samp{i6400},
17150 @samp{interaptiv},
17151 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17152 @samp{m4k},
17153 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17154 @samp{m5100}, @samp{m5101},
17155 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17156 @samp{orion},
17157 @samp{p5600},
17158 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17159 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17160 @samp{rm7000}, @samp{rm9000},
17161 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17162 @samp{sb1},
17163 @samp{sr71000},
17164 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17165 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17166 @samp{xlr} and @samp{xlp}.
17167 The special value @samp{from-abi} selects the
17168 most compatible architecture for the selected ABI (that is,
17169 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17171 The native Linux/GNU toolchain also supports the value @samp{native},
17172 which selects the best architecture option for the host processor.
17173 @option{-march=native} has no effect if GCC does not recognize
17174 the processor.
17176 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17177 (for example, @option{-march=r2k}).  Prefixes are optional, and
17178 @samp{vr} may be written @samp{r}.
17180 Names of the form @samp{@var{n}f2_1} refer to processors with
17181 FPUs clocked at half the rate of the core, names of the form
17182 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17183 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17184 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17185 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17186 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17187 accepted as synonyms for @samp{@var{n}f1_1}.
17189 GCC defines two macros based on the value of this option.  The first
17190 is @code{_MIPS_ARCH}, which gives the name of target architecture, as
17191 a string.  The second has the form @code{_MIPS_ARCH_@var{foo}},
17192 where @var{foo} is the capitalized value of @code{_MIPS_ARCH}@.
17193 For example, @option{-march=r2000} sets @code{_MIPS_ARCH}
17194 to @code{"r2000"} and defines the macro @code{_MIPS_ARCH_R2000}.
17196 Note that the @code{_MIPS_ARCH} macro uses the processor names given
17197 above.  In other words, it has the full prefix and does not
17198 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17199 the macro names the resolved architecture (either @code{"mips1"} or
17200 @code{"mips3"}).  It names the default architecture when no
17201 @option{-march} option is given.
17203 @item -mtune=@var{arch}
17204 @opindex mtune
17205 Optimize for @var{arch}.  Among other things, this option controls
17206 the way instructions are scheduled, and the perceived cost of arithmetic
17207 operations.  The list of @var{arch} values is the same as for
17208 @option{-march}.
17210 When this option is not used, GCC optimizes for the processor
17211 specified by @option{-march}.  By using @option{-march} and
17212 @option{-mtune} together, it is possible to generate code that
17213 runs on a family of processors, but optimize the code for one
17214 particular member of that family.
17216 @option{-mtune} defines the macros @code{_MIPS_TUNE} and
17217 @code{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17218 @option{-march} ones described above.
17220 @item -mips1
17221 @opindex mips1
17222 Equivalent to @option{-march=mips1}.
17224 @item -mips2
17225 @opindex mips2
17226 Equivalent to @option{-march=mips2}.
17228 @item -mips3
17229 @opindex mips3
17230 Equivalent to @option{-march=mips3}.
17232 @item -mips4
17233 @opindex mips4
17234 Equivalent to @option{-march=mips4}.
17236 @item -mips32
17237 @opindex mips32
17238 Equivalent to @option{-march=mips32}.
17240 @item -mips32r3
17241 @opindex mips32r3
17242 Equivalent to @option{-march=mips32r3}.
17244 @item -mips32r5
17245 @opindex mips32r5
17246 Equivalent to @option{-march=mips32r5}.
17248 @item -mips32r6
17249 @opindex mips32r6
17250 Equivalent to @option{-march=mips32r6}.
17252 @item -mips64
17253 @opindex mips64
17254 Equivalent to @option{-march=mips64}.
17256 @item -mips64r2
17257 @opindex mips64r2
17258 Equivalent to @option{-march=mips64r2}.
17260 @item -mips64r3
17261 @opindex mips64r3
17262 Equivalent to @option{-march=mips64r3}.
17264 @item -mips64r5
17265 @opindex mips64r5
17266 Equivalent to @option{-march=mips64r5}.
17268 @item -mips64r6
17269 @opindex mips64r6
17270 Equivalent to @option{-march=mips64r6}.
17272 @item -mips16
17273 @itemx -mno-mips16
17274 @opindex mips16
17275 @opindex mno-mips16
17276 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17277 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17279 MIPS16 code generation can also be controlled on a per-function basis
17280 by means of @code{mips16} and @code{nomips16} attributes.
17281 @xref{Function Attributes}, for more information.
17283 @item -mflip-mips16
17284 @opindex mflip-mips16
17285 Generate MIPS16 code on alternating functions.  This option is provided
17286 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17287 not intended for ordinary use in compiling user code.
17289 @item -minterlink-compressed
17290 @item -mno-interlink-compressed
17291 @opindex minterlink-compressed
17292 @opindex mno-interlink-compressed
17293 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17294 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17296 For example, code using the standard ISA encoding cannot jump directly
17297 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17298 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17299 knows that the target of the jump is not compressed.
17301 @item -minterlink-mips16
17302 @itemx -mno-interlink-mips16
17303 @opindex minterlink-mips16
17304 @opindex mno-interlink-mips16
17305 Aliases of @option{-minterlink-compressed} and
17306 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17307 and are retained for backwards compatibility.
17309 @item -mabi=32
17310 @itemx -mabi=o64
17311 @itemx -mabi=n32
17312 @itemx -mabi=64
17313 @itemx -mabi=eabi
17314 @opindex mabi=32
17315 @opindex mabi=o64
17316 @opindex mabi=n32
17317 @opindex mabi=64
17318 @opindex mabi=eabi
17319 Generate code for the given ABI@.
17321 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17322 generates 64-bit code when you select a 64-bit architecture, but you
17323 can use @option{-mgp32} to get 32-bit code instead.
17325 For information about the O64 ABI, see
17326 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17328 GCC supports a variant of the o32 ABI in which floating-point registers
17329 are 64 rather than 32 bits wide.  You can select this combination with
17330 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17331 and @code{mfhc1} instructions and is therefore only supported for
17332 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17334 The register assignments for arguments and return values remain the
17335 same, but each scalar value is passed in a single 64-bit register
17336 rather than a pair of 32-bit registers.  For example, scalar
17337 floating-point values are returned in @samp{$f0} only, not a
17338 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17339 remains the same in that the even-numbered double-precision registers
17340 are saved.
17342 Two additional variants of the o32 ABI are supported to enable
17343 a transition from 32-bit to 64-bit registers.  These are FPXX
17344 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17345 The FPXX extension mandates that all code must execute correctly
17346 when run using 32-bit or 64-bit registers.  The code can be interlinked
17347 with either FP32 or FP64, but not both.
17348 The FP64A extension is similar to the FP64 extension but forbids the
17349 use of odd-numbered single-precision registers.  This can be used
17350 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17351 processors and allows both FP32 and FP64A code to interlink and
17352 run in the same process without changing FPU modes.
17354 @item -mabicalls
17355 @itemx -mno-abicalls
17356 @opindex mabicalls
17357 @opindex mno-abicalls
17358 Generate (do not generate) code that is suitable for SVR4-style
17359 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17360 systems.
17362 @item -mshared
17363 @itemx -mno-shared
17364 Generate (do not generate) code that is fully position-independent,
17365 and that can therefore be linked into shared libraries.  This option
17366 only affects @option{-mabicalls}.
17368 All @option{-mabicalls} code has traditionally been position-independent,
17369 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17370 as an extension, the GNU toolchain allows executables to use absolute
17371 accesses for locally-binding symbols.  It can also use shorter GP
17372 initialization sequences and generate direct calls to locally-defined
17373 functions.  This mode is selected by @option{-mno-shared}.
17375 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17376 objects that can only be linked by the GNU linker.  However, the option
17377 does not affect the ABI of the final executable; it only affects the ABI
17378 of relocatable objects.  Using @option{-mno-shared} generally makes
17379 executables both smaller and quicker.
17381 @option{-mshared} is the default.
17383 @item -mplt
17384 @itemx -mno-plt
17385 @opindex mplt
17386 @opindex mno-plt
17387 Assume (do not assume) that the static and dynamic linkers
17388 support PLTs and copy relocations.  This option only affects
17389 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17390 has no effect without @option{-msym32}.
17392 You can make @option{-mplt} the default by configuring
17393 GCC with @option{--with-mips-plt}.  The default is
17394 @option{-mno-plt} otherwise.
17396 @item -mxgot
17397 @itemx -mno-xgot
17398 @opindex mxgot
17399 @opindex mno-xgot
17400 Lift (do not lift) the usual restrictions on the size of the global
17401 offset table.
17403 GCC normally uses a single instruction to load values from the GOT@.
17404 While this is relatively efficient, it only works if the GOT
17405 is smaller than about 64k.  Anything larger causes the linker
17406 to report an error such as:
17408 @cindex relocation truncated to fit (MIPS)
17409 @smallexample
17410 relocation truncated to fit: R_MIPS_GOT16 foobar
17411 @end smallexample
17413 If this happens, you should recompile your code with @option{-mxgot}.
17414 This works with very large GOTs, although the code is also
17415 less efficient, since it takes three instructions to fetch the
17416 value of a global symbol.
17418 Note that some linkers can create multiple GOTs.  If you have such a
17419 linker, you should only need to use @option{-mxgot} when a single object
17420 file accesses more than 64k's worth of GOT entries.  Very few do.
17422 These options have no effect unless GCC is generating position
17423 independent code.
17425 @item -mgp32
17426 @opindex mgp32
17427 Assume that general-purpose registers are 32 bits wide.
17429 @item -mgp64
17430 @opindex mgp64
17431 Assume that general-purpose registers are 64 bits wide.
17433 @item -mfp32
17434 @opindex mfp32
17435 Assume that floating-point registers are 32 bits wide.
17437 @item -mfp64
17438 @opindex mfp64
17439 Assume that floating-point registers are 64 bits wide.
17441 @item -mfpxx
17442 @opindex mfpxx
17443 Do not assume the width of floating-point registers.
17445 @item -mhard-float
17446 @opindex mhard-float
17447 Use floating-point coprocessor instructions.
17449 @item -msoft-float
17450 @opindex msoft-float
17451 Do not use floating-point coprocessor instructions.  Implement
17452 floating-point calculations using library calls instead.
17454 @item -mno-float
17455 @opindex mno-float
17456 Equivalent to @option{-msoft-float}, but additionally asserts that the
17457 program being compiled does not perform any floating-point operations.
17458 This option is presently supported only by some bare-metal MIPS
17459 configurations, where it may select a special set of libraries
17460 that lack all floating-point support (including, for example, the
17461 floating-point @code{printf} formats).  
17462 If code compiled with @option{-mno-float} accidentally contains
17463 floating-point operations, it is likely to suffer a link-time
17464 or run-time failure.
17466 @item -msingle-float
17467 @opindex msingle-float
17468 Assume that the floating-point coprocessor only supports single-precision
17469 operations.
17471 @item -mdouble-float
17472 @opindex mdouble-float
17473 Assume that the floating-point coprocessor supports double-precision
17474 operations.  This is the default.
17476 @item -modd-spreg
17477 @itemx -mno-odd-spreg
17478 @opindex modd-spreg
17479 @opindex mno-odd-spreg
17480 Enable the use of odd-numbered single-precision floating-point registers
17481 for the o32 ABI.  This is the default for processors that are known to
17482 support these registers.  When using the o32 FPXX ABI, @option{-mno-odd-spreg}
17483 is set by default.
17485 @item -mcompact-branches=never
17486 @itemx -mcompact-branches=optimal
17487 @itemx -mcompact-branches=always
17488 @opindex mcompact-branches=never
17489 @opindex mcompact-branches=optimal
17490 @opindex mcompact-branches=always
17491 These options control which form of branches will be generated.  The
17492 default is @option{-mcompact-branches=optimal}.
17494 The @option{-mcompact-branches=never} option ensures that compact branch
17495 instructions will never be generated.
17497 The @option{-mcompact-branches=always} option ensures that a compact
17498 branch instruction will be generated if available.  If a compact branch
17499 instruction is not available, a delay slot form of the branch will be
17500 used instead.
17502 This option is supported from MIPS Release 6 onwards.
17504 The @option{-mcompact-branches=optimal} option will cause a delay slot
17505 branch to be used if one is available in the current ISA and the delay
17506 slot is successfully filled.  If the delay slot is not filled, a compact
17507 branch will be chosen if one is available.
17509 @item -mabs=2008
17510 @itemx -mabs=legacy
17511 @opindex mabs=2008
17512 @opindex mabs=legacy
17513 These options control the treatment of the special not-a-number (NaN)
17514 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17515 @code{neg.@i{fmt}} machine instructions.
17517 By default or when @option{-mabs=legacy} is used the legacy
17518 treatment is selected.  In this case these instructions are considered
17519 arithmetic and avoided where correct operation is required and the
17520 input operand might be a NaN.  A longer sequence of instructions that
17521 manipulate the sign bit of floating-point datum manually is used
17522 instead unless the @option{-ffinite-math-only} option has also been
17523 specified.
17525 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17526 this case these instructions are considered non-arithmetic and therefore
17527 operating correctly in all cases, including in particular where the
17528 input operand is a NaN.  These instructions are therefore always used
17529 for the respective operations.
17531 @item -mnan=2008
17532 @itemx -mnan=legacy
17533 @opindex mnan=2008
17534 @opindex mnan=legacy
17535 These options control the encoding of the special not-a-number (NaN)
17536 IEEE 754 floating-point data.
17538 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17539 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17540 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17541 by the first bit of their trailing significand field being 1.
17543 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17544 this case qNaNs are denoted by the first bit of their trailing
17545 significand field being 1, whereas sNaNs are denoted by the first bit of
17546 their trailing significand field being 0.
17548 The default is @option{-mnan=legacy} unless GCC has been configured with
17549 @option{--with-nan=2008}.
17551 @item -mllsc
17552 @itemx -mno-llsc
17553 @opindex mllsc
17554 @opindex mno-llsc
17555 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17556 implement atomic memory built-in functions.  When neither option is
17557 specified, GCC uses the instructions if the target architecture
17558 supports them.
17560 @option{-mllsc} is useful if the runtime environment can emulate the
17561 instructions and @option{-mno-llsc} can be useful when compiling for
17562 nonstandard ISAs.  You can make either option the default by
17563 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17564 respectively.  @option{--with-llsc} is the default for some
17565 configurations; see the installation documentation for details.
17567 @item -mdsp
17568 @itemx -mno-dsp
17569 @opindex mdsp
17570 @opindex mno-dsp
17571 Use (do not use) revision 1 of the MIPS DSP ASE@.
17572 @xref{MIPS DSP Built-in Functions}.  This option defines the
17573 preprocessor macro @code{__mips_dsp}.  It also defines
17574 @code{__mips_dsp_rev} to 1.
17576 @item -mdspr2
17577 @itemx -mno-dspr2
17578 @opindex mdspr2
17579 @opindex mno-dspr2
17580 Use (do not use) revision 2 of the MIPS DSP ASE@.
17581 @xref{MIPS DSP Built-in Functions}.  This option defines the
17582 preprocessor macros @code{__mips_dsp} and @code{__mips_dspr2}.
17583 It also defines @code{__mips_dsp_rev} to 2.
17585 @item -msmartmips
17586 @itemx -mno-smartmips
17587 @opindex msmartmips
17588 @opindex mno-smartmips
17589 Use (do not use) the MIPS SmartMIPS ASE.
17591 @item -mpaired-single
17592 @itemx -mno-paired-single
17593 @opindex mpaired-single
17594 @opindex mno-paired-single
17595 Use (do not use) paired-single floating-point instructions.
17596 @xref{MIPS Paired-Single Support}.  This option requires
17597 hardware floating-point support to be enabled.
17599 @item -mdmx
17600 @itemx -mno-mdmx
17601 @opindex mdmx
17602 @opindex mno-mdmx
17603 Use (do not use) MIPS Digital Media Extension instructions.
17604 This option can only be used when generating 64-bit code and requires
17605 hardware floating-point support to be enabled.
17607 @item -mips3d
17608 @itemx -mno-mips3d
17609 @opindex mips3d
17610 @opindex mno-mips3d
17611 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17612 The option @option{-mips3d} implies @option{-mpaired-single}.
17614 @item -mmicromips
17615 @itemx -mno-micromips
17616 @opindex mmicromips
17617 @opindex mno-mmicromips
17618 Generate (do not generate) microMIPS code.
17620 MicroMIPS code generation can also be controlled on a per-function basis
17621 by means of @code{micromips} and @code{nomicromips} attributes.
17622 @xref{Function Attributes}, for more information.
17624 @item -mmt
17625 @itemx -mno-mt
17626 @opindex mmt
17627 @opindex mno-mt
17628 Use (do not use) MT Multithreading instructions.
17630 @item -mmcu
17631 @itemx -mno-mcu
17632 @opindex mmcu
17633 @opindex mno-mcu
17634 Use (do not use) the MIPS MCU ASE instructions.
17636 @item -meva
17637 @itemx -mno-eva
17638 @opindex meva
17639 @opindex mno-eva
17640 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17642 @item -mvirt
17643 @itemx -mno-virt
17644 @opindex mvirt
17645 @opindex mno-virt
17646 Use (do not use) the MIPS Virtualization Application Specific instructions.
17648 @item -mxpa
17649 @itemx -mno-xpa
17650 @opindex mxpa
17651 @opindex mno-xpa
17652 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
17654 @item -mlong64
17655 @opindex mlong64
17656 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17657 an explanation of the default and the way that the pointer size is
17658 determined.
17660 @item -mlong32
17661 @opindex mlong32
17662 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17664 The default size of @code{int}s, @code{long}s and pointers depends on
17665 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17666 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17667 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17668 or the same size as integer registers, whichever is smaller.
17670 @item -msym32
17671 @itemx -mno-sym32
17672 @opindex msym32
17673 @opindex mno-sym32
17674 Assume (do not assume) that all symbols have 32-bit values, regardless
17675 of the selected ABI@.  This option is useful in combination with
17676 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17677 to generate shorter and faster references to symbolic addresses.
17679 @item -G @var{num}
17680 @opindex G
17681 Put definitions of externally-visible data in a small data section
17682 if that data is no bigger than @var{num} bytes.  GCC can then generate
17683 more efficient accesses to the data; see @option{-mgpopt} for details.
17685 The default @option{-G} option depends on the configuration.
17687 @item -mlocal-sdata
17688 @itemx -mno-local-sdata
17689 @opindex mlocal-sdata
17690 @opindex mno-local-sdata
17691 Extend (do not extend) the @option{-G} behavior to local data too,
17692 such as to static variables in C@.  @option{-mlocal-sdata} is the
17693 default for all configurations.
17695 If the linker complains that an application is using too much small data,
17696 you might want to try rebuilding the less performance-critical parts with
17697 @option{-mno-local-sdata}.  You might also want to build large
17698 libraries with @option{-mno-local-sdata}, so that the libraries leave
17699 more room for the main program.
17701 @item -mextern-sdata
17702 @itemx -mno-extern-sdata
17703 @opindex mextern-sdata
17704 @opindex mno-extern-sdata
17705 Assume (do not assume) that externally-defined data is in
17706 a small data section if the size of that data is within the @option{-G} limit.
17707 @option{-mextern-sdata} is the default for all configurations.
17709 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17710 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17711 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17712 is placed in a small data section.  If @var{Var} is defined by another
17713 module, you must either compile that module with a high-enough
17714 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17715 definition.  If @var{Var} is common, you must link the application
17716 with a high-enough @option{-G} setting.
17718 The easiest way of satisfying these restrictions is to compile
17719 and link every module with the same @option{-G} option.  However,
17720 you may wish to build a library that supports several different
17721 small data limits.  You can do this by compiling the library with
17722 the highest supported @option{-G} setting and additionally using
17723 @option{-mno-extern-sdata} to stop the library from making assumptions
17724 about externally-defined data.
17726 @item -mgpopt
17727 @itemx -mno-gpopt
17728 @opindex mgpopt
17729 @opindex mno-gpopt
17730 Use (do not use) GP-relative accesses for symbols that are known to be
17731 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17732 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17733 configurations.
17735 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17736 might not hold the value of @code{_gp}.  For example, if the code is
17737 part of a library that might be used in a boot monitor, programs that
17738 call boot monitor routines pass an unknown value in @code{$gp}.
17739 (In such situations, the boot monitor itself is usually compiled
17740 with @option{-G0}.)
17742 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17743 @option{-mno-extern-sdata}.
17745 @item -membedded-data
17746 @itemx -mno-embedded-data
17747 @opindex membedded-data
17748 @opindex mno-embedded-data
17749 Allocate variables to the read-only data section first if possible, then
17750 next in the small data section if possible, otherwise in data.  This gives
17751 slightly slower code than the default, but reduces the amount of RAM required
17752 when executing, and thus may be preferred for some embedded systems.
17754 @item -muninit-const-in-rodata
17755 @itemx -mno-uninit-const-in-rodata
17756 @opindex muninit-const-in-rodata
17757 @opindex mno-uninit-const-in-rodata
17758 Put uninitialized @code{const} variables in the read-only data section.
17759 This option is only meaningful in conjunction with @option{-membedded-data}.
17761 @item -mcode-readable=@var{setting}
17762 @opindex mcode-readable
17763 Specify whether GCC may generate code that reads from executable sections.
17764 There are three possible settings:
17766 @table @gcctabopt
17767 @item -mcode-readable=yes
17768 Instructions may freely access executable sections.  This is the
17769 default setting.
17771 @item -mcode-readable=pcrel
17772 MIPS16 PC-relative load instructions can access executable sections,
17773 but other instructions must not do so.  This option is useful on 4KSc
17774 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17775 It is also useful on processors that can be configured to have a dual
17776 instruction/data SRAM interface and that, like the M4K, automatically
17777 redirect PC-relative loads to the instruction RAM.
17779 @item -mcode-readable=no
17780 Instructions must not access executable sections.  This option can be
17781 useful on targets that are configured to have a dual instruction/data
17782 SRAM interface but that (unlike the M4K) do not automatically redirect
17783 PC-relative loads to the instruction RAM.
17784 @end table
17786 @item -msplit-addresses
17787 @itemx -mno-split-addresses
17788 @opindex msplit-addresses
17789 @opindex mno-split-addresses
17790 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17791 relocation operators.  This option has been superseded by
17792 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17794 @item -mexplicit-relocs
17795 @itemx -mno-explicit-relocs
17796 @opindex mexplicit-relocs
17797 @opindex mno-explicit-relocs
17798 Use (do not use) assembler relocation operators when dealing with symbolic
17799 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17800 is to use assembler macros instead.
17802 @option{-mexplicit-relocs} is the default if GCC was configured
17803 to use an assembler that supports relocation operators.
17805 @item -mcheck-zero-division
17806 @itemx -mno-check-zero-division
17807 @opindex mcheck-zero-division
17808 @opindex mno-check-zero-division
17809 Trap (do not trap) on integer division by zero.
17811 The default is @option{-mcheck-zero-division}.
17813 @item -mdivide-traps
17814 @itemx -mdivide-breaks
17815 @opindex mdivide-traps
17816 @opindex mdivide-breaks
17817 MIPS systems check for division by zero by generating either a
17818 conditional trap or a break instruction.  Using traps results in
17819 smaller code, but is only supported on MIPS II and later.  Also, some
17820 versions of the Linux kernel have a bug that prevents trap from
17821 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17822 allow conditional traps on architectures that support them and
17823 @option{-mdivide-breaks} to force the use of breaks.
17825 The default is usually @option{-mdivide-traps}, but this can be
17826 overridden at configure time using @option{--with-divide=breaks}.
17827 Divide-by-zero checks can be completely disabled using
17828 @option{-mno-check-zero-division}.
17830 @item -mmemcpy
17831 @itemx -mno-memcpy
17832 @opindex mmemcpy
17833 @opindex mno-memcpy
17834 Force (do not force) the use of @code{memcpy} for non-trivial block
17835 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17836 most constant-sized copies.
17838 @item -mlong-calls
17839 @itemx -mno-long-calls
17840 @opindex mlong-calls
17841 @opindex mno-long-calls
17842 Disable (do not disable) use of the @code{jal} instruction.  Calling
17843 functions using @code{jal} is more efficient but requires the caller
17844 and callee to be in the same 256 megabyte segment.
17846 This option has no effect on abicalls code.  The default is
17847 @option{-mno-long-calls}.
17849 @item -mmad
17850 @itemx -mno-mad
17851 @opindex mmad
17852 @opindex mno-mad
17853 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17854 instructions, as provided by the R4650 ISA@.
17856 @item -mimadd
17857 @itemx -mno-imadd
17858 @opindex mimadd
17859 @opindex mno-imadd
17860 Enable (disable) use of the @code{madd} and @code{msub} integer
17861 instructions.  The default is @option{-mimadd} on architectures
17862 that support @code{madd} and @code{msub} except for the 74k 
17863 architecture where it was found to generate slower code.
17865 @item -mfused-madd
17866 @itemx -mno-fused-madd
17867 @opindex mfused-madd
17868 @opindex mno-fused-madd
17869 Enable (disable) use of the floating-point multiply-accumulate
17870 instructions, when they are available.  The default is
17871 @option{-mfused-madd}.
17873 On the R8000 CPU when multiply-accumulate instructions are used,
17874 the intermediate product is calculated to infinite precision
17875 and is not subject to the FCSR Flush to Zero bit.  This may be
17876 undesirable in some circumstances.  On other processors the result
17877 is numerically identical to the equivalent computation using
17878 separate multiply, add, subtract and negate instructions.
17880 @item -nocpp
17881 @opindex nocpp
17882 Tell the MIPS assembler to not run its preprocessor over user
17883 assembler files (with a @samp{.s} suffix) when assembling them.
17885 @item -mfix-24k
17886 @item -mno-fix-24k
17887 @opindex mfix-24k
17888 @opindex mno-fix-24k
17889 Work around the 24K E48 (lost data on stores during refill) errata.
17890 The workarounds are implemented by the assembler rather than by GCC@.
17892 @item -mfix-r4000
17893 @itemx -mno-fix-r4000
17894 @opindex mfix-r4000
17895 @opindex mno-fix-r4000
17896 Work around certain R4000 CPU errata:
17897 @itemize @minus
17898 @item
17899 A double-word or a variable shift may give an incorrect result if executed
17900 immediately after starting an integer division.
17901 @item
17902 A double-word or a variable shift may give an incorrect result if executed
17903 while an integer multiplication is in progress.
17904 @item
17905 An integer division may give an incorrect result if started in a delay slot
17906 of a taken branch or a jump.
17907 @end itemize
17909 @item -mfix-r4400
17910 @itemx -mno-fix-r4400
17911 @opindex mfix-r4400
17912 @opindex mno-fix-r4400
17913 Work around certain R4400 CPU errata:
17914 @itemize @minus
17915 @item
17916 A double-word or a variable shift may give an incorrect result if executed
17917 immediately after starting an integer division.
17918 @end itemize
17920 @item -mfix-r10000
17921 @itemx -mno-fix-r10000
17922 @opindex mfix-r10000
17923 @opindex mno-fix-r10000
17924 Work around certain R10000 errata:
17925 @itemize @minus
17926 @item
17927 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17928 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17929 @end itemize
17931 This option can only be used if the target architecture supports
17932 branch-likely instructions.  @option{-mfix-r10000} is the default when
17933 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17934 otherwise.
17936 @item -mfix-rm7000
17937 @itemx -mno-fix-rm7000
17938 @opindex mfix-rm7000
17939 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17940 workarounds are implemented by the assembler rather than by GCC@.
17942 @item -mfix-vr4120
17943 @itemx -mno-fix-vr4120
17944 @opindex mfix-vr4120
17945 Work around certain VR4120 errata:
17946 @itemize @minus
17947 @item
17948 @code{dmultu} does not always produce the correct result.
17949 @item
17950 @code{div} and @code{ddiv} do not always produce the correct result if one
17951 of the operands is negative.
17952 @end itemize
17953 The workarounds for the division errata rely on special functions in
17954 @file{libgcc.a}.  At present, these functions are only provided by
17955 the @code{mips64vr*-elf} configurations.
17957 Other VR4120 errata require a NOP to be inserted between certain pairs of
17958 instructions.  These errata are handled by the assembler, not by GCC itself.
17960 @item -mfix-vr4130
17961 @opindex mfix-vr4130
17962 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17963 workarounds are implemented by the assembler rather than by GCC,
17964 although GCC avoids using @code{mflo} and @code{mfhi} if the
17965 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17966 instructions are available instead.
17968 @item -mfix-sb1
17969 @itemx -mno-fix-sb1
17970 @opindex mfix-sb1
17971 Work around certain SB-1 CPU core errata.
17972 (This flag currently works around the SB-1 revision 2
17973 ``F1'' and ``F2'' floating-point errata.)
17975 @item -mr10k-cache-barrier=@var{setting}
17976 @opindex mr10k-cache-barrier
17977 Specify whether GCC should insert cache barriers to avoid the
17978 side-effects of speculation on R10K processors.
17980 In common with many processors, the R10K tries to predict the outcome
17981 of a conditional branch and speculatively executes instructions from
17982 the ``taken'' branch.  It later aborts these instructions if the
17983 predicted outcome is wrong.  However, on the R10K, even aborted
17984 instructions can have side effects.
17986 This problem only affects kernel stores and, depending on the system,
17987 kernel loads.  As an example, a speculatively-executed store may load
17988 the target memory into cache and mark the cache line as dirty, even if
17989 the store itself is later aborted.  If a DMA operation writes to the
17990 same area of memory before the ``dirty'' line is flushed, the cached
17991 data overwrites the DMA-ed data.  See the R10K processor manual
17992 for a full description, including other potential problems.
17994 One workaround is to insert cache barrier instructions before every memory
17995 access that might be speculatively executed and that might have side
17996 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17997 controls GCC's implementation of this workaround.  It assumes that
17998 aborted accesses to any byte in the following regions does not have
17999 side effects:
18001 @enumerate
18002 @item
18003 the memory occupied by the current function's stack frame;
18005 @item
18006 the memory occupied by an incoming stack argument;
18008 @item
18009 the memory occupied by an object with a link-time-constant address.
18010 @end enumerate
18012 It is the kernel's responsibility to ensure that speculative
18013 accesses to these regions are indeed safe.
18015 If the input program contains a function declaration such as:
18017 @smallexample
18018 void foo (void);
18019 @end smallexample
18021 then the implementation of @code{foo} must allow @code{j foo} and
18022 @code{jal foo} to be executed speculatively.  GCC honors this
18023 restriction for functions it compiles itself.  It expects non-GCC
18024 functions (such as hand-written assembly code) to do the same.
18026 The option has three forms:
18028 @table @gcctabopt
18029 @item -mr10k-cache-barrier=load-store
18030 Insert a cache barrier before a load or store that might be
18031 speculatively executed and that might have side effects even
18032 if aborted.
18034 @item -mr10k-cache-barrier=store
18035 Insert a cache barrier before a store that might be speculatively
18036 executed and that might have side effects even if aborted.
18038 @item -mr10k-cache-barrier=none
18039 Disable the insertion of cache barriers.  This is the default setting.
18040 @end table
18042 @item -mflush-func=@var{func}
18043 @itemx -mno-flush-func
18044 @opindex mflush-func
18045 Specifies the function to call to flush the I and D caches, or to not
18046 call any such function.  If called, the function must take the same
18047 arguments as the common @code{_flush_func}, that is, the address of the
18048 memory range for which the cache is being flushed, the size of the
18049 memory range, and the number 3 (to flush both caches).  The default
18050 depends on the target GCC was configured for, but commonly is either
18051 @code{_flush_func} or @code{__cpu_flush}.
18053 @item mbranch-cost=@var{num}
18054 @opindex mbranch-cost
18055 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18056 This cost is only a heuristic and is not guaranteed to produce
18057 consistent results across releases.  A zero cost redundantly selects
18058 the default, which is based on the @option{-mtune} setting.
18060 @item -mbranch-likely
18061 @itemx -mno-branch-likely
18062 @opindex mbranch-likely
18063 @opindex mno-branch-likely
18064 Enable or disable use of Branch Likely instructions, regardless of the
18065 default for the selected architecture.  By default, Branch Likely
18066 instructions may be generated if they are supported by the selected
18067 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18068 and processors that implement those architectures; for those, Branch
18069 Likely instructions are not be generated by default because the MIPS32
18070 and MIPS64 architectures specifically deprecate their use.
18072 @item -mfp-exceptions
18073 @itemx -mno-fp-exceptions
18074 @opindex mfp-exceptions
18075 Specifies whether FP exceptions are enabled.  This affects how
18076 FP instructions are scheduled for some processors.
18077 The default is that FP exceptions are
18078 enabled.
18080 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18081 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18082 FP pipe.
18084 @item -mvr4130-align
18085 @itemx -mno-vr4130-align
18086 @opindex mvr4130-align
18087 The VR4130 pipeline is two-way superscalar, but can only issue two
18088 instructions together if the first one is 8-byte aligned.  When this
18089 option is enabled, GCC aligns pairs of instructions that it
18090 thinks should execute in parallel.
18092 This option only has an effect when optimizing for the VR4130.
18093 It normally makes code faster, but at the expense of making it bigger.
18094 It is enabled by default at optimization level @option{-O3}.
18096 @item -msynci
18097 @itemx -mno-synci
18098 @opindex msynci
18099 Enable (disable) generation of @code{synci} instructions on
18100 architectures that support it.  The @code{synci} instructions (if
18101 enabled) are generated when @code{__builtin___clear_cache} is
18102 compiled.
18104 This option defaults to @option{-mno-synci}, but the default can be
18105 overridden by configuring GCC with @option{--with-synci}.
18107 When compiling code for single processor systems, it is generally safe
18108 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18109 does not invalidate the instruction caches on all cores and may lead
18110 to undefined behavior.
18112 @item -mrelax-pic-calls
18113 @itemx -mno-relax-pic-calls
18114 @opindex mrelax-pic-calls
18115 Try to turn PIC calls that are normally dispatched via register
18116 @code{$25} into direct calls.  This is only possible if the linker can
18117 resolve the destination at link-time and if the destination is within
18118 range for a direct call.
18120 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18121 an assembler and a linker that support the @code{.reloc} assembly
18122 directive and @option{-mexplicit-relocs} is in effect.  With
18123 @option{-mno-explicit-relocs}, this optimization can be performed by the
18124 assembler and the linker alone without help from the compiler.
18126 @item -mmcount-ra-address
18127 @itemx -mno-mcount-ra-address
18128 @opindex mmcount-ra-address
18129 @opindex mno-mcount-ra-address
18130 Emit (do not emit) code that allows @code{_mcount} to modify the
18131 calling function's return address.  When enabled, this option extends
18132 the usual @code{_mcount} interface with a new @var{ra-address}
18133 parameter, which has type @code{intptr_t *} and is passed in register
18134 @code{$12}.  @code{_mcount} can then modify the return address by
18135 doing both of the following:
18136 @itemize
18137 @item
18138 Returning the new address in register @code{$31}.
18139 @item
18140 Storing the new address in @code{*@var{ra-address}},
18141 if @var{ra-address} is nonnull.
18142 @end itemize
18144 The default is @option{-mno-mcount-ra-address}.
18146 @item -mframe-header-opt
18147 @itemx -mno-frame-header-opt
18148 @opindex mframe-header-opt
18149 Enable (disable) frame header optimization in the o32 ABI.  When using the
18150 o32 ABI, calling functions will allocate 16 bytes on the stack for the called
18151 function to write out register arguments.  When enabled, this optimization
18152 will suppress the allocation of the frame header if it can be determined that
18153 it is unused.
18155 This optimization is off by default at all optimization levels.
18157 @end table
18159 @node MMIX Options
18160 @subsection MMIX Options
18161 @cindex MMIX Options
18163 These options are defined for the MMIX:
18165 @table @gcctabopt
18166 @item -mlibfuncs
18167 @itemx -mno-libfuncs
18168 @opindex mlibfuncs
18169 @opindex mno-libfuncs
18170 Specify that intrinsic library functions are being compiled, passing all
18171 values in registers, no matter the size.
18173 @item -mepsilon
18174 @itemx -mno-epsilon
18175 @opindex mepsilon
18176 @opindex mno-epsilon
18177 Generate floating-point comparison instructions that compare with respect
18178 to the @code{rE} epsilon register.
18180 @item -mabi=mmixware
18181 @itemx -mabi=gnu
18182 @opindex mabi=mmixware
18183 @opindex mabi=gnu
18184 Generate code that passes function parameters and return values that (in
18185 the called function) are seen as registers @code{$0} and up, as opposed to
18186 the GNU ABI which uses global registers @code{$231} and up.
18188 @item -mzero-extend
18189 @itemx -mno-zero-extend
18190 @opindex mzero-extend
18191 @opindex mno-zero-extend
18192 When reading data from memory in sizes shorter than 64 bits, use (do not
18193 use) zero-extending load instructions by default, rather than
18194 sign-extending ones.
18196 @item -mknuthdiv
18197 @itemx -mno-knuthdiv
18198 @opindex mknuthdiv
18199 @opindex mno-knuthdiv
18200 Make the result of a division yielding a remainder have the same sign as
18201 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18202 remainder follows the sign of the dividend.  Both methods are
18203 arithmetically valid, the latter being almost exclusively used.
18205 @item -mtoplevel-symbols
18206 @itemx -mno-toplevel-symbols
18207 @opindex mtoplevel-symbols
18208 @opindex mno-toplevel-symbols
18209 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18210 code can be used with the @code{PREFIX} assembly directive.
18212 @item -melf
18213 @opindex melf
18214 Generate an executable in the ELF format, rather than the default
18215 @samp{mmo} format used by the @command{mmix} simulator.
18217 @item -mbranch-predict
18218 @itemx -mno-branch-predict
18219 @opindex mbranch-predict
18220 @opindex mno-branch-predict
18221 Use (do not use) the probable-branch instructions, when static branch
18222 prediction indicates a probable branch.
18224 @item -mbase-addresses
18225 @itemx -mno-base-addresses
18226 @opindex mbase-addresses
18227 @opindex mno-base-addresses
18228 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18229 base address automatically generates a request (handled by the assembler
18230 and the linker) for a constant to be set up in a global register.  The
18231 register is used for one or more base address requests within the range 0
18232 to 255 from the value held in the register.  The generally leads to short
18233 and fast code, but the number of different data items that can be
18234 addressed is limited.  This means that a program that uses lots of static
18235 data may require @option{-mno-base-addresses}.
18237 @item -msingle-exit
18238 @itemx -mno-single-exit
18239 @opindex msingle-exit
18240 @opindex mno-single-exit
18241 Force (do not force) generated code to have a single exit point in each
18242 function.
18243 @end table
18245 @node MN10300 Options
18246 @subsection MN10300 Options
18247 @cindex MN10300 options
18249 These @option{-m} options are defined for Matsushita MN10300 architectures:
18251 @table @gcctabopt
18252 @item -mmult-bug
18253 @opindex mmult-bug
18254 Generate code to avoid bugs in the multiply instructions for the MN10300
18255 processors.  This is the default.
18257 @item -mno-mult-bug
18258 @opindex mno-mult-bug
18259 Do not generate code to avoid bugs in the multiply instructions for the
18260 MN10300 processors.
18262 @item -mam33
18263 @opindex mam33
18264 Generate code using features specific to the AM33 processor.
18266 @item -mno-am33
18267 @opindex mno-am33
18268 Do not generate code using features specific to the AM33 processor.  This
18269 is the default.
18271 @item -mam33-2
18272 @opindex mam33-2
18273 Generate code using features specific to the AM33/2.0 processor.
18275 @item -mam34
18276 @opindex mam34
18277 Generate code using features specific to the AM34 processor.
18279 @item -mtune=@var{cpu-type}
18280 @opindex mtune
18281 Use the timing characteristics of the indicated CPU type when
18282 scheduling instructions.  This does not change the targeted processor
18283 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18284 @samp{am33-2} or @samp{am34}.
18286 @item -mreturn-pointer-on-d0
18287 @opindex mreturn-pointer-on-d0
18288 When generating a function that returns a pointer, return the pointer
18289 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18290 only in @code{a0}, and attempts to call such functions without a prototype
18291 result in errors.  Note that this option is on by default; use
18292 @option{-mno-return-pointer-on-d0} to disable it.
18294 @item -mno-crt0
18295 @opindex mno-crt0
18296 Do not link in the C run-time initialization object file.
18298 @item -mrelax
18299 @opindex mrelax
18300 Indicate to the linker that it should perform a relaxation optimization pass
18301 to shorten branches, calls and absolute memory addresses.  This option only
18302 has an effect when used on the command line for the final link step.
18304 This option makes symbolic debugging impossible.
18306 @item -mliw
18307 @opindex mliw
18308 Allow the compiler to generate @emph{Long Instruction Word}
18309 instructions if the target is the @samp{AM33} or later.  This is the
18310 default.  This option defines the preprocessor macro @code{__LIW__}.
18312 @item -mnoliw
18313 @opindex mnoliw
18314 Do not allow the compiler to generate @emph{Long Instruction Word}
18315 instructions.  This option defines the preprocessor macro
18316 @code{__NO_LIW__}.
18318 @item -msetlb
18319 @opindex msetlb
18320 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18321 instructions if the target is the @samp{AM33} or later.  This is the
18322 default.  This option defines the preprocessor macro @code{__SETLB__}.
18324 @item -mnosetlb
18325 @opindex mnosetlb
18326 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18327 instructions.  This option defines the preprocessor macro
18328 @code{__NO_SETLB__}.
18330 @end table
18332 @node Moxie Options
18333 @subsection Moxie Options
18334 @cindex Moxie Options
18336 @table @gcctabopt
18338 @item -meb
18339 @opindex meb
18340 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18341 configurations.
18343 @item -mel
18344 @opindex mel
18345 Generate little-endian code.
18347 @item -mmul.x
18348 @opindex mmul.x
18349 Generate mul.x and umul.x instructions.  This is the default for
18350 @samp{moxiebox-*-*} configurations.
18352 @item -mno-crt0
18353 @opindex mno-crt0
18354 Do not link in the C run-time initialization object file.
18356 @end table
18358 @node MSP430 Options
18359 @subsection MSP430 Options
18360 @cindex MSP430 Options
18362 These options are defined for the MSP430:
18364 @table @gcctabopt
18366 @item -masm-hex
18367 @opindex masm-hex
18368 Force assembly output to always use hex constants.  Normally such
18369 constants are signed decimals, but this option is available for
18370 testsuite and/or aesthetic purposes.
18372 @item -mmcu=
18373 @opindex mmcu=
18374 Select the MCU to target.  This is used to create a C preprocessor
18375 symbol based upon the MCU name, converted to upper case and pre- and
18376 post-fixed with @samp{__}.  This in turn is used by the
18377 @file{msp430.h} header file to select an MCU-specific supplementary
18378 header file.
18380 The option also sets the ISA to use.  If the MCU name is one that is
18381 known to only support the 430 ISA then that is selected, otherwise the
18382 430X ISA is selected.  A generic MCU name of @samp{msp430} can also be
18383 used to select the 430 ISA.  Similarly the generic @samp{msp430x} MCU
18384 name selects the 430X ISA.
18386 In addition an MCU-specific linker script is added to the linker
18387 command line.  The script's name is the name of the MCU with
18388 @file{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the @command{gcc}
18389 command line defines the C preprocessor symbol @code{__XXX__} and
18390 cause the linker to search for a script called @file{xxx.ld}.
18392 This option is also passed on to the assembler.
18394 @item -mcpu=
18395 @opindex mcpu=
18396 Specifies the ISA to use.  Accepted values are @samp{msp430},
18397 @samp{msp430x} and @samp{msp430xv2}.  This option is deprecated.  The
18398 @option{-mmcu=} option should be used to select the ISA.
18400 @item -msim
18401 @opindex msim
18402 Link to the simulator runtime libraries and linker script.  Overrides
18403 any scripts that would be selected by the @option{-mmcu=} option.
18405 @item -mlarge
18406 @opindex mlarge
18407 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18409 @item -msmall
18410 @opindex msmall
18411 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18413 @item -mrelax
18414 @opindex mrelax
18415 This option is passed to the assembler and linker, and allows the
18416 linker to perform certain optimizations that cannot be done until
18417 the final link.
18419 @item mhwmult=
18420 @opindex mhwmult=
18421 Describes the type of hardware multiply supported by the target.
18422 Accepted values are @samp{none} for no hardware multiply, @samp{16bit}
18423 for the original 16-bit-only multiply supported by early MCUs.
18424 @samp{32bit} for the 16/32-bit multiply supported by later MCUs and
18425 @samp{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18426 A value of @samp{auto} can also be given.  This tells GCC to deduce
18427 the hardware multiply support based upon the MCU name provided by the
18428 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18429 @samp{32bit} hardware multiply support is assumed.  If the MCU name is
18430 not recognised then no hardware multiply support is assumed.
18431 @code{auto} is the default setting.
18433 Hardware multiplies are normally performed by calling a library
18434 routine.  This saves space in the generated code.  When compiling at
18435 @option{-O3} or higher however the hardware multiplier is invoked
18436 inline.  This makes for bigger, but faster code.
18438 The hardware multiply routines disable interrupts whilst running and
18439 restore the previous interrupt state when they finish.  This makes
18440 them safe to use inside interrupt handlers as well as in normal code.
18442 @item -minrt
18443 @opindex minrt
18444 Enable the use of a minimum runtime environment - no static
18445 initializers or constructors.  This is intended for memory-constrained
18446 devices.  The compiler includes special symbols in some objects
18447 that tell the linker and runtime which code fragments are required.
18449 @item -mcode-region=
18450 @itemx -mdata-region=
18451 @opindex mcode-region
18452 @opindex mdata-region
18453 These options tell the compiler where to place functions and data that
18454 do not have one of the @code{lower}, @code{upper}, @code{either} or
18455 @code{section} attributes.  Possible values are @code{lower},
18456 @code{upper}, @code{either} or @code{any}.  The first three behave
18457 like the corresponding attribute.  The fourth possible value -
18458 @code{any} - is the default.  It leaves placement entirely up to the
18459 linker script and how it assigns the standard sections (.text, .data
18460 etc) to the memory regions.
18462 @item -msilicon-errata=
18463 @opindex msilicon-errata
18464 This option passes on a request to assembler to enable the fixes for
18465 the named silicon errata.
18467 @item -msilicon-errata-warn=
18468 @opindex msilicon-errata-warn
18469 This option passes on a request to the assembler to enable warning
18470 messages when a silicon errata might need to be applied.
18472 @end table
18474 @node NDS32 Options
18475 @subsection NDS32 Options
18476 @cindex NDS32 Options
18478 These options are defined for NDS32 implementations:
18480 @table @gcctabopt
18482 @item -mbig-endian
18483 @opindex mbig-endian
18484 Generate code in big-endian mode.
18486 @item -mlittle-endian
18487 @opindex mlittle-endian
18488 Generate code in little-endian mode.
18490 @item -mreduced-regs
18491 @opindex mreduced-regs
18492 Use reduced-set registers for register allocation.
18494 @item -mfull-regs
18495 @opindex mfull-regs
18496 Use full-set registers for register allocation.
18498 @item -mcmov
18499 @opindex mcmov
18500 Generate conditional move instructions.
18502 @item -mno-cmov
18503 @opindex mno-cmov
18504 Do not generate conditional move instructions.
18506 @item -mperf-ext
18507 @opindex mperf-ext
18508 Generate performance extension instructions.
18510 @item -mno-perf-ext
18511 @opindex mno-perf-ext
18512 Do not generate performance extension instructions.
18514 @item -mv3push
18515 @opindex mv3push
18516 Generate v3 push25/pop25 instructions.
18518 @item -mno-v3push
18519 @opindex mno-v3push
18520 Do not generate v3 push25/pop25 instructions.
18522 @item -m16-bit
18523 @opindex m16-bit
18524 Generate 16-bit instructions.
18526 @item -mno-16-bit
18527 @opindex mno-16-bit
18528 Do not generate 16-bit instructions.
18530 @item -misr-vector-size=@var{num}
18531 @opindex misr-vector-size
18532 Specify the size of each interrupt vector, which must be 4 or 16.
18534 @item -mcache-block-size=@var{num}
18535 @opindex mcache-block-size
18536 Specify the size of each cache block,
18537 which must be a power of 2 between 4 and 512.
18539 @item -march=@var{arch}
18540 @opindex march
18541 Specify the name of the target architecture.
18543 @item -mcmodel=@var{code-model}
18544 @opindex mcmodel
18545 Set the code model to one of
18546 @table @asis
18547 @item @samp{small}
18548 All the data and read-only data segments must be within 512KB addressing space.
18549 The text segment must be within 16MB addressing space.
18550 @item @samp{medium}
18551 The data segment must be within 512KB while the read-only data segment can be
18552 within 4GB addressing space.  The text segment should be still within 16MB
18553 addressing space.
18554 @item @samp{large}
18555 All the text and data segments can be within 4GB addressing space.
18556 @end table
18558 @item -mctor-dtor
18559 @opindex mctor-dtor
18560 Enable constructor/destructor feature.
18562 @item -mrelax
18563 @opindex mrelax
18564 Guide linker to relax instructions.
18566 @end table
18568 @node Nios II Options
18569 @subsection Nios II Options
18570 @cindex Nios II options
18571 @cindex Altera Nios II options
18573 These are the options defined for the Altera Nios II processor.
18575 @table @gcctabopt
18577 @item -G @var{num}
18578 @opindex G
18579 @cindex smaller data references
18580 Put global and static objects less than or equal to @var{num} bytes
18581 into the small data or BSS sections instead of the normal data or BSS
18582 sections.  The default value of @var{num} is 8.
18584 @item -mgpopt=@var{option}
18585 @item -mgpopt
18586 @itemx -mno-gpopt
18587 @opindex mgpopt
18588 @opindex mno-gpopt
18589 Generate (do not generate) GP-relative accesses.  The following 
18590 @var{option} names are recognized:
18592 @table @samp
18594 @item none
18595 Do not generate GP-relative accesses.
18597 @item local
18598 Generate GP-relative accesses for small data objects that are not 
18599 external, weak, or uninitialized common symbols.  
18600 Also use GP-relative addressing for objects that
18601 have been explicitly placed in a small data section via a @code{section}
18602 attribute.
18604 @item global
18605 As for @samp{local}, but also generate GP-relative accesses for
18606 small data objects that are external, weak, or common.  If you use this option,
18607 you must ensure that all parts of your program (including libraries) are
18608 compiled with the same @option{-G} setting.
18610 @item data
18611 Generate GP-relative accesses for all data objects in the program.  If you
18612 use this option, the entire data and BSS segments
18613 of your program must fit in 64K of memory and you must use an appropriate
18614 linker script to allocate them within the addressible range of the
18615 global pointer.
18617 @item all
18618 Generate GP-relative addresses for function pointers as well as data
18619 pointers.  If you use this option, the entire text, data, and BSS segments
18620 of your program must fit in 64K of memory and you must use an appropriate
18621 linker script to allocate them within the addressible range of the
18622 global pointer.
18624 @end table
18626 @option{-mgpopt} is equivalent to @option{-mgpopt=local}, and
18627 @option{-mno-gpopt} is equivalent to @option{-mgpopt=none}.
18629 The default is @option{-mgpopt} except when @option{-fpic} or
18630 @option{-fPIC} is specified to generate position-independent code.
18631 Note that the Nios II ABI does not permit GP-relative accesses from
18632 shared libraries.
18634 You may need to specify @option{-mno-gpopt} explicitly when building
18635 programs that include large amounts of small data, including large
18636 GOT data sections.  In this case, the 16-bit offset for GP-relative
18637 addressing may not be large enough to allow access to the entire 
18638 small data section.
18640 @item -mel
18641 @itemx -meb
18642 @opindex mel
18643 @opindex meb
18644 Generate little-endian (default) or big-endian (experimental) code,
18645 respectively.
18647 @item -march=@var{arch}
18648 @opindex march
18649 This specifies the name of the target Nios II architecture.  GCC uses this
18650 name to determine what kind of instructions it can emit when generating
18651 assembly code.  Permissible names are: @samp{r1}, @samp{r2}.
18653 The preprocessor macro @code{__nios2_arch__} is available to programs,
18654 with value 1 or 2, indicating the targeted ISA level.
18656 @item -mbypass-cache
18657 @itemx -mno-bypass-cache
18658 @opindex mno-bypass-cache
18659 @opindex mbypass-cache
18660 Force all load and store instructions to always bypass cache by 
18661 using I/O variants of the instructions. The default is not to
18662 bypass the cache.
18664 @item -mno-cache-volatile 
18665 @itemx -mcache-volatile       
18666 @opindex mcache-volatile 
18667 @opindex mno-cache-volatile
18668 Volatile memory access bypass the cache using the I/O variants of 
18669 the load and store instructions. The default is not to bypass the cache.
18671 @item -mno-fast-sw-div
18672 @itemx -mfast-sw-div
18673 @opindex mno-fast-sw-div
18674 @opindex mfast-sw-div
18675 Do not use table-based fast divide for small numbers. The default 
18676 is to use the fast divide at @option{-O3} and above.
18678 @item -mno-hw-mul
18679 @itemx -mhw-mul
18680 @itemx -mno-hw-mulx
18681 @itemx -mhw-mulx
18682 @itemx -mno-hw-div
18683 @itemx -mhw-div
18684 @opindex mno-hw-mul
18685 @opindex mhw-mul
18686 @opindex mno-hw-mulx
18687 @opindex mhw-mulx
18688 @opindex mno-hw-div
18689 @opindex mhw-div
18690 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18691 instructions by the compiler. The default is to emit @code{mul}
18692 and not emit @code{div} and @code{mulx}.
18694 @item -mbmx
18695 @itemx -mno-bmx
18696 @itemx -mcdx
18697 @itemx -mno-cdx
18698 Enable or disable generation of Nios II R2 BMX (bit manipulation) and
18699 CDX (code density) instructions.  Enabling these instructions also
18700 requires @option{-march=r2}.  Since these instructions are optional
18701 extensions to the R2 architecture, the default is not to emit them.
18703 @item -mcustom-@var{insn}=@var{N}
18704 @itemx -mno-custom-@var{insn}
18705 @opindex mcustom-@var{insn}
18706 @opindex mno-custom-@var{insn}
18707 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18708 custom instruction with encoding @var{N} when generating code that uses 
18709 @var{insn}.  For example, @option{-mcustom-fadds=253} generates custom
18710 instruction 253 for single-precision floating-point add operations instead
18711 of the default behavior of using a library call.
18713 The following values of @var{insn} are supported.  Except as otherwise
18714 noted, floating-point operations are expected to be implemented with
18715 normal IEEE 754 semantics and correspond directly to the C operators or the
18716 equivalent GCC built-in functions (@pxref{Other Builtins}).
18718 Single-precision floating point:
18719 @table @asis
18721 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18722 Binary arithmetic operations.
18724 @item @samp{fnegs}
18725 Unary negation.
18727 @item @samp{fabss}
18728 Unary absolute value.
18730 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18731 Comparison operations.
18733 @item @samp{fmins}, @samp{fmaxs}
18734 Floating-point minimum and maximum.  These instructions are only
18735 generated if @option{-ffinite-math-only} is specified.
18737 @item @samp{fsqrts}
18738 Unary square root operation.
18740 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18741 Floating-point trigonometric and exponential functions.  These instructions
18742 are only generated if @option{-funsafe-math-optimizations} is also specified.
18744 @end table
18746 Double-precision floating point:
18747 @table @asis
18749 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18750 Binary arithmetic operations.
18752 @item @samp{fnegd}
18753 Unary negation.
18755 @item @samp{fabsd}
18756 Unary absolute value.
18758 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18759 Comparison operations.
18761 @item @samp{fmind}, @samp{fmaxd}
18762 Double-precision minimum and maximum.  These instructions are only
18763 generated if @option{-ffinite-math-only} is specified.
18765 @item @samp{fsqrtd}
18766 Unary square root operation.
18768 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18769 Double-precision trigonometric and exponential functions.  These instructions
18770 are only generated if @option{-funsafe-math-optimizations} is also specified.
18772 @end table
18774 Conversions:
18775 @table @asis
18776 @item @samp{fextsd}
18777 Conversion from single precision to double precision.
18779 @item @samp{ftruncds}
18780 Conversion from double precision to single precision.
18782 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18783 Conversion from floating point to signed or unsigned integer types, with
18784 truncation towards zero.
18786 @item @samp{round}
18787 Conversion from single-precision floating point to signed integer,
18788 rounding to the nearest integer and ties away from zero.
18789 This corresponds to the @code{__builtin_lroundf} function when
18790 @option{-fno-math-errno} is used.
18792 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18793 Conversion from signed or unsigned integer types to floating-point types.
18795 @end table
18797 In addition, all of the following transfer instructions for internal
18798 registers X and Y must be provided to use any of the double-precision
18799 floating-point instructions.  Custom instructions taking two
18800 double-precision source operands expect the first operand in the
18801 64-bit register X.  The other operand (or only operand of a unary
18802 operation) is given to the custom arithmetic instruction with the
18803 least significant half in source register @var{src1} and the most
18804 significant half in @var{src2}.  A custom instruction that returns a
18805 double-precision result returns the most significant 32 bits in the
18806 destination register and the other half in 32-bit register Y.  
18807 GCC automatically generates the necessary code sequences to write
18808 register X and/or read register Y when double-precision floating-point
18809 instructions are used.
18811 @table @asis
18813 @item @samp{fwrx}
18814 Write @var{src1} into the least significant half of X and @var{src2} into
18815 the most significant half of X.
18817 @item @samp{fwry}
18818 Write @var{src1} into Y.
18820 @item @samp{frdxhi}, @samp{frdxlo}
18821 Read the most or least (respectively) significant half of X and store it in
18822 @var{dest}.
18824 @item @samp{frdy}
18825 Read the value of Y and store it into @var{dest}.
18826 @end table
18828 Note that you can gain more local control over generation of Nios II custom
18829 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18830 and @code{target("no-custom-@var{insn}")} function attributes
18831 (@pxref{Function Attributes})
18832 or pragmas (@pxref{Function Specific Option Pragmas}).
18834 @item -mcustom-fpu-cfg=@var{name}
18835 @opindex mcustom-fpu-cfg
18837 This option enables a predefined, named set of custom instruction encodings
18838 (see @option{-mcustom-@var{insn}} above).  
18839 Currently, the following sets are defined:
18841 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18842 @gccoptlist{-mcustom-fmuls=252 @gol
18843 -mcustom-fadds=253 @gol
18844 -mcustom-fsubs=254 @gol
18845 -fsingle-precision-constant}
18847 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18848 @gccoptlist{-mcustom-fmuls=252 @gol
18849 -mcustom-fadds=253 @gol
18850 -mcustom-fsubs=254 @gol
18851 -mcustom-fdivs=255 @gol
18852 -fsingle-precision-constant}
18854 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18855 @gccoptlist{-mcustom-floatus=243 @gol
18856 -mcustom-fixsi=244 @gol
18857 -mcustom-floatis=245 @gol
18858 -mcustom-fcmpgts=246 @gol
18859 -mcustom-fcmples=249 @gol
18860 -mcustom-fcmpeqs=250 @gol
18861 -mcustom-fcmpnes=251 @gol
18862 -mcustom-fmuls=252 @gol
18863 -mcustom-fadds=253 @gol
18864 -mcustom-fsubs=254 @gol
18865 -mcustom-fdivs=255 @gol
18866 -fsingle-precision-constant}
18868 Custom instruction assignments given by individual
18869 @option{-mcustom-@var{insn}=} options override those given by
18870 @option{-mcustom-fpu-cfg=}, regardless of the
18871 order of the options on the command line.
18873 Note that you can gain more local control over selection of a FPU
18874 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18875 function attribute (@pxref{Function Attributes})
18876 or pragma (@pxref{Function Specific Option Pragmas}).
18878 @end table
18880 These additional @samp{-m} options are available for the Altera Nios II
18881 ELF (bare-metal) target:
18883 @table @gcctabopt
18885 @item -mhal
18886 @opindex mhal
18887 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18888 startup and termination code, and is typically used in conjunction with
18889 @option{-msys-crt0=} to specify the location of the alternate startup code
18890 provided by the HAL BSP.
18892 @item -msmallc
18893 @opindex msmallc
18894 Link with a limited version of the C library, @option{-lsmallc}, rather than
18895 Newlib.
18897 @item -msys-crt0=@var{startfile}
18898 @opindex msys-crt0
18899 @var{startfile} is the file name of the startfile (crt0) to use 
18900 when linking.  This option is only useful in conjunction with @option{-mhal}.
18902 @item -msys-lib=@var{systemlib}
18903 @opindex msys-lib
18904 @var{systemlib} is the library name of the library that provides
18905 low-level system calls required by the C library,
18906 e.g. @code{read} and @code{write}.
18907 This option is typically used to link with a library provided by a HAL BSP.
18909 @end table
18911 @node Nvidia PTX Options
18912 @subsection Nvidia PTX Options
18913 @cindex Nvidia PTX options
18914 @cindex nvptx options
18916 These options are defined for Nvidia PTX:
18918 @table @gcctabopt
18920 @item -m32
18921 @itemx -m64
18922 @opindex m32
18923 @opindex m64
18924 Generate code for 32-bit or 64-bit ABI.
18926 @item -mmainkernel
18927 @opindex mmainkernel
18928 Link in code for a __main kernel.  This is for stand-alone instead of
18929 offloading execution.
18931 @end table
18933 @node PDP-11 Options
18934 @subsection PDP-11 Options
18935 @cindex PDP-11 Options
18937 These options are defined for the PDP-11:
18939 @table @gcctabopt
18940 @item -mfpu
18941 @opindex mfpu
18942 Use hardware FPP floating point.  This is the default.  (FIS floating
18943 point on the PDP-11/40 is not supported.)
18945 @item -msoft-float
18946 @opindex msoft-float
18947 Do not use hardware floating point.
18949 @item -mac0
18950 @opindex mac0
18951 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18953 @item -mno-ac0
18954 @opindex mno-ac0
18955 Return floating-point results in memory.  This is the default.
18957 @item -m40
18958 @opindex m40
18959 Generate code for a PDP-11/40.
18961 @item -m45
18962 @opindex m45
18963 Generate code for a PDP-11/45.  This is the default.
18965 @item -m10
18966 @opindex m10
18967 Generate code for a PDP-11/10.
18969 @item -mbcopy-builtin
18970 @opindex mbcopy-builtin
18971 Use inline @code{movmemhi} patterns for copying memory.  This is the
18972 default.
18974 @item -mbcopy
18975 @opindex mbcopy
18976 Do not use inline @code{movmemhi} patterns for copying memory.
18978 @item -mint16
18979 @itemx -mno-int32
18980 @opindex mint16
18981 @opindex mno-int32
18982 Use 16-bit @code{int}.  This is the default.
18984 @item -mint32
18985 @itemx -mno-int16
18986 @opindex mint32
18987 @opindex mno-int16
18988 Use 32-bit @code{int}.
18990 @item -mfloat64
18991 @itemx -mno-float32
18992 @opindex mfloat64
18993 @opindex mno-float32
18994 Use 64-bit @code{float}.  This is the default.
18996 @item -mfloat32
18997 @itemx -mno-float64
18998 @opindex mfloat32
18999 @opindex mno-float64
19000 Use 32-bit @code{float}.
19002 @item -mabshi
19003 @opindex mabshi
19004 Use @code{abshi2} pattern.  This is the default.
19006 @item -mno-abshi
19007 @opindex mno-abshi
19008 Do not use @code{abshi2} pattern.
19010 @item -mbranch-expensive
19011 @opindex mbranch-expensive
19012 Pretend that branches are expensive.  This is for experimenting with
19013 code generation only.
19015 @item -mbranch-cheap
19016 @opindex mbranch-cheap
19017 Do not pretend that branches are expensive.  This is the default.
19019 @item -munix-asm
19020 @opindex munix-asm
19021 Use Unix assembler syntax.  This is the default when configured for
19022 @samp{pdp11-*-bsd}.
19024 @item -mdec-asm
19025 @opindex mdec-asm
19026 Use DEC assembler syntax.  This is the default when configured for any
19027 PDP-11 target other than @samp{pdp11-*-bsd}.
19028 @end table
19030 @node picoChip Options
19031 @subsection picoChip Options
19032 @cindex picoChip options
19034 These @samp{-m} options are defined for picoChip implementations:
19036 @table @gcctabopt
19038 @item -mae=@var{ae_type}
19039 @opindex mcpu
19040 Set the instruction set, register set, and instruction scheduling
19041 parameters for array element type @var{ae_type}.  Supported values
19042 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19044 @option{-mae=ANY} selects a completely generic AE type.  Code
19045 generated with this option runs on any of the other AE types.  The
19046 code is not as efficient as it would be if compiled for a specific
19047 AE type, and some types of operation (e.g., multiplication) do not
19048 work properly on all types of AE.
19050 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19051 for compiled code, and is the default.
19053 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19054 option may suffer from poor performance of byte (char) manipulation,
19055 since the DSP AE does not provide hardware support for byte load/stores.
19057 @item -msymbol-as-address
19058 Enable the compiler to directly use a symbol name as an address in a
19059 load/store instruction, without first loading it into a
19060 register.  Typically, the use of this option generates larger
19061 programs, which run faster than when the option isn't used.  However, the
19062 results vary from program to program, so it is left as a user option,
19063 rather than being permanently enabled.
19065 @item -mno-inefficient-warnings
19066 Disables warnings about the generation of inefficient code.  These
19067 warnings can be generated, for example, when compiling code that
19068 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19069 no hardware support for byte-level memory operations, so all byte
19070 load/stores must be synthesized from word load/store operations.  This is
19071 inefficient and a warning is generated to indicate
19072 that you should rewrite the code to avoid byte operations, or to target
19073 an AE type that has the necessary hardware support.  This option disables
19074 these warnings.
19076 @end table
19078 @node PowerPC Options
19079 @subsection PowerPC Options
19080 @cindex PowerPC options
19082 These are listed under @xref{RS/6000 and PowerPC Options}.
19084 @node RL78 Options
19085 @subsection RL78 Options
19086 @cindex RL78 Options
19088 @table @gcctabopt
19090 @item -msim
19091 @opindex msim
19092 Links in additional target libraries to support operation within a
19093 simulator.
19095 @item -mmul=none
19096 @itemx -mmul=g10
19097 @itemx -mmul=g13
19098 @itemx -mmul=g14
19099 @itemx -mmul=rl78
19100 @opindex mmul
19101 Specifies the type of hardware multiplication and division support to
19102 be used.  The simplest is @code{none}, which uses software for both
19103 multiplication and division.  This is the default.  The @code{g13}
19104 value is for the hardware multiply/divide peripheral found on the
19105 RL78/G13 (S2 core) targets.  The @code{g14} value selects the use of
19106 the multiplication and division instructions supported by the RL78/G14
19107 (S3 core) parts.  The value @code{rl78} is an alias for @code{g14} and
19108 the value @code{mg10} is an alias for @code{none}.
19110 In addition a C preprocessor macro is defined, based upon the setting
19111 of this option.  Possible values are: @code{__RL78_MUL_NONE__},
19112 @code{__RL78_MUL_G13__} or @code{__RL78_MUL_G14__}.
19114 @item -mcpu=g10
19115 @itemx -mcpu=g13
19116 @itemx -mcpu=g14
19117 @itemx -mcpu=rl78
19118 @opindex mcpu
19119 Specifies the RL78 core to target.  The default is the G14 core, also
19120 known as an S3 core or just RL78.  The G13 or S2 core does not have
19121 multiply or divide instructions, instead it uses a hardware peripheral
19122 for these operations.  The G10 or S1 core does not have register
19123 banks, so it uses a different calling convention.
19125 If this option is set it also selects the type of hardware multiply
19126 support to use, unless this is overridden by an explicit
19127 @option{-mmul=none} option on the command line.  Thus specifying
19128 @option{-mcpu=g13} enables the use of the G13 hardware multiply
19129 peripheral and specifying @option{-mcpu=g10} disables the use of
19130 hardware multipications altogether.
19132 Note, although the RL78/G14 core is the default target, specifying
19133 @option{-mcpu=g14} or @option{-mcpu=rl78} on the command line does
19134 change the behaviour of the toolchain since it also enables G14
19135 hardware multiply support.  If these options are not specified on the
19136 command line then software multiplication routines will be used even
19137 though the code targets the RL78 core.  This is for backwards
19138 compatibility with older toolchains which did not have hardware
19139 multiply and divide support.
19141 In addition a C preprocessor macro is defined, based upon the setting
19142 of this option.  Possible values are: @code{__RL78_G10__},
19143 @code{__RL78_G13__} or @code{__RL78_G14__}.
19145 @item -mg10
19146 @itemx -mg13
19147 @itemx -mg14
19148 @itemx -mrl78
19149 @opindex mg10
19150 @opindex mg13
19151 @opindex mg14
19152 @opindex mrl78
19153 These are aliases for the corresponding @option{-mcpu=} option.  They
19154 are provided for backwards compatibility.
19156 @item -mallregs
19157 @opindex mallregs
19158 Allow the compiler to use all of the available registers.  By default
19159 registers @code{r24..r31} are reserved for use in interrupt handlers.
19160 With this option enabled these registers can be used in ordinary
19161 functions as well.
19163 @item -m64bit-doubles
19164 @itemx -m32bit-doubles
19165 @opindex m64bit-doubles
19166 @opindex m32bit-doubles
19167 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19168 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19169 @option{-m32bit-doubles}.
19171 @end table
19173 @node RS/6000 and PowerPC Options
19174 @subsection IBM RS/6000 and PowerPC Options
19175 @cindex RS/6000 and PowerPC Options
19176 @cindex IBM RS/6000 and PowerPC Options
19178 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19179 @table @gcctabopt
19180 @item -mpowerpc-gpopt
19181 @itemx -mno-powerpc-gpopt
19182 @itemx -mpowerpc-gfxopt
19183 @itemx -mno-powerpc-gfxopt
19184 @need 800
19185 @itemx -mpowerpc64
19186 @itemx -mno-powerpc64
19187 @itemx -mmfcrf
19188 @itemx -mno-mfcrf
19189 @itemx -mpopcntb
19190 @itemx -mno-popcntb
19191 @itemx -mpopcntd
19192 @itemx -mno-popcntd
19193 @itemx -mfprnd
19194 @itemx -mno-fprnd
19195 @need 800
19196 @itemx -mcmpb
19197 @itemx -mno-cmpb
19198 @itemx -mmfpgpr
19199 @itemx -mno-mfpgpr
19200 @itemx -mhard-dfp
19201 @itemx -mno-hard-dfp
19202 @opindex mpowerpc-gpopt
19203 @opindex mno-powerpc-gpopt
19204 @opindex mpowerpc-gfxopt
19205 @opindex mno-powerpc-gfxopt
19206 @opindex mpowerpc64
19207 @opindex mno-powerpc64
19208 @opindex mmfcrf
19209 @opindex mno-mfcrf
19210 @opindex mpopcntb
19211 @opindex mno-popcntb
19212 @opindex mpopcntd
19213 @opindex mno-popcntd
19214 @opindex mfprnd
19215 @opindex mno-fprnd
19216 @opindex mcmpb
19217 @opindex mno-cmpb
19218 @opindex mmfpgpr
19219 @opindex mno-mfpgpr
19220 @opindex mhard-dfp
19221 @opindex mno-hard-dfp
19222 You use these options to specify which instructions are available on the
19223 processor you are using.  The default value of these options is
19224 determined when configuring GCC@.  Specifying the
19225 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19226 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19227 rather than the options listed above.
19229 Specifying @option{-mpowerpc-gpopt} allows
19230 GCC to use the optional PowerPC architecture instructions in the
19231 General Purpose group, including floating-point square root.  Specifying
19232 @option{-mpowerpc-gfxopt} allows GCC to
19233 use the optional PowerPC architecture instructions in the Graphics
19234 group, including floating-point select.
19236 The @option{-mmfcrf} option allows GCC to generate the move from
19237 condition register field instruction implemented on the POWER4
19238 processor and other processors that support the PowerPC V2.01
19239 architecture.
19240 The @option{-mpopcntb} option allows GCC to generate the popcount and
19241 double-precision FP reciprocal estimate instruction implemented on the
19242 POWER5 processor and other processors that support the PowerPC V2.02
19243 architecture.
19244 The @option{-mpopcntd} option allows GCC to generate the popcount
19245 instruction implemented on the POWER7 processor and other processors
19246 that support the PowerPC V2.06 architecture.
19247 The @option{-mfprnd} option allows GCC to generate the FP round to
19248 integer instructions implemented on the POWER5+ processor and other
19249 processors that support the PowerPC V2.03 architecture.
19250 The @option{-mcmpb} option allows GCC to generate the compare bytes
19251 instruction implemented on the POWER6 processor and other processors
19252 that support the PowerPC V2.05 architecture.
19253 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19254 general-purpose register instructions implemented on the POWER6X
19255 processor and other processors that support the extended PowerPC V2.05
19256 architecture.
19257 The @option{-mhard-dfp} option allows GCC to generate the decimal
19258 floating-point instructions implemented on some POWER processors.
19260 The @option{-mpowerpc64} option allows GCC to generate the additional
19261 64-bit instructions that are found in the full PowerPC64 architecture
19262 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19263 @option{-mno-powerpc64}.
19265 @item -mcpu=@var{cpu_type}
19266 @opindex mcpu
19267 Set architecture type, register usage, and
19268 instruction scheduling parameters for machine type @var{cpu_type}.
19269 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19270 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19271 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19272 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19273 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19274 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19275 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19276 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19277 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19278 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19279 @samp{powerpc64}, @samp{powerpc64le}, and @samp{rs64}.
19281 @option{-mcpu=powerpc}, @option{-mcpu=powerpc64}, and
19282 @option{-mcpu=powerpc64le} specify pure 32-bit PowerPC (either
19283 endian), 64-bit big endian PowerPC and 64-bit little endian PowerPC
19284 architecture machine types, with an appropriate, generic processor
19285 model assumed for scheduling purposes.
19287 The other options specify a specific processor.  Code generated under
19288 those options runs best on that processor, and may not run at all on
19289 others.
19291 The @option{-mcpu} options automatically enable or disable the
19292 following options:
19294 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19295 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19296 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19297 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19298 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19299 -mquad-memory -mquad-memory-atomic}
19301 The particular options set for any particular CPU varies between
19302 compiler versions, depending on what setting seems to produce optimal
19303 code for that CPU; it doesn't necessarily reflect the actual hardware's
19304 capabilities.  If you wish to set an individual option to a particular
19305 value, you may specify it after the @option{-mcpu} option, like
19306 @option{-mcpu=970 -mno-altivec}.
19308 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19309 not enabled or disabled by the @option{-mcpu} option at present because
19310 AIX does not have full support for these options.  You may still
19311 enable or disable them individually if you're sure it'll work in your
19312 environment.
19314 @item -mtune=@var{cpu_type}
19315 @opindex mtune
19316 Set the instruction scheduling parameters for machine type
19317 @var{cpu_type}, but do not set the architecture type or register usage,
19318 as @option{-mcpu=@var{cpu_type}} does.  The same
19319 values for @var{cpu_type} are used for @option{-mtune} as for
19320 @option{-mcpu}.  If both are specified, the code generated uses the
19321 architecture and registers set by @option{-mcpu}, but the
19322 scheduling parameters set by @option{-mtune}.
19324 @item -mcmodel=small
19325 @opindex mcmodel=small
19326 Generate PowerPC64 code for the small model: The TOC is limited to
19327 64k.
19329 @item -mcmodel=medium
19330 @opindex mcmodel=medium
19331 Generate PowerPC64 code for the medium model: The TOC and other static
19332 data may be up to a total of 4G in size.
19334 @item -mcmodel=large
19335 @opindex mcmodel=large
19336 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19337 in size.  Other data and code is only limited by the 64-bit address
19338 space.
19340 @item -maltivec
19341 @itemx -mno-altivec
19342 @opindex maltivec
19343 @opindex mno-altivec
19344 Generate code that uses (does not use) AltiVec instructions, and also
19345 enable the use of built-in functions that allow more direct access to
19346 the AltiVec instruction set.  You may also need to set
19347 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19348 enhancements.
19350 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19351 @option{-maltivec=be}, the element order for Altivec intrinsics such
19352 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} 
19353 match array element order corresponding to the endianness of the
19354 target.  That is, element zero identifies the leftmost element in a
19355 vector register when targeting a big-endian platform, and identifies
19356 the rightmost element in a vector register when targeting a
19357 little-endian platform.
19359 @item -maltivec=be
19360 @opindex maltivec=be
19361 Generate Altivec instructions using big-endian element order,
19362 regardless of whether the target is big- or little-endian.  This is
19363 the default when targeting a big-endian platform.
19365 The element order is used to interpret element numbers in Altivec
19366 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19367 @code{vec_insert}.  By default, these match array element order
19368 corresponding to the endianness for the target.
19370 @item -maltivec=le
19371 @opindex maltivec=le
19372 Generate Altivec instructions using little-endian element order,
19373 regardless of whether the target is big- or little-endian.  This is
19374 the default when targeting a little-endian platform.  This option is
19375 currently ignored when targeting a big-endian platform.
19377 The element order is used to interpret element numbers in Altivec
19378 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19379 @code{vec_insert}.  By default, these match array element order
19380 corresponding to the endianness for the target.
19382 @item -mvrsave
19383 @itemx -mno-vrsave
19384 @opindex mvrsave
19385 @opindex mno-vrsave
19386 Generate VRSAVE instructions when generating AltiVec code.
19388 @item -mgen-cell-microcode
19389 @opindex mgen-cell-microcode
19390 Generate Cell microcode instructions.
19392 @item -mwarn-cell-microcode
19393 @opindex mwarn-cell-microcode
19394 Warn when a Cell microcode instruction is emitted.  An example
19395 of a Cell microcode instruction is a variable shift.
19397 @item -msecure-plt
19398 @opindex msecure-plt
19399 Generate code that allows @command{ld} and @command{ld.so}
19400 to build executables and shared
19401 libraries with non-executable @code{.plt} and @code{.got} sections.
19402 This is a PowerPC
19403 32-bit SYSV ABI option.
19405 @item -mbss-plt
19406 @opindex mbss-plt
19407 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19408 fills in, and
19409 requires @code{.plt} and @code{.got}
19410 sections that are both writable and executable.
19411 This is a PowerPC 32-bit SYSV ABI option.
19413 @item -misel
19414 @itemx -mno-isel
19415 @opindex misel
19416 @opindex mno-isel
19417 This switch enables or disables the generation of ISEL instructions.
19419 @item -misel=@var{yes/no}
19420 This switch has been deprecated.  Use @option{-misel} and
19421 @option{-mno-isel} instead.
19423 @item -mspe
19424 @itemx -mno-spe
19425 @opindex mspe
19426 @opindex mno-spe
19427 This switch enables or disables the generation of SPE simd
19428 instructions.
19430 @item -mpaired
19431 @itemx -mno-paired
19432 @opindex mpaired
19433 @opindex mno-paired
19434 This switch enables or disables the generation of PAIRED simd
19435 instructions.
19437 @item -mspe=@var{yes/no}
19438 This option has been deprecated.  Use @option{-mspe} and
19439 @option{-mno-spe} instead.
19441 @item -mvsx
19442 @itemx -mno-vsx
19443 @opindex mvsx
19444 @opindex mno-vsx
19445 Generate code that uses (does not use) vector/scalar (VSX)
19446 instructions, and also enable the use of built-in functions that allow
19447 more direct access to the VSX instruction set.
19449 @item -mcrypto
19450 @itemx -mno-crypto
19451 @opindex mcrypto
19452 @opindex mno-crypto
19453 Enable the use (disable) of the built-in functions that allow direct
19454 access to the cryptographic instructions that were added in version
19455 2.07 of the PowerPC ISA.
19457 @item -mdirect-move
19458 @itemx -mno-direct-move
19459 @opindex mdirect-move
19460 @opindex mno-direct-move
19461 Generate code that uses (does not use) the instructions to move data
19462 between the general purpose registers and the vector/scalar (VSX)
19463 registers that were added in version 2.07 of the PowerPC ISA.
19465 @item -mpower8-fusion
19466 @itemx -mno-power8-fusion
19467 @opindex mpower8-fusion
19468 @opindex mno-power8-fusion
19469 Generate code that keeps (does not keeps) some integer operations
19470 adjacent so that the instructions can be fused together on power8 and
19471 later processors.
19473 @item -mpower8-vector
19474 @itemx -mno-power8-vector
19475 @opindex mpower8-vector
19476 @opindex mno-power8-vector
19477 Generate code that uses (does not use) the vector and scalar
19478 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19479 enable the use of built-in functions that allow more direct access to
19480 the vector instructions.
19482 @item -mquad-memory
19483 @itemx -mno-quad-memory
19484 @opindex mquad-memory
19485 @opindex mno-quad-memory
19486 Generate code that uses (does not use) the non-atomic quad word memory
19487 instructions.  The @option{-mquad-memory} option requires use of
19488 64-bit mode.
19490 @item -mquad-memory-atomic
19491 @itemx -mno-quad-memory-atomic
19492 @opindex mquad-memory-atomic
19493 @opindex mno-quad-memory-atomic
19494 Generate code that uses (does not use) the atomic quad word memory
19495 instructions.  The @option{-mquad-memory-atomic} option requires use of
19496 64-bit mode.
19498 @item -mupper-regs-df
19499 @itemx -mno-upper-regs-df
19500 @opindex mupper-regs-df
19501 @opindex mno-upper-regs-df
19502 Generate code that uses (does not use) the scalar double precision
19503 instructions that target all 64 registers in the vector/scalar
19504 floating point register set that were added in version 2.06 of the
19505 PowerPC ISA.  @option{-mupper-regs-df} is turned on by default if you
19506 use any of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19507 @option{-mvsx} options.
19509 @item -mupper-regs-sf
19510 @itemx -mno-upper-regs-sf
19511 @opindex mupper-regs-sf
19512 @opindex mno-upper-regs-sf
19513 Generate code that uses (does not use) the scalar single precision
19514 instructions that target all 64 registers in the vector/scalar
19515 floating point register set that were added in version 2.07 of the
19516 PowerPC ISA.  @option{-mupper-regs-sf} is turned on by default if you
19517 use either of the @option{-mcpu=power8} or @option{-mpower8-vector}
19518 options.
19520 @item -mupper-regs
19521 @itemx -mno-upper-regs
19522 @opindex mupper-regs
19523 @opindex mno-upper-regs
19524 Generate code that uses (does not use) the scalar
19525 instructions that target all 64 registers in the vector/scalar
19526 floating point register set, depending on the model of the machine.
19528 If the @option{-mno-upper-regs} option is used, it turns off both
19529 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19531 @item -mfloat128
19532 @itemx -mno-float128
19533 @opindex mfloat128
19534 @opindex mno-float128
19535 Enable/disable the @var{__float128} keyword for IEEE 128-bit floating point
19536 and use software emulation for IEEE 128-bit floating point.
19538 The VSX instruction set (@option{-mvsx}, @option{-mcpu=power7}, or
19539 @option{-mcpu=power8}) must be enabled to use the @option{-mfloat128}
19540 option.
19542 @item -mfloat-gprs=@var{yes/single/double/no}
19543 @itemx -mfloat-gprs
19544 @opindex mfloat-gprs
19545 This switch enables or disables the generation of floating-point
19546 operations on the general-purpose registers for architectures that
19547 support it.
19549 The argument @samp{yes} or @samp{single} enables the use of
19550 single-precision floating-point operations.
19552 The argument @samp{double} enables the use of single and
19553 double-precision floating-point operations.
19555 The argument @samp{no} disables floating-point operations on the
19556 general-purpose registers.
19558 This option is currently only available on the MPC854x.
19560 @item -m32
19561 @itemx -m64
19562 @opindex m32
19563 @opindex m64
19564 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19565 targets (including GNU/Linux).  The 32-bit environment sets int, long
19566 and pointer to 32 bits and generates code that runs on any PowerPC
19567 variant.  The 64-bit environment sets int to 32 bits and long and
19568 pointer to 64 bits, and generates code for PowerPC64, as for
19569 @option{-mpowerpc64}.
19571 @item -mfull-toc
19572 @itemx -mno-fp-in-toc
19573 @itemx -mno-sum-in-toc
19574 @itemx -mminimal-toc
19575 @opindex mfull-toc
19576 @opindex mno-fp-in-toc
19577 @opindex mno-sum-in-toc
19578 @opindex mminimal-toc
19579 Modify generation of the TOC (Table Of Contents), which is created for
19580 every executable file.  The @option{-mfull-toc} option is selected by
19581 default.  In that case, GCC allocates at least one TOC entry for
19582 each unique non-automatic variable reference in your program.  GCC
19583 also places floating-point constants in the TOC@.  However, only
19584 16,384 entries are available in the TOC@.
19586 If you receive a linker error message that saying you have overflowed
19587 the available TOC space, you can reduce the amount of TOC space used
19588 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19589 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19590 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19591 generate code to calculate the sum of an address and a constant at
19592 run time instead of putting that sum into the TOC@.  You may specify one
19593 or both of these options.  Each causes GCC to produce very slightly
19594 slower and larger code at the expense of conserving TOC space.
19596 If you still run out of space in the TOC even when you specify both of
19597 these options, specify @option{-mminimal-toc} instead.  This option causes
19598 GCC to make only one TOC entry for every file.  When you specify this
19599 option, GCC produces code that is slower and larger but which
19600 uses extremely little TOC space.  You may wish to use this option
19601 only on files that contain less frequently-executed code.
19603 @item -maix64
19604 @itemx -maix32
19605 @opindex maix64
19606 @opindex maix32
19607 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19608 @code{long} type, and the infrastructure needed to support them.
19609 Specifying @option{-maix64} implies @option{-mpowerpc64},
19610 while @option{-maix32} disables the 64-bit ABI and
19611 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19613 @item -mxl-compat
19614 @itemx -mno-xl-compat
19615 @opindex mxl-compat
19616 @opindex mno-xl-compat
19617 Produce code that conforms more closely to IBM XL compiler semantics
19618 when using AIX-compatible ABI@.  Pass floating-point arguments to
19619 prototyped functions beyond the register save area (RSA) on the stack
19620 in addition to argument FPRs.  Do not assume that most significant
19621 double in 128-bit long double value is properly rounded when comparing
19622 values and converting to double.  Use XL symbol names for long double
19623 support routines.
19625 The AIX calling convention was extended but not initially documented to
19626 handle an obscure K&R C case of calling a function that takes the
19627 address of its arguments with fewer arguments than declared.  IBM XL
19628 compilers access floating-point arguments that do not fit in the
19629 RSA from the stack when a subroutine is compiled without
19630 optimization.  Because always storing floating-point arguments on the
19631 stack is inefficient and rarely needed, this option is not enabled by
19632 default and only is necessary when calling subroutines compiled by IBM
19633 XL compilers without optimization.
19635 @item -mpe
19636 @opindex mpe
19637 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19638 application written to use message passing with special startup code to
19639 enable the application to run.  The system must have PE installed in the
19640 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19641 must be overridden with the @option{-specs=} option to specify the
19642 appropriate directory location.  The Parallel Environment does not
19643 support threads, so the @option{-mpe} option and the @option{-pthread}
19644 option are incompatible.
19646 @item -malign-natural
19647 @itemx -malign-power
19648 @opindex malign-natural
19649 @opindex malign-power
19650 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19651 @option{-malign-natural} overrides the ABI-defined alignment of larger
19652 types, such as floating-point doubles, on their natural size-based boundary.
19653 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19654 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19656 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19657 is not supported.
19659 @item -msoft-float
19660 @itemx -mhard-float
19661 @opindex msoft-float
19662 @opindex mhard-float
19663 Generate code that does not use (uses) the floating-point register set.
19664 Software floating-point emulation is provided if you use the
19665 @option{-msoft-float} option, and pass the option to GCC when linking.
19667 @item -msingle-float
19668 @itemx -mdouble-float
19669 @opindex msingle-float
19670 @opindex mdouble-float
19671 Generate code for single- or double-precision floating-point operations.
19672 @option{-mdouble-float} implies @option{-msingle-float}.
19674 @item -msimple-fpu
19675 @opindex msimple-fpu
19676 Do not generate @code{sqrt} and @code{div} instructions for hardware
19677 floating-point unit.
19679 @item -mfpu=@var{name}
19680 @opindex mfpu
19681 Specify type of floating-point unit.  Valid values for @var{name} are
19682 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19683 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19684 @samp{sp_full} (equivalent to @option{-msingle-float}),
19685 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19687 @item -mxilinx-fpu
19688 @opindex mxilinx-fpu
19689 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19691 @item -mmultiple
19692 @itemx -mno-multiple
19693 @opindex mmultiple
19694 @opindex mno-multiple
19695 Generate code that uses (does not use) the load multiple word
19696 instructions and the store multiple word instructions.  These
19697 instructions are generated by default on POWER systems, and not
19698 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19699 PowerPC systems, since those instructions do not work when the
19700 processor is in little-endian mode.  The exceptions are PPC740 and
19701 PPC750 which permit these instructions in little-endian mode.
19703 @item -mstring
19704 @itemx -mno-string
19705 @opindex mstring
19706 @opindex mno-string
19707 Generate code that uses (does not use) the load string instructions
19708 and the store string word instructions to save multiple registers and
19709 do small block moves.  These instructions are generated by default on
19710 POWER systems, and not generated on PowerPC systems.  Do not use
19711 @option{-mstring} on little-endian PowerPC systems, since those
19712 instructions do not work when the processor is in little-endian mode.
19713 The exceptions are PPC740 and PPC750 which permit these instructions
19714 in little-endian mode.
19716 @item -mupdate
19717 @itemx -mno-update
19718 @opindex mupdate
19719 @opindex mno-update
19720 Generate code that uses (does not use) the load or store instructions
19721 that update the base register to the address of the calculated memory
19722 location.  These instructions are generated by default.  If you use
19723 @option{-mno-update}, there is a small window between the time that the
19724 stack pointer is updated and the address of the previous frame is
19725 stored, which means code that walks the stack frame across interrupts or
19726 signals may get corrupted data.
19728 @item -mavoid-indexed-addresses
19729 @itemx -mno-avoid-indexed-addresses
19730 @opindex mavoid-indexed-addresses
19731 @opindex mno-avoid-indexed-addresses
19732 Generate code that tries to avoid (not avoid) the use of indexed load
19733 or store instructions. These instructions can incur a performance
19734 penalty on Power6 processors in certain situations, such as when
19735 stepping through large arrays that cross a 16M boundary.  This option
19736 is enabled by default when targeting Power6 and disabled otherwise.
19738 @item -mfused-madd
19739 @itemx -mno-fused-madd
19740 @opindex mfused-madd
19741 @opindex mno-fused-madd
19742 Generate code that uses (does not use) the floating-point multiply and
19743 accumulate instructions.  These instructions are generated by default
19744 if hardware floating point is used.  The machine-dependent
19745 @option{-mfused-madd} option is now mapped to the machine-independent
19746 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19747 mapped to @option{-ffp-contract=off}.
19749 @item -mmulhw
19750 @itemx -mno-mulhw
19751 @opindex mmulhw
19752 @opindex mno-mulhw
19753 Generate code that uses (does not use) the half-word multiply and
19754 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19755 These instructions are generated by default when targeting those
19756 processors.
19758 @item -mdlmzb
19759 @itemx -mno-dlmzb
19760 @opindex mdlmzb
19761 @opindex mno-dlmzb
19762 Generate code that uses (does not use) the string-search @samp{dlmzb}
19763 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19764 generated by default when targeting those processors.
19766 @item -mno-bit-align
19767 @itemx -mbit-align
19768 @opindex mno-bit-align
19769 @opindex mbit-align
19770 On System V.4 and embedded PowerPC systems do not (do) force structures
19771 and unions that contain bit-fields to be aligned to the base type of the
19772 bit-field.
19774 For example, by default a structure containing nothing but 8
19775 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19776 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19777 the structure is aligned to a 1-byte boundary and is 1 byte in
19778 size.
19780 @item -mno-strict-align
19781 @itemx -mstrict-align
19782 @opindex mno-strict-align
19783 @opindex mstrict-align
19784 On System V.4 and embedded PowerPC systems do not (do) assume that
19785 unaligned memory references are handled by the system.
19787 @item -mrelocatable
19788 @itemx -mno-relocatable
19789 @opindex mrelocatable
19790 @opindex mno-relocatable
19791 Generate code that allows (does not allow) a static executable to be
19792 relocated to a different address at run time.  A simple embedded
19793 PowerPC system loader should relocate the entire contents of
19794 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19795 a table of 32-bit addresses generated by this option.  For this to
19796 work, all objects linked together must be compiled with
19797 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19798 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19800 @item -mrelocatable-lib
19801 @itemx -mno-relocatable-lib
19802 @opindex mrelocatable-lib
19803 @opindex mno-relocatable-lib
19804 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19805 @code{.fixup} section to allow static executables to be relocated at
19806 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19807 alignment of @option{-mrelocatable}.  Objects compiled with
19808 @option{-mrelocatable-lib} may be linked with objects compiled with
19809 any combination of the @option{-mrelocatable} options.
19811 @item -mno-toc
19812 @itemx -mtoc
19813 @opindex mno-toc
19814 @opindex mtoc
19815 On System V.4 and embedded PowerPC systems do not (do) assume that
19816 register 2 contains a pointer to a global area pointing to the addresses
19817 used in the program.
19819 @item -mlittle
19820 @itemx -mlittle-endian
19821 @opindex mlittle
19822 @opindex mlittle-endian
19823 On System V.4 and embedded PowerPC systems compile code for the
19824 processor in little-endian mode.  The @option{-mlittle-endian} option is
19825 the same as @option{-mlittle}.
19827 @item -mbig
19828 @itemx -mbig-endian
19829 @opindex mbig
19830 @opindex mbig-endian
19831 On System V.4 and embedded PowerPC systems compile code for the
19832 processor in big-endian mode.  The @option{-mbig-endian} option is
19833 the same as @option{-mbig}.
19835 @item -mdynamic-no-pic
19836 @opindex mdynamic-no-pic
19837 On Darwin and Mac OS X systems, compile code so that it is not
19838 relocatable, but that its external references are relocatable.  The
19839 resulting code is suitable for applications, but not shared
19840 libraries.
19842 @item -msingle-pic-base
19843 @opindex msingle-pic-base
19844 Treat the register used for PIC addressing as read-only, rather than
19845 loading it in the prologue for each function.  The runtime system is
19846 responsible for initializing this register with an appropriate value
19847 before execution begins.
19849 @item -mprioritize-restricted-insns=@var{priority}
19850 @opindex mprioritize-restricted-insns
19851 This option controls the priority that is assigned to
19852 dispatch-slot restricted instructions during the second scheduling
19853 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19854 or @samp{2} to assign no, highest, or second-highest (respectively) 
19855 priority to dispatch-slot restricted
19856 instructions.
19858 @item -msched-costly-dep=@var{dependence_type}
19859 @opindex msched-costly-dep
19860 This option controls which dependences are considered costly
19861 by the target during instruction scheduling.  The argument
19862 @var{dependence_type} takes one of the following values:
19864 @table @asis
19865 @item @samp{no}
19866 No dependence is costly.
19868 @item @samp{all}
19869 All dependences are costly.
19871 @item @samp{true_store_to_load}
19872 A true dependence from store to load is costly.
19874 @item @samp{store_to_load}
19875 Any dependence from store to load is costly.
19877 @item @var{number}
19878 Any dependence for which the latency is greater than or equal to 
19879 @var{number} is costly.
19880 @end table
19882 @item -minsert-sched-nops=@var{scheme}
19883 @opindex minsert-sched-nops
19884 This option controls which NOP insertion scheme is used during
19885 the second scheduling pass.  The argument @var{scheme} takes one of the
19886 following values:
19888 @table @asis
19889 @item @samp{no}
19890 Don't insert NOPs.
19892 @item @samp{pad}
19893 Pad with NOPs any dispatch group that has vacant issue slots,
19894 according to the scheduler's grouping.
19896 @item @samp{regroup_exact}
19897 Insert NOPs to force costly dependent insns into
19898 separate groups.  Insert exactly as many NOPs as needed to force an insn
19899 to a new group, according to the estimated processor grouping.
19901 @item @var{number}
19902 Insert NOPs to force costly dependent insns into
19903 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19904 @end table
19906 @item -mcall-sysv
19907 @opindex mcall-sysv
19908 On System V.4 and embedded PowerPC systems compile code using calling
19909 conventions that adhere to the March 1995 draft of the System V
19910 Application Binary Interface, PowerPC processor supplement.  This is the
19911 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19913 @item -mcall-sysv-eabi
19914 @itemx -mcall-eabi
19915 @opindex mcall-sysv-eabi
19916 @opindex mcall-eabi
19917 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19919 @item -mcall-sysv-noeabi
19920 @opindex mcall-sysv-noeabi
19921 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19923 @item -mcall-aixdesc
19924 @opindex m
19925 On System V.4 and embedded PowerPC systems compile code for the AIX
19926 operating system.
19928 @item -mcall-linux
19929 @opindex mcall-linux
19930 On System V.4 and embedded PowerPC systems compile code for the
19931 Linux-based GNU system.
19933 @item -mcall-freebsd
19934 @opindex mcall-freebsd
19935 On System V.4 and embedded PowerPC systems compile code for the
19936 FreeBSD operating system.
19938 @item -mcall-netbsd
19939 @opindex mcall-netbsd
19940 On System V.4 and embedded PowerPC systems compile code for the
19941 NetBSD operating system.
19943 @item -mcall-openbsd
19944 @opindex mcall-netbsd
19945 On System V.4 and embedded PowerPC systems compile code for the
19946 OpenBSD operating system.
19948 @item -maix-struct-return
19949 @opindex maix-struct-return
19950 Return all structures in memory (as specified by the AIX ABI)@.
19952 @item -msvr4-struct-return
19953 @opindex msvr4-struct-return
19954 Return structures smaller than 8 bytes in registers (as specified by the
19955 SVR4 ABI)@.
19957 @item -mabi=@var{abi-type}
19958 @opindex mabi
19959 Extend the current ABI with a particular extension, or remove such extension.
19960 Valid values are @samp{altivec}, @samp{no-altivec}, @samp{spe},
19961 @samp{no-spe}, @samp{ibmlongdouble}, @samp{ieeelongdouble},
19962 @samp{elfv1}, @samp{elfv2}@.
19964 @item -mabi=spe
19965 @opindex mabi=spe
19966 Extend the current ABI with SPE ABI extensions.  This does not change
19967 the default ABI, instead it adds the SPE ABI extensions to the current
19968 ABI@.
19970 @item -mabi=no-spe
19971 @opindex mabi=no-spe
19972 Disable Book-E SPE ABI extensions for the current ABI@.
19974 @item -mabi=ibmlongdouble
19975 @opindex mabi=ibmlongdouble
19976 Change the current ABI to use IBM extended-precision long double.
19977 This is a PowerPC 32-bit SYSV ABI option.
19979 @item -mabi=ieeelongdouble
19980 @opindex mabi=ieeelongdouble
19981 Change the current ABI to use IEEE extended-precision long double.
19982 This is a PowerPC 32-bit Linux ABI option.
19984 @item -mabi=elfv1
19985 @opindex mabi=elfv1
19986 Change the current ABI to use the ELFv1 ABI.
19987 This is the default ABI for big-endian PowerPC 64-bit Linux.
19988 Overriding the default ABI requires special system support and is
19989 likely to fail in spectacular ways.
19991 @item -mabi=elfv2
19992 @opindex mabi=elfv2
19993 Change the current ABI to use the ELFv2 ABI.
19994 This is the default ABI for little-endian PowerPC 64-bit Linux.
19995 Overriding the default ABI requires special system support and is
19996 likely to fail in spectacular ways.
19998 @item -mprototype
19999 @itemx -mno-prototype
20000 @opindex mprototype
20001 @opindex mno-prototype
20002 On System V.4 and embedded PowerPC systems assume that all calls to
20003 variable argument functions are properly prototyped.  Otherwise, the
20004 compiler must insert an instruction before every non-prototyped call to
20005 set or clear bit 6 of the condition code register (@code{CR}) to
20006 indicate whether floating-point values are passed in the floating-point
20007 registers in case the function takes variable arguments.  With
20008 @option{-mprototype}, only calls to prototyped variable argument functions
20009 set or clear the bit.
20011 @item -msim
20012 @opindex msim
20013 On embedded PowerPC systems, assume that the startup module is called
20014 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20015 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20016 configurations.
20018 @item -mmvme
20019 @opindex mmvme
20020 On embedded PowerPC systems, assume that the startup module is called
20021 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20022 @file{libc.a}.
20024 @item -mads
20025 @opindex mads
20026 On embedded PowerPC systems, assume that the startup module is called
20027 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20028 @file{libc.a}.
20030 @item -myellowknife
20031 @opindex myellowknife
20032 On embedded PowerPC systems, assume that the startup module is called
20033 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20034 @file{libc.a}.
20036 @item -mvxworks
20037 @opindex mvxworks
20038 On System V.4 and embedded PowerPC systems, specify that you are
20039 compiling for a VxWorks system.
20041 @item -memb
20042 @opindex memb
20043 On embedded PowerPC systems, set the @code{PPC_EMB} bit in the ELF flags
20044 header to indicate that @samp{eabi} extended relocations are used.
20046 @item -meabi
20047 @itemx -mno-eabi
20048 @opindex meabi
20049 @opindex mno-eabi
20050 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20051 Embedded Applications Binary Interface (EABI), which is a set of
20052 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20053 means that the stack is aligned to an 8-byte boundary, a function
20054 @code{__eabi} is called from @code{main} to set up the EABI
20055 environment, and the @option{-msdata} option can use both @code{r2} and
20056 @code{r13} to point to two separate small data areas.  Selecting
20057 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20058 no EABI initialization function is called from @code{main}, and the
20059 @option{-msdata} option only uses @code{r13} to point to a single
20060 small data area.  The @option{-meabi} option is on by default if you
20061 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20063 @item -msdata=eabi
20064 @opindex msdata=eabi
20065 On System V.4 and embedded PowerPC systems, put small initialized
20066 @code{const} global and static data in the @code{.sdata2} section, which
20067 is pointed to by register @code{r2}.  Put small initialized
20068 non-@code{const} global and static data in the @code{.sdata} section,
20069 which is pointed to by register @code{r13}.  Put small uninitialized
20070 global and static data in the @code{.sbss} section, which is adjacent to
20071 the @code{.sdata} section.  The @option{-msdata=eabi} option is
20072 incompatible with the @option{-mrelocatable} option.  The
20073 @option{-msdata=eabi} option also sets the @option{-memb} option.
20075 @item -msdata=sysv
20076 @opindex msdata=sysv
20077 On System V.4 and embedded PowerPC systems, put small global and static
20078 data in the @code{.sdata} section, which is pointed to by register
20079 @code{r13}.  Put small uninitialized global and static data in the
20080 @code{.sbss} section, which is adjacent to the @code{.sdata} section.
20081 The @option{-msdata=sysv} option is incompatible with the
20082 @option{-mrelocatable} option.
20084 @item -msdata=default
20085 @itemx -msdata
20086 @opindex msdata=default
20087 @opindex msdata
20088 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20089 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20090 same as @option{-msdata=sysv}.
20092 @item -msdata=data
20093 @opindex msdata=data
20094 On System V.4 and embedded PowerPC systems, put small global
20095 data in the @code{.sdata} section.  Put small uninitialized global
20096 data in the @code{.sbss} section.  Do not use register @code{r13}
20097 to address small data however.  This is the default behavior unless
20098 other @option{-msdata} options are used.
20100 @item -msdata=none
20101 @itemx -mno-sdata
20102 @opindex msdata=none
20103 @opindex mno-sdata
20104 On embedded PowerPC systems, put all initialized global and static data
20105 in the @code{.data} section, and all uninitialized data in the
20106 @code{.bss} section.
20108 @item -mblock-move-inline-limit=@var{num}
20109 @opindex mblock-move-inline-limit
20110 Inline all block moves (such as calls to @code{memcpy} or structure
20111 copies) less than or equal to @var{num} bytes.  The minimum value for
20112 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20113 targets.  The default value is target-specific.
20115 @item -G @var{num}
20116 @opindex G
20117 @cindex smaller data references (PowerPC)
20118 @cindex .sdata/.sdata2 references (PowerPC)
20119 On embedded PowerPC systems, put global and static items less than or
20120 equal to @var{num} bytes into the small data or BSS sections instead of
20121 the normal data or BSS section.  By default, @var{num} is 8.  The
20122 @option{-G @var{num}} switch is also passed to the linker.
20123 All modules should be compiled with the same @option{-G @var{num}} value.
20125 @item -mregnames
20126 @itemx -mno-regnames
20127 @opindex mregnames
20128 @opindex mno-regnames
20129 On System V.4 and embedded PowerPC systems do (do not) emit register
20130 names in the assembly language output using symbolic forms.
20132 @item -mlongcall
20133 @itemx -mno-longcall
20134 @opindex mlongcall
20135 @opindex mno-longcall
20136 By default assume that all calls are far away so that a longer and more
20137 expensive calling sequence is required.  This is required for calls
20138 farther than 32 megabytes (33,554,432 bytes) from the current location.
20139 A short call is generated if the compiler knows
20140 the call cannot be that far away.  This setting can be overridden by
20141 the @code{shortcall} function attribute, or by @code{#pragma
20142 longcall(0)}.
20144 Some linkers are capable of detecting out-of-range calls and generating
20145 glue code on the fly.  On these systems, long calls are unnecessary and
20146 generate slower code.  As of this writing, the AIX linker can do this,
20147 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20148 to the GNU linker for 32-bit PowerPC systems as well.
20150 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20151 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20152 addresses represent the callee and the branch island.  The
20153 Darwin/PPC linker prefers the first address and generates a @code{bl
20154 callee} if the PPC @code{bl} instruction reaches the callee directly;
20155 otherwise, the linker generates @code{bl L42} to call the branch
20156 island.  The branch island is appended to the body of the
20157 calling function; it computes the full 32-bit address of the callee
20158 and jumps to it.
20160 On Mach-O (Darwin) systems, this option directs the compiler emit to
20161 the glue for every direct call, and the Darwin linker decides whether
20162 to use or discard it.
20164 In the future, GCC may ignore all longcall specifications
20165 when the linker is known to generate glue.
20167 @item -mtls-markers
20168 @itemx -mno-tls-markers
20169 @opindex mtls-markers
20170 @opindex mno-tls-markers
20171 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20172 specifying the function argument.  The relocation allows the linker to
20173 reliably associate function call with argument setup instructions for
20174 TLS optimization, which in turn allows GCC to better schedule the
20175 sequence.
20177 @item -pthread
20178 @opindex pthread
20179 Adds support for multithreading with the @dfn{pthreads} library.
20180 This option sets flags for both the preprocessor and linker.
20182 @item -mrecip
20183 @itemx -mno-recip
20184 @opindex mrecip
20185 This option enables use of the reciprocal estimate and
20186 reciprocal square root estimate instructions with additional
20187 Newton-Raphson steps to increase precision instead of doing a divide or
20188 square root and divide for floating-point arguments.  You should use
20189 the @option{-ffast-math} option when using @option{-mrecip} (or at
20190 least @option{-funsafe-math-optimizations},
20191 @option{-finite-math-only}, @option{-freciprocal-math} and
20192 @option{-fno-trapping-math}).  Note that while the throughput of the
20193 sequence is generally higher than the throughput of the non-reciprocal
20194 instruction, the precision of the sequence can be decreased by up to 2
20195 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20196 roots.
20198 @item -mrecip=@var{opt}
20199 @opindex mrecip=opt
20200 This option controls which reciprocal estimate instructions
20201 may be used.  @var{opt} is a comma-separated list of options, which may
20202 be preceded by a @code{!} to invert the option:
20204 @table @samp
20206 @item all
20207 Enable all estimate instructions.
20209 @item default 
20210 Enable the default instructions, equivalent to @option{-mrecip}.
20212 @item none 
20213 Disable all estimate instructions, equivalent to @option{-mno-recip}.
20215 @item div 
20216 Enable the reciprocal approximation instructions for both 
20217 single and double precision.
20219 @item divf 
20220 Enable the single-precision reciprocal approximation instructions.
20222 @item divd 
20223 Enable the double-precision reciprocal approximation instructions.
20225 @item rsqrt 
20226 Enable the reciprocal square root approximation instructions for both
20227 single and double precision.
20229 @item rsqrtf 
20230 Enable the single-precision reciprocal square root approximation instructions.
20232 @item rsqrtd 
20233 Enable the double-precision reciprocal square root approximation instructions.
20235 @end table
20237 So, for example, @option{-mrecip=all,!rsqrtd} enables
20238 all of the reciprocal estimate instructions, except for the
20239 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20240 which handle the double-precision reciprocal square root calculations.
20242 @item -mrecip-precision
20243 @itemx -mno-recip-precision
20244 @opindex mrecip-precision
20245 Assume (do not assume) that the reciprocal estimate instructions
20246 provide higher-precision estimates than is mandated by the PowerPC
20247 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20248 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20249 The double-precision square root estimate instructions are not generated by
20250 default on low-precision machines, since they do not provide an
20251 estimate that converges after three steps.
20253 @item -mveclibabi=@var{type}
20254 @opindex mveclibabi
20255 Specifies the ABI type to use for vectorizing intrinsics using an
20256 external library.  The only type supported at present is @samp{mass},
20257 which specifies to use IBM's Mathematical Acceleration Subsystem
20258 (MASS) libraries for vectorizing intrinsics using external libraries.
20259 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20260 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20261 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20262 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20263 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20264 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20265 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20266 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20267 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20268 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20269 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20270 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20271 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20272 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20273 for power7.  Both @option{-ftree-vectorize} and
20274 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20275 libraries must be specified at link time.
20277 @item -mfriz
20278 @itemx -mno-friz
20279 @opindex mfriz
20280 Generate (do not generate) the @code{friz} instruction when the
20281 @option{-funsafe-math-optimizations} option is used to optimize
20282 rounding of floating-point values to 64-bit integer and back to floating
20283 point.  The @code{friz} instruction does not return the same value if
20284 the floating-point number is too large to fit in an integer.
20286 @item -mpointers-to-nested-functions
20287 @itemx -mno-pointers-to-nested-functions
20288 @opindex mpointers-to-nested-functions
20289 Generate (do not generate) code to load up the static chain register
20290 (@code{r11}) when calling through a pointer on AIX and 64-bit Linux
20291 systems where a function pointer points to a 3-word descriptor giving
20292 the function address, TOC value to be loaded in register @code{r2}, and
20293 static chain value to be loaded in register @code{r11}.  The
20294 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20295 call through pointers to nested functions or pointers
20296 to functions compiled in other languages that use the static chain if
20297 you use @option{-mno-pointers-to-nested-functions}.
20299 @item -msave-toc-indirect
20300 @itemx -mno-save-toc-indirect
20301 @opindex msave-toc-indirect
20302 Generate (do not generate) code to save the TOC value in the reserved
20303 stack location in the function prologue if the function calls through
20304 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20305 saved in the prologue, it is saved just before the call through the
20306 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20308 @item -mcompat-align-parm
20309 @itemx -mno-compat-align-parm
20310 @opindex mcompat-align-parm
20311 Generate (do not generate) code to pass structure parameters with a
20312 maximum alignment of 64 bits, for compatibility with older versions
20313 of GCC.
20315 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20316 structure parameter on a 128-bit boundary when that structure contained
20317 a member requiring 128-bit alignment.  This is corrected in more
20318 recent versions of GCC.  This option may be used to generate code
20319 that is compatible with functions compiled with older versions of
20320 GCC.
20322 The @option{-mno-compat-align-parm} option is the default.
20323 @end table
20325 @node RX Options
20326 @subsection RX Options
20327 @cindex RX Options
20329 These command-line options are defined for RX targets:
20331 @table @gcctabopt
20332 @item -m64bit-doubles
20333 @itemx -m32bit-doubles
20334 @opindex m64bit-doubles
20335 @opindex m32bit-doubles
20336 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20337 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20338 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20339 works on 32-bit values, which is why the default is
20340 @option{-m32bit-doubles}.
20342 @item -fpu
20343 @itemx -nofpu
20344 @opindex fpu
20345 @opindex nofpu
20346 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20347 floating-point hardware.  The default is enabled for the RX600
20348 series and disabled for the RX200 series.
20350 Floating-point instructions are only generated for 32-bit floating-point 
20351 values, however, so the FPU hardware is not used for doubles if the
20352 @option{-m64bit-doubles} option is used.
20354 @emph{Note} If the @option{-fpu} option is enabled then
20355 @option{-funsafe-math-optimizations} is also enabled automatically.
20356 This is because the RX FPU instructions are themselves unsafe.
20358 @item -mcpu=@var{name}
20359 @opindex mcpu
20360 Selects the type of RX CPU to be targeted.  Currently three types are
20361 supported, the generic @samp{RX600} and @samp{RX200} series hardware and
20362 the specific @samp{RX610} CPU.  The default is @samp{RX600}.
20364 The only difference between @samp{RX600} and @samp{RX610} is that the
20365 @samp{RX610} does not support the @code{MVTIPL} instruction.
20367 The @samp{RX200} series does not have a hardware floating-point unit
20368 and so @option{-nofpu} is enabled by default when this type is
20369 selected.
20371 @item -mbig-endian-data
20372 @itemx -mlittle-endian-data
20373 @opindex mbig-endian-data
20374 @opindex mlittle-endian-data
20375 Store data (but not code) in the big-endian format.  The default is
20376 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20377 format.
20379 @item -msmall-data-limit=@var{N}
20380 @opindex msmall-data-limit
20381 Specifies the maximum size in bytes of global and static variables
20382 which can be placed into the small data area.  Using the small data
20383 area can lead to smaller and faster code, but the size of area is
20384 limited and it is up to the programmer to ensure that the area does
20385 not overflow.  Also when the small data area is used one of the RX's
20386 registers (usually @code{r13}) is reserved for use pointing to this
20387 area, so it is no longer available for use by the compiler.  This
20388 could result in slower and/or larger code if variables are pushed onto
20389 the stack instead of being held in this register.
20391 Note, common variables (variables that have not been initialized) and
20392 constants are not placed into the small data area as they are assigned
20393 to other sections in the output executable.
20395 The default value is zero, which disables this feature.  Note, this
20396 feature is not enabled by default with higher optimization levels
20397 (@option{-O2} etc) because of the potentially detrimental effects of
20398 reserving a register.  It is up to the programmer to experiment and
20399 discover whether this feature is of benefit to their program.  See the
20400 description of the @option{-mpid} option for a description of how the
20401 actual register to hold the small data area pointer is chosen.
20403 @item -msim
20404 @itemx -mno-sim
20405 @opindex msim
20406 @opindex mno-sim
20407 Use the simulator runtime.  The default is to use the libgloss
20408 board-specific runtime.
20410 @item -mas100-syntax
20411 @itemx -mno-as100-syntax
20412 @opindex mas100-syntax
20413 @opindex mno-as100-syntax
20414 When generating assembler output use a syntax that is compatible with
20415 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20416 assembler, but it has some restrictions so it is not generated by default.
20418 @item -mmax-constant-size=@var{N}
20419 @opindex mmax-constant-size
20420 Specifies the maximum size, in bytes, of a constant that can be used as
20421 an operand in a RX instruction.  Although the RX instruction set does
20422 allow constants of up to 4 bytes in length to be used in instructions,
20423 a longer value equates to a longer instruction.  Thus in some
20424 circumstances it can be beneficial to restrict the size of constants
20425 that are used in instructions.  Constants that are too big are instead
20426 placed into a constant pool and referenced via register indirection.
20428 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20429 or 4 means that constants of any size are allowed.
20431 @item -mrelax
20432 @opindex mrelax
20433 Enable linker relaxation.  Linker relaxation is a process whereby the
20434 linker attempts to reduce the size of a program by finding shorter
20435 versions of various instructions.  Disabled by default.
20437 @item -mint-register=@var{N}
20438 @opindex mint-register
20439 Specify the number of registers to reserve for fast interrupt handler
20440 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20441 means that register @code{r13} is reserved for the exclusive use
20442 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20443 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20444 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20445 A value of 0, the default, does not reserve any registers.
20447 @item -msave-acc-in-interrupts
20448 @opindex msave-acc-in-interrupts
20449 Specifies that interrupt handler functions should preserve the
20450 accumulator register.  This is only necessary if normal code might use
20451 the accumulator register, for example because it performs 64-bit
20452 multiplications.  The default is to ignore the accumulator as this
20453 makes the interrupt handlers faster.
20455 @item -mpid
20456 @itemx -mno-pid
20457 @opindex mpid
20458 @opindex mno-pid
20459 Enables the generation of position independent data.  When enabled any
20460 access to constant data is done via an offset from a base address
20461 held in a register.  This allows the location of constant data to be
20462 determined at run time without requiring the executable to be
20463 relocated, which is a benefit to embedded applications with tight
20464 memory constraints.  Data that can be modified is not affected by this
20465 option.
20467 Note, using this feature reserves a register, usually @code{r13}, for
20468 the constant data base address.  This can result in slower and/or
20469 larger code, especially in complicated functions.
20471 The actual register chosen to hold the constant data base address
20472 depends upon whether the @option{-msmall-data-limit} and/or the
20473 @option{-mint-register} command-line options are enabled.  Starting
20474 with register @code{r13} and proceeding downwards, registers are
20475 allocated first to satisfy the requirements of @option{-mint-register},
20476 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20477 is possible for the small data area register to be @code{r8} if both
20478 @option{-mint-register=4} and @option{-mpid} are specified on the
20479 command line.
20481 By default this feature is not enabled.  The default can be restored
20482 via the @option{-mno-pid} command-line option.
20484 @item -mno-warn-multiple-fast-interrupts
20485 @itemx -mwarn-multiple-fast-interrupts
20486 @opindex mno-warn-multiple-fast-interrupts
20487 @opindex mwarn-multiple-fast-interrupts
20488 Prevents GCC from issuing a warning message if it finds more than one
20489 fast interrupt handler when it is compiling a file.  The default is to
20490 issue a warning for each extra fast interrupt handler found, as the RX
20491 only supports one such interrupt.
20493 @item -mallow-string-insns
20494 @itemx -mno-allow-string-insns
20495 @opindex mallow-string-insns
20496 @opindex mno-allow-string-insns
20497 Enables or disables the use of the string manipulation instructions
20498 @code{SMOVF}, @code{SCMPU}, @code{SMOVB}, @code{SMOVU}, @code{SUNTIL}
20499 @code{SWHILE} and also the @code{RMPA} instruction.  These
20500 instructions may prefetch data, which is not safe to do if accessing
20501 an I/O register.  (See section 12.2.7 of the RX62N Group User's Manual
20502 for more information).
20504 The default is to allow these instructions, but it is not possible for
20505 GCC to reliably detect all circumstances where a string instruction
20506 might be used to access an I/O register, so their use cannot be
20507 disabled automatically.  Instead it is reliant upon the programmer to
20508 use the @option{-mno-allow-string-insns} option if their program
20509 accesses I/O space.
20511 When the instructions are enabled GCC defines the C preprocessor
20512 symbol @code{__RX_ALLOW_STRING_INSNS__}, otherwise it defines the
20513 symbol @code{__RX_DISALLOW_STRING_INSNS__}.
20514 @end table
20516 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20517 has special significance to the RX port when used with the
20518 @code{interrupt} function attribute.  This attribute indicates a
20519 function intended to process fast interrupts.  GCC ensures
20520 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20521 and/or @code{r13} and only provided that the normal use of the
20522 corresponding registers have been restricted via the
20523 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20524 options.
20526 @node S/390 and zSeries Options
20527 @subsection S/390 and zSeries Options
20528 @cindex S/390 and zSeries Options
20530 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20532 @table @gcctabopt
20533 @item -mhard-float
20534 @itemx -msoft-float
20535 @opindex mhard-float
20536 @opindex msoft-float
20537 Use (do not use) the hardware floating-point instructions and registers
20538 for floating-point operations.  When @option{-msoft-float} is specified,
20539 functions in @file{libgcc.a} are used to perform floating-point
20540 operations.  When @option{-mhard-float} is specified, the compiler
20541 generates IEEE floating-point instructions.  This is the default.
20543 @item -mhard-dfp
20544 @itemx -mno-hard-dfp
20545 @opindex mhard-dfp
20546 @opindex mno-hard-dfp
20547 Use (do not use) the hardware decimal-floating-point instructions for
20548 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20549 specified, functions in @file{libgcc.a} are used to perform
20550 decimal-floating-point operations.  When @option{-mhard-dfp} is
20551 specified, the compiler generates decimal-floating-point hardware
20552 instructions.  This is the default for @option{-march=z9-ec} or higher.
20554 @item -mlong-double-64
20555 @itemx -mlong-double-128
20556 @opindex mlong-double-64
20557 @opindex mlong-double-128
20558 These switches control the size of @code{long double} type. A size
20559 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20560 type. This is the default.
20562 @item -mbackchain
20563 @itemx -mno-backchain
20564 @opindex mbackchain
20565 @opindex mno-backchain
20566 Store (do not store) the address of the caller's frame as backchain pointer
20567 into the callee's stack frame.
20568 A backchain may be needed to allow debugging using tools that do not understand
20569 DWARF 2 call frame information.
20570 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20571 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20572 the backchain is placed into the topmost word of the 96/160 byte register
20573 save area.
20575 In general, code compiled with @option{-mbackchain} is call-compatible with
20576 code compiled with @option{-mmo-backchain}; however, use of the backchain
20577 for debugging purposes usually requires that the whole binary is built with
20578 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20579 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20580 to build a linux kernel use @option{-msoft-float}.
20582 The default is to not maintain the backchain.
20584 @item -mpacked-stack
20585 @itemx -mno-packed-stack
20586 @opindex mpacked-stack
20587 @opindex mno-packed-stack
20588 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20589 specified, the compiler uses the all fields of the 96/160 byte register save
20590 area only for their default purpose; unused fields still take up stack space.
20591 When @option{-mpacked-stack} is specified, register save slots are densely
20592 packed at the top of the register save area; unused space is reused for other
20593 purposes, allowing for more efficient use of the available stack space.
20594 However, when @option{-mbackchain} is also in effect, the topmost word of
20595 the save area is always used to store the backchain, and the return address
20596 register is always saved two words below the backchain.
20598 As long as the stack frame backchain is not used, code generated with
20599 @option{-mpacked-stack} is call-compatible with code generated with
20600 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20601 S/390 or zSeries generated code that uses the stack frame backchain at run
20602 time, not just for debugging purposes.  Such code is not call-compatible
20603 with code compiled with @option{-mpacked-stack}.  Also, note that the
20604 combination of @option{-mbackchain},
20605 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20606 to build a linux kernel use @option{-msoft-float}.
20608 The default is to not use the packed stack layout.
20610 @item -msmall-exec
20611 @itemx -mno-small-exec
20612 @opindex msmall-exec
20613 @opindex mno-small-exec
20614 Generate (or do not generate) code using the @code{bras} instruction
20615 to do subroutine calls.
20616 This only works reliably if the total executable size does not
20617 exceed 64k.  The default is to use the @code{basr} instruction instead,
20618 which does not have this limitation.
20620 @item -m64
20621 @itemx -m31
20622 @opindex m64
20623 @opindex m31
20624 When @option{-m31} is specified, generate code compliant to the
20625 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20626 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20627 particular to generate 64-bit instructions.  For the @samp{s390}
20628 targets, the default is @option{-m31}, while the @samp{s390x}
20629 targets default to @option{-m64}.
20631 @item -mzarch
20632 @itemx -mesa
20633 @opindex mzarch
20634 @opindex mesa
20635 When @option{-mzarch} is specified, generate code using the
20636 instructions available on z/Architecture.
20637 When @option{-mesa} is specified, generate code using the
20638 instructions available on ESA/390.  Note that @option{-mesa} is
20639 not possible with @option{-m64}.
20640 When generating code compliant to the GNU/Linux for S/390 ABI,
20641 the default is @option{-mesa}.  When generating code compliant
20642 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20644 @item -mhtm
20645 @itemx -mno-htm
20646 @opindex mhtm
20647 @opindex mno-htm
20648 The @option{-mhtm} option enables a set of builtins making use of
20649 instructions available with the transactional execution facility
20650 introduced with the IBM zEnterprise EC12 machine generation
20651 @ref{S/390 System z Built-in Functions}.
20652 @option{-mhtm} is enabled by default when using @option{-march=zEC12}.
20654 @item -mvx
20655 @itemx -mno-vx
20656 @opindex mvx
20657 @opindex mno-vx
20658 When @option{-mvx} is specified, generate code using the instructions
20659 available with the vector extension facility introduced with the IBM
20660 z13 machine generation.
20661 This option changes the ABI for some vector type values with regard to
20662 alignment and calling conventions.  In case vector type values are
20663 being used in an ABI-relevant context a GAS @samp{.gnu_attribute}
20664 command will be added to mark the resulting binary with the ABI used.
20665 @option{-mvx} is enabled by default when using @option{-march=z13}.
20667 @item -mzvector
20668 @itemx -mno-zvector
20669 @opindex mzvector
20670 @opindex mno-zvector
20671 The @option{-mzvector} option enables vector language extensions and
20672 builtins using instructions available with the vector extension
20673 facility introduced with the IBM z13 machine generation.
20674 This option adds support for @samp{vector} to be used as a keyword to
20675 define vector type variables and arguments.  @samp{vector} is only
20676 available when GNU extensions are enabled.  It will not be expanded
20677 when requesting strict standard compliance e.g. with @option{-std=c99}.
20678 In addition to the GCC low-level builtins @option{-mzvector} enables
20679 a set of builtins added for compatibility with Altivec-style
20680 implementations like Power and Cell.  In order to make use of these
20681 builtins the header file @file{vecintrin.h} needs to be included.
20682 @option{-mzvector} is disabled by default.
20684 @item -mmvcle
20685 @itemx -mno-mvcle
20686 @opindex mmvcle
20687 @opindex mno-mvcle
20688 Generate (or do not generate) code using the @code{mvcle} instruction
20689 to perform block moves.  When @option{-mno-mvcle} is specified,
20690 use a @code{mvc} loop instead.  This is the default unless optimizing for
20691 size.
20693 @item -mdebug
20694 @itemx -mno-debug
20695 @opindex mdebug
20696 @opindex mno-debug
20697 Print (or do not print) additional debug information when compiling.
20698 The default is to not print debug information.
20700 @item -march=@var{cpu-type}
20701 @opindex march
20702 Generate code that runs on @var{cpu-type}, which is the name of a system
20703 representing a certain processor type.  Possible values for
20704 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20705 @samp{z9-109}, @samp{z9-ec}, @samp{z10},  @samp{z196}, @samp{zEC12},
20706 and @samp{z13}.
20707 When generating code using the instructions available on z/Architecture,
20708 the default is @option{-march=z900}.  Otherwise, the default is
20709 @option{-march=g5}.
20711 @item -mtune=@var{cpu-type}
20712 @opindex mtune
20713 Tune to @var{cpu-type} everything applicable about the generated code,
20714 except for the ABI and the set of available instructions.
20715 The list of @var{cpu-type} values is the same as for @option{-march}.
20716 The default is the value used for @option{-march}.
20718 @item -mtpf-trace
20719 @itemx -mno-tpf-trace
20720 @opindex mtpf-trace
20721 @opindex mno-tpf-trace
20722 Generate code that adds (does not add) in TPF OS specific branches to trace
20723 routines in the operating system.  This option is off by default, even
20724 when compiling for the TPF OS@.
20726 @item -mfused-madd
20727 @itemx -mno-fused-madd
20728 @opindex mfused-madd
20729 @opindex mno-fused-madd
20730 Generate code that uses (does not use) the floating-point multiply and
20731 accumulate instructions.  These instructions are generated by default if
20732 hardware floating point is used.
20734 @item -mwarn-framesize=@var{framesize}
20735 @opindex mwarn-framesize
20736 Emit a warning if the current function exceeds the given frame size.  Because
20737 this is a compile-time check it doesn't need to be a real problem when the program
20738 runs.  It is intended to identify functions that most probably cause
20739 a stack overflow.  It is useful to be used in an environment with limited stack
20740 size e.g.@: the linux kernel.
20742 @item -mwarn-dynamicstack
20743 @opindex mwarn-dynamicstack
20744 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20745 arrays.  This is generally a bad idea with a limited stack size.
20747 @item -mstack-guard=@var{stack-guard}
20748 @itemx -mstack-size=@var{stack-size}
20749 @opindex mstack-guard
20750 @opindex mstack-size
20751 If these options are provided the S/390 back end emits additional instructions in
20752 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20753 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20754 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20755 the frame size of the compiled function is chosen.
20756 These options are intended to be used to help debugging stack overflow problems.
20757 The additionally emitted code causes only little overhead and hence can also be
20758 used in production-like systems without greater performance degradation.  The given
20759 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20760 @var{stack-guard} without exceeding 64k.
20761 In order to be efficient the extra code makes the assumption that the stack starts
20762 at an address aligned to the value given by @var{stack-size}.
20763 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20765 @item -mhotpatch=@var{pre-halfwords},@var{post-halfwords}
20766 @opindex mhotpatch
20767 If the hotpatch option is enabled, a ``hot-patching'' function
20768 prologue is generated for all functions in the compilation unit.
20769 The funtion label is prepended with the given number of two-byte
20770 NOP instructions (@var{pre-halfwords}, maximum 1000000).  After
20771 the label, 2 * @var{post-halfwords} bytes are appended, using the
20772 largest NOP like instructions the architecture allows (maximum
20773 1000000).
20775 If both arguments are zero, hotpatching is disabled.
20777 This option can be overridden for individual functions with the
20778 @code{hotpatch} attribute.
20779 @end table
20781 @node Score Options
20782 @subsection Score Options
20783 @cindex Score Options
20785 These options are defined for Score implementations:
20787 @table @gcctabopt
20788 @item -meb
20789 @opindex meb
20790 Compile code for big-endian mode.  This is the default.
20792 @item -mel
20793 @opindex mel
20794 Compile code for little-endian mode.
20796 @item -mnhwloop
20797 @opindex mnhwloop
20798 Disable generation of @code{bcnz} instructions.
20800 @item -muls
20801 @opindex muls
20802 Enable generation of unaligned load and store instructions.
20804 @item -mmac
20805 @opindex mmac
20806 Enable the use of multiply-accumulate instructions. Disabled by default.
20808 @item -mscore5
20809 @opindex mscore5
20810 Specify the SCORE5 as the target architecture.
20812 @item -mscore5u
20813 @opindex mscore5u
20814 Specify the SCORE5U of the target architecture.
20816 @item -mscore7
20817 @opindex mscore7
20818 Specify the SCORE7 as the target architecture. This is the default.
20820 @item -mscore7d
20821 @opindex mscore7d
20822 Specify the SCORE7D as the target architecture.
20823 @end table
20825 @node SH Options
20826 @subsection SH Options
20828 These @samp{-m} options are defined for the SH implementations:
20830 @table @gcctabopt
20831 @item -m1
20832 @opindex m1
20833 Generate code for the SH1.
20835 @item -m2
20836 @opindex m2
20837 Generate code for the SH2.
20839 @item -m2e
20840 Generate code for the SH2e.
20842 @item -m2a-nofpu
20843 @opindex m2a-nofpu
20844 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20845 that the floating-point unit is not used.
20847 @item -m2a-single-only
20848 @opindex m2a-single-only
20849 Generate code for the SH2a-FPU, in such a way that no double-precision
20850 floating-point operations are used.
20852 @item -m2a-single
20853 @opindex m2a-single
20854 Generate code for the SH2a-FPU assuming the floating-point unit is in
20855 single-precision mode by default.
20857 @item -m2a
20858 @opindex m2a
20859 Generate code for the SH2a-FPU assuming the floating-point unit is in
20860 double-precision mode by default.
20862 @item -m3
20863 @opindex m3
20864 Generate code for the SH3.
20866 @item -m3e
20867 @opindex m3e
20868 Generate code for the SH3e.
20870 @item -m4-nofpu
20871 @opindex m4-nofpu
20872 Generate code for the SH4 without a floating-point unit.
20874 @item -m4-single-only
20875 @opindex m4-single-only
20876 Generate code for the SH4 with a floating-point unit that only
20877 supports single-precision arithmetic.
20879 @item -m4-single
20880 @opindex m4-single
20881 Generate code for the SH4 assuming the floating-point unit is in
20882 single-precision mode by default.
20884 @item -m4
20885 @opindex m4
20886 Generate code for the SH4.
20888 @item -m4-100
20889 @opindex m4-100
20890 Generate code for SH4-100.
20892 @item -m4-100-nofpu
20893 @opindex m4-100-nofpu
20894 Generate code for SH4-100 in such a way that the
20895 floating-point unit is not used.
20897 @item -m4-100-single
20898 @opindex m4-100-single
20899 Generate code for SH4-100 assuming the floating-point unit is in
20900 single-precision mode by default.
20902 @item -m4-100-single-only
20903 @opindex m4-100-single-only
20904 Generate code for SH4-100 in such a way that no double-precision
20905 floating-point operations are used.
20907 @item -m4-200
20908 @opindex m4-200
20909 Generate code for SH4-200.
20911 @item -m4-200-nofpu
20912 @opindex m4-200-nofpu
20913 Generate code for SH4-200 without in such a way that the
20914 floating-point unit is not used.
20916 @item -m4-200-single
20917 @opindex m4-200-single
20918 Generate code for SH4-200 assuming the floating-point unit is in
20919 single-precision mode by default.
20921 @item -m4-200-single-only
20922 @opindex m4-200-single-only
20923 Generate code for SH4-200 in such a way that no double-precision
20924 floating-point operations are used.
20926 @item -m4-300
20927 @opindex m4-300
20928 Generate code for SH4-300.
20930 @item -m4-300-nofpu
20931 @opindex m4-300-nofpu
20932 Generate code for SH4-300 without in such a way that the
20933 floating-point unit is not used.
20935 @item -m4-300-single
20936 @opindex m4-300-single
20937 Generate code for SH4-300 in such a way that no double-precision
20938 floating-point operations are used.
20940 @item -m4-300-single-only
20941 @opindex m4-300-single-only
20942 Generate code for SH4-300 in such a way that no double-precision
20943 floating-point operations are used.
20945 @item -m4-340
20946 @opindex m4-340
20947 Generate code for SH4-340 (no MMU, no FPU).
20949 @item -m4-500
20950 @opindex m4-500
20951 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
20952 assembler.
20954 @item -m4a-nofpu
20955 @opindex m4a-nofpu
20956 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20957 floating-point unit is not used.
20959 @item -m4a-single-only
20960 @opindex m4a-single-only
20961 Generate code for the SH4a, in such a way that no double-precision
20962 floating-point operations are used.
20964 @item -m4a-single
20965 @opindex m4a-single
20966 Generate code for the SH4a assuming the floating-point unit is in
20967 single-precision mode by default.
20969 @item -m4a
20970 @opindex m4a
20971 Generate code for the SH4a.
20973 @item -m4al
20974 @opindex m4al
20975 Same as @option{-m4a-nofpu}, except that it implicitly passes
20976 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20977 instructions at the moment.
20979 @item -mb
20980 @opindex mb
20981 Compile code for the processor in big-endian mode.
20983 @item -ml
20984 @opindex ml
20985 Compile code for the processor in little-endian mode.
20987 @item -mdalign
20988 @opindex mdalign
20989 Align doubles at 64-bit boundaries.  Note that this changes the calling
20990 conventions, and thus some functions from the standard C library do
20991 not work unless you recompile it first with @option{-mdalign}.
20993 @item -mrelax
20994 @opindex mrelax
20995 Shorten some address references at link time, when possible; uses the
20996 linker option @option{-relax}.
20998 @item -mbigtable
20999 @opindex mbigtable
21000 Use 32-bit offsets in @code{switch} tables.  The default is to use
21001 16-bit offsets.
21003 @item -mbitops
21004 @opindex mbitops
21005 Enable the use of bit manipulation instructions on SH2A.
21007 @item -mfmovd
21008 @opindex mfmovd
21009 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21010 alignment constraints.
21012 @item -mrenesas
21013 @opindex mrenesas
21014 Comply with the calling conventions defined by Renesas.
21016 @item -mno-renesas
21017 @opindex mno-renesas
21018 Comply with the calling conventions defined for GCC before the Renesas
21019 conventions were available.  This option is the default for all
21020 targets of the SH toolchain.
21022 @item -mnomacsave
21023 @opindex mnomacsave
21024 Mark the @code{MAC} register as call-clobbered, even if
21025 @option{-mrenesas} is given.
21027 @item -mieee
21028 @itemx -mno-ieee
21029 @opindex mieee
21030 @opindex mno-ieee
21031 Control the IEEE compliance of floating-point comparisons, which affects the
21032 handling of cases where the result of a comparison is unordered.  By default
21033 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21034 enabled @option{-mno-ieee} is implicitly set, which results in faster
21035 floating-point greater-equal and less-equal comparisons.  The implcit settings
21036 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21038 @item -minline-ic_invalidate
21039 @opindex minline-ic_invalidate
21040 Inline code to invalidate instruction cache entries after setting up
21041 nested function trampolines.
21042 This option has no effect if @option{-musermode} is in effect and the selected
21043 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21044 instruction.
21045 If the selected code generation option does not allow the use of the @code{icbi}
21046 instruction, and @option{-musermode} is not in effect, the inlined code
21047 manipulates the instruction cache address array directly with an associative
21048 write.  This not only requires privileged mode at run time, but it also
21049 fails if the cache line had been mapped via the TLB and has become unmapped.
21051 @item -misize
21052 @opindex misize
21053 Dump instruction size and location in the assembly code.
21055 @item -mpadstruct
21056 @opindex mpadstruct
21057 This option is deprecated.  It pads structures to multiple of 4 bytes,
21058 which is incompatible with the SH ABI@.
21060 @item -matomic-model=@var{model}
21061 @opindex matomic-model=@var{model}
21062 Sets the model of atomic operations and additional parameters as a comma
21063 separated list.  For details on the atomic built-in functions see
21064 @ref{__atomic Builtins}.  The following models and parameters are supported:
21066 @table @samp
21068 @item none
21069 Disable compiler generated atomic sequences and emit library calls for atomic
21070 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21072 @item soft-gusa
21073 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21074 built-in functions.  The generated atomic sequences require additional support
21075 from the interrupt/exception handling code of the system and are only suitable
21076 for SH3* and SH4* single-core systems.  This option is enabled by default when
21077 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21078 this option also partially utilizes the hardware atomic instructions
21079 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21080 @samp{strict} is specified.  
21082 @item soft-tcb
21083 Generate software atomic sequences that use a variable in the thread control
21084 block.  This is a variation of the gUSA sequences which can also be used on
21085 SH1* and SH2* targets.  The generated atomic sequences require additional
21086 support from the interrupt/exception handling code of the system and are only
21087 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21088 parameter has to be specified as well.
21090 @item soft-imask
21091 Generate software atomic sequences that temporarily disable interrupts by
21092 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21093 in privileged mode and is only suitable for single-core systems.  Additional
21094 support from the interrupt/exception handling code of the system is not
21095 required.  This model is enabled by default when the target is
21096 @code{sh*-*-linux*} and SH1* or SH2*.
21098 @item hard-llcs
21099 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21100 instructions only.  This is only available on SH4A and is suitable for
21101 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21102 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21103 Code compiled with this option is also compatible with other software
21104 atomic model interrupt/exception handling systems if executed on an SH4A
21105 system.  Additional support from the interrupt/exception handling code of the
21106 system is not required for this model.
21108 @item gbr-offset=
21109 This parameter specifies the offset in bytes of the variable in the thread
21110 control block structure that should be used by the generated atomic sequences
21111 when the @samp{soft-tcb} model has been selected.  For other models this
21112 parameter is ignored.  The specified value must be an integer multiple of four
21113 and in the range 0-1020.
21115 @item strict
21116 This parameter prevents mixed usage of multiple atomic models, even if they
21117 are compatible, and makes the compiler generate atomic sequences of the
21118 specified model only.
21120 @end table
21122 @item -mtas
21123 @opindex mtas
21124 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21125 Notice that depending on the particular hardware and software configuration
21126 this can degrade overall performance due to the operand cache line flushes
21127 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21128 processors the @code{tas.b} instruction must be used with caution since it
21129 can result in data corruption for certain cache configurations.
21131 @item -mprefergot
21132 @opindex mprefergot
21133 When generating position-independent code, emit function calls using
21134 the Global Offset Table instead of the Procedure Linkage Table.
21136 @item -musermode
21137 @itemx -mno-usermode
21138 @opindex musermode
21139 @opindex mno-usermode
21140 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21141 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21142 inlined code would not work in user mode.  @option{-musermode} is the default
21143 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21144 @option{-musermode} has no effect, since there is no user mode.
21146 @item -multcost=@var{number}
21147 @opindex multcost=@var{number}
21148 Set the cost to assume for a multiply insn.
21150 @item -mdiv=@var{strategy}
21151 @opindex mdiv=@var{strategy}
21152 Set the division strategy to be used for integer division operations.
21153 @var{strategy} can be one of: 
21155 @table @samp
21157 @item call-div1
21158 Calls a library function that uses the single-step division instruction
21159 @code{div1} to perform the operation.  Division by zero calculates an
21160 unspecified result and does not trap.  This is the default except for SH4,
21161 SH2A and SHcompact.
21163 @item call-fp
21164 Calls a library function that performs the operation in double precision
21165 floating point.  Division by zero causes a floating-point exception.  This is
21166 the default for SHcompact with FPU.  Specifying this for targets that do not
21167 have a double precision FPU defaults to @code{call-div1}.
21169 @item call-table
21170 Calls a library function that uses a lookup table for small divisors and
21171 the @code{div1} instruction with case distinction for larger divisors.  Division
21172 by zero calculates an unspecified result and does not trap.  This is the default
21173 for SH4.  Specifying this for targets that do not have dynamic shift
21174 instructions defaults to @code{call-div1}.
21176 @end table
21178 When a division strategy has not been specified the default strategy is
21179 selected based on the current target.  For SH2A the default strategy is to
21180 use the @code{divs} and @code{divu} instructions instead of library function
21181 calls.
21183 @item -maccumulate-outgoing-args
21184 @opindex maccumulate-outgoing-args
21185 Reserve space once for outgoing arguments in the function prologue rather
21186 than around each call.  Generally beneficial for performance and size.  Also
21187 needed for unwinding to avoid changing the stack frame around conditional code.
21189 @item -mdivsi3_libfunc=@var{name}
21190 @opindex mdivsi3_libfunc=@var{name}
21191 Set the name of the library function used for 32-bit signed division to
21192 @var{name}.
21193 This only affects the name used in the @samp{call} division strategies, and
21194 the compiler still expects the same sets of input/output/clobbered registers as
21195 if this option were not present.
21197 @item -mfixed-range=@var{register-range}
21198 @opindex mfixed-range
21199 Generate code treating the given register range as fixed registers.
21200 A fixed register is one that the register allocator can not use.  This is
21201 useful when compiling kernel code.  A register range is specified as
21202 two registers separated by a dash.  Multiple register ranges can be
21203 specified separated by a comma.
21205 @item -mbranch-cost=@var{num}
21206 @opindex mbranch-cost=@var{num}
21207 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21208 make the compiler try to generate more branch-free code if possible.  
21209 If not specified the value is selected depending on the processor type that
21210 is being compiled for.
21212 @item -mzdcbranch
21213 @itemx -mno-zdcbranch
21214 @opindex mzdcbranch
21215 @opindex mno-zdcbranch
21216 Assume (do not assume) that zero displacement conditional branch instructions
21217 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21218 compiler prefers zero displacement branch code sequences.  This is
21219 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21220 disabled by specifying @option{-mno-zdcbranch}.
21222 @item -mcbranch-force-delay-slot
21223 @opindex mcbranch-force-delay-slot
21224 Force the usage of delay slots for conditional branches, which stuffs the delay
21225 slot with a @code{nop} if a suitable instruction can't be found.  By default
21226 this option is disabled.  It can be enabled to work around hardware bugs as
21227 found in the original SH7055.
21229 @item -mfused-madd
21230 @itemx -mno-fused-madd
21231 @opindex mfused-madd
21232 @opindex mno-fused-madd
21233 Generate code that uses (does not use) the floating-point multiply and
21234 accumulate instructions.  These instructions are generated by default
21235 if hardware floating point is used.  The machine-dependent
21236 @option{-mfused-madd} option is now mapped to the machine-independent
21237 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21238 mapped to @option{-ffp-contract=off}.
21240 @item -mfsca
21241 @itemx -mno-fsca
21242 @opindex mfsca
21243 @opindex mno-fsca
21244 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21245 and cosine approximations.  The option @option{-mfsca} must be used in
21246 combination with @option{-funsafe-math-optimizations}.  It is enabled by default
21247 when generating code for SH4A.  Using @option{-mno-fsca} disables sine and cosine
21248 approximations even if @option{-funsafe-math-optimizations} is in effect.
21250 @item -mfsrra
21251 @itemx -mno-fsrra
21252 @opindex mfsrra
21253 @opindex mno-fsrra
21254 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21255 reciprocal square root approximations.  The option @option{-mfsrra} must be used
21256 in combination with @option{-funsafe-math-optimizations} and
21257 @option{-ffinite-math-only}.  It is enabled by default when generating code for
21258 SH4A.  Using @option{-mno-fsrra} disables reciprocal square root approximations
21259 even if @option{-funsafe-math-optimizations} and @option{-ffinite-math-only} are
21260 in effect.
21262 @item -mpretend-cmove
21263 @opindex mpretend-cmove
21264 Prefer zero-displacement conditional branches for conditional move instruction
21265 patterns.  This can result in faster code on the SH4 processor.
21267 @item -mfdpic
21268 @opindex fdpic
21269 Generate code using the FDPIC ABI.
21271 @end table
21273 @node Solaris 2 Options
21274 @subsection Solaris 2 Options
21275 @cindex Solaris 2 options
21277 These @samp{-m} options are supported on Solaris 2:
21279 @table @gcctabopt
21280 @item -mclear-hwcap
21281 @opindex mclear-hwcap
21282 @option{-mclear-hwcap} tells the compiler to remove the hardware
21283 capabilities generated by the Solaris assembler.  This is only necessary
21284 when object files use ISA extensions not supported by the current
21285 machine, but check at runtime whether or not to use them.
21287 @item -mimpure-text
21288 @opindex mimpure-text
21289 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21290 the compiler to not pass @option{-z text} to the linker when linking a
21291 shared object.  Using this option, you can link position-dependent
21292 code into a shared object.
21294 @option{-mimpure-text} suppresses the ``relocations remain against
21295 allocatable but non-writable sections'' linker error message.
21296 However, the necessary relocations trigger copy-on-write, and the
21297 shared object is not actually shared across processes.  Instead of
21298 using @option{-mimpure-text}, you should compile all source code with
21299 @option{-fpic} or @option{-fPIC}.
21301 @end table
21303 These switches are supported in addition to the above on Solaris 2:
21305 @table @gcctabopt
21306 @item -pthreads
21307 @opindex pthreads
21308 Add support for multithreading using the POSIX threads library.  This
21309 option sets flags for both the preprocessor and linker.  This option does
21310 not affect the thread safety of object code produced  by the compiler or
21311 that of libraries supplied with it.
21313 @item -pthread
21314 @opindex pthread
21315 This is a synonym for @option{-pthreads}.
21316 @end table
21318 @node SPARC Options
21319 @subsection SPARC Options
21320 @cindex SPARC options
21322 These @samp{-m} options are supported on the SPARC:
21324 @table @gcctabopt
21325 @item -mno-app-regs
21326 @itemx -mapp-regs
21327 @opindex mno-app-regs
21328 @opindex mapp-regs
21329 Specify @option{-mapp-regs} to generate output using the global registers
21330 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21331 global register 1, each global register 2 through 4 is then treated as an
21332 allocable register that is clobbered by function calls.  This is the default.
21334 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21335 specify @option{-mno-app-regs}.  You should compile libraries and system
21336 software with this option.
21338 @item -mflat
21339 @itemx -mno-flat
21340 @opindex mflat
21341 @opindex mno-flat
21342 With @option{-mflat}, the compiler does not generate save/restore instructions
21343 and uses a ``flat'' or single register window model.  This model is compatible
21344 with the regular register window model.  The local registers and the input
21345 registers (0--5) are still treated as ``call-saved'' registers and are
21346 saved on the stack as needed.
21348 With @option{-mno-flat} (the default), the compiler generates save/restore
21349 instructions (except for leaf functions).  This is the normal operating mode.
21351 @item -mfpu
21352 @itemx -mhard-float
21353 @opindex mfpu
21354 @opindex mhard-float
21355 Generate output containing floating-point instructions.  This is the
21356 default.
21358 @item -mno-fpu
21359 @itemx -msoft-float
21360 @opindex mno-fpu
21361 @opindex msoft-float
21362 Generate output containing library calls for floating point.
21363 @strong{Warning:} the requisite libraries are not available for all SPARC
21364 targets.  Normally the facilities of the machine's usual C compiler are
21365 used, but this cannot be done directly in cross-compilation.  You must make
21366 your own arrangements to provide suitable library functions for
21367 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21368 @samp{sparclite-*-*} do provide software floating-point support.
21370 @option{-msoft-float} changes the calling convention in the output file;
21371 therefore, it is only useful if you compile @emph{all} of a program with
21372 this option.  In particular, you need to compile @file{libgcc.a}, the
21373 library that comes with GCC, with @option{-msoft-float} in order for
21374 this to work.
21376 @item -mhard-quad-float
21377 @opindex mhard-quad-float
21378 Generate output containing quad-word (long double) floating-point
21379 instructions.
21381 @item -msoft-quad-float
21382 @opindex msoft-quad-float
21383 Generate output containing library calls for quad-word (long double)
21384 floating-point instructions.  The functions called are those specified
21385 in the SPARC ABI@.  This is the default.
21387 As of this writing, there are no SPARC implementations that have hardware
21388 support for the quad-word floating-point instructions.  They all invoke
21389 a trap handler for one of these instructions, and then the trap handler
21390 emulates the effect of the instruction.  Because of the trap handler overhead,
21391 this is much slower than calling the ABI library routines.  Thus the
21392 @option{-msoft-quad-float} option is the default.
21394 @item -mno-unaligned-doubles
21395 @itemx -munaligned-doubles
21396 @opindex mno-unaligned-doubles
21397 @opindex munaligned-doubles
21398 Assume that doubles have 8-byte alignment.  This is the default.
21400 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21401 alignment only if they are contained in another type, or if they have an
21402 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21403 Specifying this option avoids some rare compatibility problems with code
21404 generated by other compilers.  It is not the default because it results
21405 in a performance loss, especially for floating-point code.
21407 @item -muser-mode
21408 @itemx -mno-user-mode
21409 @opindex muser-mode
21410 @opindex mno-user-mode
21411 Do not generate code that can only run in supervisor mode.  This is relevant
21412 only for the @code{casa} instruction emitted for the LEON3 processor.  This
21413 is the default.
21415 @item -mno-faster-structs
21416 @itemx -mfaster-structs
21417 @opindex mno-faster-structs
21418 @opindex mfaster-structs
21419 With @option{-mfaster-structs}, the compiler assumes that structures
21420 should have 8-byte alignment.  This enables the use of pairs of
21421 @code{ldd} and @code{std} instructions for copies in structure
21422 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21423 However, the use of this changed alignment directly violates the SPARC
21424 ABI@.  Thus, it's intended only for use on targets where the developer
21425 acknowledges that their resulting code is not directly in line with
21426 the rules of the ABI@.
21428 @item -mcpu=@var{cpu_type}
21429 @opindex mcpu
21430 Set the instruction set, register set, and instruction scheduling parameters
21431 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21432 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21433 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21434 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21435 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21436 @samp{niagara3} and @samp{niagara4}.
21438 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21439 which selects the best architecture option for the host processor.
21440 @option{-mcpu=native} has no effect if GCC does not recognize
21441 the processor.
21443 Default instruction scheduling parameters are used for values that select
21444 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21445 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21447 Here is a list of each supported architecture and their supported
21448 implementations.
21450 @table @asis
21451 @item v7
21452 cypress, leon3v7
21454 @item v8
21455 supersparc, hypersparc, leon, leon3
21457 @item sparclite
21458 f930, f934, sparclite86x
21460 @item sparclet
21461 tsc701
21463 @item v9
21464 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21465 @end table
21467 By default (unless configured otherwise), GCC generates code for the V7
21468 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21469 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21470 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21471 SPARCStation 1, 2, IPX etc.
21473 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21474 architecture.  The only difference from V7 code is that the compiler emits
21475 the integer multiply and integer divide instructions which exist in SPARC-V8
21476 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21477 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21478 2000 series.
21480 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21481 the SPARC architecture.  This adds the integer multiply, integer divide step
21482 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21483 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21484 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21485 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21486 MB86934 chip, which is the more recent SPARClite with FPU@.
21488 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21489 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21490 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21491 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21492 optimizes it for the TEMIC SPARClet chip.
21494 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21495 architecture.  This adds 64-bit integer and floating-point move instructions,
21496 3 additional floating-point condition code registers and conditional move
21497 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21498 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21499 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21500 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21501 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21502 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21503 additionally optimizes it for Sun UltraSPARC T2 chips. With
21504 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21505 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21506 additionally optimizes it for Sun UltraSPARC T4 chips.
21508 @item -mtune=@var{cpu_type}
21509 @opindex mtune
21510 Set the instruction scheduling parameters for machine type
21511 @var{cpu_type}, but do not set the instruction set or register set that the
21512 option @option{-mcpu=@var{cpu_type}} does.
21514 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21515 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21516 that select a particular CPU implementation.  Those are @samp{cypress},
21517 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21518 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21519 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21520 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21521 toolchains, @samp{native} can also be used.
21523 @item -mv8plus
21524 @itemx -mno-v8plus
21525 @opindex mv8plus
21526 @opindex mno-v8plus
21527 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21528 difference from the V8 ABI is that the global and out registers are
21529 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21530 mode for all SPARC-V9 processors.
21532 @item -mvis
21533 @itemx -mno-vis
21534 @opindex mvis
21535 @opindex mno-vis
21536 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21537 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21539 @item -mvis2
21540 @itemx -mno-vis2
21541 @opindex mvis2
21542 @opindex mno-vis2
21543 With @option{-mvis2}, GCC generates code that takes advantage of
21544 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21545 default is @option{-mvis2} when targeting a cpu that supports such
21546 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21547 also sets @option{-mvis}.
21549 @item -mvis3
21550 @itemx -mno-vis3
21551 @opindex mvis3
21552 @opindex mno-vis3
21553 With @option{-mvis3}, GCC generates code that takes advantage of
21554 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21555 default is @option{-mvis3} when targeting a cpu that supports such
21556 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21557 also sets @option{-mvis2} and @option{-mvis}.
21559 @item -mcbcond
21560 @itemx -mno-cbcond
21561 @opindex mcbcond
21562 @opindex mno-cbcond
21563 With @option{-mcbcond}, GCC generates code that takes advantage of
21564 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21565 The default is @option{-mcbcond} when targeting a cpu that supports such
21566 instructions, such as niagara-4 and later.
21568 @item -mpopc
21569 @itemx -mno-popc
21570 @opindex mpopc
21571 @opindex mno-popc
21572 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21573 population count instruction.  The default is @option{-mpopc}
21574 when targeting a cpu that supports such instructions, such as Niagara-2 and
21575 later.
21577 @item -mfmaf
21578 @itemx -mno-fmaf
21579 @opindex mfmaf
21580 @opindex mno-fmaf
21581 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21582 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21583 when targeting a cpu that supports such instructions, such as Niagara-3 and
21584 later.
21586 @item -mfix-at697f
21587 @opindex mfix-at697f
21588 Enable the documented workaround for the single erratum of the Atmel AT697F
21589 processor (which corresponds to erratum #13 of the AT697E processor).
21591 @item -mfix-ut699
21592 @opindex mfix-ut699
21593 Enable the documented workarounds for the floating-point errata and the data
21594 cache nullify errata of the UT699 processor.
21595 @end table
21597 These @samp{-m} options are supported in addition to the above
21598 on SPARC-V9 processors in 64-bit environments:
21600 @table @gcctabopt
21601 @item -m32
21602 @itemx -m64
21603 @opindex m32
21604 @opindex m64
21605 Generate code for a 32-bit or 64-bit environment.
21606 The 32-bit environment sets int, long and pointer to 32 bits.
21607 The 64-bit environment sets int to 32 bits and long and pointer
21608 to 64 bits.
21610 @item -mcmodel=@var{which}
21611 @opindex mcmodel
21612 Set the code model to one of
21614 @table @samp
21615 @item medlow
21616 The Medium/Low code model: 64-bit addresses, programs
21617 must be linked in the low 32 bits of memory.  Programs can be statically
21618 or dynamically linked.
21620 @item medmid
21621 The Medium/Middle code model: 64-bit addresses, programs
21622 must be linked in the low 44 bits of memory, the text and data segments must
21623 be less than 2GB in size and the data segment must be located within 2GB of
21624 the text segment.
21626 @item medany
21627 The Medium/Anywhere code model: 64-bit addresses, programs
21628 may be linked anywhere in memory, the text and data segments must be less
21629 than 2GB in size and the data segment must be located within 2GB of the
21630 text segment.
21632 @item embmedany
21633 The Medium/Anywhere code model for embedded systems:
21634 64-bit addresses, the text and data segments must be less than 2GB in
21635 size, both starting anywhere in memory (determined at link time).  The
21636 global register %g4 points to the base of the data segment.  Programs
21637 are statically linked and PIC is not supported.
21638 @end table
21640 @item -mmemory-model=@var{mem-model}
21641 @opindex mmemory-model
21642 Set the memory model in force on the processor to one of
21644 @table @samp
21645 @item default
21646 The default memory model for the processor and operating system.
21648 @item rmo
21649 Relaxed Memory Order
21651 @item pso
21652 Partial Store Order
21654 @item tso
21655 Total Store Order
21657 @item sc
21658 Sequential Consistency
21659 @end table
21661 These memory models are formally defined in Appendix D of the Sparc V9
21662 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21664 @item -mstack-bias
21665 @itemx -mno-stack-bias
21666 @opindex mstack-bias
21667 @opindex mno-stack-bias
21668 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21669 frame pointer if present, are offset by @minus{}2047 which must be added back
21670 when making stack frame references.  This is the default in 64-bit mode.
21671 Otherwise, assume no such offset is present.
21672 @end table
21674 @node SPU Options
21675 @subsection SPU Options
21676 @cindex SPU options
21678 These @samp{-m} options are supported on the SPU:
21680 @table @gcctabopt
21681 @item -mwarn-reloc
21682 @itemx -merror-reloc
21683 @opindex mwarn-reloc
21684 @opindex merror-reloc
21686 The loader for SPU does not handle dynamic relocations.  By default, GCC
21687 gives an error when it generates code that requires a dynamic
21688 relocation.  @option{-mno-error-reloc} disables the error,
21689 @option{-mwarn-reloc} generates a warning instead.
21691 @item -msafe-dma
21692 @itemx -munsafe-dma
21693 @opindex msafe-dma
21694 @opindex munsafe-dma
21696 Instructions that initiate or test completion of DMA must not be
21697 reordered with respect to loads and stores of the memory that is being
21698 accessed.
21699 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21700 memory accesses, but that can lead to inefficient code in places where the
21701 memory is known to not change.  Rather than mark the memory as volatile,
21702 you can use @option{-msafe-dma} to tell the compiler to treat
21703 the DMA instructions as potentially affecting all memory.  
21705 @item -mbranch-hints
21706 @opindex mbranch-hints
21708 By default, GCC generates a branch hint instruction to avoid
21709 pipeline stalls for always-taken or probably-taken branches.  A hint
21710 is not generated closer than 8 instructions away from its branch.
21711 There is little reason to disable them, except for debugging purposes,
21712 or to make an object a little bit smaller.
21714 @item -msmall-mem
21715 @itemx -mlarge-mem
21716 @opindex msmall-mem
21717 @opindex mlarge-mem
21719 By default, GCC generates code assuming that addresses are never larger
21720 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21721 a full 32-bit address.
21723 @item -mstdmain
21724 @opindex mstdmain
21726 By default, GCC links against startup code that assumes the SPU-style
21727 main function interface (which has an unconventional parameter list).
21728 With @option{-mstdmain}, GCC links your program against startup
21729 code that assumes a C99-style interface to @code{main}, including a
21730 local copy of @code{argv} strings.
21732 @item -mfixed-range=@var{register-range}
21733 @opindex mfixed-range
21734 Generate code treating the given register range as fixed registers.
21735 A fixed register is one that the register allocator cannot use.  This is
21736 useful when compiling kernel code.  A register range is specified as
21737 two registers separated by a dash.  Multiple register ranges can be
21738 specified separated by a comma.
21740 @item -mea32
21741 @itemx -mea64
21742 @opindex mea32
21743 @opindex mea64
21744 Compile code assuming that pointers to the PPU address space accessed
21745 via the @code{__ea} named address space qualifier are either 32 or 64
21746 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21747 all object code in an executable must be compiled with the same setting.
21749 @item -maddress-space-conversion
21750 @itemx -mno-address-space-conversion
21751 @opindex maddress-space-conversion
21752 @opindex mno-address-space-conversion
21753 Allow/disallow treating the @code{__ea} address space as superset
21754 of the generic address space.  This enables explicit type casts
21755 between @code{__ea} and generic pointer as well as implicit
21756 conversions of generic pointers to @code{__ea} pointers.  The
21757 default is to allow address space pointer conversions.
21759 @item -mcache-size=@var{cache-size}
21760 @opindex mcache-size
21761 This option controls the version of libgcc that the compiler links to an
21762 executable and selects a software-managed cache for accessing variables
21763 in the @code{__ea} address space with a particular cache size.  Possible
21764 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21765 and @samp{128}.  The default cache size is 64KB.
21767 @item -matomic-updates
21768 @itemx -mno-atomic-updates
21769 @opindex matomic-updates
21770 @opindex mno-atomic-updates
21771 This option controls the version of libgcc that the compiler links to an
21772 executable and selects whether atomic updates to the software-managed
21773 cache of PPU-side variables are used.  If you use atomic updates, changes
21774 to a PPU variable from SPU code using the @code{__ea} named address space
21775 qualifier do not interfere with changes to other PPU variables residing
21776 in the same cache line from PPU code.  If you do not use atomic updates,
21777 such interference may occur; however, writing back cache lines is
21778 more efficient.  The default behavior is to use atomic updates.
21780 @item -mdual-nops
21781 @itemx -mdual-nops=@var{n}
21782 @opindex mdual-nops
21783 By default, GCC inserts nops to increase dual issue when it expects
21784 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21785 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21786 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21788 @item -mhint-max-nops=@var{n}
21789 @opindex mhint-max-nops
21790 Maximum number of nops to insert for a branch hint.  A branch hint must
21791 be at least 8 instructions away from the branch it is affecting.  GCC
21792 inserts up to @var{n} nops to enforce this, otherwise it does not
21793 generate the branch hint.
21795 @item -mhint-max-distance=@var{n}
21796 @opindex mhint-max-distance
21797 The encoding of the branch hint instruction limits the hint to be within
21798 256 instructions of the branch it is affecting.  By default, GCC makes
21799 sure it is within 125.
21801 @item -msafe-hints
21802 @opindex msafe-hints
21803 Work around a hardware bug that causes the SPU to stall indefinitely.
21804 By default, GCC inserts the @code{hbrp} instruction to make sure
21805 this stall won't happen.
21807 @end table
21809 @node System V Options
21810 @subsection Options for System V
21812 These additional options are available on System V Release 4 for
21813 compatibility with other compilers on those systems:
21815 @table @gcctabopt
21816 @item -G
21817 @opindex G
21818 Create a shared object.
21819 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21821 @item -Qy
21822 @opindex Qy
21823 Identify the versions of each tool used by the compiler, in a
21824 @code{.ident} assembler directive in the output.
21826 @item -Qn
21827 @opindex Qn
21828 Refrain from adding @code{.ident} directives to the output file (this is
21829 the default).
21831 @item -YP,@var{dirs}
21832 @opindex YP
21833 Search the directories @var{dirs}, and no others, for libraries
21834 specified with @option{-l}.
21836 @item -Ym,@var{dir}
21837 @opindex Ym
21838 Look in the directory @var{dir} to find the M4 preprocessor.
21839 The assembler uses this option.
21840 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21841 @c the generic assembler that comes with Solaris takes just -Ym.
21842 @end table
21844 @node TILE-Gx Options
21845 @subsection TILE-Gx Options
21846 @cindex TILE-Gx options
21848 These @samp{-m} options are supported on the TILE-Gx:
21850 @table @gcctabopt
21851 @item -mcmodel=small
21852 @opindex mcmodel=small
21853 Generate code for the small model.  The distance for direct calls is
21854 limited to 500M in either direction.  PC-relative addresses are 32
21855 bits.  Absolute addresses support the full address range.
21857 @item -mcmodel=large
21858 @opindex mcmodel=large
21859 Generate code for the large model.  There is no limitation on call
21860 distance, pc-relative addresses, or absolute addresses.
21862 @item -mcpu=@var{name}
21863 @opindex mcpu
21864 Selects the type of CPU to be targeted.  Currently the only supported
21865 type is @samp{tilegx}.
21867 @item -m32
21868 @itemx -m64
21869 @opindex m32
21870 @opindex m64
21871 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21872 environment sets int, long, and pointer to 32 bits.  The 64-bit
21873 environment sets int to 32 bits and long and pointer to 64 bits.
21875 @item -mbig-endian
21876 @itemx -mlittle-endian
21877 @opindex mbig-endian
21878 @opindex mlittle-endian
21879 Generate code in big/little endian mode, respectively.
21880 @end table
21882 @node TILEPro Options
21883 @subsection TILEPro Options
21884 @cindex TILEPro options
21886 These @samp{-m} options are supported on the TILEPro:
21888 @table @gcctabopt
21889 @item -mcpu=@var{name}
21890 @opindex mcpu
21891 Selects the type of CPU to be targeted.  Currently the only supported
21892 type is @samp{tilepro}.
21894 @item -m32
21895 @opindex m32
21896 Generate code for a 32-bit environment, which sets int, long, and
21897 pointer to 32 bits.  This is the only supported behavior so the flag
21898 is essentially ignored.
21899 @end table
21901 @node V850 Options
21902 @subsection V850 Options
21903 @cindex V850 Options
21905 These @samp{-m} options are defined for V850 implementations:
21907 @table @gcctabopt
21908 @item -mlong-calls
21909 @itemx -mno-long-calls
21910 @opindex mlong-calls
21911 @opindex mno-long-calls
21912 Treat all calls as being far away (near).  If calls are assumed to be
21913 far away, the compiler always loads the function's address into a
21914 register, and calls indirect through the pointer.
21916 @item -mno-ep
21917 @itemx -mep
21918 @opindex mno-ep
21919 @opindex mep
21920 Do not optimize (do optimize) basic blocks that use the same index
21921 pointer 4 or more times to copy pointer into the @code{ep} register, and
21922 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21923 option is on by default if you optimize.
21925 @item -mno-prolog-function
21926 @itemx -mprolog-function
21927 @opindex mno-prolog-function
21928 @opindex mprolog-function
21929 Do not use (do use) external functions to save and restore registers
21930 at the prologue and epilogue of a function.  The external functions
21931 are slower, but use less code space if more than one function saves
21932 the same number of registers.  The @option{-mprolog-function} option
21933 is on by default if you optimize.
21935 @item -mspace
21936 @opindex mspace
21937 Try to make the code as small as possible.  At present, this just turns
21938 on the @option{-mep} and @option{-mprolog-function} options.
21940 @item -mtda=@var{n}
21941 @opindex mtda
21942 Put static or global variables whose size is @var{n} bytes or less into
21943 the tiny data area that register @code{ep} points to.  The tiny data
21944 area can hold up to 256 bytes in total (128 bytes for byte references).
21946 @item -msda=@var{n}
21947 @opindex msda
21948 Put static or global variables whose size is @var{n} bytes or less into
21949 the small data area that register @code{gp} points to.  The small data
21950 area can hold up to 64 kilobytes.
21952 @item -mzda=@var{n}
21953 @opindex mzda
21954 Put static or global variables whose size is @var{n} bytes or less into
21955 the first 32 kilobytes of memory.
21957 @item -mv850
21958 @opindex mv850
21959 Specify that the target processor is the V850.
21961 @item -mv850e3v5
21962 @opindex mv850e3v5
21963 Specify that the target processor is the V850E3V5.  The preprocessor
21964 constant @code{__v850e3v5__} is defined if this option is used.
21966 @item -mv850e2v4
21967 @opindex mv850e2v4
21968 Specify that the target processor is the V850E3V5.  This is an alias for
21969 the @option{-mv850e3v5} option.
21971 @item -mv850e2v3
21972 @opindex mv850e2v3
21973 Specify that the target processor is the V850E2V3.  The preprocessor
21974 constant @code{__v850e2v3__} is defined if this option is used.
21976 @item -mv850e2
21977 @opindex mv850e2
21978 Specify that the target processor is the V850E2.  The preprocessor
21979 constant @code{__v850e2__} is defined if this option is used.
21981 @item -mv850e1
21982 @opindex mv850e1
21983 Specify that the target processor is the V850E1.  The preprocessor
21984 constants @code{__v850e1__} and @code{__v850e__} are defined if
21985 this option is used.
21987 @item -mv850es
21988 @opindex mv850es
21989 Specify that the target processor is the V850ES.  This is an alias for
21990 the @option{-mv850e1} option.
21992 @item -mv850e
21993 @opindex mv850e
21994 Specify that the target processor is the V850E@.  The preprocessor
21995 constant @code{__v850e__} is defined if this option is used.
21997 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21998 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21999 are defined then a default target processor is chosen and the
22000 relevant @samp{__v850*__} preprocessor constant is defined.
22002 The preprocessor constants @code{__v850} and @code{__v851__} are always
22003 defined, regardless of which processor variant is the target.
22005 @item -mdisable-callt
22006 @itemx -mno-disable-callt
22007 @opindex mdisable-callt
22008 @opindex mno-disable-callt
22009 This option suppresses generation of the @code{CALLT} instruction for the
22010 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22011 architecture.
22013 This option is enabled by default when the RH850 ABI is
22014 in use (see @option{-mrh850-abi}), and disabled by default when the
22015 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22016 then the C preprocessor symbol @code{__V850_CALLT__} is defined.
22018 @item -mrelax
22019 @itemx -mno-relax
22020 @opindex mrelax
22021 @opindex mno-relax
22022 Pass on (or do not pass on) the @option{-mrelax} command-line option
22023 to the assembler.
22025 @item -mlong-jumps
22026 @itemx -mno-long-jumps
22027 @opindex mlong-jumps
22028 @opindex mno-long-jumps
22029 Disable (or re-enable) the generation of PC-relative jump instructions.
22031 @item -msoft-float
22032 @itemx -mhard-float
22033 @opindex msoft-float
22034 @opindex mhard-float
22035 Disable (or re-enable) the generation of hardware floating point
22036 instructions.  This option is only significant when the target
22037 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22038 instructions are being generated then the C preprocessor symbol
22039 @code{__FPU_OK__} is defined, otherwise the symbol
22040 @code{__NO_FPU__} is defined.
22042 @item -mloop
22043 @opindex mloop
22044 Enables the use of the e3v5 LOOP instruction.  The use of this
22045 instruction is not enabled by default when the e3v5 architecture is
22046 selected because its use is still experimental.
22048 @item -mrh850-abi
22049 @itemx -mghs
22050 @opindex mrh850-abi
22051 @opindex mghs
22052 Enables support for the RH850 version of the V850 ABI.  This is the
22053 default.  With this version of the ABI the following rules apply:
22055 @itemize
22056 @item
22057 Integer sized structures and unions are returned via a memory pointer
22058 rather than a register.
22060 @item
22061 Large structures and unions (more than 8 bytes in size) are passed by
22062 value.
22064 @item
22065 Functions are aligned to 16-bit boundaries.
22067 @item
22068 The @option{-m8byte-align} command-line option is supported.
22070 @item
22071 The @option{-mdisable-callt} command-line option is enabled by
22072 default.  The @option{-mno-disable-callt} command-line option is not
22073 supported.
22074 @end itemize
22076 When this version of the ABI is enabled the C preprocessor symbol
22077 @code{__V850_RH850_ABI__} is defined.
22079 @item -mgcc-abi
22080 @opindex mgcc-abi
22081 Enables support for the old GCC version of the V850 ABI.  With this
22082 version of the ABI the following rules apply:
22084 @itemize
22085 @item
22086 Integer sized structures and unions are returned in register @code{r10}.
22088 @item
22089 Large structures and unions (more than 8 bytes in size) are passed by
22090 reference.
22092 @item
22093 Functions are aligned to 32-bit boundaries, unless optimizing for
22094 size.
22096 @item
22097 The @option{-m8byte-align} command-line option is not supported.
22099 @item
22100 The @option{-mdisable-callt} command-line option is supported but not
22101 enabled by default.
22102 @end itemize
22104 When this version of the ABI is enabled the C preprocessor symbol
22105 @code{__V850_GCC_ABI__} is defined.
22107 @item -m8byte-align
22108 @itemx -mno-8byte-align
22109 @opindex m8byte-align
22110 @opindex mno-8byte-align
22111 Enables support for @code{double} and @code{long long} types to be
22112 aligned on 8-byte boundaries.  The default is to restrict the
22113 alignment of all objects to at most 4-bytes.  When
22114 @option{-m8byte-align} is in effect the C preprocessor symbol
22115 @code{__V850_8BYTE_ALIGN__} is defined.
22117 @item -mbig-switch
22118 @opindex mbig-switch
22119 Generate code suitable for big switch tables.  Use this option only if
22120 the assembler/linker complain about out of range branches within a switch
22121 table.
22123 @item -mapp-regs
22124 @opindex mapp-regs
22125 This option causes r2 and r5 to be used in the code generated by
22126 the compiler.  This setting is the default.
22128 @item -mno-app-regs
22129 @opindex mno-app-regs
22130 This option causes r2 and r5 to be treated as fixed registers.
22132 @end table
22134 @node VAX Options
22135 @subsection VAX Options
22136 @cindex VAX options
22138 These @samp{-m} options are defined for the VAX:
22140 @table @gcctabopt
22141 @item -munix
22142 @opindex munix
22143 Do not output certain jump instructions (@code{aobleq} and so on)
22144 that the Unix assembler for the VAX cannot handle across long
22145 ranges.
22147 @item -mgnu
22148 @opindex mgnu
22149 Do output those jump instructions, on the assumption that the
22150 GNU assembler is being used.
22152 @item -mg
22153 @opindex mg
22154 Output code for G-format floating-point numbers instead of D-format.
22155 @end table
22157 @node Visium Options
22158 @subsection Visium Options
22159 @cindex Visium options
22161 @table @gcctabopt
22163 @item -mdebug
22164 @opindex mdebug
22165 A program which performs file I/O and is destined to run on an MCM target
22166 should be linked with this option.  It causes the libraries libc.a and
22167 libdebug.a to be linked.  The program should be run on the target under
22168 the control of the GDB remote debugging stub.
22170 @item -msim
22171 @opindex msim
22172 A program which performs file I/O and is destined to run on the simulator
22173 should be linked with option.  This causes libraries libc.a and libsim.a to
22174 be linked.
22176 @item -mfpu
22177 @itemx -mhard-float
22178 @opindex mfpu
22179 @opindex mhard-float
22180 Generate code containing floating-point instructions.  This is the
22181 default.
22183 @item -mno-fpu
22184 @itemx -msoft-float
22185 @opindex mno-fpu
22186 @opindex msoft-float
22187 Generate code containing library calls for floating-point.
22189 @option{-msoft-float} changes the calling convention in the output file;
22190 therefore, it is only useful if you compile @emph{all} of a program with
22191 this option.  In particular, you need to compile @file{libgcc.a}, the
22192 library that comes with GCC, with @option{-msoft-float} in order for
22193 this to work.
22195 @item -mcpu=@var{cpu_type}
22196 @opindex mcpu
22197 Set the instruction set, register set, and instruction scheduling parameters
22198 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
22199 @samp{mcm}, @samp{gr5} and @samp{gr6}.
22201 @samp{mcm} is a synonym of @samp{gr5} present for backward compatibility.
22203 By default (unless configured otherwise), GCC generates code for the GR5
22204 variant of the Visium architecture.  
22206 With @option{-mcpu=gr6}, GCC generates code for the GR6 variant of the Visium
22207 architecture.  The only difference from GR5 code is that the compiler will
22208 generate block move instructions.
22210 @item -mtune=@var{cpu_type}
22211 @opindex mtune
22212 Set the instruction scheduling parameters for machine type @var{cpu_type},
22213 but do not set the instruction set or register set that the option
22214 @option{-mcpu=@var{cpu_type}} would.
22216 @item -msv-mode
22217 @opindex msv-mode
22218 Generate code for the supervisor mode, where there are no restrictions on
22219 the access to general registers.  This is the default.
22221 @item -muser-mode
22222 @opindex muser-mode
22223 Generate code for the user mode, where the access to some general registers
22224 is forbidden: on the GR5, registers r24 to r31 cannot be accessed in this
22225 mode; on the GR6, only registers r29 to r31 are affected.
22226 @end table
22228 @node VMS Options
22229 @subsection VMS Options
22231 These @samp{-m} options are defined for the VMS implementations:
22233 @table @gcctabopt
22234 @item -mvms-return-codes
22235 @opindex mvms-return-codes
22236 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22237 condition (e.g.@ error) codes.
22239 @item -mdebug-main=@var{prefix}
22240 @opindex mdebug-main=@var{prefix}
22241 Flag the first routine whose name starts with @var{prefix} as the main
22242 routine for the debugger.
22244 @item -mmalloc64
22245 @opindex mmalloc64
22246 Default to 64-bit memory allocation routines.
22248 @item -mpointer-size=@var{size}
22249 @opindex mpointer-size=@var{size}
22250 Set the default size of pointers. Possible options for @var{size} are
22251 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22252 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22253 The later option disables @code{pragma pointer_size}.
22254 @end table
22256 @node VxWorks Options
22257 @subsection VxWorks Options
22258 @cindex VxWorks Options
22260 The options in this section are defined for all VxWorks targets.
22261 Options specific to the target hardware are listed with the other
22262 options for that target.
22264 @table @gcctabopt
22265 @item -mrtp
22266 @opindex mrtp
22267 GCC can generate code for both VxWorks kernels and real time processes
22268 (RTPs).  This option switches from the former to the latter.  It also
22269 defines the preprocessor macro @code{__RTP__}.
22271 @item -non-static
22272 @opindex non-static
22273 Link an RTP executable against shared libraries rather than static
22274 libraries.  The options @option{-static} and @option{-shared} can
22275 also be used for RTPs (@pxref{Link Options}); @option{-static}
22276 is the default.
22278 @item -Bstatic
22279 @itemx -Bdynamic
22280 @opindex Bstatic
22281 @opindex Bdynamic
22282 These options are passed down to the linker.  They are defined for
22283 compatibility with Diab.
22285 @item -Xbind-lazy
22286 @opindex Xbind-lazy
22287 Enable lazy binding of function calls.  This option is equivalent to
22288 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22290 @item -Xbind-now
22291 @opindex Xbind-now
22292 Disable lazy binding of function calls.  This option is the default and
22293 is defined for compatibility with Diab.
22294 @end table
22296 @node x86 Options
22297 @subsection x86 Options
22298 @cindex x86 Options
22300 These @samp{-m} options are defined for the x86 family of computers.
22302 @table @gcctabopt
22304 @item -march=@var{cpu-type}
22305 @opindex march
22306 Generate instructions for the machine type @var{cpu-type}.  In contrast to
22307 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
22308 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
22309 to generate code that may not run at all on processors other than the one
22310 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
22311 @option{-mtune=@var{cpu-type}}.
22313 The choices for @var{cpu-type} are:
22315 @table @samp
22316 @item native
22317 This selects the CPU to generate code for at compilation time by determining
22318 the processor type of the compiling machine.  Using @option{-march=native}
22319 enables all instruction subsets supported by the local machine (hence
22320 the result might not run on different machines).  Using @option{-mtune=native}
22321 produces code optimized for the local machine under the constraints
22322 of the selected instruction set.  
22324 @item i386
22325 Original Intel i386 CPU@.
22327 @item i486
22328 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
22330 @item i586
22331 @itemx pentium
22332 Intel Pentium CPU with no MMX support.
22334 @item lakemont
22335 Intel Lakemont MCU, based on Intel Pentium CPU.
22337 @item pentium-mmx
22338 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
22340 @item pentiumpro
22341 Intel Pentium Pro CPU@.
22343 @item i686
22344 When used with @option{-march}, the Pentium Pro
22345 instruction set is used, so the code runs on all i686 family chips.
22346 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
22348 @item pentium2
22349 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
22350 support.
22352 @item pentium3
22353 @itemx pentium3m
22354 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
22355 set support.
22357 @item pentium-m
22358 Intel Pentium M; low-power version of Intel Pentium III CPU
22359 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
22361 @item pentium4
22362 @itemx pentium4m
22363 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
22365 @item prescott
22366 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
22367 set support.
22369 @item nocona
22370 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
22371 SSE2 and SSE3 instruction set support.
22373 @item core2
22374 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
22375 instruction set support.
22377 @item nehalem
22378 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22379 SSE4.1, SSE4.2 and POPCNT instruction set support.
22381 @item westmere
22382 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22383 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
22385 @item sandybridge
22386 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22387 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
22389 @item ivybridge
22390 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
22391 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
22392 instruction set support.
22394 @item haswell
22395 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22396 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22397 BMI, BMI2 and F16C instruction set support.
22399 @item broadwell
22400 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22401 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22402 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
22404 @item skylake
22405 Intel Skylake CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22406 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22407 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC and
22408 XSAVES instruction set support.
22410 @item bonnell
22411 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
22412 instruction set support.
22414 @item silvermont
22415 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
22416 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
22418 @item knl
22419 Intel Knight's Landing CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22420 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22421 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, AVX512F, AVX512PF, AVX512ER and
22422 AVX512CD instruction set support.
22424 @item skylake-avx512
22425 Intel Skylake Server CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3,
22426 SSSE3, SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
22427 BMI, BMI2, F16C, RDSEED, ADCX, PREFETCHW, CLFLUSHOPT, XSAVEC, XSAVES, AVX512F,
22428 AVX512VL, AVX512BW, AVX512DQ and AVX512CD instruction set support.
22430 @item k6
22431 AMD K6 CPU with MMX instruction set support.
22433 @item k6-2
22434 @itemx k6-3
22435 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
22437 @item athlon
22438 @itemx athlon-tbird
22439 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
22440 support.
22442 @item athlon-4
22443 @itemx athlon-xp
22444 @itemx athlon-mp
22445 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
22446 instruction set support.
22448 @item k8
22449 @itemx opteron
22450 @itemx athlon64
22451 @itemx athlon-fx
22452 Processors based on the AMD K8 core with x86-64 instruction set support,
22453 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
22454 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
22455 instruction set extensions.)
22457 @item k8-sse3
22458 @itemx opteron-sse3
22459 @itemx athlon64-sse3
22460 Improved versions of AMD K8 cores with SSE3 instruction set support.
22462 @item amdfam10
22463 @itemx barcelona
22464 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
22465 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
22466 instruction set extensions.)
22468 @item bdver1
22469 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
22470 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
22471 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
22472 @item bdver2
22473 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22474 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
22475 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
22476 extensions.)
22477 @item bdver3
22478 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22479 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
22480 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
22481 64-bit instruction set extensions.
22482 @item bdver4
22483 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
22484 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
22485 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
22486 SSE4.2, ABM and 64-bit instruction set extensions.
22488 @item znver1
22489 AMD Family 17h core based CPUs with x86-64 instruction set support.  (This
22490 supersets BMI, BMI2, F16C, FMA, FSGSBASE, AVX, AVX2, ADCX, RDSEED, MWAITX,
22491 SHA, CLZERO, AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3,
22492 SSE4.1, SSE4.2, ABM, XSAVEC, XSAVES, CLFLUSHOPT, POPCNT, and 64-bit
22493 instruction set extensions.
22495 @item btver1
22496 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
22497 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
22498 instruction set extensions.)
22500 @item btver2
22501 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
22502 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
22503 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
22505 @item winchip-c6
22506 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
22507 set support.
22509 @item winchip2
22510 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
22511 instruction set support.
22513 @item c3
22514 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
22515 implemented for this chip.)
22517 @item c3-2
22518 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
22519 (No scheduling is
22520 implemented for this chip.)
22522 @item geode
22523 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
22524 @end table
22526 @item -mtune=@var{cpu-type}
22527 @opindex mtune
22528 Tune to @var{cpu-type} everything applicable about the generated code, except
22529 for the ABI and the set of available instructions.  
22530 While picking a specific @var{cpu-type} schedules things appropriately
22531 for that particular chip, the compiler does not generate any code that
22532 cannot run on the default machine type unless you use a
22533 @option{-march=@var{cpu-type}} option.
22534 For example, if GCC is configured for i686-pc-linux-gnu
22535 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
22536 but still runs on i686 machines.
22538 The choices for @var{cpu-type} are the same as for @option{-march}.
22539 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
22541 @table @samp
22542 @item generic
22543 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
22544 If you know the CPU on which your code will run, then you should use
22545 the corresponding @option{-mtune} or @option{-march} option instead of
22546 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
22547 of your application will have, then you should use this option.
22549 As new processors are deployed in the marketplace, the behavior of this
22550 option will change.  Therefore, if you upgrade to a newer version of
22551 GCC, code generation controlled by this option will change to reflect
22552 the processors
22553 that are most common at the time that version of GCC is released.
22555 There is no @option{-march=generic} option because @option{-march}
22556 indicates the instruction set the compiler can use, and there is no
22557 generic instruction set applicable to all processors.  In contrast,
22558 @option{-mtune} indicates the processor (or, in this case, collection of
22559 processors) for which the code is optimized.
22561 @item intel
22562 Produce code optimized for the most current Intel processors, which are
22563 Haswell and Silvermont for this version of GCC.  If you know the CPU
22564 on which your code will run, then you should use the corresponding
22565 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
22566 But, if you want your application performs better on both Haswell and
22567 Silvermont, then you should use this option.
22569 As new Intel processors are deployed in the marketplace, the behavior of
22570 this option will change.  Therefore, if you upgrade to a newer version of
22571 GCC, code generation controlled by this option will change to reflect
22572 the most current Intel processors at the time that version of GCC is
22573 released.
22575 There is no @option{-march=intel} option because @option{-march} indicates
22576 the instruction set the compiler can use, and there is no common
22577 instruction set applicable to all processors.  In contrast,
22578 @option{-mtune} indicates the processor (or, in this case, collection of
22579 processors) for which the code is optimized.
22580 @end table
22582 @item -mcpu=@var{cpu-type}
22583 @opindex mcpu
22584 A deprecated synonym for @option{-mtune}.
22586 @item -mfpmath=@var{unit}
22587 @opindex mfpmath
22588 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
22589 for @var{unit} are:
22591 @table @samp
22592 @item 387
22593 Use the standard 387 floating-point coprocessor present on the majority of chips and
22594 emulated otherwise.  Code compiled with this option runs almost everywhere.
22595 The temporary results are computed in 80-bit precision instead of the precision
22596 specified by the type, resulting in slightly different results compared to most
22597 of other chips.  See @option{-ffloat-store} for more detailed description.
22599 This is the default choice for x86-32 targets.
22601 @item sse
22602 Use scalar floating-point instructions present in the SSE instruction set.
22603 This instruction set is supported by Pentium III and newer chips,
22604 and in the AMD line
22605 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
22606 instruction set supports only single-precision arithmetic, thus the double and
22607 extended-precision arithmetic are still done using 387.  A later version, present
22608 only in Pentium 4 and AMD x86-64 chips, supports double-precision
22609 arithmetic too.
22611 For the x86-32 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
22612 or @option{-msse2} switches to enable SSE extensions and make this option
22613 effective.  For the x86-64 compiler, these extensions are enabled by default.
22615 The resulting code should be considerably faster in the majority of cases and avoid
22616 the numerical instability problems of 387 code, but may break some existing
22617 code that expects temporaries to be 80 bits.
22619 This is the default choice for the x86-64 compiler.
22621 @item sse,387
22622 @itemx sse+387
22623 @itemx both
22624 Attempt to utilize both instruction sets at once.  This effectively doubles the
22625 amount of available registers, and on chips with separate execution units for
22626 387 and SSE the execution resources too.  Use this option with care, as it is
22627 still experimental, because the GCC register allocator does not model separate
22628 functional units well, resulting in unstable performance.
22629 @end table
22631 @item -masm=@var{dialect}
22632 @opindex masm=@var{dialect}
22633 Output assembly instructions using selected @var{dialect}.  Also affects
22634 which dialect is used for basic @code{asm} (@pxref{Basic Asm}) and
22635 extended @code{asm} (@pxref{Extended Asm}). Supported choices (in dialect
22636 order) are @samp{att} or @samp{intel}. The default is @samp{att}. Darwin does
22637 not support @samp{intel}.
22639 @item -mieee-fp
22640 @itemx -mno-ieee-fp
22641 @opindex mieee-fp
22642 @opindex mno-ieee-fp
22643 Control whether or not the compiler uses IEEE floating-point
22644 comparisons.  These correctly handle the case where the result of a
22645 comparison is unordered.
22647 @item -msoft-float
22648 @opindex msoft-float
22649 Generate output containing library calls for floating point.
22651 @strong{Warning:} the requisite libraries are not part of GCC@.
22652 Normally the facilities of the machine's usual C compiler are used, but
22653 this can't be done directly in cross-compilation.  You must make your
22654 own arrangements to provide suitable library functions for
22655 cross-compilation.
22657 On machines where a function returns floating-point results in the 80387
22658 register stack, some floating-point opcodes may be emitted even if
22659 @option{-msoft-float} is used.
22661 @item -mno-fp-ret-in-387
22662 @opindex mno-fp-ret-in-387
22663 Do not use the FPU registers for return values of functions.
22665 The usual calling convention has functions return values of types
22666 @code{float} and @code{double} in an FPU register, even if there
22667 is no FPU@.  The idea is that the operating system should emulate
22668 an FPU@.
22670 The option @option{-mno-fp-ret-in-387} causes such values to be returned
22671 in ordinary CPU registers instead.
22673 @item -mno-fancy-math-387
22674 @opindex mno-fancy-math-387
22675 Some 387 emulators do not support the @code{sin}, @code{cos} and
22676 @code{sqrt} instructions for the 387.  Specify this option to avoid
22677 generating those instructions.  This option is the default on
22678 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
22679 indicates that the target CPU always has an FPU and so the
22680 instruction does not need emulation.  These
22681 instructions are not generated unless you also use the
22682 @option{-funsafe-math-optimizations} switch.
22684 @item -malign-double
22685 @itemx -mno-align-double
22686 @opindex malign-double
22687 @opindex mno-align-double
22688 Control whether GCC aligns @code{double}, @code{long double}, and
22689 @code{long long} variables on a two-word boundary or a one-word
22690 boundary.  Aligning @code{double} variables on a two-word boundary
22691 produces code that runs somewhat faster on a Pentium at the
22692 expense of more memory.
22694 On x86-64, @option{-malign-double} is enabled by default.
22696 @strong{Warning:} if you use the @option{-malign-double} switch,
22697 structures containing the above types are aligned differently than
22698 the published application binary interface specifications for the x86-32
22699 and are not binary compatible with structures in code compiled
22700 without that switch.
22702 @item -m96bit-long-double
22703 @itemx -m128bit-long-double
22704 @opindex m96bit-long-double
22705 @opindex m128bit-long-double
22706 These switches control the size of @code{long double} type.  The x86-32
22707 application binary interface specifies the size to be 96 bits,
22708 so @option{-m96bit-long-double} is the default in 32-bit mode.
22710 Modern architectures (Pentium and newer) prefer @code{long double}
22711 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
22712 conforming to the ABI, this is not possible.  So specifying
22713 @option{-m128bit-long-double} aligns @code{long double}
22714 to a 16-byte boundary by padding the @code{long double} with an additional
22715 32-bit zero.
22717 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
22718 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
22720 Notice that neither of these options enable any extra precision over the x87
22721 standard of 80 bits for a @code{long double}.
22723 @strong{Warning:} if you override the default value for your target ABI, this
22724 changes the size of 
22725 structures and arrays containing @code{long double} variables,
22726 as well as modifying the function calling convention for functions taking
22727 @code{long double}.  Hence they are not binary-compatible
22728 with code compiled without that switch.
22730 @item -mlong-double-64
22731 @itemx -mlong-double-80
22732 @itemx -mlong-double-128
22733 @opindex mlong-double-64
22734 @opindex mlong-double-80
22735 @opindex mlong-double-128
22736 These switches control the size of @code{long double} type. A size
22737 of 64 bits makes the @code{long double} type equivalent to the @code{double}
22738 type. This is the default for 32-bit Bionic C library.  A size
22739 of 128 bits makes the @code{long double} type equivalent to the
22740 @code{__float128} type. This is the default for 64-bit Bionic C library.
22742 @strong{Warning:} if you override the default value for your target ABI, this
22743 changes the size of
22744 structures and arrays containing @code{long double} variables,
22745 as well as modifying the function calling convention for functions taking
22746 @code{long double}.  Hence they are not binary-compatible
22747 with code compiled without that switch.
22749 @item -malign-data=@var{type}
22750 @opindex malign-data
22751 Control how GCC aligns variables.  Supported values for @var{type} are
22752 @samp{compat} uses increased alignment value compatible uses GCC 4.8
22753 and earlier, @samp{abi} uses alignment value as specified by the
22754 psABI, and @samp{cacheline} uses increased alignment value to match
22755 the cache line size.  @samp{compat} is the default.
22757 @item -mlarge-data-threshold=@var{threshold}
22758 @opindex mlarge-data-threshold
22759 When @option{-mcmodel=medium} is specified, data objects larger than
22760 @var{threshold} are placed in the large data section.  This value must be the
22761 same across all objects linked into the binary, and defaults to 65535.
22763 @item -mrtd
22764 @opindex mrtd
22765 Use a different function-calling convention, in which functions that
22766 take a fixed number of arguments return with the @code{ret @var{num}}
22767 instruction, which pops their arguments while returning.  This saves one
22768 instruction in the caller since there is no need to pop the arguments
22769 there.
22771 You can specify that an individual function is called with this calling
22772 sequence with the function attribute @code{stdcall}.  You can also
22773 override the @option{-mrtd} option by using the function attribute
22774 @code{cdecl}.  @xref{Function Attributes}.
22776 @strong{Warning:} this calling convention is incompatible with the one
22777 normally used on Unix, so you cannot use it if you need to call
22778 libraries compiled with the Unix compiler.
22780 Also, you must provide function prototypes for all functions that
22781 take variable numbers of arguments (including @code{printf});
22782 otherwise incorrect code is generated for calls to those
22783 functions.
22785 In addition, seriously incorrect code results if you call a
22786 function with too many arguments.  (Normally, extra arguments are
22787 harmlessly ignored.)
22789 @item -mregparm=@var{num}
22790 @opindex mregparm
22791 Control how many registers are used to pass integer arguments.  By
22792 default, no registers are used to pass arguments, and at most 3
22793 registers can be used.  You can control this behavior for a specific
22794 function by using the function attribute @code{regparm}.
22795 @xref{Function Attributes}.
22797 @strong{Warning:} if you use this switch, and
22798 @var{num} is nonzero, then you must build all modules with the same
22799 value, including any libraries.  This includes the system libraries and
22800 startup modules.
22802 @item -msseregparm
22803 @opindex msseregparm
22804 Use SSE register passing conventions for float and double arguments
22805 and return values.  You can control this behavior for a specific
22806 function by using the function attribute @code{sseregparm}.
22807 @xref{Function Attributes}.
22809 @strong{Warning:} if you use this switch then you must build all
22810 modules with the same value, including any libraries.  This includes
22811 the system libraries and startup modules.
22813 @item -mvect8-ret-in-mem
22814 @opindex mvect8-ret-in-mem
22815 Return 8-byte vectors in memory instead of MMX registers.  This is the
22816 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
22817 Studio compilers until version 12.  Later compiler versions (starting
22818 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
22819 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
22820 you need to remain compatible with existing code produced by those
22821 previous compiler versions or older versions of GCC@.
22823 @item -mpc32
22824 @itemx -mpc64
22825 @itemx -mpc80
22826 @opindex mpc32
22827 @opindex mpc64
22828 @opindex mpc80
22830 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
22831 is specified, the significands of results of floating-point operations are
22832 rounded to 24 bits (single precision); @option{-mpc64} rounds the
22833 significands of results of floating-point operations to 53 bits (double
22834 precision) and @option{-mpc80} rounds the significands of results of
22835 floating-point operations to 64 bits (extended double precision), which is
22836 the default.  When this option is used, floating-point operations in higher
22837 precisions are not available to the programmer without setting the FPU
22838 control word explicitly.
22840 Setting the rounding of floating-point operations to less than the default
22841 80 bits can speed some programs by 2% or more.  Note that some mathematical
22842 libraries assume that extended-precision (80-bit) floating-point operations
22843 are enabled by default; routines in such libraries could suffer significant
22844 loss of accuracy, typically through so-called ``catastrophic cancellation'',
22845 when this option is used to set the precision to less than extended precision.
22847 @item -mstackrealign
22848 @opindex mstackrealign
22849 Realign the stack at entry.  On the x86, the @option{-mstackrealign}
22850 option generates an alternate prologue and epilogue that realigns the
22851 run-time stack if necessary.  This supports mixing legacy codes that keep
22852 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
22853 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
22854 applicable to individual functions.
22856 @item -mpreferred-stack-boundary=@var{num}
22857 @opindex mpreferred-stack-boundary
22858 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
22859 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
22860 the default is 4 (16 bytes or 128 bits).
22862 @strong{Warning:} When generating code for the x86-64 architecture with
22863 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
22864 used to keep the stack boundary aligned to 8 byte boundary.  Since
22865 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
22866 intended to be used in controlled environment where stack space is
22867 important limitation.  This option leads to wrong code when functions
22868 compiled with 16 byte stack alignment (such as functions from a standard
22869 library) are called with misaligned stack.  In this case, SSE
22870 instructions may lead to misaligned memory access traps.  In addition,
22871 variable arguments are handled incorrectly for 16 byte aligned
22872 objects (including x87 long double and __int128), leading to wrong
22873 results.  You must build all modules with
22874 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
22875 includes the system libraries and startup modules.
22877 @item -mincoming-stack-boundary=@var{num}
22878 @opindex mincoming-stack-boundary
22879 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
22880 boundary.  If @option{-mincoming-stack-boundary} is not specified,
22881 the one specified by @option{-mpreferred-stack-boundary} is used.
22883 On Pentium and Pentium Pro, @code{double} and @code{long double} values
22884 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
22885 suffer significant run time performance penalties.  On Pentium III, the
22886 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
22887 properly if it is not 16-byte aligned.
22889 To ensure proper alignment of this values on the stack, the stack boundary
22890 must be as aligned as that required by any value stored on the stack.
22891 Further, every function must be generated such that it keeps the stack
22892 aligned.  Thus calling a function compiled with a higher preferred
22893 stack boundary from a function compiled with a lower preferred stack
22894 boundary most likely misaligns the stack.  It is recommended that
22895 libraries that use callbacks always use the default setting.
22897 This extra alignment does consume extra stack space, and generally
22898 increases code size.  Code that is sensitive to stack space usage, such
22899 as embedded systems and operating system kernels, may want to reduce the
22900 preferred alignment to @option{-mpreferred-stack-boundary=2}.
22902 @need 200
22903 @item -mmmx
22904 @opindex mmmx
22905 @need 200
22906 @itemx -msse
22907 @opindex msse
22908 @need 200
22909 @itemx -msse2
22910 @opindex msse2
22911 @need 200
22912 @itemx -msse3
22913 @opindex msse3
22914 @need 200
22915 @itemx -mssse3
22916 @opindex mssse3
22917 @need 200
22918 @itemx -msse4
22919 @opindex msse4
22920 @need 200
22921 @itemx -msse4a
22922 @opindex msse4a
22923 @need 200
22924 @itemx -msse4.1
22925 @opindex msse4.1
22926 @need 200
22927 @itemx -msse4.2
22928 @opindex msse4.2
22929 @need 200
22930 @itemx -mavx
22931 @opindex mavx
22932 @need 200
22933 @itemx -mavx2
22934 @opindex mavx2
22935 @need 200
22936 @itemx -mavx512f
22937 @opindex mavx512f
22938 @need 200
22939 @itemx -mavx512pf
22940 @opindex mavx512pf
22941 @need 200
22942 @itemx -mavx512er
22943 @opindex mavx512er
22944 @need 200
22945 @itemx -mavx512cd
22946 @opindex mavx512cd
22947 @need 200
22948 @itemx -mavx512vl
22949 @opindex mavx512vl
22950 @need 200
22951 @itemx -mavx512bw
22952 @opindex mavx512bw
22953 @need 200
22954 @itemx -mavx512dq
22955 @opindex mavx512dq
22956 @need 200
22957 @itemx -mavx512ifma
22958 @opindex mavx512ifma
22959 @need 200
22960 @itemx -mavx512vbmi
22961 @opindex mavx512vbmi
22962 @need 200
22963 @itemx -msha
22964 @opindex msha
22965 @need 200
22966 @itemx -maes
22967 @opindex maes
22968 @need 200
22969 @itemx -mpclmul
22970 @opindex mpclmul
22971 @need 200
22972 @itemx -mclfushopt
22973 @opindex mclfushopt
22974 @need 200
22975 @itemx -mfsgsbase
22976 @opindex mfsgsbase
22977 @need 200
22978 @itemx -mrdrnd
22979 @opindex mrdrnd
22980 @need 200
22981 @itemx -mf16c
22982 @opindex mf16c
22983 @need 200
22984 @itemx -mfma
22985 @opindex mfma
22986 @need 200
22987 @itemx -mfma4
22988 @opindex mfma4
22989 @need 200
22990 @itemx -mno-fma4
22991 @opindex mno-fma4
22992 @need 200
22993 @itemx -mprefetchwt1
22994 @opindex mprefetchwt1
22995 @need 200
22996 @itemx -mxop
22997 @opindex mxop
22998 @need 200
22999 @itemx -mlwp
23000 @opindex mlwp
23001 @need 200
23002 @itemx -m3dnow
23003 @opindex m3dnow
23004 @need 200
23005 @itemx -mpopcnt
23006 @opindex mpopcnt
23007 @need 200
23008 @itemx -mabm
23009 @opindex mabm
23010 @need 200
23011 @itemx -mbmi
23012 @opindex mbmi
23013 @need 200
23014 @itemx -mbmi2
23015 @need 200
23016 @itemx -mlzcnt
23017 @opindex mlzcnt
23018 @need 200
23019 @itemx -mfxsr
23020 @opindex mfxsr
23021 @need 200
23022 @itemx -mxsave
23023 @opindex mxsave
23024 @need 200
23025 @itemx -mxsaveopt
23026 @opindex mxsaveopt
23027 @need 200
23028 @itemx -mxsavec
23029 @opindex mxsavec
23030 @need 200
23031 @itemx -mxsaves
23032 @opindex mxsaves
23033 @need 200
23034 @itemx -mrtm
23035 @opindex mrtm
23036 @need 200
23037 @itemx -mtbm
23038 @opindex mtbm
23039 @need 200
23040 @itemx -mmpx
23041 @opindex mmpx
23042 @need 200
23043 @itemx -mmwaitx
23044 @opindex mmwaitx
23045 These switches enable the use of instructions in the MMX, SSE,
23046 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
23047 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
23048 AVX512VL, AVX512BW, AVX512DQ, AVX512IFMA AVX512VBMI, BMI, BMI2, FXSR,
23049 XSAVE, XSAVEOPT, LZCNT, RTM, MPX, MWAITX or 3DNow!@:
23050 extended instruction sets.  Each has a corresponding @option{-mno-} option
23051 to disable use of these instructions.
23053 These extensions are also available as built-in functions: see
23054 @ref{x86 Built-in Functions}, for details of the functions enabled and
23055 disabled by these switches.
23057 To generate SSE/SSE2 instructions automatically from floating-point
23058 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
23060 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
23061 generates new AVX instructions or AVX equivalence for all SSEx instructions
23062 when needed.
23064 These options enable GCC to use these extended instructions in
23065 generated code, even without @option{-mfpmath=sse}.  Applications that
23066 perform run-time CPU detection must compile separate files for each
23067 supported architecture, using the appropriate flags.  In particular,
23068 the file containing the CPU detection code should be compiled without
23069 these options.
23071 @item -mdump-tune-features
23072 @opindex mdump-tune-features
23073 This option instructs GCC to dump the names of the x86 performance 
23074 tuning features and default settings. The names can be used in 
23075 @option{-mtune-ctrl=@var{feature-list}}.
23077 @item -mtune-ctrl=@var{feature-list}
23078 @opindex mtune-ctrl=@var{feature-list}
23079 This option is used to do fine grain control of x86 code generation features.
23080 @var{feature-list} is a comma separated list of @var{feature} names. See also
23081 @option{-mdump-tune-features}. When specified, the @var{feature} is turned
23082 on if it is not preceded with @samp{^}, otherwise, it is turned off. 
23083 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
23084 developers. Using it may lead to code paths not covered by testing and can
23085 potentially result in compiler ICEs or runtime errors.
23087 @item -mno-default
23088 @opindex mno-default
23089 This option instructs GCC to turn off all tunable features. See also 
23090 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
23092 @item -mcld
23093 @opindex mcld
23094 This option instructs GCC to emit a @code{cld} instruction in the prologue
23095 of functions that use string instructions.  String instructions depend on
23096 the DF flag to select between autoincrement or autodecrement mode.  While the
23097 ABI specifies the DF flag to be cleared on function entry, some operating
23098 systems violate this specification by not clearing the DF flag in their
23099 exception dispatchers.  The exception handler can be invoked with the DF flag
23100 set, which leads to wrong direction mode when string instructions are used.
23101 This option can be enabled by default on 32-bit x86 targets by configuring
23102 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
23103 instructions can be suppressed with the @option{-mno-cld} compiler option
23104 in this case.
23106 @item -mvzeroupper
23107 @opindex mvzeroupper
23108 This option instructs GCC to emit a @code{vzeroupper} instruction
23109 before a transfer of control flow out of the function to minimize
23110 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
23111 intrinsics.
23113 @item -mprefer-avx128
23114 @opindex mprefer-avx128
23115 This option instructs GCC to use 128-bit AVX instructions instead of
23116 256-bit AVX instructions in the auto-vectorizer.
23118 @item -mcx16
23119 @opindex mcx16
23120 This option enables GCC to generate @code{CMPXCHG16B} instructions.
23121 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
23122 (or oword) data types.  
23123 This is useful for high-resolution counters that can be updated
23124 by multiple processors (or cores).  This instruction is generated as part of
23125 atomic built-in functions: see @ref{__sync Builtins} or
23126 @ref{__atomic Builtins} for details.
23128 @item -msahf
23129 @opindex msahf
23130 This option enables generation of @code{SAHF} instructions in 64-bit code.
23131 Early Intel Pentium 4 CPUs with Intel 64 support,
23132 prior to the introduction of Pentium 4 G1 step in December 2005,
23133 lacked the @code{LAHF} and @code{SAHF} instructions
23134 which are supported by AMD64.
23135 These are load and store instructions, respectively, for certain status flags.
23136 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
23137 @code{drem}, and @code{remainder} built-in functions;
23138 see @ref{Other Builtins} for details.
23140 @item -mmovbe
23141 @opindex mmovbe
23142 This option enables use of the @code{movbe} instruction to implement
23143 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
23145 @item -mcrc32
23146 @opindex mcrc32
23147 This option enables built-in functions @code{__builtin_ia32_crc32qi},
23148 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
23149 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
23151 @item -mrecip
23152 @opindex mrecip
23153 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
23154 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
23155 with an additional Newton-Raphson step
23156 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
23157 (and their vectorized
23158 variants) for single-precision floating-point arguments.  These instructions
23159 are generated only when @option{-funsafe-math-optimizations} is enabled
23160 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
23161 Note that while the throughput of the sequence is higher than the throughput
23162 of the non-reciprocal instruction, the precision of the sequence can be
23163 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
23165 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
23166 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
23167 combination), and doesn't need @option{-mrecip}.
23169 Also note that GCC emits the above sequence with additional Newton-Raphson step
23170 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
23171 already with @option{-ffast-math} (or the above option combination), and
23172 doesn't need @option{-mrecip}.
23174 @item -mrecip=@var{opt}
23175 @opindex mrecip=opt
23176 This option controls which reciprocal estimate instructions
23177 may be used.  @var{opt} is a comma-separated list of options, which may
23178 be preceded by a @samp{!} to invert the option:
23180 @table @samp
23181 @item all
23182 Enable all estimate instructions.
23184 @item default
23185 Enable the default instructions, equivalent to @option{-mrecip}.
23187 @item none
23188 Disable all estimate instructions, equivalent to @option{-mno-recip}.
23190 @item div
23191 Enable the approximation for scalar division.
23193 @item vec-div
23194 Enable the approximation for vectorized division.
23196 @item sqrt
23197 Enable the approximation for scalar square root.
23199 @item vec-sqrt
23200 Enable the approximation for vectorized square root.
23201 @end table
23203 So, for example, @option{-mrecip=all,!sqrt} enables
23204 all of the reciprocal approximations, except for square root.
23206 @item -mveclibabi=@var{type}
23207 @opindex mveclibabi
23208 Specifies the ABI type to use for vectorizing intrinsics using an
23209 external library.  Supported values for @var{type} are @samp{svml} 
23210 for the Intel short
23211 vector math library and @samp{acml} for the AMD math core library.
23212 To use this option, both @option{-ftree-vectorize} and
23213 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
23214 ABI-compatible library must be specified at link time.
23216 GCC currently emits calls to @code{vmldExp2},
23217 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
23218 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
23219 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
23220 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
23221 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
23222 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
23223 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
23224 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
23225 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
23226 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
23227 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
23228 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
23229 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
23230 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
23231 when @option{-mveclibabi=acml} is used.  
23233 @item -mabi=@var{name}
23234 @opindex mabi
23235 Generate code for the specified calling convention.  Permissible values
23236 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
23237 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
23238 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
23239 You can control this behavior for specific functions by
23240 using the function attributes @code{ms_abi} and @code{sysv_abi}.
23241 @xref{Function Attributes}.
23243 @item -mtls-dialect=@var{type}
23244 @opindex mtls-dialect
23245 Generate code to access thread-local storage using the @samp{gnu} or
23246 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
23247 @samp{gnu2} is more efficient, but it may add compile- and run-time
23248 requirements that cannot be satisfied on all systems.
23250 @item -mpush-args
23251 @itemx -mno-push-args
23252 @opindex mpush-args
23253 @opindex mno-push-args
23254 Use PUSH operations to store outgoing parameters.  This method is shorter
23255 and usually equally fast as method using SUB/MOV operations and is enabled
23256 by default.  In some cases disabling it may improve performance because of
23257 improved scheduling and reduced dependencies.
23259 @item -maccumulate-outgoing-args
23260 @opindex maccumulate-outgoing-args
23261 If enabled, the maximum amount of space required for outgoing arguments is
23262 computed in the function prologue.  This is faster on most modern CPUs
23263 because of reduced dependencies, improved scheduling and reduced stack usage
23264 when the preferred stack boundary is not equal to 2.  The drawback is a notable
23265 increase in code size.  This switch implies @option{-mno-push-args}.
23267 @item -mthreads
23268 @opindex mthreads
23269 Support thread-safe exception handling on MinGW.  Programs that rely
23270 on thread-safe exception handling must compile and link all code with the
23271 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
23272 @option{-D_MT}; when linking, it links in a special thread helper library
23273 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
23275 @item -mno-align-stringops
23276 @opindex mno-align-stringops
23277 Do not align the destination of inlined string operations.  This switch reduces
23278 code size and improves performance in case the destination is already aligned,
23279 but GCC doesn't know about it.
23281 @item -minline-all-stringops
23282 @opindex minline-all-stringops
23283 By default GCC inlines string operations only when the destination is 
23284 known to be aligned to least a 4-byte boundary.  
23285 This enables more inlining and increases code
23286 size, but may improve performance of code that depends on fast
23287 @code{memcpy}, @code{strlen},
23288 and @code{memset} for short lengths.
23290 @item -minline-stringops-dynamically
23291 @opindex minline-stringops-dynamically
23292 For string operations of unknown size, use run-time checks with
23293 inline code for small blocks and a library call for large blocks.
23295 @item -mstringop-strategy=@var{alg}
23296 @opindex mstringop-strategy=@var{alg}
23297 Override the internal decision heuristic for the particular algorithm to use
23298 for inlining string operations.  The allowed values for @var{alg} are:
23300 @table @samp
23301 @item rep_byte
23302 @itemx rep_4byte
23303 @itemx rep_8byte
23304 Expand using i386 @code{rep} prefix of the specified size.
23306 @item byte_loop
23307 @itemx loop
23308 @itemx unrolled_loop
23309 Expand into an inline loop.
23311 @item libcall
23312 Always use a library call.
23313 @end table
23315 @item -mmemcpy-strategy=@var{strategy}
23316 @opindex mmemcpy-strategy=@var{strategy}
23317 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
23318 should be inlined and what inline algorithm to use when the expected size
23319 of the copy operation is known. @var{strategy} 
23320 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
23321 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
23322 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
23323 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
23324 in the list must be specified in increasing order.  The minimal byte size for 
23325 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
23326 preceding range.
23328 @item -mmemset-strategy=@var{strategy}
23329 @opindex mmemset-strategy=@var{strategy}
23330 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
23331 @code{__builtin_memset} expansion.
23333 @item -momit-leaf-frame-pointer
23334 @opindex momit-leaf-frame-pointer
23335 Don't keep the frame pointer in a register for leaf functions.  This
23336 avoids the instructions to save, set up, and restore frame pointers and
23337 makes an extra register available in leaf functions.  The option
23338 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
23339 which might make debugging harder.
23341 @item -mtls-direct-seg-refs
23342 @itemx -mno-tls-direct-seg-refs
23343 @opindex mtls-direct-seg-refs
23344 Controls whether TLS variables may be accessed with offsets from the
23345 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
23346 or whether the thread base pointer must be added.  Whether or not this
23347 is valid depends on the operating system, and whether it maps the
23348 segment to cover the entire TLS area.
23350 For systems that use the GNU C Library, the default is on.
23352 @item -msse2avx
23353 @itemx -mno-sse2avx
23354 @opindex msse2avx
23355 Specify that the assembler should encode SSE instructions with VEX
23356 prefix.  The option @option{-mavx} turns this on by default.
23358 @item -mfentry
23359 @itemx -mno-fentry
23360 @opindex mfentry
23361 If profiling is active (@option{-pg}), put the profiling
23362 counter call before the prologue.
23363 Note: On x86 architectures the attribute @code{ms_hook_prologue}
23364 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
23366 @item -mrecord-mcount
23367 @itemx -mno-record-mcount
23368 @opindex mrecord-mcount
23369 If profiling is active (@option{-pg}), generate a __mcount_loc section
23370 that contains pointers to each profiling call. This is useful for
23371 automatically patching and out calls.
23373 @item -mnop-mcount
23374 @itemx -mno-nop-mcount
23375 @opindex mnop-mcount
23376 If profiling is active (@option{-pg}), generate the calls to
23377 the profiling functions as nops. This is useful when they
23378 should be patched in later dynamically. This is likely only
23379 useful together with @option{-mrecord-mcount}.
23381 @item -mskip-rax-setup
23382 @itemx -mno-skip-rax-setup
23383 @opindex mskip-rax-setup
23384 When generating code for the x86-64 architecture with SSE extensions
23385 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
23386 register when there are no variable arguments passed in vector registers.
23388 @strong{Warning:} Since RAX register is used to avoid unnecessarily
23389 saving vector registers on stack when passing variable arguments, the
23390 impacts of this option are callees may waste some stack space,
23391 misbehave or jump to a random location.  GCC 4.4 or newer don't have
23392 those issues, regardless the RAX register value.
23394 @item -m8bit-idiv
23395 @itemx -mno-8bit-idiv
23396 @opindex m8bit-idiv
23397 On some processors, like Intel Atom, 8-bit unsigned integer divide is
23398 much faster than 32-bit/64-bit integer divide.  This option generates a
23399 run-time check.  If both dividend and divisor are within range of 0
23400 to 255, 8-bit unsigned integer divide is used instead of
23401 32-bit/64-bit integer divide.
23403 @item -mavx256-split-unaligned-load
23404 @itemx -mavx256-split-unaligned-store
23405 @opindex mavx256-split-unaligned-load
23406 @opindex mavx256-split-unaligned-store
23407 Split 32-byte AVX unaligned load and store.
23409 @item -mstack-protector-guard=@var{guard}
23410 @opindex mstack-protector-guard=@var{guard}
23411 Generate stack protection code using canary at @var{guard}.  Supported
23412 locations are @samp{global} for global canary or @samp{tls} for per-thread
23413 canary in the TLS block (the default).  This option has effect only when
23414 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
23416 @end table
23418 These @samp{-m} switches are supported in addition to the above
23419 on x86-64 processors in 64-bit environments.
23421 @table @gcctabopt
23422 @item -m32
23423 @itemx -m64
23424 @itemx -mx32
23425 @itemx -m16
23426 @itemx -miamcu
23427 @opindex m32
23428 @opindex m64
23429 @opindex mx32
23430 @opindex m16
23431 @opindex miamcu
23432 Generate code for a 16-bit, 32-bit or 64-bit environment.
23433 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
23434 to 32 bits, and
23435 generates code that runs on any i386 system.
23437 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
23438 types to 64 bits, and generates code for the x86-64 architecture.
23439 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
23440 and @option{-mdynamic-no-pic} options.
23442 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
23443 to 32 bits, and
23444 generates code for the x86-64 architecture.
23446 The @option{-m16} option is the same as @option{-m32}, except for that
23447 it outputs the @code{.code16gcc} assembly directive at the beginning of
23448 the assembly output so that the binary can run in 16-bit mode.
23450 The @option{-miamcu} option generates code which conforms to Intel MCU
23451 psABI.  It requires the @option{-m32} option to be turned on.
23453 @item -mno-red-zone
23454 @opindex mno-red-zone
23455 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
23456 by the x86-64 ABI; it is a 128-byte area beyond the location of the
23457 stack pointer that is not modified by signal or interrupt handlers
23458 and therefore can be used for temporary data without adjusting the stack
23459 pointer.  The flag @option{-mno-red-zone} disables this red zone.
23461 @item -mcmodel=small
23462 @opindex mcmodel=small
23463 Generate code for the small code model: the program and its symbols must
23464 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
23465 Programs can be statically or dynamically linked.  This is the default
23466 code model.
23468 @item -mcmodel=kernel
23469 @opindex mcmodel=kernel
23470 Generate code for the kernel code model.  The kernel runs in the
23471 negative 2 GB of the address space.
23472 This model has to be used for Linux kernel code.
23474 @item -mcmodel=medium
23475 @opindex mcmodel=medium
23476 Generate code for the medium model: the program is linked in the lower 2
23477 GB of the address space.  Small symbols are also placed there.  Symbols
23478 with sizes larger than @option{-mlarge-data-threshold} are put into
23479 large data or BSS sections and can be located above 2GB.  Programs can
23480 be statically or dynamically linked.
23482 @item -mcmodel=large
23483 @opindex mcmodel=large
23484 Generate code for the large model.  This model makes no assumptions
23485 about addresses and sizes of sections.
23487 @item -maddress-mode=long
23488 @opindex maddress-mode=long
23489 Generate code for long address mode.  This is only supported for 64-bit
23490 and x32 environments.  It is the default address mode for 64-bit
23491 environments.
23493 @item -maddress-mode=short
23494 @opindex maddress-mode=short
23495 Generate code for short address mode.  This is only supported for 32-bit
23496 and x32 environments.  It is the default address mode for 32-bit and
23497 x32 environments.
23498 @end table
23500 @node x86 Windows Options
23501 @subsection x86 Windows Options
23502 @cindex x86 Windows Options
23503 @cindex Windows Options for x86
23505 These additional options are available for Microsoft Windows targets:
23507 @table @gcctabopt
23508 @item -mconsole
23509 @opindex mconsole
23510 This option
23511 specifies that a console application is to be generated, by
23512 instructing the linker to set the PE header subsystem type
23513 required for console applications.
23514 This option is available for Cygwin and MinGW targets and is
23515 enabled by default on those targets.
23517 @item -mdll
23518 @opindex mdll
23519 This option is available for Cygwin and MinGW targets.  It
23520 specifies that a DLL---a dynamic link library---is to be
23521 generated, enabling the selection of the required runtime
23522 startup object and entry point.
23524 @item -mnop-fun-dllimport
23525 @opindex mnop-fun-dllimport
23526 This option is available for Cygwin and MinGW targets.  It
23527 specifies that the @code{dllimport} attribute should be ignored.
23529 @item -mthread
23530 @opindex mthread
23531 This option is available for MinGW targets. It specifies
23532 that MinGW-specific thread support is to be used.
23534 @item -municode
23535 @opindex municode
23536 This option is available for MinGW-w64 targets.  It causes
23537 the @code{UNICODE} preprocessor macro to be predefined, and
23538 chooses Unicode-capable runtime startup code.
23540 @item -mwin32
23541 @opindex mwin32
23542 This option is available for Cygwin and MinGW targets.  It
23543 specifies that the typical Microsoft Windows predefined macros are to
23544 be set in the pre-processor, but does not influence the choice
23545 of runtime library/startup code.
23547 @item -mwindows
23548 @opindex mwindows
23549 This option is available for Cygwin and MinGW targets.  It
23550 specifies that a GUI application is to be generated by
23551 instructing the linker to set the PE header subsystem type
23552 appropriately.
23554 @item -fno-set-stack-executable
23555 @opindex fno-set-stack-executable
23556 This option is available for MinGW targets. It specifies that
23557 the executable flag for the stack used by nested functions isn't
23558 set. This is necessary for binaries running in kernel mode of
23559 Microsoft Windows, as there the User32 API, which is used to set executable
23560 privileges, isn't available.
23562 @item -fwritable-relocated-rdata
23563 @opindex fno-writable-relocated-rdata
23564 This option is available for MinGW and Cygwin targets.  It specifies
23565 that relocated-data in read-only section is put into .data
23566 section.  This is a necessary for older runtimes not supporting
23567 modification of .rdata sections for pseudo-relocation.
23569 @item -mpe-aligned-commons
23570 @opindex mpe-aligned-commons
23571 This option is available for Cygwin and MinGW targets.  It
23572 specifies that the GNU extension to the PE file format that
23573 permits the correct alignment of COMMON variables should be
23574 used when generating code.  It is enabled by default if
23575 GCC detects that the target assembler found during configuration
23576 supports the feature.
23577 @end table
23579 See also under @ref{x86 Options} for standard options.
23581 @node Xstormy16 Options
23582 @subsection Xstormy16 Options
23583 @cindex Xstormy16 Options
23585 These options are defined for Xstormy16:
23587 @table @gcctabopt
23588 @item -msim
23589 @opindex msim
23590 Choose startup files and linker script suitable for the simulator.
23591 @end table
23593 @node Xtensa Options
23594 @subsection Xtensa Options
23595 @cindex Xtensa Options
23597 These options are supported for Xtensa targets:
23599 @table @gcctabopt
23600 @item -mconst16
23601 @itemx -mno-const16
23602 @opindex mconst16
23603 @opindex mno-const16
23604 Enable or disable use of @code{CONST16} instructions for loading
23605 constant values.  The @code{CONST16} instruction is currently not a
23606 standard option from Tensilica.  When enabled, @code{CONST16}
23607 instructions are always used in place of the standard @code{L32R}
23608 instructions.  The use of @code{CONST16} is enabled by default only if
23609 the @code{L32R} instruction is not available.
23611 @item -mfused-madd
23612 @itemx -mno-fused-madd
23613 @opindex mfused-madd
23614 @opindex mno-fused-madd
23615 Enable or disable use of fused multiply/add and multiply/subtract
23616 instructions in the floating-point option.  This has no effect if the
23617 floating-point option is not also enabled.  Disabling fused multiply/add
23618 and multiply/subtract instructions forces the compiler to use separate
23619 instructions for the multiply and add/subtract operations.  This may be
23620 desirable in some cases where strict IEEE 754-compliant results are
23621 required: the fused multiply add/subtract instructions do not round the
23622 intermediate result, thereby producing results with @emph{more} bits of
23623 precision than specified by the IEEE standard.  Disabling fused multiply
23624 add/subtract instructions also ensures that the program output is not
23625 sensitive to the compiler's ability to combine multiply and add/subtract
23626 operations.
23628 @item -mserialize-volatile
23629 @itemx -mno-serialize-volatile
23630 @opindex mserialize-volatile
23631 @opindex mno-serialize-volatile
23632 When this option is enabled, GCC inserts @code{MEMW} instructions before
23633 @code{volatile} memory references to guarantee sequential consistency.
23634 The default is @option{-mserialize-volatile}.  Use
23635 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
23637 @item -mforce-no-pic
23638 @opindex mforce-no-pic
23639 For targets, like GNU/Linux, where all user-mode Xtensa code must be
23640 position-independent code (PIC), this option disables PIC for compiling
23641 kernel code.
23643 @item -mtext-section-literals
23644 @itemx -mno-text-section-literals
23645 @opindex mtext-section-literals
23646 @opindex mno-text-section-literals
23647 These options control the treatment of literal pools.  The default is
23648 @option{-mno-text-section-literals}, which places literals in a separate
23649 section in the output file.  This allows the literal pool to be placed
23650 in a data RAM/ROM, and it also allows the linker to combine literal
23651 pools from separate object files to remove redundant literals and
23652 improve code size.  With @option{-mtext-section-literals}, the literals
23653 are interspersed in the text section in order to keep them as close as
23654 possible to their references.  This may be necessary for large assembly
23655 files.  Literals for each function are placed right before that function.
23657 @item -mauto-litpools
23658 @itemx -mno-auto-litpools
23659 @opindex mauto-litpools
23660 @opindex mno-auto-litpools
23661 These options control the treatment of literal pools.  The default is
23662 @option{-mno-auto-litpools}, which places literals in a separate
23663 section in the output file unless @option{-mtext-section-literals} is
23664 used.  With @option{-mauto-litpools} the literals are interspersed in
23665 the text section by the assembler.  Compiler does not produce explicit
23666 @code{.literal} directives and loads literals into registers with
23667 @code{MOVI} instructions instead of @code{L32R} to let the assembler
23668 do relaxation and place literals as necessary.  This option allows
23669 assembler to create several literal pools per function and assemble
23670 very big functions, which may not be possible with
23671 @option{-mtext-section-literals}.
23673 @item -mtarget-align
23674 @itemx -mno-target-align
23675 @opindex mtarget-align
23676 @opindex mno-target-align
23677 When this option is enabled, GCC instructs the assembler to
23678 automatically align instructions to reduce branch penalties at the
23679 expense of some code density.  The assembler attempts to widen density
23680 instructions to align branch targets and the instructions following call
23681 instructions.  If there are not enough preceding safe density
23682 instructions to align a target, no widening is performed.  The
23683 default is @option{-mtarget-align}.  These options do not affect the
23684 treatment of auto-aligned instructions like @code{LOOP}, which the
23685 assembler always aligns, either by widening density instructions or
23686 by inserting NOP instructions.
23688 @item -mlongcalls
23689 @itemx -mno-longcalls
23690 @opindex mlongcalls
23691 @opindex mno-longcalls
23692 When this option is enabled, GCC instructs the assembler to translate
23693 direct calls to indirect calls unless it can determine that the target
23694 of a direct call is in the range allowed by the call instruction.  This
23695 translation typically occurs for calls to functions in other source
23696 files.  Specifically, the assembler translates a direct @code{CALL}
23697 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
23698 The default is @option{-mno-longcalls}.  This option should be used in
23699 programs where the call target can potentially be out of range.  This
23700 option is implemented in the assembler, not the compiler, so the
23701 assembly code generated by GCC still shows direct call
23702 instructions---look at the disassembled object code to see the actual
23703 instructions.  Note that the assembler uses an indirect call for
23704 every cross-file call, not just those that really are out of range.
23705 @end table
23707 @node zSeries Options
23708 @subsection zSeries Options
23709 @cindex zSeries options
23711 These are listed under @xref{S/390 and zSeries Options}.
23713 @node Code Gen Options
23714 @section Options for Code Generation Conventions
23715 @cindex code generation conventions
23716 @cindex options, code generation
23717 @cindex run-time options
23719 These machine-independent options control the interface conventions
23720 used in code generation.
23722 Most of them have both positive and negative forms; the negative form
23723 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
23724 one of the forms is listed---the one that is not the default.  You
23725 can figure out the other form by either removing @samp{no-} or adding
23728 @table @gcctabopt
23729 @item -fbounds-check
23730 @opindex fbounds-check
23731 For front ends that support it, generate additional code to check that
23732 indices used to access arrays are within the declared range.  This is
23733 currently only supported by the Java and Fortran front ends, where
23734 this option defaults to true and false respectively.
23736 @item -fstack-reuse=@var{reuse-level}
23737 @opindex fstack_reuse
23738 This option controls stack space reuse for user declared local/auto variables
23739 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
23740 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
23741 local variables and temporaries, @samp{named_vars} enables the reuse only for
23742 user defined local variables with names, and @samp{none} disables stack reuse
23743 completely. The default value is @samp{all}. The option is needed when the
23744 program extends the lifetime of a scoped local variable or a compiler generated
23745 temporary beyond the end point defined by the language.  When a lifetime of
23746 a variable ends, and if the variable lives in memory, the optimizing compiler
23747 has the freedom to reuse its stack space with other temporaries or scoped
23748 local variables whose live range does not overlap with it. Legacy code extending
23749 local lifetime is likely to break with the stack reuse optimization.
23751 For example,
23753 @smallexample
23754    int *p;
23755    @{
23756      int local1;
23758      p = &local1;
23759      local1 = 10;
23760      ....
23761    @}
23762    @{
23763       int local2;
23764       local2 = 20;
23765       ...
23766    @}
23768    if (*p == 10)  // out of scope use of local1
23769      @{
23771      @}
23772 @end smallexample
23774 Another example:
23775 @smallexample
23777    struct A
23778    @{
23779        A(int k) : i(k), j(k) @{ @}
23780        int i;
23781        int j;
23782    @};
23784    A *ap;
23786    void foo(const A& ar)
23787    @{
23788       ap = &ar;
23789    @}
23791    void bar()
23792    @{
23793       foo(A(10)); // temp object's lifetime ends when foo returns
23795       @{
23796         A a(20);
23797         ....
23798       @}
23799       ap->i+= 10;  // ap references out of scope temp whose space
23800                    // is reused with a. What is the value of ap->i?
23801    @}
23803 @end smallexample
23805 The lifetime of a compiler generated temporary is well defined by the C++
23806 standard. When a lifetime of a temporary ends, and if the temporary lives
23807 in memory, the optimizing compiler has the freedom to reuse its stack
23808 space with other temporaries or scoped local variables whose live range
23809 does not overlap with it. However some of the legacy code relies on
23810 the behavior of older compilers in which temporaries' stack space is
23811 not reused, the aggressive stack reuse can lead to runtime errors. This
23812 option is used to control the temporary stack reuse optimization.
23814 @item -ftrapv
23815 @opindex ftrapv
23816 This option generates traps for signed overflow on addition, subtraction,
23817 multiplication operations.
23818 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23819 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23820 @option{-fwrapv} being effective.  Note that only active options override, so
23821 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23822 results in @option{-ftrapv} being effective.
23824 @item -fwrapv
23825 @opindex fwrapv
23826 This option instructs the compiler to assume that signed arithmetic
23827 overflow of addition, subtraction and multiplication wraps around
23828 using twos-complement representation.  This flag enables some optimizations
23829 and disables others.  This option is enabled by default for the Java
23830 front end, as required by the Java language specification.
23831 The options @option{-ftrapv} and @option{-fwrapv} override each other, so using
23832 @option{-ftrapv} @option{-fwrapv} on the command-line results in
23833 @option{-fwrapv} being effective.  Note that only active options override, so
23834 using @option{-ftrapv} @option{-fwrapv} @option{-fno-wrapv} on the command-line
23835 results in @option{-ftrapv} being effective.
23837 @item -fexceptions
23838 @opindex fexceptions
23839 Enable exception handling.  Generates extra code needed to propagate
23840 exceptions.  For some targets, this implies GCC generates frame
23841 unwind information for all functions, which can produce significant data
23842 size overhead, although it does not affect execution.  If you do not
23843 specify this option, GCC enables it by default for languages like
23844 C++ that normally require exception handling, and disables it for
23845 languages like C that do not normally require it.  However, you may need
23846 to enable this option when compiling C code that needs to interoperate
23847 properly with exception handlers written in C++.  You may also wish to
23848 disable this option if you are compiling older C++ programs that don't
23849 use exception handling.
23851 @item -fnon-call-exceptions
23852 @opindex fnon-call-exceptions
23853 Generate code that allows trapping instructions to throw exceptions.
23854 Note that this requires platform-specific runtime support that does
23855 not exist everywhere.  Moreover, it only allows @emph{trapping}
23856 instructions to throw exceptions, i.e.@: memory references or floating-point
23857 instructions.  It does not allow exceptions to be thrown from
23858 arbitrary signal handlers such as @code{SIGALRM}.
23860 @item -fdelete-dead-exceptions
23861 @opindex fdelete-dead-exceptions
23862 Consider that instructions that may throw exceptions but don't otherwise
23863 contribute to the execution of the program can be optimized away.
23864 This option is enabled by default for the Ada front end, as permitted by
23865 the Ada language specification.
23866 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
23868 @item -funwind-tables
23869 @opindex funwind-tables
23870 Similar to @option{-fexceptions}, except that it just generates any needed
23871 static data, but does not affect the generated code in any other way.
23872 You normally do not need to enable this option; instead, a language processor
23873 that needs this handling enables it on your behalf.
23875 @item -fasynchronous-unwind-tables
23876 @opindex fasynchronous-unwind-tables
23877 Generate unwind table in DWARF 2 format, if supported by target machine.  The
23878 table is exact at each instruction boundary, so it can be used for stack
23879 unwinding from asynchronous events (such as debugger or garbage collector).
23881 @item -fno-gnu-unique
23882 @opindex fno-gnu-unique
23883 On systems with recent GNU assembler and C library, the C++ compiler
23884 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
23885 of template static data members and static local variables in inline
23886 functions are unique even in the presence of @code{RTLD_LOCAL}; this
23887 is necessary to avoid problems with a library used by two different
23888 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
23889 therefore disagreeing with the other one about the binding of the
23890 symbol.  But this causes @code{dlclose} to be ignored for affected
23891 DSOs; if your program relies on reinitialization of a DSO via
23892 @code{dlclose} and @code{dlopen}, you can use
23893 @option{-fno-gnu-unique}.
23895 @item -fpcc-struct-return
23896 @opindex fpcc-struct-return
23897 Return ``short'' @code{struct} and @code{union} values in memory like
23898 longer ones, rather than in registers.  This convention is less
23899 efficient, but it has the advantage of allowing intercallability between
23900 GCC-compiled files and files compiled with other compilers, particularly
23901 the Portable C Compiler (pcc).
23903 The precise convention for returning structures in memory depends
23904 on the target configuration macros.
23906 Short structures and unions are those whose size and alignment match
23907 that of some integer type.
23909 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
23910 switch is not binary compatible with code compiled with the
23911 @option{-freg-struct-return} switch.
23912 Use it to conform to a non-default application binary interface.
23914 @item -freg-struct-return
23915 @opindex freg-struct-return
23916 Return @code{struct} and @code{union} values in registers when possible.
23917 This is more efficient for small structures than
23918 @option{-fpcc-struct-return}.
23920 If you specify neither @option{-fpcc-struct-return} nor
23921 @option{-freg-struct-return}, GCC defaults to whichever convention is
23922 standard for the target.  If there is no standard convention, GCC
23923 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
23924 the principal compiler.  In those cases, we can choose the standard, and
23925 we chose the more efficient register return alternative.
23927 @strong{Warning:} code compiled with the @option{-freg-struct-return}
23928 switch is not binary compatible with code compiled with the
23929 @option{-fpcc-struct-return} switch.
23930 Use it to conform to a non-default application binary interface.
23932 @item -fshort-enums
23933 @opindex fshort-enums
23934 Allocate to an @code{enum} type only as many bytes as it needs for the
23935 declared range of possible values.  Specifically, the @code{enum} type
23936 is equivalent to the smallest integer type that has enough room.
23938 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23939 code that is not binary compatible with code generated without that switch.
23940 Use it to conform to a non-default application binary interface.
23942 @item -fshort-double
23943 @opindex fshort-double
23944 Use the same size for @code{double} as for @code{float}.
23946 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23947 code that is not binary compatible with code generated without that switch.
23948 Use it to conform to a non-default application binary interface.
23950 @item -fshort-wchar
23951 @opindex fshort-wchar
23952 Override the underlying type for @code{wchar_t} to be @code{short
23953 unsigned int} instead of the default for the target.  This option is
23954 useful for building programs to run under WINE@.
23956 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23957 code that is not binary compatible with code generated without that switch.
23958 Use it to conform to a non-default application binary interface.
23960 @item -fno-common
23961 @opindex fno-common
23962 In C code, controls the placement of uninitialized global variables.
23963 Unix C compilers have traditionally permitted multiple definitions of
23964 such variables in different compilation units by placing the variables
23965 in a common block.
23966 This is the behavior specified by @option{-fcommon}, and is the default
23967 for GCC on most targets.
23968 On the other hand, this behavior is not required by ISO C, and on some
23969 targets may carry a speed or code size penalty on variable references.
23970 The @option{-fno-common} option specifies that the compiler should place
23971 uninitialized global variables in the data section of the object file,
23972 rather than generating them as common blocks.
23973 This has the effect that if the same variable is declared
23974 (without @code{extern}) in two different compilations,
23975 you get a multiple-definition error when you link them.
23976 In this case, you must compile with @option{-fcommon} instead.
23977 Compiling with @option{-fno-common} is useful on targets for which
23978 it provides better performance, or if you wish to verify that the
23979 program will work on other systems that always treat uninitialized
23980 variable declarations this way.
23982 @item -fno-ident
23983 @opindex fno-ident
23984 Ignore the @code{#ident} directive.
23986 @item -finhibit-size-directive
23987 @opindex finhibit-size-directive
23988 Don't output a @code{.size} assembler directive, or anything else that
23989 would cause trouble if the function is split in the middle, and the
23990 two halves are placed at locations far apart in memory.  This option is
23991 used when compiling @file{crtstuff.c}; you should not need to use it
23992 for anything else.
23994 @item -fverbose-asm
23995 @opindex fverbose-asm
23996 Put extra commentary information in the generated assembly code to
23997 make it more readable.  This option is generally only of use to those
23998 who actually need to read the generated assembly code (perhaps while
23999 debugging the compiler itself).
24001 @option{-fno-verbose-asm}, the default, causes the
24002 extra information to be omitted and is useful when comparing two assembler
24003 files.
24005 @item -frecord-gcc-switches
24006 @opindex frecord-gcc-switches
24007 This switch causes the command line used to invoke the
24008 compiler to be recorded into the object file that is being created.
24009 This switch is only implemented on some targets and the exact format
24010 of the recording is target and binary file format dependent, but it
24011 usually takes the form of a section containing ASCII text.  This
24012 switch is related to the @option{-fverbose-asm} switch, but that
24013 switch only records information in the assembler output file as
24014 comments, so it never reaches the object file.
24015 See also @option{-grecord-gcc-switches} for another
24016 way of storing compiler options into the object file.
24018 @item -fpic
24019 @opindex fpic
24020 @cindex global offset table
24021 @cindex PIC
24022 Generate position-independent code (PIC) suitable for use in a shared
24023 library, if supported for the target machine.  Such code accesses all
24024 constant addresses through a global offset table (GOT)@.  The dynamic
24025 loader resolves the GOT entries when the program starts (the dynamic
24026 loader is not part of GCC; it is part of the operating system).  If
24027 the GOT size for the linked executable exceeds a machine-specific
24028 maximum size, you get an error message from the linker indicating that
24029 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
24030 instead.  (These maximums are 8k on the SPARC and 32k
24031 on the m68k and RS/6000.  The x86 has no such limit.)
24033 Position-independent code requires special support, and therefore works
24034 only on certain machines.  For the x86, GCC supports PIC for System V
24035 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
24036 position-independent.
24038 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
24039 are defined to 1.
24041 @item -fPIC
24042 @opindex fPIC
24043 If supported for the target machine, emit position-independent code,
24044 suitable for dynamic linking and avoiding any limit on the size of the
24045 global offset table.  This option makes a difference on the m68k,
24046 PowerPC and SPARC@.
24048 Position-independent code requires special support, and therefore works
24049 only on certain machines.
24051 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
24052 are defined to 2.
24054 @item -fpie
24055 @itemx -fPIE
24056 @opindex fpie
24057 @opindex fPIE
24058 These options are similar to @option{-fpic} and @option{-fPIC}, but
24059 generated position independent code can be only linked into executables.
24060 Usually these options are used when @option{-pie} GCC option is
24061 used during linking.
24063 @option{-fpie} and @option{-fPIE} both define the macros
24064 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
24065 for @option{-fpie} and 2 for @option{-fPIE}.
24067 @item -fno-plt
24068 @opindex fno-plt
24069 Do not use PLT for external function calls in position-independent code.
24070 Instead, load callee address at call site from GOT and branch to it.
24071 This leads to more efficient code by eliminating PLT stubs and exposing
24072 GOT load to optimizations.  On architectures such as 32-bit x86 where
24073 PLT stubs expect GOT pointer in a specific register, this gives more
24074 register allocation freedom to the compiler.  Lazy binding requires PLT:
24075 with @option{-fno-plt} all external symbols are resolved at load time.
24077 Alternatively, function attribute @code{noplt} can be used to avoid PLT
24078 for calls to specific external functions by marking those functions with
24079 this attribute.
24081 Additionally, a few targets also convert calls to those functions that are
24082 marked to not use the PLT to use the GOT instead for non-position independent
24083 code.
24085 @item -fno-jump-tables
24086 @opindex fno-jump-tables
24087 Do not use jump tables for switch statements even where it would be
24088 more efficient than other code generation strategies.  This option is
24089 of use in conjunction with @option{-fpic} or @option{-fPIC} for
24090 building code that forms part of a dynamic linker and cannot
24091 reference the address of a jump table.  On some targets, jump tables
24092 do not require a GOT and this option is not needed.
24094 @item -ffixed-@var{reg}
24095 @opindex ffixed
24096 Treat the register named @var{reg} as a fixed register; generated code
24097 should never refer to it (except perhaps as a stack pointer, frame
24098 pointer or in some other fixed role).
24100 @var{reg} must be the name of a register.  The register names accepted
24101 are machine-specific and are defined in the @code{REGISTER_NAMES}
24102 macro in the machine description macro file.
24104 This flag does not have a negative form, because it specifies a
24105 three-way choice.
24107 @item -fcall-used-@var{reg}
24108 @opindex fcall-used
24109 Treat the register named @var{reg} as an allocable register that is
24110 clobbered by function calls.  It may be allocated for temporaries or
24111 variables that do not live across a call.  Functions compiled this way
24112 do not save and restore the register @var{reg}.
24114 It is an error to use this flag with the frame pointer or stack pointer.
24115 Use of this flag for other registers that have fixed pervasive roles in
24116 the machine's execution model produces disastrous results.
24118 This flag does not have a negative form, because it specifies a
24119 three-way choice.
24121 @item -fcall-saved-@var{reg}
24122 @opindex fcall-saved
24123 Treat the register named @var{reg} as an allocable register saved by
24124 functions.  It may be allocated even for temporaries or variables that
24125 live across a call.  Functions compiled this way save and restore
24126 the register @var{reg} if they use it.
24128 It is an error to use this flag with the frame pointer or stack pointer.
24129 Use of this flag for other registers that have fixed pervasive roles in
24130 the machine's execution model produces disastrous results.
24132 A different sort of disaster results from the use of this flag for
24133 a register in which function values may be returned.
24135 This flag does not have a negative form, because it specifies a
24136 three-way choice.
24138 @item -fpack-struct[=@var{n}]
24139 @opindex fpack-struct
24140 Without a value specified, pack all structure members together without
24141 holes.  When a value is specified (which must be a small power of two), pack
24142 structure members according to this value, representing the maximum
24143 alignment (that is, objects with default alignment requirements larger than
24144 this are output potentially unaligned at the next fitting location.
24146 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
24147 code that is not binary compatible with code generated without that switch.
24148 Additionally, it makes the code suboptimal.
24149 Use it to conform to a non-default application binary interface.
24151 @item -finstrument-functions
24152 @opindex finstrument-functions
24153 Generate instrumentation calls for entry and exit to functions.  Just
24154 after function entry and just before function exit, the following
24155 profiling functions are called with the address of the current
24156 function and its call site.  (On some platforms,
24157 @code{__builtin_return_address} does not work beyond the current
24158 function, so the call site information may not be available to the
24159 profiling functions otherwise.)
24161 @smallexample
24162 void __cyg_profile_func_enter (void *this_fn,
24163                                void *call_site);
24164 void __cyg_profile_func_exit  (void *this_fn,
24165                                void *call_site);
24166 @end smallexample
24168 The first argument is the address of the start of the current function,
24169 which may be looked up exactly in the symbol table.
24171 This instrumentation is also done for functions expanded inline in other
24172 functions.  The profiling calls indicate where, conceptually, the
24173 inline function is entered and exited.  This means that addressable
24174 versions of such functions must be available.  If all your uses of a
24175 function are expanded inline, this may mean an additional expansion of
24176 code size.  If you use @code{extern inline} in your C code, an
24177 addressable version of such functions must be provided.  (This is
24178 normally the case anyway, but if you get lucky and the optimizer always
24179 expands the functions inline, you might have gotten away without
24180 providing static copies.)
24182 A function may be given the attribute @code{no_instrument_function}, in
24183 which case this instrumentation is not done.  This can be used, for
24184 example, for the profiling functions listed above, high-priority
24185 interrupt routines, and any functions from which the profiling functions
24186 cannot safely be called (perhaps signal handlers, if the profiling
24187 routines generate output or allocate memory).
24189 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
24190 @opindex finstrument-functions-exclude-file-list
24192 Set the list of functions that are excluded from instrumentation (see
24193 the description of @option{-finstrument-functions}).  If the file that
24194 contains a function definition matches with one of @var{file}, then
24195 that function is not instrumented.  The match is done on substrings:
24196 if the @var{file} parameter is a substring of the file name, it is
24197 considered to be a match.
24199 For example:
24201 @smallexample
24202 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
24203 @end smallexample
24205 @noindent
24206 excludes any inline function defined in files whose pathnames
24207 contain @file{/bits/stl} or @file{include/sys}.
24209 If, for some reason, you want to include letter @samp{,} in one of
24210 @var{sym}, write @samp{\,}. For example,
24211 @option{-finstrument-functions-exclude-file-list='\,\,tmp'}
24212 (note the single quote surrounding the option).
24214 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
24215 @opindex finstrument-functions-exclude-function-list
24217 This is similar to @option{-finstrument-functions-exclude-file-list},
24218 but this option sets the list of function names to be excluded from
24219 instrumentation.  The function name to be matched is its user-visible
24220 name, such as @code{vector<int> blah(const vector<int> &)}, not the
24221 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
24222 match is done on substrings: if the @var{sym} parameter is a substring
24223 of the function name, it is considered to be a match.  For C99 and C++
24224 extended identifiers, the function name must be given in UTF-8, not
24225 using universal character names.
24227 @item -fstack-check
24228 @opindex fstack-check
24229 Generate code to verify that you do not go beyond the boundary of the
24230 stack.  You should specify this flag if you are running in an
24231 environment with multiple threads, but you only rarely need to specify it in
24232 a single-threaded environment since stack overflow is automatically
24233 detected on nearly all systems if there is only one stack.
24235 Note that this switch does not actually cause checking to be done; the
24236 operating system or the language runtime must do that.  The switch causes
24237 generation of code to ensure that they see the stack being extended.
24239 You can additionally specify a string parameter: @samp{no} means no
24240 checking, @samp{generic} means force the use of old-style checking,
24241 @samp{specific} means use the best checking method and is equivalent
24242 to bare @option{-fstack-check}.
24244 Old-style checking is a generic mechanism that requires no specific
24245 target support in the compiler but comes with the following drawbacks:
24247 @enumerate
24248 @item
24249 Modified allocation strategy for large objects: they are always
24250 allocated dynamically if their size exceeds a fixed threshold.
24252 @item
24253 Fixed limit on the size of the static frame of functions: when it is
24254 topped by a particular function, stack checking is not reliable and
24255 a warning is issued by the compiler.
24257 @item
24258 Inefficiency: because of both the modified allocation strategy and the
24259 generic implementation, code performance is hampered.
24260 @end enumerate
24262 Note that old-style stack checking is also the fallback method for
24263 @samp{specific} if no target support has been added in the compiler.
24265 @item -fstack-limit-register=@var{reg}
24266 @itemx -fstack-limit-symbol=@var{sym}
24267 @itemx -fno-stack-limit
24268 @opindex fstack-limit-register
24269 @opindex fstack-limit-symbol
24270 @opindex fno-stack-limit
24271 Generate code to ensure that the stack does not grow beyond a certain value,
24272 either the value of a register or the address of a symbol.  If a larger
24273 stack is required, a signal is raised at run time.  For most targets,
24274 the signal is raised before the stack overruns the boundary, so
24275 it is possible to catch the signal without taking special precautions.
24277 For instance, if the stack starts at absolute address @samp{0x80000000}
24278 and grows downwards, you can use the flags
24279 @option{-fstack-limit-symbol=__stack_limit} and
24280 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
24281 of 128KB@.  Note that this may only work with the GNU linker.
24283 @item -fsplit-stack
24284 @opindex fsplit-stack
24285 Generate code to automatically split the stack before it overflows.
24286 The resulting program has a discontiguous stack which can only
24287 overflow if the program is unable to allocate any more memory.  This
24288 is most useful when running threaded programs, as it is no longer
24289 necessary to calculate a good stack size to use for each thread.  This
24290 is currently only implemented for the x86 targets running
24291 GNU/Linux.
24293 When code compiled with @option{-fsplit-stack} calls code compiled
24294 without @option{-fsplit-stack}, there may not be much stack space
24295 available for the latter code to run.  If compiling all code,
24296 including library code, with @option{-fsplit-stack} is not an option,
24297 then the linker can fix up these calls so that the code compiled
24298 without @option{-fsplit-stack} always has a large stack.  Support for
24299 this is implemented in the gold linker in GNU binutils release 2.21
24300 and later.
24302 @item -fleading-underscore
24303 @opindex fleading-underscore
24304 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
24305 change the way C symbols are represented in the object file.  One use
24306 is to help link with legacy assembly code.
24308 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
24309 generate code that is not binary compatible with code generated without that
24310 switch.  Use it to conform to a non-default application binary interface.
24311 Not all targets provide complete support for this switch.
24313 @item -ftls-model=@var{model}
24314 @opindex ftls-model
24315 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
24316 The @var{model} argument should be one of @samp{global-dynamic},
24317 @samp{local-dynamic}, @samp{initial-exec} or @samp{local-exec}.
24318 Note that the choice is subject to optimization: the compiler may use
24319 a more efficient model for symbols not visible outside of the translation
24320 unit, or if @option{-fpic} is not given on the command line.
24322 The default without @option{-fpic} is @samp{initial-exec}; with
24323 @option{-fpic} the default is @samp{global-dynamic}.
24325 @item -fvisibility=@r{[}default@r{|}internal@r{|}hidden@r{|}protected@r{]}
24326 @opindex fvisibility
24327 Set the default ELF image symbol visibility to the specified option---all
24328 symbols are marked with this unless overridden within the code.
24329 Using this feature can very substantially improve linking and
24330 load times of shared object libraries, produce more optimized
24331 code, provide near-perfect API export and prevent symbol clashes.
24332 It is @strong{strongly} recommended that you use this in any shared objects
24333 you distribute.
24335 Despite the nomenclature, @samp{default} always means public; i.e.,
24336 available to be linked against from outside the shared object.
24337 @samp{protected} and @samp{internal} are pretty useless in real-world
24338 usage so the only other commonly used option is @samp{hidden}.
24339 The default if @option{-fvisibility} isn't specified is
24340 @samp{default}, i.e., make every symbol public.
24342 A good explanation of the benefits offered by ensuring ELF
24343 symbols have the correct visibility is given by ``How To Write
24344 Shared Libraries'' by Ulrich Drepper (which can be found at
24345 @w{@uref{http://www.akkadia.org/drepper/}})---however a superior
24346 solution made possible by this option to marking things hidden when
24347 the default is public is to make the default hidden and mark things
24348 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
24349 and @code{__attribute__ ((visibility("default")))} instead of
24350 @code{__declspec(dllexport)} you get almost identical semantics with
24351 identical syntax.  This is a great boon to those working with
24352 cross-platform projects.
24354 For those adding visibility support to existing code, you may find
24355 @code{#pragma GCC visibility} of use.  This works by you enclosing
24356 the declarations you wish to set visibility for with (for example)
24357 @code{#pragma GCC visibility push(hidden)} and
24358 @code{#pragma GCC visibility pop}.
24359 Bear in mind that symbol visibility should be viewed @strong{as
24360 part of the API interface contract} and thus all new code should
24361 always specify visibility when it is not the default; i.e., declarations
24362 only for use within the local DSO should @strong{always} be marked explicitly
24363 as hidden as so to avoid PLT indirection overheads---making this
24364 abundantly clear also aids readability and self-documentation of the code.
24365 Note that due to ISO C++ specification requirements, @code{operator new} and
24366 @code{operator delete} must always be of default visibility.
24368 Be aware that headers from outside your project, in particular system
24369 headers and headers from any other library you use, may not be
24370 expecting to be compiled with visibility other than the default.  You
24371 may need to explicitly say @code{#pragma GCC visibility push(default)}
24372 before including any such headers.
24374 @code{extern} declarations are not affected by @option{-fvisibility}, so
24375 a lot of code can be recompiled with @option{-fvisibility=hidden} with
24376 no modifications.  However, this means that calls to @code{extern}
24377 functions with no explicit visibility use the PLT, so it is more
24378 effective to use @code{__attribute ((visibility))} and/or
24379 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
24380 declarations should be treated as hidden.
24382 Note that @option{-fvisibility} does affect C++ vague linkage
24383 entities. This means that, for instance, an exception class that is
24384 be thrown between DSOs must be explicitly marked with default
24385 visibility so that the @samp{type_info} nodes are unified between
24386 the DSOs.
24388 An overview of these techniques, their benefits and how to use them
24389 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
24391 @item -fstrict-volatile-bitfields
24392 @opindex fstrict-volatile-bitfields
24393 This option should be used if accesses to volatile bit-fields (or other
24394 structure fields, although the compiler usually honors those types
24395 anyway) should use a single access of the width of the
24396 field's type, aligned to a natural alignment if possible.  For
24397 example, targets with memory-mapped peripheral registers might require
24398 all such accesses to be 16 bits wide; with this flag you can
24399 declare all peripheral bit-fields as @code{unsigned short} (assuming short
24400 is 16 bits on these targets) to force GCC to use 16-bit accesses
24401 instead of, perhaps, a more efficient 32-bit access.
24403 If this option is disabled, the compiler uses the most efficient
24404 instruction.  In the previous example, that might be a 32-bit load
24405 instruction, even though that accesses bytes that do not contain
24406 any portion of the bit-field, or memory-mapped registers unrelated to
24407 the one being updated.
24409 In some cases, such as when the @code{packed} attribute is applied to a 
24410 structure field, it may not be possible to access the field with a single
24411 read or write that is correctly aligned for the target machine.  In this
24412 case GCC falls back to generating multiple accesses rather than code that 
24413 will fault or truncate the result at run time.
24415 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
24416 not allowed to touch non bit-field members.  It is therefore recommended
24417 to define all bits of the field's type as bit-field members.
24419 The default value of this option is determined by the application binary
24420 interface for the target processor.
24422 @item -fsync-libcalls
24423 @opindex fsync-libcalls
24424 This option controls whether any out-of-line instance of the @code{__sync}
24425 family of functions may be used to implement the C++11 @code{__atomic}
24426 family of functions.
24428 The default value of this option is enabled, thus the only useful form
24429 of the option is @option{-fno-sync-libcalls}.  This option is used in
24430 the implementation of the @file{libatomic} runtime library.
24432 @end table
24434 @c man end
24436 @node Environment Variables
24437 @section Environment Variables Affecting GCC
24438 @cindex environment variables
24440 @c man begin ENVIRONMENT
24441 This section describes several environment variables that affect how GCC
24442 operates.  Some of them work by specifying directories or prefixes to use
24443 when searching for various kinds of files.  Some are used to specify other
24444 aspects of the compilation environment.
24446 Note that you can also specify places to search using options such as
24447 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
24448 take precedence over places specified using environment variables, which
24449 in turn take precedence over those specified by the configuration of GCC@.
24450 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
24451 GNU Compiler Collection (GCC) Internals}.
24453 @table @env
24454 @item LANG
24455 @itemx LC_CTYPE
24456 @c @itemx LC_COLLATE
24457 @itemx LC_MESSAGES
24458 @c @itemx LC_MONETARY
24459 @c @itemx LC_NUMERIC
24460 @c @itemx LC_TIME
24461 @itemx LC_ALL
24462 @findex LANG
24463 @findex LC_CTYPE
24464 @c @findex LC_COLLATE
24465 @findex LC_MESSAGES
24466 @c @findex LC_MONETARY
24467 @c @findex LC_NUMERIC
24468 @c @findex LC_TIME
24469 @findex LC_ALL
24470 @cindex locale
24471 These environment variables control the way that GCC uses
24472 localization information which allows GCC to work with different
24473 national conventions.  GCC inspects the locale categories
24474 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
24475 so.  These locale categories can be set to any value supported by your
24476 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
24477 Kingdom encoded in UTF-8.
24479 The @env{LC_CTYPE} environment variable specifies character
24480 classification.  GCC uses it to determine the character boundaries in
24481 a string; this is needed for some multibyte encodings that contain quote
24482 and escape characters that are otherwise interpreted as a string
24483 end or escape.
24485 The @env{LC_MESSAGES} environment variable specifies the language to
24486 use in diagnostic messages.
24488 If the @env{LC_ALL} environment variable is set, it overrides the value
24489 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
24490 and @env{LC_MESSAGES} default to the value of the @env{LANG}
24491 environment variable.  If none of these variables are set, GCC
24492 defaults to traditional C English behavior.
24494 @item TMPDIR
24495 @findex TMPDIR
24496 If @env{TMPDIR} is set, it specifies the directory to use for temporary
24497 files.  GCC uses temporary files to hold the output of one stage of
24498 compilation which is to be used as input to the next stage: for example,
24499 the output of the preprocessor, which is the input to the compiler
24500 proper.
24502 @item GCC_COMPARE_DEBUG
24503 @findex GCC_COMPARE_DEBUG
24504 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
24505 @option{-fcompare-debug} to the compiler driver.  See the documentation
24506 of this option for more details.
24508 @item GCC_EXEC_PREFIX
24509 @findex GCC_EXEC_PREFIX
24510 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
24511 names of the subprograms executed by the compiler.  No slash is added
24512 when this prefix is combined with the name of a subprogram, but you can
24513 specify a prefix that ends with a slash if you wish.
24515 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
24516 an appropriate prefix to use based on the pathname it is invoked with.
24518 If GCC cannot find the subprogram using the specified prefix, it
24519 tries looking in the usual places for the subprogram.
24521 The default value of @env{GCC_EXEC_PREFIX} is
24522 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
24523 the installed compiler. In many cases @var{prefix} is the value
24524 of @code{prefix} when you ran the @file{configure} script.
24526 Other prefixes specified with @option{-B} take precedence over this prefix.
24528 This prefix is also used for finding files such as @file{crt0.o} that are
24529 used for linking.
24531 In addition, the prefix is used in an unusual way in finding the
24532 directories to search for header files.  For each of the standard
24533 directories whose name normally begins with @samp{/usr/local/lib/gcc}
24534 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
24535 replacing that beginning with the specified prefix to produce an
24536 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
24537 @file{foo/bar} just before it searches the standard directory 
24538 @file{/usr/local/lib/bar}.
24539 If a standard directory begins with the configured
24540 @var{prefix} then the value of @var{prefix} is replaced by
24541 @env{GCC_EXEC_PREFIX} when looking for header files.
24543 @item COMPILER_PATH
24544 @findex COMPILER_PATH
24545 The value of @env{COMPILER_PATH} is a colon-separated list of
24546 directories, much like @env{PATH}.  GCC tries the directories thus
24547 specified when searching for subprograms, if it can't find the
24548 subprograms using @env{GCC_EXEC_PREFIX}.
24550 @item LIBRARY_PATH
24551 @findex LIBRARY_PATH
24552 The value of @env{LIBRARY_PATH} is a colon-separated list of
24553 directories, much like @env{PATH}.  When configured as a native compiler,
24554 GCC tries the directories thus specified when searching for special
24555 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
24556 using GCC also uses these directories when searching for ordinary
24557 libraries for the @option{-l} option (but directories specified with
24558 @option{-L} come first).
24560 @item LANG
24561 @findex LANG
24562 @cindex locale definition
24563 This variable is used to pass locale information to the compiler.  One way in
24564 which this information is used is to determine the character set to be used
24565 when character literals, string literals and comments are parsed in C and C++.
24566 When the compiler is configured to allow multibyte characters,
24567 the following values for @env{LANG} are recognized:
24569 @table @samp
24570 @item C-JIS
24571 Recognize JIS characters.
24572 @item C-SJIS
24573 Recognize SJIS characters.
24574 @item C-EUCJP
24575 Recognize EUCJP characters.
24576 @end table
24578 If @env{LANG} is not defined, or if it has some other value, then the
24579 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
24580 recognize and translate multibyte characters.
24581 @end table
24583 @noindent
24584 Some additional environment variables affect the behavior of the
24585 preprocessor.
24587 @include cppenv.texi
24589 @c man end
24591 @node Precompiled Headers
24592 @section Using Precompiled Headers
24593 @cindex precompiled headers
24594 @cindex speed of compilation
24596 Often large projects have many header files that are included in every
24597 source file.  The time the compiler takes to process these header files
24598 over and over again can account for nearly all of the time required to
24599 build the project.  To make builds faster, GCC allows you to
24600 @dfn{precompile} a header file.
24602 To create a precompiled header file, simply compile it as you would any
24603 other file, if necessary using the @option{-x} option to make the driver
24604 treat it as a C or C++ header file.  You may want to use a
24605 tool like @command{make} to keep the precompiled header up-to-date when
24606 the headers it contains change.
24608 A precompiled header file is searched for when @code{#include} is
24609 seen in the compilation.  As it searches for the included file
24610 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
24611 compiler looks for a precompiled header in each directory just before it
24612 looks for the include file in that directory.  The name searched for is
24613 the name specified in the @code{#include} with @samp{.gch} appended.  If
24614 the precompiled header file can't be used, it is ignored.
24616 For instance, if you have @code{#include "all.h"}, and you have
24617 @file{all.h.gch} in the same directory as @file{all.h}, then the
24618 precompiled header file is used if possible, and the original
24619 header is used otherwise.
24621 Alternatively, you might decide to put the precompiled header file in a
24622 directory and use @option{-I} to ensure that directory is searched
24623 before (or instead of) the directory containing the original header.
24624 Then, if you want to check that the precompiled header file is always
24625 used, you can put a file of the same name as the original header in this
24626 directory containing an @code{#error} command.
24628 This also works with @option{-include}.  So yet another way to use
24629 precompiled headers, good for projects not designed with precompiled
24630 header files in mind, is to simply take most of the header files used by
24631 a project, include them from another header file, precompile that header
24632 file, and @option{-include} the precompiled header.  If the header files
24633 have guards against multiple inclusion, they are skipped because
24634 they've already been included (in the precompiled header).
24636 If you need to precompile the same header file for different
24637 languages, targets, or compiler options, you can instead make a
24638 @emph{directory} named like @file{all.h.gch}, and put each precompiled
24639 header in the directory, perhaps using @option{-o}.  It doesn't matter
24640 what you call the files in the directory; every precompiled header in
24641 the directory is considered.  The first precompiled header
24642 encountered in the directory that is valid for this compilation is
24643 used; they're searched in no particular order.
24645 There are many other possibilities, limited only by your imagination,
24646 good sense, and the constraints of your build system.
24648 A precompiled header file can be used only when these conditions apply:
24650 @itemize
24651 @item
24652 Only one precompiled header can be used in a particular compilation.
24654 @item
24655 A precompiled header can't be used once the first C token is seen.  You
24656 can have preprocessor directives before a precompiled header; you cannot
24657 include a precompiled header from inside another header.
24659 @item
24660 The precompiled header file must be produced for the same language as
24661 the current compilation.  You can't use a C precompiled header for a C++
24662 compilation.
24664 @item
24665 The precompiled header file must have been produced by the same compiler
24666 binary as the current compilation is using.
24668 @item
24669 Any macros defined before the precompiled header is included must
24670 either be defined in the same way as when the precompiled header was
24671 generated, or must not affect the precompiled header, which usually
24672 means that they don't appear in the precompiled header at all.
24674 The @option{-D} option is one way to define a macro before a
24675 precompiled header is included; using a @code{#define} can also do it.
24676 There are also some options that define macros implicitly, like
24677 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
24678 defined this way.
24680 @item If debugging information is output when using the precompiled
24681 header, using @option{-g} or similar, the same kind of debugging information
24682 must have been output when building the precompiled header.  However,
24683 a precompiled header built using @option{-g} can be used in a compilation
24684 when no debugging information is being output.
24686 @item The same @option{-m} options must generally be used when building
24687 and using the precompiled header.  @xref{Submodel Options},
24688 for any cases where this rule is relaxed.
24690 @item Each of the following options must be the same when building and using
24691 the precompiled header:
24693 @gccoptlist{-fexceptions}
24695 @item
24696 Some other command-line options starting with @option{-f},
24697 @option{-p}, or @option{-O} must be defined in the same way as when
24698 the precompiled header was generated.  At present, it's not clear
24699 which options are safe to change and which are not; the safest choice
24700 is to use exactly the same options when generating and using the
24701 precompiled header.  The following are known to be safe:
24703 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
24704 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
24705 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
24706 -pedantic-errors}
24708 @end itemize
24710 For all of these except the last, the compiler automatically
24711 ignores the precompiled header if the conditions aren't met.  If you
24712 find an option combination that doesn't work and doesn't cause the
24713 precompiled header to be ignored, please consider filing a bug report,
24714 see @ref{Bugs}.
24716 If you do use differing options when generating and using the
24717 precompiled header, the actual behavior is a mixture of the
24718 behavior for the options.  For instance, if you use @option{-g} to
24719 generate the precompiled header but not when using it, you may or may
24720 not get debugging information for routines in the precompiled header.