2015-01-03 Sandra Loosemore <sandra@codesourcery.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob434790d24582fee7ee6f31fe945764ff49f4aa0d
1 @c Copyright (C) 1988-2014 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-2014 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.  @samp{g++} accepts mostly the same options as @samp{gcc}.
45 @c man end
46 @c man begin SEEALSO
47 gpl(7), gfdl(7), fsf-funding(7),
48 cpp(1), gcov(1), as(1), ld(1), gdb(1), adb(1), dbx(1), sdb(1)
49 and the Info entries for @file{gcc}, @file{cpp}, @file{as},
50 @file{ld}, @file{binutils} and @file{gdb}.
51 @c man end
52 @c man begin BUGS
53 For instructions on reporting bugs, see
54 @w{@value{BUGURL}}.
55 @c man end
56 @c man begin AUTHOR
57 See the Info entry for @command{gcc}, or
58 @w{@uref{http://gcc.gnu.org/onlinedocs/gcc/Contributors.html}},
59 for contributors to GCC@.
60 @c man end
61 @end ignore
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 * Language Independent Options:: Controlling how diagnostics should be
129                         formatted.
130 * Warning Options::     How picky should the compiler be?
131 * Debugging Options::   Symbol tables, measurements, and debugging dumps.
132 * Optimize Options::    How much optimization?
133 * Preprocessor Options:: Controlling header files and macro definitions.
134                          Also, getting dependency information for Make.
135 * Assembler Options::   Passing options to the assembler.
136 * Link Options::        Specifying libraries and so on.
137 * Directory Options::   Where to find header files and libraries.
138                         Where to find the compiler executable files.
139 * Spec Files::          How to pass switches to sub-processes.
140 * Target Options::      Running a cross-compiler, or an old version of GCC.
141 * Submodel Options::    Specifying minor hardware or convention variations,
142                         such as 68010 vs 68020.
143 * Code Gen Options::    Specifying conventions for function calls, data layout
144                         and register usage.
145 * Environment Variables:: Env vars that affect GCC.
146 * Precompiled Headers:: Compiling a header once, and using it many times.
147 @end menu
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 -fopenmp -fopenmp-simd -fms-extensions @gol
172 -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=@var{std|preinit|none} @gol
197 -fvtv-counts -fvtv-debug @gol
198 -fvisibility-ms-compat @gol
199 -fext-numeric-literals @gol
200 -Wabi=@var{n}  -Wconversion-null  -Wctor-dtor-privacy @gol
201 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
202 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
203 -Weffc++  -Wstrict-null-sentinel @gol
204 -Wno-non-template-friend  -Wold-style-cast @gol
205 -Woverloaded-virtual  -Wno-pmf-conversions @gol
206 -Wsign-promo}
208 @item Objective-C and Objective-C++ Language Options
209 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
210 Objective-C and Objective-C++ Dialects}.
211 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
212 -fgnu-runtime  -fnext-runtime @gol
213 -fno-nil-receivers @gol
214 -fobjc-abi-version=@var{n} @gol
215 -fobjc-call-cxx-cdtors @gol
216 -fobjc-direct-dispatch @gol
217 -fobjc-exceptions @gol
218 -fobjc-gc @gol
219 -fobjc-nilcheck @gol
220 -fobjc-std=objc1 @gol
221 -fno-local-ivars @gol
222 -fivar-visibility=@var{public|protected|private|package} @gol
223 -freplace-objc-classes @gol
224 -fzero-link @gol
225 -gen-decls @gol
226 -Wassign-intercept @gol
227 -Wno-protocol  -Wselector @gol
228 -Wstrict-selector-match @gol
229 -Wundeclared-selector}
231 @item Language Independent Options
232 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
233 @gccoptlist{-fmessage-length=@var{n}  @gol
234 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
235 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
236 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
238 @item Warning Options
239 @xref{Warning Options,,Options to Request or Suppress Warnings}.
240 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
241 -pedantic-errors @gol
242 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
243 -Waggressive-loop-optimizations -Warray-bounds @gol
244 -Wbool-compare @gol
245 -Wno-attributes -Wno-builtin-macro-redefined @gol
246 -Wc90-c99-compat -Wc99-c11-compat @gol
247 -Wc++-compat -Wc++11-compat -Wc++14-compat -Wcast-align  -Wcast-qual  @gol
248 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
249 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
250 -Wno-deprecated -Wno-deprecated-declarations -Wno-designated-init @gol
251 -Wdisabled-optimization @gol
252 -Wno-discarded-qualifiers -Wno-discarded-array-qualifiers @gol
253 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
254 -Wno-endif-labels -Werror  -Werror=* @gol
255 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
256 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
257 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
258 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
259 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
260 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
261 -Winit-self  -Winline  -Wno-int-conversion @gol
262 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
263 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
264 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
265 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args -Wmissing-braces @gol
266 -Wmissing-field-initializers -Wmissing-include-dirs @gol
267 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
268  -Wodr  -Wno-overflow  -Wopenmp-simd @gol
269 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
270 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
271 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
272 -Wredundant-decls  -Wno-return-local-addr @gol
273 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
274 -Wshift-count-negative -Wshift-count-overflow @gol
275 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
276 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
277 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
278 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
279 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
280 -Wsuggest-final-types @gol -Wsuggest-final-methods @gol
281 -Wmissing-format-attribute @gol
282 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
283 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
284 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
285 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
286 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
287 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
288 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
289 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
290 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
292 @item C and Objective-C-only Warning Options
293 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
294 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
295 -Wold-style-declaration  -Wold-style-definition @gol
296 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
297 -Wdeclaration-after-statement -Wpointer-sign}
299 @item Debugging Options
300 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
301 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
302 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
303 -fasan-shadow-offset=@var{number} -fsanitize-undefined-trap-on-error @gol
304 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
305 -fdisable-ipa-@var{pass_name} @gol
306 -fdisable-rtl-@var{pass_name} @gol
307 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
308 -fdisable-tree-@var{pass_name} @gol
309 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
310 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
311 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
312 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
313 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
314 -fdump-passes @gol
315 -fdump-statistics @gol
316 -fdump-tree-all @gol
317 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
318 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-cfg -fdump-tree-alias @gol
320 -fdump-tree-ch @gol
321 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-gimple@r{[}-raw@r{]} @gol
324 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
327 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
328 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
329 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
330 -fdump-tree-nrv -fdump-tree-vect @gol
331 -fdump-tree-sink @gol
332 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
333 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
334 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
335 -fdump-tree-vtable-verify @gol
336 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
337 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
338 -fdump-final-insns=@var{file} @gol
339 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
340 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
341 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
342 -fenable-@var{kind}-@var{pass} @gol
343 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
344 -fdebug-types-section -fmem-report-wpa @gol
345 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
346 -fopt-info @gol
347 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
348 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
349 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
350 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
351 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
352 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
353 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
354 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
355 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
356 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
357 -fdebug-prefix-map=@var{old}=@var{new} @gol
358 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
359 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
360 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
361 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
362 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
363 -print-sysroot -print-sysroot-headers-suffix @gol
364 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
366 @item Optimization Options
367 @xref{Optimize Options,,Options that Control Optimization}.
368 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
369 -falign-jumps[=@var{n}] @gol
370 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
371 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
372 -fauto-inc-dec -fbranch-probabilities @gol
373 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
374 -fbtr-bb-exclusive -fcaller-saves @gol
375 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
376 -fcompare-elim -fcprop-registers -fcrossjumping @gol
377 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
378 -fcx-limited-range @gol
379 -fdata-sections -fdce -fdelayed-branch @gol
380 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
381 -fdevirtualize-at-ltrans -fdse @gol
382 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
383 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
384 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
385 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
386 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
387 -fif-conversion2 -findirect-inlining @gol
388 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
389 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
390 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
391 -fira-algorithm=@var{algorithm} @gol
392 -fira-region=@var{region} -fira-hoist-pressure @gol
393 -fira-loop-pressure -fno-ira-share-save-slots @gol
394 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
395 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
396 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
397 -floop-block -floop-interchange -floop-strip-mine @gol  
398 -floop-unroll-and-jam -floop-nest-optimize @gol
399 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
400 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
401 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
402 -fmove-loop-invariants -fno-branch-count-reg @gol
403 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
404 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
405 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
406 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
407 -fomit-frame-pointer -foptimize-sibling-calls @gol
408 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
409 -fprefetch-loop-arrays -fprofile-report @gol
410 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
411 -fprofile-generate=@var{path} @gol
412 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
413 -freciprocal-math -free -frename-registers -fschedule-fusion -freorder-blocks @gol
414 -freorder-blocks-and-partition -freorder-functions @gol
415 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
416 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
417 -fsched-spec-load -fsched-spec-load-dangerous @gol
418 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
419 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
420 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
421 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
422 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
423 -fselective-scheduling -fselective-scheduling2 @gol
424 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
425 -fsemantic-interposition @gol
426 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
427 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
428 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
429 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
430 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
431 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
432 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
433 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
434 -ftree-loop-if-convert-stores -ftree-loop-im @gol
435 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
436 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
437 -ftree-loop-vectorize @gol
438 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
439 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
440 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
441 -ftree-vectorize -ftree-vrp @gol
442 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
443 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
444 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
445 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
446 --param @var{name}=@var{value}
447 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
449 @item Preprocessor Options
450 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
451 @gccoptlist{-A@var{question}=@var{answer} @gol
452 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
453 -C  -dD  -dI  -dM  -dN @gol
454 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
455 -idirafter @var{dir} @gol
456 -include @var{file}  -imacros @var{file} @gol
457 -iprefix @var{file}  -iwithprefix @var{dir} @gol
458 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
459 -imultilib @var{dir} -isysroot @var{dir} @gol
460 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
461 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
462 -remap -trigraphs  -undef  -U@var{macro}  @gol
463 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
465 @item Assembler Option
466 @xref{Assembler Options,,Passing Options to the Assembler}.
467 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
469 @item Linker Options
470 @xref{Link Options,,Options for Linking}.
471 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
472 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
473 -s  -static -static-libgcc -static-libstdc++ @gol
474 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
475 -shared -shared-libgcc  -symbolic @gol
476 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
477 -u @var{symbol} -z @var{keyword}}
479 @item Directory Options
480 @xref{Directory Options,,Options for Directory Search}.
481 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
482 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
483 --sysroot=@var{dir} --no-sysroot-suffix}
485 @item Machine Dependent Options
486 @xref{Submodel Options,,Hardware Models and Configurations}.
487 @c This list is ordered alphanumerically by subsection name.
488 @c Try and put the significant identifier (CPU or system) first,
489 @c so users have a clue at guessing where the ones they want will be.
491 @emph{AArch64 Options}
492 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
493 -mgeneral-regs-only @gol
494 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
495 -mstrict-align @gol
496 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
497 -mtls-dialect=desc  -mtls-dialect=traditional @gol
498 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
499 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
501 @emph{Adapteva Epiphany Options}
502 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
503 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
504 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
505 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
506 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
507 -msplit-vecmove-early -m1reg-@var{reg}}
509 @emph{ARC Options}
510 @gccoptlist{-mbarrel-shifter @gol
511 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
512 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
513 -mea -mno-mpy -mmul32x16 -mmul64 @gol
514 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
515 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
516 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
517 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
518 -mucb-mcount -mvolatile-cache @gol
519 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
520 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
521 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
522 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
523 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
524 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
526 @emph{ARM Options}
527 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
528 -mabi=@var{name} @gol
529 -mapcs-stack-check  -mno-apcs-stack-check @gol
530 -mapcs-float  -mno-apcs-float @gol
531 -mapcs-reentrant  -mno-apcs-reentrant @gol
532 -msched-prolog  -mno-sched-prolog @gol
533 -mlittle-endian  -mbig-endian @gol
534 -mfloat-abi=@var{name} @gol
535 -mfp16-format=@var{name}
536 -mthumb-interwork  -mno-thumb-interwork @gol
537 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
538 -mstructure-size-boundary=@var{n} @gol
539 -mabort-on-noreturn @gol
540 -mlong-calls  -mno-long-calls @gol
541 -msingle-pic-base  -mno-single-pic-base @gol
542 -mpic-register=@var{reg} @gol
543 -mnop-fun-dllimport @gol
544 -mpoke-function-name @gol
545 -mthumb  -marm @gol
546 -mtpcs-frame  -mtpcs-leaf-frame @gol
547 -mcaller-super-interworking  -mcallee-super-interworking @gol
548 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
549 -mword-relocations @gol
550 -mfix-cortex-m3-ldrd @gol
551 -munaligned-access @gol
552 -mneon-for-64bits @gol
553 -mslow-flash-data @gol
554 -masm-syntax-unified @gol
555 -mrestrict-it}
557 @emph{AVR Options}
558 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
559 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
560 -mstrict-X -mtiny-stack -Waddr-space-convert}
562 @emph{Blackfin Options}
563 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
564 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
565 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
566 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
567 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
568 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
569 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
570 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
571 -micplb}
573 @emph{C6X Options}
574 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
575 -msim -msdata=@var{sdata-type}}
577 @emph{CRIS Options}
578 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
579 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
580 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
581 -mstack-align  -mdata-align  -mconst-align @gol
582 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
583 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
584 -mmul-bug-workaround  -mno-mul-bug-workaround}
586 @emph{CR16 Options}
587 @gccoptlist{-mmac @gol
588 -mcr16cplus -mcr16c @gol
589 -msim -mint32 -mbit-ops
590 -mdata-model=@var{model}}
592 @emph{Darwin Options}
593 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
594 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
595 -client_name  -compatibility_version  -current_version @gol
596 -dead_strip @gol
597 -dependency-file  -dylib_file  -dylinker_install_name @gol
598 -dynamic  -dynamiclib  -exported_symbols_list @gol
599 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
600 -force_flat_namespace  -headerpad_max_install_names @gol
601 -iframework @gol
602 -image_base  -init  -install_name  -keep_private_externs @gol
603 -multi_module  -multiply_defined  -multiply_defined_unused @gol
604 -noall_load   -no_dead_strip_inits_and_terms @gol
605 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
606 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
607 -private_bundle  -read_only_relocs  -sectalign @gol
608 -sectobjectsymbols  -whyload  -seg1addr @gol
609 -sectcreate  -sectobjectsymbols  -sectorder @gol
610 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
611 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
612 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
613 -single_module  -static  -sub_library  -sub_umbrella @gol
614 -twolevel_namespace  -umbrella  -undefined @gol
615 -unexported_symbols_list  -weak_reference_mismatches @gol
616 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
617 -mkernel -mone-byte-bool}
619 @emph{DEC Alpha Options}
620 @gccoptlist{-mno-fp-regs  -msoft-float @gol
621 -mieee  -mieee-with-inexact  -mieee-conformant @gol
622 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
623 -mtrap-precision=@var{mode}  -mbuild-constants @gol
624 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
625 -mbwx  -mmax  -mfix  -mcix @gol
626 -mfloat-vax  -mfloat-ieee @gol
627 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
628 -msmall-text  -mlarge-text @gol
629 -mmemory-latency=@var{time}}
631 @emph{FR30 Options}
632 @gccoptlist{-msmall-model -mno-lsim}
634 @emph{FRV Options}
635 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
636 -mhard-float  -msoft-float @gol
637 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
638 -mdouble  -mno-double @gol
639 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
640 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
641 -mlinked-fp  -mlong-calls  -malign-labels @gol
642 -mlibrary-pic  -macc-4  -macc-8 @gol
643 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
644 -moptimize-membar -mno-optimize-membar @gol
645 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
646 -mvliw-branch  -mno-vliw-branch @gol
647 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
648 -mno-nested-cond-exec  -mtomcat-stats @gol
649 -mTLS -mtls @gol
650 -mcpu=@var{cpu}}
652 @emph{GNU/Linux Options}
653 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
654 -tno-android-cc -tno-android-ld}
656 @emph{H8/300 Options}
657 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
659 @emph{HPPA Options}
660 @gccoptlist{-march=@var{architecture-type} @gol
661 -mdisable-fpregs  -mdisable-indexing @gol
662 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
663 -mfixed-range=@var{register-range} @gol
664 -mjump-in-delay -mlinker-opt -mlong-calls @gol
665 -mlong-load-store  -mno-disable-fpregs @gol
666 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
667 -mno-jump-in-delay  -mno-long-load-store @gol
668 -mno-portable-runtime  -mno-soft-float @gol
669 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
670 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
671 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
672 -munix=@var{unix-std}  -nolibdld  -static  -threads}
674 @emph{i386 and x86-64 Options}
675 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
676 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
677 -mfpmath=@var{unit} @gol
678 -masm=@var{dialect}  -mno-fancy-math-387 @gol
679 -mno-fp-ret-in-387  -msoft-float @gol
680 -mno-wide-multiply  -mrtd  -malign-double @gol
681 -mpreferred-stack-boundary=@var{num} @gol
682 -mincoming-stack-boundary=@var{num} @gol
683 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
684 -mrecip -mrecip=@var{opt} @gol
685 -mvzeroupper -mprefer-avx128 @gol
686 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
687 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
688 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
689 -mclflushopt -mxsavec -mxsaves @gol
690 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
691 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
692 -mno-align-stringops  -minline-all-stringops @gol
693 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
694 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
695 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
696 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
697 -mregparm=@var{num}  -msseregparm @gol
698 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
699 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
700 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
701 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
702 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
703 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
704 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
705 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
707 @emph{i386 and x86-64 Windows Options}
708 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
709 -mnop-fun-dllimport -mthread @gol
710 -municode -mwin32 -mwindows -fno-set-stack-executable}
712 @emph{IA-64 Options}
713 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
714 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
715 -mconstant-gp  -mauto-pic  -mfused-madd @gol
716 -minline-float-divide-min-latency @gol
717 -minline-float-divide-max-throughput @gol
718 -mno-inline-float-divide @gol
719 -minline-int-divide-min-latency @gol
720 -minline-int-divide-max-throughput  @gol
721 -mno-inline-int-divide @gol
722 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
723 -mno-inline-sqrt @gol
724 -mdwarf2-asm -mearly-stop-bits @gol
725 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
726 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
727 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
728 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
729 -msched-spec-ldc -msched-spec-control-ldc @gol
730 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
731 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
732 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
733 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
735 @emph{LM32 Options}
736 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
737 -msign-extend-enabled -muser-enabled}
739 @emph{M32R/D Options}
740 @gccoptlist{-m32r2 -m32rx -m32r @gol
741 -mdebug @gol
742 -malign-loops -mno-align-loops @gol
743 -missue-rate=@var{number} @gol
744 -mbranch-cost=@var{number} @gol
745 -mmodel=@var{code-size-model-type} @gol
746 -msdata=@var{sdata-type} @gol
747 -mno-flush-func -mflush-func=@var{name} @gol
748 -mno-flush-trap -mflush-trap=@var{number} @gol
749 -G @var{num}}
751 @emph{M32C Options}
752 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
754 @emph{M680x0 Options}
755 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
756 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
757 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
758 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
759 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
760 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
761 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
762 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
763 -mxgot -mno-xgot}
765 @emph{MCore Options}
766 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
767 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
768 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
769 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
770 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
772 @emph{MeP Options}
773 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
774 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
775 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
776 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
777 -mtiny=@var{n}}
779 @emph{MicroBlaze Options}
780 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
781 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
782 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
783 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
784 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
786 @emph{MIPS Options}
787 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
788 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
789 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
790 -mips16  -mno-mips16  -mflip-mips16 @gol
791 -minterlink-compressed -mno-interlink-compressed @gol
792 -minterlink-mips16  -mno-interlink-mips16 @gol
793 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
794 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
795 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
796 -mno-float  -msingle-float  -mdouble-float @gol
797 -modd-spreg -mno-odd-spreg @gol
798 -mabs=@var{mode}  -mnan=@var{encoding} @gol
799 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
800 -mmcu -mmno-mcu @gol
801 -meva -mno-eva @gol
802 -mvirt -mno-virt @gol
803 -mxpa -mno-xpa @gol
804 -mmicromips -mno-micromips @gol
805 -mfpu=@var{fpu-type} @gol
806 -msmartmips  -mno-smartmips @gol
807 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
808 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
809 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
810 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
811 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
812 -membedded-data  -mno-embedded-data @gol
813 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
814 -mcode-readable=@var{setting} @gol
815 -msplit-addresses  -mno-split-addresses @gol
816 -mexplicit-relocs  -mno-explicit-relocs @gol
817 -mcheck-zero-division  -mno-check-zero-division @gol
818 -mdivide-traps  -mdivide-breaks @gol
819 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
820 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
821 -mfix-24k -mno-fix-24k @gol
822 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
823 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
824 -mfix-vr4120  -mno-fix-vr4120 @gol
825 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
826 -mflush-func=@var{func}  -mno-flush-func @gol
827 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
828 -mfp-exceptions -mno-fp-exceptions @gol
829 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
830 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
832 @emph{MMIX Options}
833 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
834 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
835 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
836 -mno-base-addresses  -msingle-exit  -mno-single-exit}
838 @emph{MN10300 Options}
839 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
840 -mno-am33 -mam33 -mam33-2 -mam34 @gol
841 -mtune=@var{cpu-type} @gol
842 -mreturn-pointer-on-d0 @gol
843 -mno-crt0  -mrelax -mliw -msetlb}
845 @emph{Moxie Options}
846 @gccoptlist{-meb -mel -mmul.x -mno-crt0}
848 @emph{MSP430 Options}
849 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
850 -mhwmult= -minrt}
852 @emph{NDS32 Options}
853 @gccoptlist{-mbig-endian -mlittle-endian @gol
854 -mreduced-regs -mfull-regs @gol
855 -mcmov -mno-cmov @gol
856 -mperf-ext -mno-perf-ext @gol
857 -mv3push -mno-v3push @gol
858 -m16bit -mno-16bit @gol
859 -mgp-direct -mno-gp-direct @gol
860 -misr-vector-size=@var{num} @gol
861 -mcache-block-size=@var{num} @gol
862 -march=@var{arch} @gol
863 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
864 -mex9 -mctor-dtor -mrelax}
866 @emph{Nios II Options}
867 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
868 -mno-bypass-cache -mbypass-cache @gol
869 -mno-cache-volatile -mcache-volatile @gol
870 -mno-fast-sw-div -mfast-sw-div @gol
871 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
872 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
873 -mcustom-fpu-cfg=@var{name} @gol
874 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
876 @emph{PDP-11 Options}
877 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
878 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
879 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
880 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
881 -mbranch-expensive  -mbranch-cheap @gol
882 -munix-asm  -mdec-asm}
884 @emph{picoChip Options}
885 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
886 -msymbol-as-address -mno-inefficient-warnings}
888 @emph{PowerPC Options}
889 See RS/6000 and PowerPC Options.
891 @emph{RL78 Options}
892 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @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}
951 @emph{RX Options}
952 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
953 -mcpu=@gol
954 -mbig-endian-data -mlittle-endian-data @gol
955 -msmall-data @gol
956 -msim  -mno-sim@gol
957 -mas100-syntax -mno-as100-syntax@gol
958 -mrelax@gol
959 -mmax-constant-size=@gol
960 -mint-register=@gol
961 -mpid@gol
962 -mno-warn-multiple-fast-interrupts@gol
963 -msave-acc-in-interrupts}
965 @emph{S/390 and zSeries Options}
966 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
967 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
968 -mlong-double-64 -mlong-double-128 @gol
969 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
970 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
971 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
972 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
973 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
974 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
976 @emph{Score Options}
977 @gccoptlist{-meb -mel @gol
978 -mnhwloop @gol
979 -muls @gol
980 -mmac @gol
981 -mscore5 -mscore5u -mscore7 -mscore7d}
983 @emph{SH Options}
984 @gccoptlist{-m1  -m2  -m2e @gol
985 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
986 -m3  -m3e @gol
987 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
988 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
989 -m5-64media  -m5-64media-nofpu @gol
990 -m5-32media  -m5-32media-nofpu @gol
991 -m5-compact  -m5-compact-nofpu @gol
992 -mb  -ml  -mdalign  -mrelax @gol
993 -mbigtable -mfmovd -mhitachi -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 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
998 -maccumulate-outgoing-args -minvalid-symbols @gol
999 -matomic-model=@var{atomic-model} @gol
1000 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @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{VMS Options}
1068 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1069 -mpointer-size=@var{size}}
1071 @emph{VxWorks Options}
1072 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1073 -Xbind-lazy  -Xbind-now}
1075 @emph{x86-64 Options}
1076 See i386 and x86-64 Options.
1078 @emph{Xstormy16 Options}
1079 @gccoptlist{-msim}
1081 @emph{Xtensa Options}
1082 @gccoptlist{-mconst16 -mno-const16 @gol
1083 -mfused-madd  -mno-fused-madd @gol
1084 -mforce-no-pic @gol
1085 -mserialize-volatile  -mno-serialize-volatile @gol
1086 -mtext-section-literals  -mno-text-section-literals @gol
1087 -mtarget-align  -mno-target-align @gol
1088 -mlongcalls  -mno-longcalls}
1090 @emph{zSeries Options}
1091 See S/390 and zSeries Options.
1093 @item Code Generation Options
1094 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1095 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1096 -ffixed-@var{reg}  -fexceptions @gol
1097 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1098 -fasynchronous-unwind-tables @gol
1099 -fno-gnu-unique @gol
1100 -finhibit-size-directive  -finstrument-functions @gol
1101 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1102 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1103 -fno-common  -fno-ident @gol
1104 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1105 -fno-jump-tables @gol
1106 -frecord-gcc-switches @gol
1107 -freg-struct-return  -fshort-enums @gol
1108 -fshort-double  -fshort-wchar @gol
1109 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1110 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1111 -fno-stack-limit -fsplit-stack @gol
1112 -fleading-underscore  -ftls-model=@var{model} @gol
1113 -fstack-reuse=@var{reuse_level} @gol
1114 -ftrapv  -fwrapv  -fbounds-check @gol
1115 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1116 @end table
1119 @node Overall Options
1120 @section Options Controlling the Kind of Output
1122 Compilation can involve up to four stages: preprocessing, compilation
1123 proper, assembly and linking, always in that order.  GCC is capable of
1124 preprocessing and compiling several files either into several
1125 assembler input files, or into one assembler input file; then each
1126 assembler input file produces an object file, and linking combines all
1127 the object files (those newly compiled, and those specified as input)
1128 into an executable file.
1130 @cindex file name suffix
1131 For any given input file, the file name suffix determines what kind of
1132 compilation is done:
1134 @table @gcctabopt
1135 @item @var{file}.c
1136 C source code that must be preprocessed.
1138 @item @var{file}.i
1139 C source code that should not be preprocessed.
1141 @item @var{file}.ii
1142 C++ source code that should not be preprocessed.
1144 @item @var{file}.m
1145 Objective-C source code.  Note that you must link with the @file{libobjc}
1146 library to make an Objective-C program work.
1148 @item @var{file}.mi
1149 Objective-C source code that should not be preprocessed.
1151 @item @var{file}.mm
1152 @itemx @var{file}.M
1153 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1154 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1155 to a literal capital M@.
1157 @item @var{file}.mii
1158 Objective-C++ source code that should not be preprocessed.
1160 @item @var{file}.h
1161 C, C++, Objective-C or Objective-C++ header file to be turned into a
1162 precompiled header (default), or C, C++ header file to be turned into an
1163 Ada spec (via the @option{-fdump-ada-spec} switch).
1165 @item @var{file}.cc
1166 @itemx @var{file}.cp
1167 @itemx @var{file}.cxx
1168 @itemx @var{file}.cpp
1169 @itemx @var{file}.CPP
1170 @itemx @var{file}.c++
1171 @itemx @var{file}.C
1172 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1173 the last two letters must both be literally @samp{x}.  Likewise,
1174 @samp{.C} refers to a literal capital C@.
1176 @item @var{file}.mm
1177 @itemx @var{file}.M
1178 Objective-C++ source code that must be preprocessed.
1180 @item @var{file}.mii
1181 Objective-C++ source code that should not be preprocessed.
1183 @item @var{file}.hh
1184 @itemx @var{file}.H
1185 @itemx @var{file}.hp
1186 @itemx @var{file}.hxx
1187 @itemx @var{file}.hpp
1188 @itemx @var{file}.HPP
1189 @itemx @var{file}.h++
1190 @itemx @var{file}.tcc
1191 C++ header file to be turned into a precompiled header or Ada spec.
1193 @item @var{file}.f
1194 @itemx @var{file}.for
1195 @itemx @var{file}.ftn
1196 Fixed form Fortran source code that should not be preprocessed.
1198 @item @var{file}.F
1199 @itemx @var{file}.FOR
1200 @itemx @var{file}.fpp
1201 @itemx @var{file}.FPP
1202 @itemx @var{file}.FTN
1203 Fixed form Fortran source code that must be preprocessed (with the traditional
1204 preprocessor).
1206 @item @var{file}.f90
1207 @itemx @var{file}.f95
1208 @itemx @var{file}.f03
1209 @itemx @var{file}.f08
1210 Free form Fortran source code that should not be preprocessed.
1212 @item @var{file}.F90
1213 @itemx @var{file}.F95
1214 @itemx @var{file}.F03
1215 @itemx @var{file}.F08
1216 Free form Fortran source code that must be preprocessed (with the
1217 traditional preprocessor).
1219 @item @var{file}.go
1220 Go source code.
1222 @c FIXME: Descriptions of Java file types.
1223 @c @var{file}.java
1224 @c @var{file}.class
1225 @c @var{file}.zip
1226 @c @var{file}.jar
1228 @item @var{file}.ads
1229 Ada source code file that contains a library unit declaration (a
1230 declaration of a package, subprogram, or generic, or a generic
1231 instantiation), or a library unit renaming declaration (a package,
1232 generic, or subprogram renaming declaration).  Such files are also
1233 called @dfn{specs}.
1235 @item @var{file}.adb
1236 Ada source code file containing a library unit body (a subprogram or
1237 package body).  Such files are also called @dfn{bodies}.
1239 @c GCC also knows about some suffixes for languages not yet included:
1240 @c Pascal:
1241 @c @var{file}.p
1242 @c @var{file}.pas
1243 @c Ratfor:
1244 @c @var{file}.r
1246 @item @var{file}.s
1247 Assembler code.
1249 @item @var{file}.S
1250 @itemx @var{file}.sx
1251 Assembler code that must be preprocessed.
1253 @item @var{other}
1254 An object file to be fed straight into linking.
1255 Any file name with no recognized suffix is treated this way.
1256 @end table
1258 @opindex x
1259 You can specify the input language explicitly with the @option{-x} option:
1261 @table @gcctabopt
1262 @item -x @var{language}
1263 Specify explicitly the @var{language} for the following input files
1264 (rather than letting the compiler choose a default based on the file
1265 name suffix).  This option applies to all following input files until
1266 the next @option{-x} option.  Possible values for @var{language} are:
1267 @smallexample
1268 c  c-header  cpp-output
1269 c++  c++-header  c++-cpp-output
1270 objective-c  objective-c-header  objective-c-cpp-output
1271 objective-c++ objective-c++-header objective-c++-cpp-output
1272 assembler  assembler-with-cpp
1274 f77  f77-cpp-input f95  f95-cpp-input
1276 java
1277 @end smallexample
1279 @item -x none
1280 Turn off any specification of a language, so that subsequent files are
1281 handled according to their file name suffixes (as they are if @option{-x}
1282 has not been used at all).
1284 @item -pass-exit-codes
1285 @opindex pass-exit-codes
1286 Normally the @command{gcc} program exits with the code of 1 if any
1287 phase of the compiler returns a non-success return code.  If you specify
1288 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1289 the numerically highest error produced by any phase returning an error
1290 indication.  The C, C++, and Fortran front ends return 4 if an internal
1291 compiler error is encountered.
1292 @end table
1294 If you only want some of the stages of compilation, you can use
1295 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1296 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1297 @command{gcc} is to stop.  Note that some combinations (for example,
1298 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1300 @table @gcctabopt
1301 @item -c
1302 @opindex c
1303 Compile or assemble the source files, but do not link.  The linking
1304 stage simply is not done.  The ultimate output is in the form of an
1305 object file for each source file.
1307 By default, the object file name for a source file is made by replacing
1308 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1310 Unrecognized input files, not requiring compilation or assembly, are
1311 ignored.
1313 @item -S
1314 @opindex S
1315 Stop after the stage of compilation proper; do not assemble.  The output
1316 is in the form of an assembler code file for each non-assembler input
1317 file specified.
1319 By default, the assembler file name for a source file is made by
1320 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1322 Input files that don't require compilation are ignored.
1324 @item -E
1325 @opindex E
1326 Stop after the preprocessing stage; do not run the compiler proper.  The
1327 output is in the form of preprocessed source code, which is sent to the
1328 standard output.
1330 Input files that don't require preprocessing are ignored.
1332 @cindex output file option
1333 @item -o @var{file}
1334 @opindex o
1335 Place output in file @var{file}.  This applies to whatever
1336 sort of output is being produced, whether it be an executable file,
1337 an object file, an assembler file or preprocessed C code.
1339 If @option{-o} is not specified, the default is to put an executable
1340 file in @file{a.out}, the object file for
1341 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1342 assembler file in @file{@var{source}.s}, a precompiled header file in
1343 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1344 standard output.
1346 @item -v
1347 @opindex v
1348 Print (on standard error output) the commands executed to run the stages
1349 of compilation.  Also print the version number of the compiler driver
1350 program and of the preprocessor and the compiler proper.
1352 @item -###
1353 @opindex ###
1354 Like @option{-v} except the commands are not executed and arguments
1355 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1356 This is useful for shell scripts to capture the driver-generated command lines.
1358 @item -pipe
1359 @opindex pipe
1360 Use pipes rather than temporary files for communication between the
1361 various stages of compilation.  This fails to work on some systems where
1362 the assembler is unable to read from a pipe; but the GNU assembler has
1363 no trouble.
1365 @item --help
1366 @opindex help
1367 Print (on the standard output) a description of the command-line options
1368 understood by @command{gcc}.  If the @option{-v} option is also specified
1369 then @option{--help} is also passed on to the various processes
1370 invoked by @command{gcc}, so that they can display the command-line options
1371 they accept.  If the @option{-Wextra} option has also been specified
1372 (prior to the @option{--help} option), then command-line options that
1373 have no documentation associated with them are also displayed.
1375 @item --target-help
1376 @opindex target-help
1377 Print (on the standard output) a description of target-specific command-line
1378 options for each tool.  For some targets extra target-specific
1379 information may also be printed.
1381 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1382 Print (on the standard output) a description of the command-line
1383 options understood by the compiler that fit into all specified classes
1384 and qualifiers.  These are the supported classes:
1386 @table @asis
1387 @item @samp{optimizers}
1388 Display all of the optimization options supported by the
1389 compiler.
1391 @item @samp{warnings}
1392 Display all of the options controlling warning messages
1393 produced by the compiler.
1395 @item @samp{target}
1396 Display target-specific options.  Unlike the
1397 @option{--target-help} option however, target-specific options of the
1398 linker and assembler are not displayed.  This is because those
1399 tools do not currently support the extended @option{--help=} syntax.
1401 @item @samp{params}
1402 Display the values recognized by the @option{--param}
1403 option.
1405 @item @var{language}
1406 Display the options supported for @var{language}, where
1407 @var{language} is the name of one of the languages supported in this
1408 version of GCC@.
1410 @item @samp{common}
1411 Display the options that are common to all languages.
1412 @end table
1414 These are the supported qualifiers:
1416 @table @asis
1417 @item @samp{undocumented}
1418 Display only those options that are undocumented.
1420 @item @samp{joined}
1421 Display options taking an argument that appears after an equal
1422 sign in the same continuous piece of text, such as:
1423 @samp{--help=target}.
1425 @item @samp{separate}
1426 Display options taking an argument that appears as a separate word
1427 following the original option, such as: @samp{-o output-file}.
1428 @end table
1430 Thus for example to display all the undocumented target-specific
1431 switches supported by the compiler, use:
1433 @smallexample
1434 --help=target,undocumented
1435 @end smallexample
1437 The sense of a qualifier can be inverted by prefixing it with the
1438 @samp{^} character, so for example to display all binary warning
1439 options (i.e., ones that are either on or off and that do not take an
1440 argument) that have a description, use:
1442 @smallexample
1443 --help=warnings,^joined,^undocumented
1444 @end smallexample
1446 The argument to @option{--help=} should not consist solely of inverted
1447 qualifiers.
1449 Combining several classes is possible, although this usually
1450 restricts the output so much that there is nothing to display.  One
1451 case where it does work, however, is when one of the classes is
1452 @var{target}.  For example, to display all the target-specific
1453 optimization options, use:
1455 @smallexample
1456 --help=target,optimizers
1457 @end smallexample
1459 The @option{--help=} option can be repeated on the command line.  Each
1460 successive use displays its requested class of options, skipping
1461 those that have already been displayed.
1463 If the @option{-Q} option appears on the command line before the
1464 @option{--help=} option, then the descriptive text displayed by
1465 @option{--help=} is changed.  Instead of describing the displayed
1466 options, an indication is given as to whether the option is enabled,
1467 disabled or set to a specific value (assuming that the compiler
1468 knows this at the point where the @option{--help=} option is used).
1470 Here is a truncated example from the ARM port of @command{gcc}:
1472 @smallexample
1473   % gcc -Q -mabi=2 --help=target -c
1474   The following options are target specific:
1475   -mabi=                                2
1476   -mabort-on-noreturn                   [disabled]
1477   -mapcs                                [disabled]
1478 @end smallexample
1480 The output is sensitive to the effects of previous command-line
1481 options, so for example it is possible to find out which optimizations
1482 are enabled at @option{-O2} by using:
1484 @smallexample
1485 -Q -O2 --help=optimizers
1486 @end smallexample
1488 Alternatively you can discover which binary optimizations are enabled
1489 by @option{-O3} by using:
1491 @smallexample
1492 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1493 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1494 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1495 @end smallexample
1497 @item -no-canonical-prefixes
1498 @opindex no-canonical-prefixes
1499 Do not expand any symbolic links, resolve references to @samp{/../}
1500 or @samp{/./}, or make the path absolute when generating a relative
1501 prefix.
1503 @item --version
1504 @opindex version
1505 Display the version number and copyrights of the invoked GCC@.
1507 @item -wrapper
1508 @opindex wrapper
1509 Invoke all subcommands under a wrapper program.  The name of the
1510 wrapper program and its parameters are passed as a comma separated
1511 list.
1513 @smallexample
1514 gcc -c t.c -wrapper gdb,--args
1515 @end smallexample
1517 @noindent
1518 This invokes all subprograms of @command{gcc} under
1519 @samp{gdb --args}, thus the invocation of @command{cc1} is
1520 @samp{gdb --args cc1 @dots{}}.
1522 @item -fplugin=@var{name}.so
1523 @opindex fplugin
1524 Load the plugin code in file @var{name}.so, assumed to be a
1525 shared object to be dlopen'd by the compiler.  The base name of
1526 the shared object file is used to identify the plugin for the
1527 purposes of argument parsing (See
1528 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1529 Each plugin should define the callback functions specified in the
1530 Plugins API.
1532 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1533 @opindex fplugin-arg
1534 Define an argument called @var{key} with a value of @var{value}
1535 for the plugin called @var{name}.
1537 @item -fdump-ada-spec@r{[}-slim@r{]}
1538 @opindex fdump-ada-spec
1539 For C and C++ source and include files, generate corresponding Ada specs.
1540 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1541 GNAT User's Guide}, which provides detailed documentation on this feature.
1543 @item -fada-spec-parent=@var{unit}
1544 @opindex fada-spec-parent
1545 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1546 Ada specs as child units of parent @var{unit}.
1548 @item -fdump-go-spec=@var{file}
1549 @opindex fdump-go-spec
1550 For input files in any language, generate corresponding Go
1551 declarations in @var{file}.  This generates Go @code{const},
1552 @code{type}, @code{var}, and @code{func} declarations which may be a
1553 useful way to start writing a Go interface to code written in some
1554 other language.
1556 @include @value{srcdir}/../libiberty/at-file.texi
1557 @end table
1559 @node Invoking G++
1560 @section Compiling C++ Programs
1562 @cindex suffixes for C++ source
1563 @cindex C++ source file suffixes
1564 C++ source files conventionally use one of the suffixes @samp{.C},
1565 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1566 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1567 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1568 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1569 files with these names and compiles them as C++ programs even if you
1570 call the compiler the same way as for compiling C programs (usually
1571 with the name @command{gcc}).
1573 @findex g++
1574 @findex c++
1575 However, the use of @command{gcc} does not add the C++ library.
1576 @command{g++} is a program that calls GCC and automatically specifies linking
1577 against the C++ library.  It treats @samp{.c},
1578 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1579 files unless @option{-x} is used.  This program is also useful when
1580 precompiling a C header file with a @samp{.h} extension for use in C++
1581 compilations.  On many systems, @command{g++} is also installed with
1582 the name @command{c++}.
1584 @cindex invoking @command{g++}
1585 When you compile C++ programs, you may specify many of the same
1586 command-line options that you use for compiling programs in any
1587 language; or command-line options meaningful for C and related
1588 languages; or options that are meaningful only for C++ programs.
1589 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1590 explanations of options for languages related to C@.
1591 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1592 explanations of options that are meaningful only for C++ programs.
1594 @node C Dialect Options
1595 @section Options Controlling C Dialect
1596 @cindex dialect options
1597 @cindex language dialect options
1598 @cindex options, dialect
1600 The following options control the dialect of C (or languages derived
1601 from C, such as C++, Objective-C and Objective-C++) that the compiler
1602 accepts:
1604 @table @gcctabopt
1605 @cindex ANSI support
1606 @cindex ISO support
1607 @item -ansi
1608 @opindex ansi
1609 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1610 equivalent to @option{-std=c++98}.
1612 This turns off certain features of GCC that are incompatible with ISO
1613 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1614 such as the @code{asm} and @code{typeof} keywords, and
1615 predefined macros such as @code{unix} and @code{vax} that identify the
1616 type of system you are using.  It also enables the undesirable and
1617 rarely used ISO trigraph feature.  For the C compiler,
1618 it disables recognition of C++ style @samp{//} comments as well as
1619 the @code{inline} keyword.
1621 The alternate keywords @code{__asm__}, @code{__extension__},
1622 @code{__inline__} and @code{__typeof__} continue to work despite
1623 @option{-ansi}.  You would not want to use them in an ISO C program, of
1624 course, but it is useful to put them in header files that might be included
1625 in compilations done with @option{-ansi}.  Alternate predefined macros
1626 such as @code{__unix__} and @code{__vax__} are also available, with or
1627 without @option{-ansi}.
1629 The @option{-ansi} option does not cause non-ISO programs to be
1630 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1631 addition to @option{-ansi}.  @xref{Warning Options}.
1633 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1634 option is used.  Some header files may notice this macro and refrain
1635 from declaring certain functions or defining certain macros that the
1636 ISO standard doesn't call for; this is to avoid interfering with any
1637 programs that might use these names for other things.
1639 Functions that are normally built in but do not have semantics
1640 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1641 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1642 built-in functions provided by GCC}, for details of the functions
1643 affected.
1645 @item -std=
1646 @opindex std
1647 Determine the language standard. @xref{Standards,,Language Standards
1648 Supported by GCC}, for details of these standard versions.  This option
1649 is currently only supported when compiling C or C++.
1651 The compiler can accept several base standards, such as @samp{c90} or
1652 @samp{c++98}, and GNU dialects of those standards, such as
1653 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1654 compiler accepts all programs following that standard plus those
1655 using GNU extensions that do not contradict it.  For example,
1656 @option{-std=c90} turns off certain features of GCC that are
1657 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1658 keywords, but not other GNU extensions that do not have a meaning in
1659 ISO C90, such as omitting the middle term of a @code{?:}
1660 expression. On the other hand, when a GNU dialect of a standard is
1661 specified, all features supported by the compiler are enabled, even when
1662 those features change the meaning of the base standard.  As a result, some
1663 strict-conforming programs may be rejected.  The particular standard
1664 is used by @option{-Wpedantic} to identify which features are GNU
1665 extensions given that version of the standard. For example
1666 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1667 comments, while @option{-std=gnu99 -Wpedantic} does not.
1669 A value for this option must be provided; possible values are
1671 @table @samp
1672 @item c90
1673 @itemx c89
1674 @itemx iso9899:1990
1675 Support all ISO C90 programs (certain GNU extensions that conflict
1676 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1678 @item iso9899:199409
1679 ISO C90 as modified in amendment 1.
1681 @item c99
1682 @itemx c9x
1683 @itemx iso9899:1999
1684 @itemx iso9899:199x
1685 ISO C99.  This standard is substantially completely supported, modulo
1686 bugs and floating-point issues
1687 (mainly but not entirely relating to optional C99 features from
1688 Annexes F and G).  See
1689 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1690 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1692 @item c11
1693 @itemx c1x
1694 @itemx iso9899:2011
1695 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1696 substantially completely supported, modulo bugs, floating-point issues
1697 (mainly but not entirely relating to optional C11 features from
1698 Annexes F and G) and the optional Annexes K (Bounds-checking
1699 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1701 @item gnu90
1702 @itemx gnu89
1703 GNU dialect of ISO C90 (including some C99 features).
1705 @item gnu99
1706 @itemx gnu9x
1707 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1709 @item gnu11
1710 @itemx gnu1x
1711 GNU dialect of ISO C11.  This is the default for C code.
1712 The name @samp{gnu1x} is deprecated.
1714 @item c++98
1715 @itemx c++03
1716 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1717 additional defect reports. Same as @option{-ansi} for C++ code.
1719 @item gnu++98
1720 @itemx gnu++03
1721 GNU dialect of @option{-std=c++98}.  This is the default for
1722 C++ code.
1724 @item c++11
1725 @itemx c++0x
1726 The 2011 ISO C++ standard plus amendments.
1727 The name @samp{c++0x} is deprecated.
1729 @item gnu++11
1730 @itemx gnu++0x
1731 GNU dialect of @option{-std=c++11}.
1732 The name @samp{gnu++0x} is deprecated.
1734 @item c++14
1735 @itemx c++1y
1736 The 2014 ISO C++ standard plus amendments.
1737 The name @samp{c++1y} is deprecated.
1739 @item gnu++14
1740 @itemx gnu++1y
1741 GNU dialect of @option{-std=c++14}.
1742 The name @samp{gnu++1y} is deprecated.
1744 @item c++1z
1745 The next revision of the ISO C++ standard, tentatively planned for
1746 2017.  Support is highly experimental, and will almost certainly
1747 change in incompatible ways in future releases.
1749 @item gnu++1z
1750 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1751 and will almost certainly change in incompatible ways in future
1752 releases.
1753 @end table
1755 @item -fgnu89-inline
1756 @opindex fgnu89-inline
1757 The option @option{-fgnu89-inline} tells GCC to use the traditional
1758 GNU semantics for @code{inline} functions when in C99 mode.
1759 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1760 is accepted and ignored by GCC versions 4.1.3 up to but not including
1761 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1762 C99 mode.  Using this option is roughly equivalent to adding the
1763 @code{gnu_inline} function attribute to all inline functions
1764 (@pxref{Function Attributes}).
1766 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1767 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1768 specifies the default behavior).  This option was first supported in
1769 GCC 4.3.  This option is not supported in @option{-std=c90} or
1770 @option{-std=gnu90} mode.
1772 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1773 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1774 in effect for @code{inline} functions.  @xref{Common Predefined
1775 Macros,,,cpp,The C Preprocessor}.
1777 @item -aux-info @var{filename}
1778 @opindex aux-info
1779 Output to the given filename prototyped declarations for all functions
1780 declared and/or defined in a translation unit, including those in header
1781 files.  This option is silently ignored in any language other than C@.
1783 Besides declarations, the file indicates, in comments, the origin of
1784 each declaration (source file and line), whether the declaration was
1785 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1786 @samp{O} for old, respectively, in the first character after the line
1787 number and the colon), and whether it came from a declaration or a
1788 definition (@samp{C} or @samp{F}, respectively, in the following
1789 character).  In the case of function definitions, a K&R-style list of
1790 arguments followed by their declarations is also provided, inside
1791 comments, after the declaration.
1793 @item -fallow-parameterless-variadic-functions
1794 @opindex fallow-parameterless-variadic-functions
1795 Accept variadic functions without named parameters.
1797 Although it is possible to define such a function, this is not very
1798 useful as it is not possible to read the arguments.  This is only
1799 supported for C as this construct is allowed by C++.
1801 @item -fno-asm
1802 @opindex fno-asm
1803 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1804 keyword, so that code can use these words as identifiers.  You can use
1805 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1806 instead.  @option{-ansi} implies @option{-fno-asm}.
1808 In C++, this switch only affects the @code{typeof} keyword, since
1809 @code{asm} and @code{inline} are standard keywords.  You may want to
1810 use the @option{-fno-gnu-keywords} flag instead, which has the same
1811 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1812 switch only affects the @code{asm} and @code{typeof} keywords, since
1813 @code{inline} is a standard keyword in ISO C99.
1815 @item -fno-builtin
1816 @itemx -fno-builtin-@var{function}
1817 @opindex fno-builtin
1818 @cindex built-in functions
1819 Don't recognize built-in functions that do not begin with
1820 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1821 functions provided by GCC}, for details of the functions affected,
1822 including those which are not built-in functions when @option{-ansi} or
1823 @option{-std} options for strict ISO C conformance are used because they
1824 do not have an ISO standard meaning.
1826 GCC normally generates special code to handle certain built-in functions
1827 more efficiently; for instance, calls to @code{alloca} may become single
1828 instructions which adjust the stack directly, and calls to @code{memcpy}
1829 may become inline copy loops.  The resulting code is often both smaller
1830 and faster, but since the function calls no longer appear as such, you
1831 cannot set a breakpoint on those calls, nor can you change the behavior
1832 of the functions by linking with a different library.  In addition,
1833 when a function is recognized as a built-in function, GCC may use
1834 information about that function to warn about problems with calls to
1835 that function, or to generate more efficient code, even if the
1836 resulting code still contains calls to that function.  For example,
1837 warnings are given with @option{-Wformat} for bad calls to
1838 @code{printf} when @code{printf} is built in and @code{strlen} is
1839 known not to modify global memory.
1841 With the @option{-fno-builtin-@var{function}} option
1842 only the built-in function @var{function} is
1843 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1844 function is named that is not built-in in this version of GCC, this
1845 option is ignored.  There is no corresponding
1846 @option{-fbuiltin-@var{function}} option; if you wish to enable
1847 built-in functions selectively when using @option{-fno-builtin} or
1848 @option{-ffreestanding}, you may define macros such as:
1850 @smallexample
1851 #define abs(n)          __builtin_abs ((n))
1852 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1853 @end smallexample
1855 @item -fhosted
1856 @opindex fhosted
1857 @cindex hosted environment
1859 Assert that compilation targets a hosted environment.  This implies
1860 @option{-fbuiltin}.  A hosted environment is one in which the
1861 entire standard library is available, and in which @code{main} has a return
1862 type of @code{int}.  Examples are nearly everything except a kernel.
1863 This is equivalent to @option{-fno-freestanding}.
1865 @item -ffreestanding
1866 @opindex ffreestanding
1867 @cindex hosted environment
1869 Assert that compilation targets a freestanding environment.  This
1870 implies @option{-fno-builtin}.  A freestanding environment
1871 is one in which the standard library may not exist, and program startup may
1872 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1873 This is equivalent to @option{-fno-hosted}.
1875 @xref{Standards,,Language Standards Supported by GCC}, for details of
1876 freestanding and hosted environments.
1878 @item -fopenmp
1879 @opindex fopenmp
1880 @cindex OpenMP parallel
1881 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1882 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1883 compiler generates parallel code according to the OpenMP Application
1884 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1885 implies @option{-pthread}, and thus is only supported on targets that
1886 have support for @option{-pthread}. @option{-fopenmp} implies
1887 @option{-fopenmp-simd}.
1889 @item -fopenmp-simd
1890 @opindex fopenmp-simd
1891 @cindex OpenMP SIMD
1892 @cindex SIMD
1893 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1894 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1895 are ignored.
1897 @item -fcilkplus
1898 @opindex fcilkplus
1899 @cindex Enable Cilk Plus
1900 Enable the usage of Cilk Plus language extension features for C/C++.
1901 When the option @option{-fcilkplus} is specified, enable the usage of
1902 the Cilk Plus Language extension features for C/C++.  The present
1903 implementation follows ABI version 1.2.  This is an experimental
1904 feature that is only partially complete, and whose interface may
1905 change in future versions of GCC as the official specification
1906 changes.  Currently, all features but @code{_Cilk_for} have been
1907 implemented.
1909 @item -fgnu-tm
1910 @opindex fgnu-tm
1911 When the option @option{-fgnu-tm} is specified, the compiler
1912 generates code for the Linux variant of Intel's current Transactional
1913 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1914 an experimental feature whose interface may change in future versions
1915 of GCC, as the official specification changes.  Please note that not
1916 all architectures are supported for this feature.
1918 For more information on GCC's support for transactional memory,
1919 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1920 Transactional Memory Library}.
1922 Note that the transactional memory feature is not supported with
1923 non-call exceptions (@option{-fnon-call-exceptions}).
1925 @item -fms-extensions
1926 @opindex fms-extensions
1927 Accept some non-standard constructs used in Microsoft header files.
1929 In C++ code, this allows member names in structures to be similar
1930 to previous types declarations.
1932 @smallexample
1933 typedef int UOW;
1934 struct ABC @{
1935   UOW UOW;
1937 @end smallexample
1939 Some cases of unnamed fields in structures and unions are only
1940 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1941 fields within structs/unions}, for details.
1943 Note that this option is off for all targets but i?86 and x86_64
1944 targets using ms-abi.
1946 @item -fplan9-extensions
1947 @opindex fplan9-extensions
1948 Accept some non-standard constructs used in Plan 9 code.
1950 This enables @option{-fms-extensions}, permits passing pointers to
1951 structures with anonymous fields to functions that expect pointers to
1952 elements of the type of the field, and permits referring to anonymous
1953 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1954 struct/union fields within structs/unions}, for details.  This is only
1955 supported for C, not C++.
1957 @item -trigraphs
1958 @opindex trigraphs
1959 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1960 options for strict ISO C conformance) implies @option{-trigraphs}.
1962 @cindex traditional C language
1963 @cindex C language, traditional
1964 @item -traditional
1965 @itemx -traditional-cpp
1966 @opindex traditional-cpp
1967 @opindex traditional
1968 Formerly, these options caused GCC to attempt to emulate a pre-standard
1969 C compiler.  They are now only supported with the @option{-E} switch.
1970 The preprocessor continues to support a pre-standard mode.  See the GNU
1971 CPP manual for details.
1973 @item -fcond-mismatch
1974 @opindex fcond-mismatch
1975 Allow conditional expressions with mismatched types in the second and
1976 third arguments.  The value of such an expression is void.  This option
1977 is not supported for C++.
1979 @item -flax-vector-conversions
1980 @opindex flax-vector-conversions
1981 Allow implicit conversions between vectors with differing numbers of
1982 elements and/or incompatible element types.  This option should not be
1983 used for new code.
1985 @item -funsigned-char
1986 @opindex funsigned-char
1987 Let the type @code{char} be unsigned, like @code{unsigned char}.
1989 Each kind of machine has a default for what @code{char} should
1990 be.  It is either like @code{unsigned char} by default or like
1991 @code{signed char} by default.
1993 Ideally, a portable program should always use @code{signed char} or
1994 @code{unsigned char} when it depends on the signedness of an object.
1995 But many programs have been written to use plain @code{char} and
1996 expect it to be signed, or expect it to be unsigned, depending on the
1997 machines they were written for.  This option, and its inverse, let you
1998 make such a program work with the opposite default.
2000 The type @code{char} is always a distinct type from each of
2001 @code{signed char} or @code{unsigned char}, even though its behavior
2002 is always just like one of those two.
2004 @item -fsigned-char
2005 @opindex fsigned-char
2006 Let the type @code{char} be signed, like @code{signed char}.
2008 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2009 the negative form of @option{-funsigned-char}.  Likewise, the option
2010 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2012 @item -fsigned-bitfields
2013 @itemx -funsigned-bitfields
2014 @itemx -fno-signed-bitfields
2015 @itemx -fno-unsigned-bitfields
2016 @opindex fsigned-bitfields
2017 @opindex funsigned-bitfields
2018 @opindex fno-signed-bitfields
2019 @opindex fno-unsigned-bitfields
2020 These options control whether a bit-field is signed or unsigned, when the
2021 declaration does not use either @code{signed} or @code{unsigned}.  By
2022 default, such a bit-field is signed, because this is consistent: the
2023 basic integer types such as @code{int} are signed types.
2024 @end table
2026 @node C++ Dialect Options
2027 @section Options Controlling C++ Dialect
2029 @cindex compiler options, C++
2030 @cindex C++ options, command-line
2031 @cindex options, C++
2032 This section describes the command-line options that are only meaningful
2033 for C++ programs.  You can also use most of the GNU compiler options
2034 regardless of what language your program is in.  For example, you
2035 might compile a file @code{firstClass.C} like this:
2037 @smallexample
2038 g++ -g -frepo -O -c firstClass.C
2039 @end smallexample
2041 @noindent
2042 In this example, only @option{-frepo} is an option meant
2043 only for C++ programs; you can use the other options with any
2044 language supported by GCC@.
2046 Here is a list of options that are @emph{only} for compiling C++ programs:
2048 @table @gcctabopt
2050 @item -fabi-version=@var{n}
2051 @opindex fabi-version
2052 Use version @var{n} of the C++ ABI@.  The default is version 0.
2054 Version 0 refers to the version conforming most closely to
2055 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2056 will change in different versions of G++ as ABI bugs are fixed.
2058 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2060 Version 2 is the version of the C++ ABI that first appeared in G++
2061 3.4, and was the default through G++ 4.9.
2063 Version 3 corrects an error in mangling a constant address as a
2064 template argument.
2066 Version 4, which first appeared in G++ 4.5, implements a standard
2067 mangling for vector types.
2069 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2070 attribute const/volatile on function pointer types, decltype of a
2071 plain decl, and use of a function parameter in the declaration of
2072 another parameter.
2074 Version 6, which first appeared in G++ 4.7, corrects the promotion
2075 behavior of C++11 scoped enums and the mangling of template argument
2076 packs, const/static_cast, prefix ++ and --, and a class scope function
2077 used as a template argument.
2079 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2080 builtin type and corrects the mangling of lambdas in default argument
2081 scope.
2083 Version 8, which first appeared in G++ 4.9, corrects the substitution
2084 behavior of function types with function-cv-qualifiers.
2086 See also @option{-Wabi}.
2088 @item -fabi-compat-version=@var{n}
2089 @opindex fabi-compat-version
2090 Starting with GCC 4.5, on targets that support strong aliases, G++
2091 works around mangling changes by creating an alias with the correct
2092 mangled name when defining a symbol with an incorrect mangled name.
2093 This switch specifies which ABI version to use for the alias.
2095 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2096 another ABI version is explicitly selected, this defaults to 0.
2098 The compatibility version is also set by @option{-Wabi=@var{n}}.
2100 @item -fno-access-control
2101 @opindex fno-access-control
2102 Turn off all access checking.  This switch is mainly useful for working
2103 around bugs in the access control code.
2105 @item -fcheck-new
2106 @opindex fcheck-new
2107 Check that the pointer returned by @code{operator new} is non-null
2108 before attempting to modify the storage allocated.  This check is
2109 normally unnecessary because the C++ standard specifies that
2110 @code{operator new} only returns @code{0} if it is declared
2111 @samp{throw()}, in which case the compiler always checks the
2112 return value even without this option.  In all other cases, when
2113 @code{operator new} has a non-empty exception specification, memory
2114 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2115 @samp{new (nothrow)}.
2117 @item -fconstexpr-depth=@var{n}
2118 @opindex fconstexpr-depth
2119 Set the maximum nested evaluation depth for C++11 constexpr functions
2120 to @var{n}.  A limit is needed to detect endless recursion during
2121 constant expression evaluation.  The minimum specified by the standard
2122 is 512.
2124 @item -fdeduce-init-list
2125 @opindex fdeduce-init-list
2126 Enable deduction of a template type parameter as
2127 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2129 @smallexample
2130 template <class T> auto forward(T t) -> decltype (realfn (t))
2132   return realfn (t);
2135 void f()
2137   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2139 @end smallexample
2141 This deduction was implemented as a possible extension to the
2142 originally proposed semantics for the C++11 standard, but was not part
2143 of the final standard, so it is disabled by default.  This option is
2144 deprecated, and may be removed in a future version of G++.
2146 @item -ffriend-injection
2147 @opindex ffriend-injection
2148 Inject friend functions into the enclosing namespace, so that they are
2149 visible outside the scope of the class in which they are declared.
2150 Friend functions were documented to work this way in the old Annotated
2151 C++ Reference Manual, and versions of G++ before 4.1 always worked
2152 that way.  However, in ISO C++ a friend function that is not declared
2153 in an enclosing scope can only be found using argument dependent
2154 lookup.  This option causes friends to be injected as they were in
2155 earlier releases.
2157 This option is for compatibility, and may be removed in a future
2158 release of G++.
2160 @item -fno-elide-constructors
2161 @opindex fno-elide-constructors
2162 The C++ standard allows an implementation to omit creating a temporary
2163 that is only used to initialize another object of the same type.
2164 Specifying this option disables that optimization, and forces G++ to
2165 call the copy constructor in all cases.
2167 @item -fno-enforce-eh-specs
2168 @opindex fno-enforce-eh-specs
2169 Don't generate code to check for violation of exception specifications
2170 at run time.  This option violates the C++ standard, but may be useful
2171 for reducing code size in production builds, much like defining
2172 @samp{NDEBUG}.  This does not give user code permission to throw
2173 exceptions in violation of the exception specifications; the compiler
2174 still optimizes based on the specifications, so throwing an
2175 unexpected exception results in undefined behavior at run time.
2177 @item -fextern-tls-init
2178 @itemx -fno-extern-tls-init
2179 @opindex fextern-tls-init
2180 @opindex fno-extern-tls-init
2181 The C++11 and OpenMP standards allow @samp{thread_local} and
2182 @samp{threadprivate} variables to have dynamic (runtime)
2183 initialization.  To support this, any use of such a variable goes
2184 through a wrapper function that performs any necessary initialization.
2185 When the use and definition of the variable are in the same
2186 translation unit, this overhead can be optimized away, but when the
2187 use is in a different translation unit there is significant overhead
2188 even if the variable doesn't actually need dynamic initialization.  If
2189 the programmer can be sure that no use of the variable in a
2190 non-defining TU needs to trigger dynamic initialization (either
2191 because the variable is statically initialized, or a use of the
2192 variable in the defining TU will be executed before any uses in
2193 another TU), they can avoid this overhead with the
2194 @option{-fno-extern-tls-init} option.
2196 On targets that support symbol aliases, the default is
2197 @option{-fextern-tls-init}.  On targets that do not support symbol
2198 aliases, the default is @option{-fno-extern-tls-init}.
2200 @item -ffor-scope
2201 @itemx -fno-for-scope
2202 @opindex ffor-scope
2203 @opindex fno-for-scope
2204 If @option{-ffor-scope} is specified, the scope of variables declared in
2205 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2206 as specified by the C++ standard.
2207 If @option{-fno-for-scope} is specified, the scope of variables declared in
2208 a @i{for-init-statement} extends to the end of the enclosing scope,
2209 as was the case in old versions of G++, and other (traditional)
2210 implementations of C++.
2212 If neither flag is given, the default is to follow the standard,
2213 but to allow and give a warning for old-style code that would
2214 otherwise be invalid, or have different behavior.
2216 @item -fno-gnu-keywords
2217 @opindex fno-gnu-keywords
2218 Do not recognize @code{typeof} as a keyword, so that code can use this
2219 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2220 @option{-ansi} implies @option{-fno-gnu-keywords}.
2222 @item -fno-implicit-templates
2223 @opindex fno-implicit-templates
2224 Never emit code for non-inline templates that are instantiated
2225 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2226 @xref{Template Instantiation}, for more information.
2228 @item -fno-implicit-inline-templates
2229 @opindex fno-implicit-inline-templates
2230 Don't emit code for implicit instantiations of inline templates, either.
2231 The default is to handle inlines differently so that compiles with and
2232 without optimization need the same set of explicit instantiations.
2234 @item -fno-implement-inlines
2235 @opindex fno-implement-inlines
2236 To save space, do not emit out-of-line copies of inline functions
2237 controlled by @samp{#pragma implementation}.  This causes linker
2238 errors if these functions are not inlined everywhere they are called.
2240 @item -fms-extensions
2241 @opindex fms-extensions
2242 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2243 int and getting a pointer to member function via non-standard syntax.
2245 @item -fno-nonansi-builtins
2246 @opindex fno-nonansi-builtins
2247 Disable built-in declarations of functions that are not mandated by
2248 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2249 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2251 @item -fnothrow-opt
2252 @opindex fnothrow-opt
2253 Treat a @code{throw()} exception specification as if it were a
2254 @code{noexcept} specification to reduce or eliminate the text size
2255 overhead relative to a function with no exception specification.  If
2256 the function has local variables of types with non-trivial
2257 destructors, the exception specification actually makes the
2258 function smaller because the EH cleanups for those variables can be
2259 optimized away.  The semantic effect is that an exception thrown out of
2260 a function with such an exception specification results in a call
2261 to @code{terminate} rather than @code{unexpected}.
2263 @item -fno-operator-names
2264 @opindex fno-operator-names
2265 Do not treat the operator name keywords @code{and}, @code{bitand},
2266 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2267 synonyms as keywords.
2269 @item -fno-optional-diags
2270 @opindex fno-optional-diags
2271 Disable diagnostics that the standard says a compiler does not need to
2272 issue.  Currently, the only such diagnostic issued by G++ is the one for
2273 a name having multiple meanings within a class.
2275 @item -fpermissive
2276 @opindex fpermissive
2277 Downgrade some diagnostics about nonconformant code from errors to
2278 warnings.  Thus, using @option{-fpermissive} allows some
2279 nonconforming code to compile.
2281 @item -fno-pretty-templates
2282 @opindex fno-pretty-templates
2283 When an error message refers to a specialization of a function
2284 template, the compiler normally prints the signature of the
2285 template followed by the template arguments and any typedefs or
2286 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2287 rather than @code{void f(int)}) so that it's clear which template is
2288 involved.  When an error message refers to a specialization of a class
2289 template, the compiler omits any template arguments that match
2290 the default template arguments for that template.  If either of these
2291 behaviors make it harder to understand the error message rather than
2292 easier, you can use @option{-fno-pretty-templates} to disable them.
2294 @item -frepo
2295 @opindex frepo
2296 Enable automatic template instantiation at link time.  This option also
2297 implies @option{-fno-implicit-templates}.  @xref{Template
2298 Instantiation}, for more information.
2300 @item -fno-rtti
2301 @opindex fno-rtti
2302 Disable generation of information about every class with virtual
2303 functions for use by the C++ run-time type identification features
2304 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2305 of the language, you can save some space by using this flag.  Note that
2306 exception handling uses the same information, but G++ generates it as
2307 needed. The @samp{dynamic_cast} operator can still be used for casts that
2308 do not require run-time type information, i.e.@: casts to @code{void *} or to
2309 unambiguous base classes.
2311 @item -fsized-deallocation
2312 @opindex fsized-deallocation
2313 Enable the built-in global declarations
2314 @smallexample
2315 void operator delete (void *, std::size_t) noexcept;
2316 void operator delete[] (void *, std::size_t) noexcept;
2317 @end smallexample
2318 as introduced in C++14.  This is useful for user-defined replacement
2319 deallocation functions that, for example, use the size of the object
2320 to make deallocation faster.  Enabled by default under
2321 @samp{-std=c++14} and above.  The flag @option{-Wsized-deallocation} will
2322 warn about places that might want to add a definition.
2324 @item -fstats
2325 @opindex fstats
2326 Emit statistics about front-end processing at the end of the compilation.
2327 This information is generally only useful to the G++ development team.
2329 @item -fstrict-enums
2330 @opindex fstrict-enums
2331 Allow the compiler to optimize using the assumption that a value of
2332 enumerated type can only be one of the values of the enumeration (as
2333 defined in the C++ standard; basically, a value that can be
2334 represented in the minimum number of bits needed to represent all the
2335 enumerators).  This assumption may not be valid if the program uses a
2336 cast to convert an arbitrary integer value to the enumerated type.
2338 @item -ftemplate-backtrace-limit=@var{n}
2339 @opindex ftemplate-backtrace-limit
2340 Set the maximum number of template instantiation notes for a single
2341 warning or error to @var{n}.  The default value is 10.
2343 @item -ftemplate-depth=@var{n}
2344 @opindex ftemplate-depth
2345 Set the maximum instantiation depth for template classes to @var{n}.
2346 A limit on the template instantiation depth is needed to detect
2347 endless recursions during template class instantiation.  ANSI/ISO C++
2348 conforming programs must not rely on a maximum depth greater than 17
2349 (changed to 1024 in C++11).  The default value is 900, as the compiler
2350 can run out of stack space before hitting 1024 in some situations.
2352 @item -fno-threadsafe-statics
2353 @opindex fno-threadsafe-statics
2354 Do not emit the extra code to use the routines specified in the C++
2355 ABI for thread-safe initialization of local statics.  You can use this
2356 option to reduce code size slightly in code that doesn't need to be
2357 thread-safe.
2359 @item -fuse-cxa-atexit
2360 @opindex fuse-cxa-atexit
2361 Register destructors for objects with static storage duration with the
2362 @code{__cxa_atexit} function rather than the @code{atexit} function.
2363 This option is required for fully standards-compliant handling of static
2364 destructors, but only works if your C library supports
2365 @code{__cxa_atexit}.
2367 @item -fno-use-cxa-get-exception-ptr
2368 @opindex fno-use-cxa-get-exception-ptr
2369 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2370 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2371 if the runtime routine is not available.
2373 @item -fvisibility-inlines-hidden
2374 @opindex fvisibility-inlines-hidden
2375 This switch declares that the user does not attempt to compare
2376 pointers to inline functions or methods where the addresses of the two functions
2377 are taken in different shared objects.
2379 The effect of this is that GCC may, effectively, mark inline methods with
2380 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2381 appear in the export table of a DSO and do not require a PLT indirection
2382 when used within the DSO@.  Enabling this option can have a dramatic effect
2383 on load and link times of a DSO as it massively reduces the size of the
2384 dynamic export table when the library makes heavy use of templates.
2386 The behavior of this switch is not quite the same as marking the
2387 methods as hidden directly, because it does not affect static variables
2388 local to the function or cause the compiler to deduce that
2389 the function is defined in only one shared object.
2391 You may mark a method as having a visibility explicitly to negate the
2392 effect of the switch for that method.  For example, if you do want to
2393 compare pointers to a particular inline method, you might mark it as
2394 having default visibility.  Marking the enclosing class with explicit
2395 visibility has no effect.
2397 Explicitly instantiated inline methods are unaffected by this option
2398 as their linkage might otherwise cross a shared library boundary.
2399 @xref{Template Instantiation}.
2401 @item -fvisibility-ms-compat
2402 @opindex fvisibility-ms-compat
2403 This flag attempts to use visibility settings to make GCC's C++
2404 linkage model compatible with that of Microsoft Visual Studio.
2406 The flag makes these changes to GCC's linkage model:
2408 @enumerate
2409 @item
2410 It sets the default visibility to @code{hidden}, like
2411 @option{-fvisibility=hidden}.
2413 @item
2414 Types, but not their members, are not hidden by default.
2416 @item
2417 The One Definition Rule is relaxed for types without explicit
2418 visibility specifications that are defined in more than one
2419 shared object: those declarations are permitted if they are
2420 permitted when this option is not used.
2421 @end enumerate
2423 In new code it is better to use @option{-fvisibility=hidden} and
2424 export those classes that are intended to be externally visible.
2425 Unfortunately it is possible for code to rely, perhaps accidentally,
2426 on the Visual Studio behavior.
2428 Among the consequences of these changes are that static data members
2429 of the same type with the same name but defined in different shared
2430 objects are different, so changing one does not change the other;
2431 and that pointers to function members defined in different shared
2432 objects may not compare equal.  When this flag is given, it is a
2433 violation of the ODR to define types with the same name differently.
2435 @item -fvtable-verify=@var{std|preinit|none}
2436 @opindex fvtable-verify
2437 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2438 feature that verifies at runtime, for every virtual call that is made, that
2439 the vtable pointer through which the call is made is valid for the type of
2440 the object, and has not been corrupted or overwritten.  If an invalid vtable
2441 pointer is detected (at runtime), an error is reported and execution of the
2442 program is immediately halted.
2444 This option causes runtime data structures to be built, at program start up,
2445 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2446 control the timing of when these data structures are built.  In both cases the
2447 data structures are built before execution reaches 'main'.  The
2448 @option{-fvtable-verify=std} causes these data structure to be built after the
2449 shared libraries have been loaded and initialized.
2450 @option{-fvtable-verify=preinit} causes them to be built before the shared
2451 libraries have been loaded and initialized.
2453 If this option appears multiple times in the compiler line, with different
2454 values specified, 'none' will take highest priority over both 'std' and
2455 'preinit'; 'preinit' will take priority over 'std'.
2457 @item -fvtv-debug
2458 @opindex fvtv-debug
2459 Causes debug versions of the runtime functions for the vtable verification 
2460 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2461 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2462 compiler to keep track of which vtable pointers it found for each class, and
2463 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2464 file directory on the user's machine.
2466 Note:  This feature APPENDS data to the log file. If you want a fresh log
2467 file, be sure to delete any existing one.
2469 @item -fvtv-counts
2470 @opindex fvtv-counts
2471 This is a debugging flag.  When used in conjunction with
2472 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2473 causes the compiler to keep track of the total number of virtual calls
2474 it encountered and the number of verifications it inserted.  It also
2475 counts the number of calls to certain runtime library functions
2476 that it inserts.  This information, for each compilation unit, is written
2477 to a file named ``vtv_count_data.log'', in the dump_file directory on
2478 the user's machine.   It also counts the size of the vtable pointer sets
2479 for each class, and writes this information to ``vtv_class_set_sizes.log''
2480 in the same directory.
2482 Note:  This feature APPENDS data to the log files.  To get a fresh log
2483 files, be sure to delete any existing ones.
2485 @item -fno-weak
2486 @opindex fno-weak
2487 Do not use weak symbol support, even if it is provided by the linker.
2488 By default, G++ uses weak symbols if they are available.  This
2489 option exists only for testing, and should not be used by end-users;
2490 it results in inferior code and has no benefits.  This option may
2491 be removed in a future release of G++.
2493 @item -nostdinc++
2494 @opindex nostdinc++
2495 Do not search for header files in the standard directories specific to
2496 C++, but do still search the other standard directories.  (This option
2497 is used when building the C++ library.)
2498 @end table
2500 In addition, these optimization, warning, and code generation options
2501 have meanings only for C++ programs:
2503 @table @gcctabopt
2504 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2505 @opindex Wabi
2506 @opindex Wno-abi
2507 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2508 G++ to warn when it generates code that is probably not compatible with the
2509 vendor-neutral C++ ABI@.  Since G++ now defaults to
2510 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2511 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2512 or an older compatibility version is selected (with
2513 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2515 Although an effort has been made to warn about
2516 all such cases, there are probably some cases that are not warned about,
2517 even though G++ is generating incompatible code.  There may also be
2518 cases where warnings are emitted even though the code that is generated
2519 is compatible.
2521 You should rewrite your code to avoid these warnings if you are
2522 concerned about the fact that code generated by G++ may not be binary
2523 compatible with code generated by other compilers.
2525 @option{-Wabi} can also be used with an explicit version number to
2526 warn about compatibility with a particular @option{-fabi-version}
2527 level, e.g. @option{-Wabi=2} to warn about changes relative to
2528 @option{-fabi-version=2}.  Specifying a version number also sets
2529 @option{-fabi-compat-version=@var{n}}.
2531 The known incompatibilities in @option{-fabi-version=2} (which was the
2532 default from GCC 3.4 to 4.9) include:
2534 @itemize @bullet
2536 @item
2537 A template with a non-type template parameter of reference type was
2538 mangled incorrectly:
2539 @smallexample
2540 extern int N;
2541 template <int &> struct S @{@};
2542 void n (S<N>) @{2@}
2543 @end smallexample
2545 This was fixed in @option{-fabi-version=3}.
2547 @item
2548 SIMD vector types declared using @code{__attribute ((vector_size))} were
2549 mangled in a non-standard way that does not allow for overloading of
2550 functions taking vectors of different sizes.
2552 The mangling was changed in @option{-fabi-version=4}.
2554 @item
2555 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2556 qualifiers, and @code{decltype} of a plain declaration was folded away.
2558 These mangling issues were fixed in @option{-fabi-version=5}.
2560 @item
2561 Scoped enumerators passed as arguments to a variadic function are
2562 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2563 On most targets this does not actually affect the parameter passing
2564 ABI, as there is no way to pass an argument smaller than @samp{int}.
2566 Also, the ABI changed the mangling of template argument packs,
2567 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2568 a class scope function used as a template argument.
2570 These issues were corrected in @option{-fabi-version=6}.
2572 @item
2573 Lambdas in default argument scope were mangled incorrectly, and the
2574 ABI changed the mangling of nullptr_t.
2576 These issues were corrected in @option{-fabi-version=7}.
2578 @item
2579 When mangling a function type with function-cv-qualifiers, the
2580 un-qualified function type was incorrectly treated as a substitution
2581 candidate.
2583 This was fixed in @option{-fabi-version=8}.
2584 @end itemize
2586 It also warns about psABI-related changes.  The known psABI changes at this
2587 point include:
2589 @itemize @bullet
2591 @item
2592 For SysV/x86-64, unions with @code{long double} members are 
2593 passed in memory as specified in psABI.  For example:
2595 @smallexample
2596 union U @{
2597   long double ld;
2598   int i;
2600 @end smallexample
2602 @noindent
2603 @code{union U} is always passed in memory.
2605 @end itemize
2607 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2608 @opindex Wctor-dtor-privacy
2609 @opindex Wno-ctor-dtor-privacy
2610 Warn when a class seems unusable because all the constructors or
2611 destructors in that class are private, and it has neither friends nor
2612 public static member functions.  Also warn if there are no non-private
2613 methods, and there's at least one private member function that isn't
2614 a constructor or destructor.
2616 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2617 @opindex Wdelete-non-virtual-dtor
2618 @opindex Wno-delete-non-virtual-dtor
2619 Warn when @samp{delete} is used to destroy an instance of a class that
2620 has virtual functions and non-virtual destructor. It is unsafe to delete
2621 an instance of a derived class through a pointer to a base class if the
2622 base class does not have a virtual destructor.  This warning is enabled
2623 by @option{-Wall}.
2625 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2626 @opindex Wliteral-suffix
2627 @opindex Wno-literal-suffix
2628 Warn when a string or character literal is followed by a ud-suffix which does
2629 not begin with an underscore.  As a conforming extension, GCC treats such
2630 suffixes as separate preprocessing tokens in order to maintain backwards
2631 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2632 For example:
2634 @smallexample
2635 #define __STDC_FORMAT_MACROS
2636 #include <inttypes.h>
2637 #include <stdio.h>
2639 int main() @{
2640   int64_t i64 = 123;
2641   printf("My int64: %"PRId64"\n", i64);
2643 @end smallexample
2645 In this case, @code{PRId64} is treated as a separate preprocessing token.
2647 This warning is enabled by default.
2649 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2650 @opindex Wnarrowing
2651 @opindex Wno-narrowing
2652 Warn when a narrowing conversion prohibited by C++11 occurs within
2653 @samp{@{ @}}, e.g.
2655 @smallexample
2656 int i = @{ 2.2 @}; // error: narrowing from double to int
2657 @end smallexample
2659 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2661 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2662 non-constants the diagnostic required by the standard.  Note that this
2663 does not affect the meaning of well-formed code; narrowing conversions
2664 are still considered ill-formed in SFINAE context.
2666 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2667 @opindex Wnoexcept
2668 @opindex Wno-noexcept
2669 Warn when a noexcept-expression evaluates to false because of a call
2670 to a function that does not have a non-throwing exception
2671 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2672 the compiler to never throw an exception.
2674 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2675 @opindex Wnon-virtual-dtor
2676 @opindex Wno-non-virtual-dtor
2677 Warn when a class has virtual functions and an accessible non-virtual
2678 destructor itself or in an accessible polymorphic base class, in which
2679 case it is possible but unsafe to delete an instance of a derived
2680 class through a pointer to the class itself or base class.  This
2681 warning is automatically enabled if @option{-Weffc++} is specified.
2683 @item -Wreorder @r{(C++ and Objective-C++ only)}
2684 @opindex Wreorder
2685 @opindex Wno-reorder
2686 @cindex reordering, warning
2687 @cindex warning for reordering of member initializers
2688 Warn when the order of member initializers given in the code does not
2689 match the order in which they must be executed.  For instance:
2691 @smallexample
2692 struct A @{
2693   int i;
2694   int j;
2695   A(): j (0), i (1) @{ @}
2697 @end smallexample
2699 @noindent
2700 The compiler rearranges the member initializers for @samp{i}
2701 and @samp{j} to match the declaration order of the members, emitting
2702 a warning to that effect.  This warning is enabled by @option{-Wall}.
2704 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2705 @opindex fext-numeric-literals
2706 @opindex fno-ext-numeric-literals
2707 Accept imaginary, fixed-point, or machine-defined
2708 literal number suffixes as GNU extensions.
2709 When this option is turned off these suffixes are treated
2710 as C++11 user-defined literal numeric suffixes.
2711 This is on by default for all pre-C++11 dialects and all GNU dialects:
2712 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2713 @option{-std=gnu++14}.
2714 This option is off by default
2715 for ISO C++11 onwards (@option{-std=c++11}, ...).
2716 @end table
2718 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2720 @table @gcctabopt
2721 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2722 @opindex Weffc++
2723 @opindex Wno-effc++
2724 Warn about violations of the following style guidelines from Scott Meyers'
2725 @cite{Effective C++} series of books:
2727 @itemize @bullet
2728 @item
2729 Define a copy constructor and an assignment operator for classes
2730 with dynamically-allocated memory.
2732 @item
2733 Prefer initialization to assignment in constructors.
2735 @item
2736 Have @code{operator=} return a reference to @code{*this}.
2738 @item
2739 Don't try to return a reference when you must return an object.
2741 @item
2742 Distinguish between prefix and postfix forms of increment and
2743 decrement operators.
2745 @item
2746 Never overload @code{&&}, @code{||}, or @code{,}.
2748 @end itemize
2750 This option also enables @option{-Wnon-virtual-dtor}, which is also
2751 one of the effective C++ recommendations.  However, the check is
2752 extended to warn about the lack of virtual destructor in accessible
2753 non-polymorphic bases classes too.
2755 When selecting this option, be aware that the standard library
2756 headers do not obey all of these guidelines; use @samp{grep -v}
2757 to filter out those warnings.
2759 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2760 @opindex Wstrict-null-sentinel
2761 @opindex Wno-strict-null-sentinel
2762 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2763 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2764 to @code{__null}.  Although it is a null pointer constant rather than a
2765 null pointer, it is guaranteed to be of the same size as a pointer.
2766 But this use is not portable across different compilers.
2768 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2769 @opindex Wno-non-template-friend
2770 @opindex Wnon-template-friend
2771 Disable warnings when non-templatized friend functions are declared
2772 within a template.  Since the advent of explicit template specification
2773 support in G++, if the name of the friend is an unqualified-id (i.e.,
2774 @samp{friend foo(int)}), the C++ language specification demands that the
2775 friend declare or define an ordinary, nontemplate function.  (Section
2776 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2777 could be interpreted as a particular specialization of a templatized
2778 function.  Because this non-conforming behavior is no longer the default
2779 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2780 check existing code for potential trouble spots and is on by default.
2781 This new compiler behavior can be turned off with
2782 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2783 but disables the helpful warning.
2785 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2786 @opindex Wold-style-cast
2787 @opindex Wno-old-style-cast
2788 Warn if an old-style (C-style) cast to a non-void type is used within
2789 a C++ program.  The new-style casts (@samp{dynamic_cast},
2790 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2791 less vulnerable to unintended effects and much easier to search for.
2793 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2794 @opindex Woverloaded-virtual
2795 @opindex Wno-overloaded-virtual
2796 @cindex overloaded virtual function, warning
2797 @cindex warning for overloaded virtual function
2798 Warn when a function declaration hides virtual functions from a
2799 base class.  For example, in:
2801 @smallexample
2802 struct A @{
2803   virtual void f();
2806 struct B: public A @{
2807   void f(int);
2809 @end smallexample
2811 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2812 like:
2814 @smallexample
2815 B* b;
2816 b->f();
2817 @end smallexample
2819 @noindent
2820 fails to compile.
2822 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2823 @opindex Wno-pmf-conversions
2824 @opindex Wpmf-conversions
2825 Disable the diagnostic for converting a bound pointer to member function
2826 to a plain pointer.
2828 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2829 @opindex Wsign-promo
2830 @opindex Wno-sign-promo
2831 Warn when overload resolution chooses a promotion from unsigned or
2832 enumerated type to a signed type, over a conversion to an unsigned type of
2833 the same size.  Previous versions of G++ tried to preserve
2834 unsignedness, but the standard mandates the current behavior.
2835 @end table
2837 @node Objective-C and Objective-C++ Dialect Options
2838 @section Options Controlling Objective-C and Objective-C++ Dialects
2840 @cindex compiler options, Objective-C and Objective-C++
2841 @cindex Objective-C and Objective-C++ options, command-line
2842 @cindex options, Objective-C and Objective-C++
2843 (NOTE: This manual does not describe the Objective-C and Objective-C++
2844 languages themselves.  @xref{Standards,,Language Standards
2845 Supported by GCC}, for references.)
2847 This section describes the command-line options that are only meaningful
2848 for Objective-C and Objective-C++ programs.  You can also use most of
2849 the language-independent GNU compiler options.
2850 For example, you might compile a file @code{some_class.m} like this:
2852 @smallexample
2853 gcc -g -fgnu-runtime -O -c some_class.m
2854 @end smallexample
2856 @noindent
2857 In this example, @option{-fgnu-runtime} is an option meant only for
2858 Objective-C and Objective-C++ programs; you can use the other options with
2859 any language supported by GCC@.
2861 Note that since Objective-C is an extension of the C language, Objective-C
2862 compilations may also use options specific to the C front-end (e.g.,
2863 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2864 C++-specific options (e.g., @option{-Wabi}).
2866 Here is a list of options that are @emph{only} for compiling Objective-C
2867 and Objective-C++ programs:
2869 @table @gcctabopt
2870 @item -fconstant-string-class=@var{class-name}
2871 @opindex fconstant-string-class
2872 Use @var{class-name} as the name of the class to instantiate for each
2873 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2874 class name is @code{NXConstantString} if the GNU runtime is being used, and
2875 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2876 @option{-fconstant-cfstrings} option, if also present, overrides the
2877 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2878 to be laid out as constant CoreFoundation strings.
2880 @item -fgnu-runtime
2881 @opindex fgnu-runtime
2882 Generate object code compatible with the standard GNU Objective-C
2883 runtime.  This is the default for most types of systems.
2885 @item -fnext-runtime
2886 @opindex fnext-runtime
2887 Generate output compatible with the NeXT runtime.  This is the default
2888 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2889 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2890 used.
2892 @item -fno-nil-receivers
2893 @opindex fno-nil-receivers
2894 Assume that all Objective-C message dispatches (@code{[receiver
2895 message:arg]}) in this translation unit ensure that the receiver is
2896 not @code{nil}.  This allows for more efficient entry points in the
2897 runtime to be used.  This option is only available in conjunction with
2898 the NeXT runtime and ABI version 0 or 1.
2900 @item -fobjc-abi-version=@var{n}
2901 @opindex fobjc-abi-version
2902 Use version @var{n} of the Objective-C ABI for the selected runtime.
2903 This option is currently supported only for the NeXT runtime.  In that
2904 case, Version 0 is the traditional (32-bit) ABI without support for
2905 properties and other Objective-C 2.0 additions.  Version 1 is the
2906 traditional (32-bit) ABI with support for properties and other
2907 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2908 nothing is specified, the default is Version 0 on 32-bit target
2909 machines, and Version 2 on 64-bit target machines.
2911 @item -fobjc-call-cxx-cdtors
2912 @opindex fobjc-call-cxx-cdtors
2913 For each Objective-C class, check if any of its instance variables is a
2914 C++ object with a non-trivial default constructor.  If so, synthesize a
2915 special @code{- (id) .cxx_construct} instance method which runs
2916 non-trivial default constructors on any such instance variables, in order,
2917 and then return @code{self}.  Similarly, check if any instance variable
2918 is a C++ object with a non-trivial destructor, and if so, synthesize a
2919 special @code{- (void) .cxx_destruct} method which runs
2920 all such default destructors, in reverse order.
2922 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2923 methods thusly generated only operate on instance variables
2924 declared in the current Objective-C class, and not those inherited
2925 from superclasses.  It is the responsibility of the Objective-C
2926 runtime to invoke all such methods in an object's inheritance
2927 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2928 by the runtime immediately after a new object instance is allocated;
2929 the @code{- (void) .cxx_destruct} methods are invoked immediately
2930 before the runtime deallocates an object instance.
2932 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2933 support for invoking the @code{- (id) .cxx_construct} and
2934 @code{- (void) .cxx_destruct} methods.
2936 @item -fobjc-direct-dispatch
2937 @opindex fobjc-direct-dispatch
2938 Allow fast jumps to the message dispatcher.  On Darwin this is
2939 accomplished via the comm page.
2941 @item -fobjc-exceptions
2942 @opindex fobjc-exceptions
2943 Enable syntactic support for structured exception handling in
2944 Objective-C, similar to what is offered by C++ and Java.  This option
2945 is required to use the Objective-C keywords @code{@@try},
2946 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2947 @code{@@synchronized}.  This option is available with both the GNU
2948 runtime and the NeXT runtime (but not available in conjunction with
2949 the NeXT runtime on Mac OS X 10.2 and earlier).
2951 @item -fobjc-gc
2952 @opindex fobjc-gc
2953 Enable garbage collection (GC) in Objective-C and Objective-C++
2954 programs.  This option is only available with the NeXT runtime; the
2955 GNU runtime has a different garbage collection implementation that
2956 does not require special compiler flags.
2958 @item -fobjc-nilcheck
2959 @opindex fobjc-nilcheck
2960 For the NeXT runtime with version 2 of the ABI, check for a nil
2961 receiver in method invocations before doing the actual method call.
2962 This is the default and can be disabled using
2963 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2964 checked for nil in this way no matter what this flag is set to.
2965 Currently this flag does nothing when the GNU runtime, or an older
2966 version of the NeXT runtime ABI, is used.
2968 @item -fobjc-std=objc1
2969 @opindex fobjc-std
2970 Conform to the language syntax of Objective-C 1.0, the language
2971 recognized by GCC 4.0.  This only affects the Objective-C additions to
2972 the C/C++ language; it does not affect conformance to C/C++ standards,
2973 which is controlled by the separate C/C++ dialect option flags.  When
2974 this option is used with the Objective-C or Objective-C++ compiler,
2975 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2976 This is useful if you need to make sure that your Objective-C code can
2977 be compiled with older versions of GCC@.
2979 @item -freplace-objc-classes
2980 @opindex freplace-objc-classes
2981 Emit a special marker instructing @command{ld(1)} not to statically link in
2982 the resulting object file, and allow @command{dyld(1)} to load it in at
2983 run time instead.  This is used in conjunction with the Fix-and-Continue
2984 debugging mode, where the object file in question may be recompiled and
2985 dynamically reloaded in the course of program execution, without the need
2986 to restart the program itself.  Currently, Fix-and-Continue functionality
2987 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2988 and later.
2990 @item -fzero-link
2991 @opindex fzero-link
2992 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2993 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2994 compile time) with static class references that get initialized at load time,
2995 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2996 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2997 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2998 for individual class implementations to be modified during program execution.
2999 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
3000 regardless of command-line options.
3002 @item -fno-local-ivars
3003 @opindex fno-local-ivars
3004 @opindex flocal-ivars
3005 By default instance variables in Objective-C can be accessed as if
3006 they were local variables from within the methods of the class they're
3007 declared in.  This can lead to shadowing between instance variables
3008 and other variables declared either locally inside a class method or
3009 globally with the same name.  Specifying the @option{-fno-local-ivars}
3010 flag disables this behavior thus avoiding variable shadowing issues.
3012 @item -fivar-visibility=@var{public|protected|private|package}
3013 @opindex fivar-visibility
3014 Set the default instance variable visibility to the specified option
3015 so that instance variables declared outside the scope of any access
3016 modifier directives default to the specified visibility.
3018 @item -gen-decls
3019 @opindex gen-decls
3020 Dump interface declarations for all classes seen in the source file to a
3021 file named @file{@var{sourcename}.decl}.
3023 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3024 @opindex Wassign-intercept
3025 @opindex Wno-assign-intercept
3026 Warn whenever an Objective-C assignment is being intercepted by the
3027 garbage collector.
3029 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3030 @opindex Wno-protocol
3031 @opindex Wprotocol
3032 If a class is declared to implement a protocol, a warning is issued for
3033 every method in the protocol that is not implemented by the class.  The
3034 default behavior is to issue a warning for every method not explicitly
3035 implemented in the class, even if a method implementation is inherited
3036 from the superclass.  If you use the @option{-Wno-protocol} option, then
3037 methods inherited from the superclass are considered to be implemented,
3038 and no warning is issued for them.
3040 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3041 @opindex Wselector
3042 @opindex Wno-selector
3043 Warn if multiple methods of different types for the same selector are
3044 found during compilation.  The check is performed on the list of methods
3045 in the final stage of compilation.  Additionally, a check is performed
3046 for each selector appearing in a @code{@@selector(@dots{})}
3047 expression, and a corresponding method for that selector has been found
3048 during compilation.  Because these checks scan the method table only at
3049 the end of compilation, these warnings are not produced if the final
3050 stage of compilation is not reached, for example because an error is
3051 found during compilation, or because the @option{-fsyntax-only} option is
3052 being used.
3054 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3055 @opindex Wstrict-selector-match
3056 @opindex Wno-strict-selector-match
3057 Warn if multiple methods with differing argument and/or return types are
3058 found for a given selector when attempting to send a message using this
3059 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3060 is off (which is the default behavior), the compiler omits such warnings
3061 if any differences found are confined to types that share the same size
3062 and alignment.
3064 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3065 @opindex Wundeclared-selector
3066 @opindex Wno-undeclared-selector
3067 Warn if a @code{@@selector(@dots{})} expression referring to an
3068 undeclared selector is found.  A selector is considered undeclared if no
3069 method with that name has been declared before the
3070 @code{@@selector(@dots{})} expression, either explicitly in an
3071 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3072 an @code{@@implementation} section.  This option always performs its
3073 checks as soon as a @code{@@selector(@dots{})} expression is found,
3074 while @option{-Wselector} only performs its checks in the final stage of
3075 compilation.  This also enforces the coding style convention
3076 that methods and selectors must be declared before being used.
3078 @item -print-objc-runtime-info
3079 @opindex print-objc-runtime-info
3080 Generate C header describing the largest structure that is passed by
3081 value, if any.
3083 @end table
3085 @node Language Independent Options
3086 @section Options to Control Diagnostic Messages Formatting
3087 @cindex options to control diagnostics formatting
3088 @cindex diagnostic messages
3089 @cindex message formatting
3091 Traditionally, diagnostic messages have been formatted irrespective of
3092 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3093 options described below
3094 to control the formatting algorithm for diagnostic messages, 
3095 e.g.@: how many characters per line, how often source location
3096 information should be reported.  Note that some language front ends may not
3097 honor these options.
3099 @table @gcctabopt
3100 @item -fmessage-length=@var{n}
3101 @opindex fmessage-length
3102 Try to format error messages so that they fit on lines of about
3103 @var{n} characters.  If @var{n} is zero, then no line-wrapping will be
3104 done; each error message will appear on a single line.  This is the
3105 default for all front ends.
3107 @item -fdiagnostics-show-location=once
3108 @opindex fdiagnostics-show-location
3109 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3110 reporter to emit source location information @emph{once}; that is, in
3111 case the message is too long to fit on a single physical line and has to
3112 be wrapped, the source location won't be emitted (as prefix) again,
3113 over and over, in subsequent continuation lines.  This is the default
3114 behavior.
3116 @item -fdiagnostics-show-location=every-line
3117 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3118 messages reporter to emit the same source location information (as
3119 prefix) for physical lines that result from the process of breaking
3120 a message which is too long to fit on a single line.
3122 @item -fdiagnostics-color[=@var{WHEN}]
3123 @itemx -fno-diagnostics-color
3124 @opindex fdiagnostics-color
3125 @cindex highlight, color, colour
3126 @vindex GCC_COLORS @r{environment variable}
3127 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3128 or @samp{auto}.  The default depends on how the compiler has been configured,
3129 it can be any of the above @var{WHEN} options or also @samp{never}
3130 if @env{GCC_COLORS} environment variable isn't present in the environment,
3131 and @samp{auto} otherwise.
3132 @samp{auto} means to use color only when the standard error is a terminal.
3133 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3134 aliases for @option{-fdiagnostics-color=always} and
3135 @option{-fdiagnostics-color=never}, respectively.
3137 The colors are defined by the environment variable @env{GCC_COLORS}.
3138 Its value is a colon-separated list of capabilities and Select Graphic
3139 Rendition (SGR) substrings. SGR commands are interpreted by the
3140 terminal or terminal emulator.  (See the section in the documentation
3141 of your text terminal for permitted values and their meanings as
3142 character attributes.)  These substring values are integers in decimal
3143 representation and can be concatenated with semicolons.
3144 Common values to concatenate include
3145 @samp{1} for bold,
3146 @samp{4} for underline,
3147 @samp{5} for blink,
3148 @samp{7} for inverse,
3149 @samp{39} for default foreground color,
3150 @samp{30} to @samp{37} for foreground colors,
3151 @samp{90} to @samp{97} for 16-color mode foreground colors,
3152 @samp{38;5;0} to @samp{38;5;255}
3153 for 88-color and 256-color modes foreground colors,
3154 @samp{49} for default background color,
3155 @samp{40} to @samp{47} for background colors,
3156 @samp{100} to @samp{107} for 16-color mode background colors,
3157 and @samp{48;5;0} to @samp{48;5;255}
3158 for 88-color and 256-color modes background colors.
3160 The default @env{GCC_COLORS} is
3161 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3162 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3163 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3164 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3165 string disables colors.
3166 Supported capabilities are as follows.
3168 @table @code
3169 @item error=
3170 @vindex error GCC_COLORS @r{capability}
3171 SGR substring for error: markers.
3173 @item warning=
3174 @vindex warning GCC_COLORS @r{capability}
3175 SGR substring for warning: markers.
3177 @item note=
3178 @vindex note GCC_COLORS @r{capability}
3179 SGR substring for note: markers.
3181 @item caret=
3182 @vindex caret GCC_COLORS @r{capability}
3183 SGR substring for caret line.
3185 @item locus=
3186 @vindex locus GCC_COLORS @r{capability}
3187 SGR substring for location information, @samp{file:line} or
3188 @samp{file:line:column} etc.
3190 @item quote=
3191 @vindex quote GCC_COLORS @r{capability}
3192 SGR substring for information printed within quotes.
3193 @end table
3195 @item -fno-diagnostics-show-option
3196 @opindex fno-diagnostics-show-option
3197 @opindex fdiagnostics-show-option
3198 By default, each diagnostic emitted includes text indicating the
3199 command-line option that directly controls the diagnostic (if such an
3200 option is known to the diagnostic machinery).  Specifying the
3201 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3203 @item -fno-diagnostics-show-caret
3204 @opindex fno-diagnostics-show-caret
3205 @opindex fdiagnostics-show-caret
3206 By default, each diagnostic emitted includes the original source line
3207 and a caret '^' indicating the column.  This option suppresses this
3208 information.  The source line is truncated to @var{n} characters, if
3209 the @option{-fmessage-length=n} is given.  When the output is done
3210 to the terminal, the width is limited to the width given by the
3211 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3213 @end table
3215 @node Warning Options
3216 @section Options to Request or Suppress Warnings
3217 @cindex options to control warnings
3218 @cindex warning messages
3219 @cindex messages, warning
3220 @cindex suppressing warnings
3222 Warnings are diagnostic messages that report constructions that
3223 are not inherently erroneous but that are risky or suggest there
3224 may have been an error.
3226 The following language-independent options do not enable specific
3227 warnings but control the kinds of diagnostics produced by GCC@.
3229 @table @gcctabopt
3230 @cindex syntax checking
3231 @item -fsyntax-only
3232 @opindex fsyntax-only
3233 Check the code for syntax errors, but don't do anything beyond that.
3235 @item -fmax-errors=@var{n}
3236 @opindex fmax-errors
3237 Limits the maximum number of error messages to @var{n}, at which point
3238 GCC bails out rather than attempting to continue processing the source
3239 code.  If @var{n} is 0 (the default), there is no limit on the number
3240 of error messages produced.  If @option{-Wfatal-errors} is also
3241 specified, then @option{-Wfatal-errors} takes precedence over this
3242 option.
3244 @item -w
3245 @opindex w
3246 Inhibit all warning messages.
3248 @item -Werror
3249 @opindex Werror
3250 @opindex Wno-error
3251 Make all warnings into errors.
3253 @item -Werror=
3254 @opindex Werror=
3255 @opindex Wno-error=
3256 Make the specified warning into an error.  The specifier for a warning
3257 is appended; for example @option{-Werror=switch} turns the warnings
3258 controlled by @option{-Wswitch} into errors.  This switch takes a
3259 negative form, to be used to negate @option{-Werror} for specific
3260 warnings; for example @option{-Wno-error=switch} makes
3261 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3262 is in effect.
3264 The warning message for each controllable warning includes the
3265 option that controls the warning.  That option can then be used with
3266 @option{-Werror=} and @option{-Wno-error=} as described above.
3267 (Printing of the option in the warning message can be disabled using the
3268 @option{-fno-diagnostics-show-option} flag.)
3270 Note that specifying @option{-Werror=}@var{foo} automatically implies
3271 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3272 imply anything.
3274 @item -Wfatal-errors
3275 @opindex Wfatal-errors
3276 @opindex Wno-fatal-errors
3277 This option causes the compiler to abort compilation on the first error
3278 occurred rather than trying to keep going and printing further error
3279 messages.
3281 @end table
3283 You can request many specific warnings with options beginning with
3284 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3285 implicit declarations.  Each of these specific warning options also
3286 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3287 example, @option{-Wno-implicit}.  This manual lists only one of the
3288 two forms, whichever is not the default.  For further
3289 language-specific options also refer to @ref{C++ Dialect Options} and
3290 @ref{Objective-C and Objective-C++ Dialect Options}.
3292 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3293 options, such as @option{-Wunused}, which may turn on further options,
3294 such as @option{-Wunused-value}. The combined effect of positive and
3295 negative forms is that more specific options have priority over less
3296 specific ones, independently of their position in the command-line. For
3297 options of the same specificity, the last one takes effect. Options
3298 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3299 as if they appeared at the end of the command-line.
3301 When an unrecognized warning option is requested (e.g.,
3302 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3303 that the option is not recognized.  However, if the @option{-Wno-} form
3304 is used, the behavior is slightly different: no diagnostic is
3305 produced for @option{-Wno-unknown-warning} unless other diagnostics
3306 are being produced.  This allows the use of new @option{-Wno-} options
3307 with old compilers, but if something goes wrong, the compiler
3308 warns that an unrecognized option is present.
3310 @table @gcctabopt
3311 @item -Wpedantic
3312 @itemx -pedantic
3313 @opindex pedantic
3314 @opindex Wpedantic
3315 Issue all the warnings demanded by strict ISO C and ISO C++;
3316 reject all programs that use forbidden extensions, and some other
3317 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3318 version of the ISO C standard specified by any @option{-std} option used.
3320 Valid ISO C and ISO C++ programs should compile properly with or without
3321 this option (though a rare few require @option{-ansi} or a
3322 @option{-std} option specifying the required version of ISO C)@.  However,
3323 without this option, certain GNU extensions and traditional C and C++
3324 features are supported as well.  With this option, they are rejected.
3326 @option{-Wpedantic} does not cause warning messages for use of the
3327 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3328 warnings are also disabled in the expression that follows
3329 @code{__extension__}.  However, only system header files should use
3330 these escape routes; application programs should avoid them.
3331 @xref{Alternate Keywords}.
3333 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3334 C conformance.  They soon find that it does not do quite what they want:
3335 it finds some non-ISO practices, but not all---only those for which
3336 ISO C @emph{requires} a diagnostic, and some others for which
3337 diagnostics have been added.
3339 A feature to report any failure to conform to ISO C might be useful in
3340 some instances, but would require considerable additional work and would
3341 be quite different from @option{-Wpedantic}.  We don't have plans to
3342 support such a feature in the near future.
3344 Where the standard specified with @option{-std} represents a GNU
3345 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3346 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3347 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3348 where they are required by the base standard.  (It does not make sense
3349 for such warnings to be given only for features not in the specified GNU
3350 C dialect, since by definition the GNU dialects of C include all
3351 features the compiler supports with the given option, and there would be
3352 nothing to warn about.)
3354 @item -pedantic-errors
3355 @opindex pedantic-errors
3356 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3357 requires a diagnostic, in some cases where there is undefined behavior
3358 at compile-time and in some other cases that do not prevent compilation
3359 of programs that are valid according to the standard. This is not
3360 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3361 by this option and not enabled by the latter and vice versa.
3363 @item -Wall
3364 @opindex Wall
3365 @opindex Wno-all
3366 This enables all the warnings about constructions that some users
3367 consider questionable, and that are easy to avoid (or modify to
3368 prevent the warning), even in conjunction with macros.  This also
3369 enables some language-specific warnings described in @ref{C++ Dialect
3370 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3372 @option{-Wall} turns on the following warning flags:
3374 @gccoptlist{-Waddress   @gol
3375 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3376 -Wc++11-compat  -Wc++14-compat@gol
3377 -Wchar-subscripts  @gol
3378 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3379 -Wimplicit-int @r{(C and Objective-C only)} @gol
3380 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3381 -Wcomment  @gol
3382 -Wformat   @gol
3383 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3384 -Wmaybe-uninitialized @gol
3385 -Wmissing-braces @r{(only for C/ObjC)} @gol
3386 -Wnonnull  @gol
3387 -Wopenmp-simd @gol
3388 -Wparentheses  @gol
3389 -Wpointer-sign  @gol
3390 -Wreorder   @gol
3391 -Wreturn-type  @gol
3392 -Wsequence-point  @gol
3393 -Wsign-compare @r{(only in C++)}  @gol
3394 -Wstrict-aliasing  @gol
3395 -Wstrict-overflow=1  @gol
3396 -Wswitch  @gol
3397 -Wtrigraphs  @gol
3398 -Wuninitialized  @gol
3399 -Wunknown-pragmas  @gol
3400 -Wunused-function  @gol
3401 -Wunused-label     @gol
3402 -Wunused-value     @gol
3403 -Wunused-variable  @gol
3404 -Wvolatile-register-var @gol
3407 Note that some warning flags are not implied by @option{-Wall}.  Some of
3408 them warn about constructions that users generally do not consider
3409 questionable, but which occasionally you might wish to check for;
3410 others warn about constructions that are necessary or hard to avoid in
3411 some cases, and there is no simple way to modify the code to suppress
3412 the warning. Some of them are enabled by @option{-Wextra} but many of
3413 them must be enabled individually.
3415 @item -Wextra
3416 @opindex W
3417 @opindex Wextra
3418 @opindex Wno-extra
3419 This enables some extra warning flags that are not enabled by
3420 @option{-Wall}. (This option used to be called @option{-W}.  The older
3421 name is still supported, but the newer name is more descriptive.)
3423 @gccoptlist{-Wclobbered  @gol
3424 -Wempty-body  @gol
3425 -Wignored-qualifiers @gol
3426 -Wmissing-field-initializers  @gol
3427 -Wmissing-parameter-type @r{(C only)}  @gol
3428 -Wold-style-declaration @r{(C only)}  @gol
3429 -Woverride-init  @gol
3430 -Wsign-compare  @gol
3431 -Wtype-limits  @gol
3432 -Wuninitialized  @gol
3433 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3434 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3437 The option @option{-Wextra} also prints warning messages for the
3438 following cases:
3440 @itemize @bullet
3442 @item
3443 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3444 @samp{>}, or @samp{>=}.
3446 @item
3447 (C++ only) An enumerator and a non-enumerator both appear in a
3448 conditional expression.
3450 @item
3451 (C++ only) Ambiguous virtual bases.
3453 @item
3454 (C++ only) Subscripting an array that has been declared @samp{register}.
3456 @item
3457 (C++ only) Taking the address of a variable that has been declared
3458 @samp{register}.
3460 @item
3461 (C++ only) A base class is not initialized in a derived class's copy
3462 constructor.
3464 @end itemize
3466 @item -Wchar-subscripts
3467 @opindex Wchar-subscripts
3468 @opindex Wno-char-subscripts
3469 Warn if an array subscript has type @code{char}.  This is a common cause
3470 of error, as programmers often forget that this type is signed on some
3471 machines.
3472 This warning is enabled by @option{-Wall}.
3474 @item -Wcomment
3475 @opindex Wcomment
3476 @opindex Wno-comment
3477 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3478 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3479 This warning is enabled by @option{-Wall}.
3481 @item -Wno-coverage-mismatch
3482 @opindex Wno-coverage-mismatch
3483 Warn if feedback profiles do not match when using the
3484 @option{-fprofile-use} option.
3485 If a source file is changed between compiling with @option{-fprofile-gen} and
3486 with @option{-fprofile-use}, the files with the profile feedback can fail
3487 to match the source file and GCC cannot use the profile feedback
3488 information.  By default, this warning is enabled and is treated as an
3489 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3490 warning or @option{-Wno-error=coverage-mismatch} can be used to
3491 disable the error.  Disabling the error for this warning can result in
3492 poorly optimized code and is useful only in the
3493 case of very minor changes such as bug fixes to an existing code-base.
3494 Completely disabling the warning is not recommended.
3496 @item -Wno-cpp
3497 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3499 Suppress warning messages emitted by @code{#warning} directives.
3501 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3502 @opindex Wdouble-promotion
3503 @opindex Wno-double-promotion
3504 Give a warning when a value of type @code{float} is implicitly
3505 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3506 floating-point unit implement @code{float} in hardware, but emulate
3507 @code{double} in software.  On such a machine, doing computations
3508 using @code{double} values is much more expensive because of the
3509 overhead required for software emulation.
3511 It is easy to accidentally do computations with @code{double} because
3512 floating-point literals are implicitly of type @code{double}.  For
3513 example, in:
3514 @smallexample
3515 @group
3516 float area(float radius)
3518    return 3.14159 * radius * radius;
3520 @end group
3521 @end smallexample
3522 the compiler performs the entire computation with @code{double}
3523 because the floating-point literal is a @code{double}.
3525 @item -Wformat
3526 @itemx -Wformat=@var{n}
3527 @opindex Wformat
3528 @opindex Wno-format
3529 @opindex ffreestanding
3530 @opindex fno-builtin
3531 @opindex Wformat=
3532 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3533 the arguments supplied have types appropriate to the format string
3534 specified, and that the conversions specified in the format string make
3535 sense.  This includes standard functions, and others specified by format
3536 attributes (@pxref{Function Attributes}), in the @code{printf},
3537 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3538 not in the C standard) families (or other target-specific families).
3539 Which functions are checked without format attributes having been
3540 specified depends on the standard version selected, and such checks of
3541 functions without the attribute specified are disabled by
3542 @option{-ffreestanding} or @option{-fno-builtin}.
3544 The formats are checked against the format features supported by GNU
3545 libc version 2.2.  These include all ISO C90 and C99 features, as well
3546 as features from the Single Unix Specification and some BSD and GNU
3547 extensions.  Other library implementations may not support all these
3548 features; GCC does not support warning about features that go beyond a
3549 particular library's limitations.  However, if @option{-Wpedantic} is used
3550 with @option{-Wformat}, warnings are given about format features not
3551 in the selected standard version (but not for @code{strfmon} formats,
3552 since those are not in any version of the C standard).  @xref{C Dialect
3553 Options,,Options Controlling C Dialect}.
3555 @table @gcctabopt
3556 @item -Wformat=1
3557 @itemx -Wformat
3558 @opindex Wformat
3559 @opindex Wformat=1
3560 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3561 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3562 @option{-Wformat} also checks for null format arguments for several
3563 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3564 aspects of this level of format checking can be disabled by the
3565 options: @option{-Wno-format-contains-nul},
3566 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3567 @option{-Wformat} is enabled by @option{-Wall}.
3569 @item -Wno-format-contains-nul
3570 @opindex Wno-format-contains-nul
3571 @opindex Wformat-contains-nul
3572 If @option{-Wformat} is specified, do not warn about format strings that
3573 contain NUL bytes.
3575 @item -Wno-format-extra-args
3576 @opindex Wno-format-extra-args
3577 @opindex Wformat-extra-args
3578 If @option{-Wformat} is specified, do not warn about excess arguments to a
3579 @code{printf} or @code{scanf} format function.  The C standard specifies
3580 that such arguments are ignored.
3582 Where the unused arguments lie between used arguments that are
3583 specified with @samp{$} operand number specifications, normally
3584 warnings are still given, since the implementation could not know what
3585 type to pass to @code{va_arg} to skip the unused arguments.  However,
3586 in the case of @code{scanf} formats, this option suppresses the
3587 warning if the unused arguments are all pointers, since the Single
3588 Unix Specification says that such unused arguments are allowed.
3590 @item -Wno-format-zero-length
3591 @opindex Wno-format-zero-length
3592 @opindex Wformat-zero-length
3593 If @option{-Wformat} is specified, do not warn about zero-length formats.
3594 The C standard specifies that zero-length formats are allowed.
3597 @item -Wformat=2
3598 @opindex Wformat=2
3599 Enable @option{-Wformat} plus additional format checks.  Currently
3600 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3601 -Wformat-signedness -Wformat-y2k}.
3603 @item -Wformat-nonliteral
3604 @opindex Wformat-nonliteral
3605 @opindex Wno-format-nonliteral
3606 If @option{-Wformat} is specified, also warn if the format string is not a
3607 string literal and so cannot be checked, unless the format function
3608 takes its format arguments as a @code{va_list}.
3610 @item -Wformat-security
3611 @opindex Wformat-security
3612 @opindex Wno-format-security
3613 If @option{-Wformat} is specified, also warn about uses of format
3614 functions that represent possible security problems.  At present, this
3615 warns about calls to @code{printf} and @code{scanf} functions where the
3616 format string is not a string literal and there are no format arguments,
3617 as in @code{printf (foo);}.  This may be a security hole if the format
3618 string came from untrusted input and contains @samp{%n}.  (This is
3619 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3620 in future warnings may be added to @option{-Wformat-security} that are not
3621 included in @option{-Wformat-nonliteral}.)
3623 @item -Wformat-signedness
3624 @opindex Wformat-signedness
3625 @opindex Wno-format-signedness
3626 If @option{-Wformat} is specified, also warn if the format string
3627 requires an unsigned argument and the argument is signed and vice versa.
3629 @item -Wformat-y2k
3630 @opindex Wformat-y2k
3631 @opindex Wno-format-y2k
3632 If @option{-Wformat} is specified, also warn about @code{strftime}
3633 formats that may yield only a two-digit year.
3634 @end table
3636 @item -Wnonnull
3637 @opindex Wnonnull
3638 @opindex Wno-nonnull
3639 Warn about passing a null pointer for arguments marked as
3640 requiring a non-null value by the @code{nonnull} function attribute.
3642 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3643 can be disabled with the @option{-Wno-nonnull} option.
3645 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3646 @opindex Winit-self
3647 @opindex Wno-init-self
3648 Warn about uninitialized variables that are initialized with themselves.
3649 Note this option can only be used with the @option{-Wuninitialized} option.
3651 For example, GCC warns about @code{i} being uninitialized in the
3652 following snippet only when @option{-Winit-self} has been specified:
3653 @smallexample
3654 @group
3655 int f()
3657   int i = i;
3658   return i;
3660 @end group
3661 @end smallexample
3663 This warning is enabled by @option{-Wall} in C++.
3665 @item -Wimplicit-int @r{(C and Objective-C only)}
3666 @opindex Wimplicit-int
3667 @opindex Wno-implicit-int
3668 Warn when a declaration does not specify a type.
3669 This warning is enabled by @option{-Wall}.
3671 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3672 @opindex Wimplicit-function-declaration
3673 @opindex Wno-implicit-function-declaration
3674 Give a warning whenever a function is used before being declared. In
3675 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3676 enabled by default and it is made into an error by
3677 @option{-pedantic-errors}. This warning is also enabled by
3678 @option{-Wall}.
3680 @item -Wimplicit @r{(C and Objective-C only)}
3681 @opindex Wimplicit
3682 @opindex Wno-implicit
3683 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3684 This warning is enabled by @option{-Wall}.
3686 @item -Wignored-qualifiers @r{(C and C++ only)}
3687 @opindex Wignored-qualifiers
3688 @opindex Wno-ignored-qualifiers
3689 Warn if the return type of a function has a type qualifier
3690 such as @code{const}.  For ISO C such a type qualifier has no effect,
3691 since the value returned by a function is not an lvalue.
3692 For C++, the warning is only emitted for scalar types or @code{void}.
3693 ISO C prohibits qualified @code{void} return types on function
3694 definitions, so such return types always receive a warning
3695 even without this option.
3697 This warning is also enabled by @option{-Wextra}.
3699 @item -Wmain
3700 @opindex Wmain
3701 @opindex Wno-main
3702 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3703 a function with external linkage, returning int, taking either zero
3704 arguments, two, or three arguments of appropriate types.  This warning
3705 is enabled by default in C++ and is enabled by either @option{-Wall}
3706 or @option{-Wpedantic}.
3708 @item -Wmissing-braces
3709 @opindex Wmissing-braces
3710 @opindex Wno-missing-braces
3711 Warn if an aggregate or union initializer is not fully bracketed.  In
3712 the following example, the initializer for @samp{a} is not fully
3713 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3714 enabled by @option{-Wall} in C.
3716 @smallexample
3717 int a[2][2] = @{ 0, 1, 2, 3 @};
3718 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3719 @end smallexample
3721 This warning is enabled by @option{-Wall}.
3723 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3724 @opindex Wmissing-include-dirs
3725 @opindex Wno-missing-include-dirs
3726 Warn if a user-supplied include directory does not exist.
3728 @item -Wparentheses
3729 @opindex Wparentheses
3730 @opindex Wno-parentheses
3731 Warn if parentheses are omitted in certain contexts, such
3732 as when there is an assignment in a context where a truth value
3733 is expected, or when operators are nested whose precedence people
3734 often get confused about.
3736 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3737 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3738 interpretation from that of ordinary mathematical notation.
3740 Also warn about constructions where there may be confusion to which
3741 @code{if} statement an @code{else} branch belongs.  Here is an example of
3742 such a case:
3744 @smallexample
3745 @group
3747   if (a)
3748     if (b)
3749       foo ();
3750   else
3751     bar ();
3753 @end group
3754 @end smallexample
3756 In C/C++, every @code{else} branch belongs to the innermost possible
3757 @code{if} statement, which in this example is @code{if (b)}.  This is
3758 often not what the programmer expected, as illustrated in the above
3759 example by indentation the programmer chose.  When there is the
3760 potential for this confusion, GCC issues a warning when this flag
3761 is specified.  To eliminate the warning, add explicit braces around
3762 the innermost @code{if} statement so there is no way the @code{else}
3763 can belong to the enclosing @code{if}.  The resulting code
3764 looks like this:
3766 @smallexample
3767 @group
3769   if (a)
3770     @{
3771       if (b)
3772         foo ();
3773       else
3774         bar ();
3775     @}
3777 @end group
3778 @end smallexample
3780 Also warn for dangerous uses of the GNU extension to
3781 @code{?:} with omitted middle operand. When the condition
3782 in the @code{?}: operator is a boolean expression, the omitted value is
3783 always 1.  Often programmers expect it to be a value computed
3784 inside the conditional expression instead.
3786 This warning is enabled by @option{-Wall}.
3788 @item -Wsequence-point
3789 @opindex Wsequence-point
3790 @opindex Wno-sequence-point
3791 Warn about code that may have undefined semantics because of violations
3792 of sequence point rules in the C and C++ standards.
3794 The C and C++ standards define the order in which expressions in a C/C++
3795 program are evaluated in terms of @dfn{sequence points}, which represent
3796 a partial ordering between the execution of parts of the program: those
3797 executed before the sequence point, and those executed after it.  These
3798 occur after the evaluation of a full expression (one which is not part
3799 of a larger expression), after the evaluation of the first operand of a
3800 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3801 function is called (but after the evaluation of its arguments and the
3802 expression denoting the called function), and in certain other places.
3803 Other than as expressed by the sequence point rules, the order of
3804 evaluation of subexpressions of an expression is not specified.  All
3805 these rules describe only a partial order rather than a total order,
3806 since, for example, if two functions are called within one expression
3807 with no sequence point between them, the order in which the functions
3808 are called is not specified.  However, the standards committee have
3809 ruled that function calls do not overlap.
3811 It is not specified when between sequence points modifications to the
3812 values of objects take effect.  Programs whose behavior depends on this
3813 have undefined behavior; the C and C++ standards specify that ``Between
3814 the previous and next sequence point an object shall have its stored
3815 value modified at most once by the evaluation of an expression.
3816 Furthermore, the prior value shall be read only to determine the value
3817 to be stored.''.  If a program breaks these rules, the results on any
3818 particular implementation are entirely unpredictable.
3820 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3821 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3822 diagnosed by this option, and it may give an occasional false positive
3823 result, but in general it has been found fairly effective at detecting
3824 this sort of problem in programs.
3826 The standard is worded confusingly, therefore there is some debate
3827 over the precise meaning of the sequence point rules in subtle cases.
3828 Links to discussions of the problem, including proposed formal
3829 definitions, may be found on the GCC readings page, at
3830 @uref{http://gcc.gnu.org/@/readings.html}.
3832 This warning is enabled by @option{-Wall} for C and C++.
3834 @item -Wno-return-local-addr
3835 @opindex Wno-return-local-addr
3836 @opindex Wreturn-local-addr
3837 Do not warn about returning a pointer (or in C++, a reference) to a
3838 variable that goes out of scope after the function returns.
3840 @item -Wreturn-type
3841 @opindex Wreturn-type
3842 @opindex Wno-return-type
3843 Warn whenever a function is defined with a return type that defaults
3844 to @code{int}.  Also warn about any @code{return} statement with no
3845 return value in a function whose return type is not @code{void}
3846 (falling off the end of the function body is considered returning
3847 without a value), and about a @code{return} statement with an
3848 expression in a function whose return type is @code{void}.
3850 For C++, a function without return type always produces a diagnostic
3851 message, even when @option{-Wno-return-type} is specified.  The only
3852 exceptions are @samp{main} and functions defined in system headers.
3854 This warning is enabled by @option{-Wall}.
3856 @item -Wshift-count-negative
3857 @opindex Wshift-count-negative
3858 @opindex Wno-shift-count-negative
3859 Warn if shift count is negative. This warning is enabled by default.
3861 @item -Wshift-count-overflow
3862 @opindex Wshift-count-overflow
3863 @opindex Wno-shift-count-overflow
3864 Warn if shift count >= width of type. This warning is enabled by default.
3866 @item -Wswitch
3867 @opindex Wswitch
3868 @opindex Wno-switch
3869 Warn whenever a @code{switch} statement has an index of enumerated type
3870 and lacks a @code{case} for one or more of the named codes of that
3871 enumeration.  (The presence of a @code{default} label prevents this
3872 warning.)  @code{case} labels outside the enumeration range also
3873 provoke warnings when this option is used (even if there is a
3874 @code{default} label).
3875 This warning is enabled by @option{-Wall}.
3877 @item -Wswitch-default
3878 @opindex Wswitch-default
3879 @opindex Wno-switch-default
3880 Warn whenever a @code{switch} statement does not have a @code{default}
3881 case.
3883 @item -Wswitch-enum
3884 @opindex Wswitch-enum
3885 @opindex Wno-switch-enum
3886 Warn whenever a @code{switch} statement has an index of enumerated type
3887 and lacks a @code{case} for one or more of the named codes of that
3888 enumeration.  @code{case} labels outside the enumeration range also
3889 provoke warnings when this option is used.  The only difference
3890 between @option{-Wswitch} and this option is that this option gives a
3891 warning about an omitted enumeration code even if there is a
3892 @code{default} label.
3894 @item -Wswitch-bool
3895 @opindex Wswitch-bool
3896 @opindex Wno-switch-bool
3897 Warn whenever a @code{switch} statement has an index of boolean type.
3898 It is possible to suppress this warning by casting the controlling
3899 expression to a type other than @code{bool}.  For example:
3900 @smallexample
3901 @group
3902 switch ((int) (a == 4))
3903   @{
3904   @dots{}
3905   @}
3906 @end group
3907 @end smallexample
3908 This warning is enabled by default for C and C++ programs.
3910 @item -Wsync-nand @r{(C and C++ only)}
3911 @opindex Wsync-nand
3912 @opindex Wno-sync-nand
3913 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3914 built-in functions are used.  These functions changed semantics in GCC 4.4.
3916 @item -Wtrigraphs
3917 @opindex Wtrigraphs
3918 @opindex Wno-trigraphs
3919 Warn if any trigraphs are encountered that might change the meaning of
3920 the program (trigraphs within comments are not warned about).
3921 This warning is enabled by @option{-Wall}.
3923 @item -Wunused-but-set-parameter
3924 @opindex Wunused-but-set-parameter
3925 @opindex Wno-unused-but-set-parameter
3926 Warn whenever a function parameter is assigned to, but otherwise unused
3927 (aside from its declaration).
3929 To suppress this warning use the @samp{unused} attribute
3930 (@pxref{Variable Attributes}).
3932 This warning is also enabled by @option{-Wunused} together with
3933 @option{-Wextra}.
3935 @item -Wunused-but-set-variable
3936 @opindex Wunused-but-set-variable
3937 @opindex Wno-unused-but-set-variable
3938 Warn whenever a local variable is assigned to, but otherwise unused
3939 (aside from its declaration).
3940 This warning is enabled by @option{-Wall}.
3942 To suppress this warning use the @samp{unused} attribute
3943 (@pxref{Variable Attributes}).
3945 This warning is also enabled by @option{-Wunused}, which is enabled
3946 by @option{-Wall}.
3948 @item -Wunused-function
3949 @opindex Wunused-function
3950 @opindex Wno-unused-function
3951 Warn whenever a static function is declared but not defined or a
3952 non-inline static function is unused.
3953 This warning is enabled by @option{-Wall}.
3955 @item -Wunused-label
3956 @opindex Wunused-label
3957 @opindex Wno-unused-label
3958 Warn whenever a label is declared but not used.
3959 This warning is enabled by @option{-Wall}.
3961 To suppress this warning use the @samp{unused} attribute
3962 (@pxref{Variable Attributes}).
3964 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3965 @opindex Wunused-local-typedefs
3966 Warn when a typedef locally defined in a function is not used.
3967 This warning is enabled by @option{-Wall}.
3969 @item -Wunused-parameter
3970 @opindex Wunused-parameter
3971 @opindex Wno-unused-parameter
3972 Warn whenever a function parameter is unused aside from its declaration.
3974 To suppress this warning use the @samp{unused} attribute
3975 (@pxref{Variable Attributes}).
3977 @item -Wno-unused-result
3978 @opindex Wunused-result
3979 @opindex Wno-unused-result
3980 Do not warn if a caller of a function marked with attribute
3981 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3982 its return value. The default is @option{-Wunused-result}.
3984 @item -Wunused-variable
3985 @opindex Wunused-variable
3986 @opindex Wno-unused-variable
3987 Warn whenever a local variable or non-constant static variable is unused
3988 aside from its declaration.
3989 This warning is enabled by @option{-Wall}.
3991 To suppress this warning use the @samp{unused} attribute
3992 (@pxref{Variable Attributes}).
3994 @item -Wunused-value
3995 @opindex Wunused-value
3996 @opindex Wno-unused-value
3997 Warn whenever a statement computes a result that is explicitly not
3998 used. To suppress this warning cast the unused expression to
3999 @samp{void}. This includes an expression-statement or the left-hand
4000 side of a comma expression that contains no side effects. For example,
4001 an expression such as @samp{x[i,j]} causes a warning, while
4002 @samp{x[(void)i,j]} does not.
4004 This warning is enabled by @option{-Wall}.
4006 @item -Wunused
4007 @opindex Wunused
4008 @opindex Wno-unused
4009 All the above @option{-Wunused} options combined.
4011 In order to get a warning about an unused function parameter, you must
4012 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4013 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4015 @item -Wuninitialized
4016 @opindex Wuninitialized
4017 @opindex Wno-uninitialized
4018 Warn if an automatic variable is used without first being initialized
4019 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4020 warn if a non-static reference or non-static @samp{const} member
4021 appears in a class without constructors.
4023 If you want to warn about code that uses the uninitialized value of the
4024 variable in its own initializer, use the @option{-Winit-self} option.
4026 These warnings occur for individual uninitialized or clobbered
4027 elements of structure, union or array variables as well as for
4028 variables that are uninitialized or clobbered as a whole.  They do
4029 not occur for variables or elements declared @code{volatile}.  Because
4030 these warnings depend on optimization, the exact variables or elements
4031 for which there are warnings depends on the precise optimization
4032 options and version of GCC used.
4034 Note that there may be no warning about a variable that is used only
4035 to compute a value that itself is never used, because such
4036 computations may be deleted by data flow analysis before the warnings
4037 are printed.
4039 @item -Wmaybe-uninitialized
4040 @opindex Wmaybe-uninitialized
4041 @opindex Wno-maybe-uninitialized
4042 For an automatic variable, if there exists a path from the function
4043 entry to a use of the variable that is initialized, but there exist
4044 some other paths for which the variable is not initialized, the compiler
4045 emits a warning if it cannot prove the uninitialized paths are not
4046 executed at run time. These warnings are made optional because GCC is
4047 not smart enough to see all the reasons why the code might be correct
4048 in spite of appearing to have an error.  Here is one example of how
4049 this can happen:
4051 @smallexample
4052 @group
4054   int x;
4055   switch (y)
4056     @{
4057     case 1: x = 1;
4058       break;
4059     case 2: x = 4;
4060       break;
4061     case 3: x = 5;
4062     @}
4063   foo (x);
4065 @end group
4066 @end smallexample
4068 @noindent
4069 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4070 always initialized, but GCC doesn't know this. To suppress the
4071 warning, you need to provide a default case with assert(0) or
4072 similar code.
4074 @cindex @code{longjmp} warnings
4075 This option also warns when a non-volatile automatic variable might be
4076 changed by a call to @code{longjmp}.  These warnings as well are possible
4077 only in optimizing compilation.
4079 The compiler sees only the calls to @code{setjmp}.  It cannot know
4080 where @code{longjmp} will be called; in fact, a signal handler could
4081 call it at any point in the code.  As a result, you may get a warning
4082 even when there is in fact no problem because @code{longjmp} cannot
4083 in fact be called at the place that would cause a problem.
4085 Some spurious warnings can be avoided if you declare all the functions
4086 you use that never return as @code{noreturn}.  @xref{Function
4087 Attributes}.
4089 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4091 @item -Wunknown-pragmas
4092 @opindex Wunknown-pragmas
4093 @opindex Wno-unknown-pragmas
4094 @cindex warning for unknown pragmas
4095 @cindex unknown pragmas, warning
4096 @cindex pragmas, warning of unknown
4097 Warn when a @code{#pragma} directive is encountered that is not understood by 
4098 GCC@.  If this command-line option is used, warnings are even issued
4099 for unknown pragmas in system header files.  This is not the case if
4100 the warnings are only enabled by the @option{-Wall} command-line option.
4102 @item -Wno-pragmas
4103 @opindex Wno-pragmas
4104 @opindex Wpragmas
4105 Do not warn about misuses of pragmas, such as incorrect parameters,
4106 invalid syntax, or conflicts between pragmas.  See also
4107 @option{-Wunknown-pragmas}.
4109 @item -Wstrict-aliasing
4110 @opindex Wstrict-aliasing
4111 @opindex Wno-strict-aliasing
4112 This option is only active when @option{-fstrict-aliasing} is active.
4113 It warns about code that might break the strict aliasing rules that the
4114 compiler is using for optimization.  The warning does not catch all
4115 cases, but does attempt to catch the more common pitfalls.  It is
4116 included in @option{-Wall}.
4117 It is equivalent to @option{-Wstrict-aliasing=3}
4119 @item -Wstrict-aliasing=n
4120 @opindex Wstrict-aliasing=n
4121 This option is only active when @option{-fstrict-aliasing} is active.
4122 It warns about code that might break the strict aliasing rules that the
4123 compiler is using for optimization.
4124 Higher levels correspond to higher accuracy (fewer false positives).
4125 Higher levels also correspond to more effort, similar to the way @option{-O} 
4126 works.
4127 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4129 Level 1: Most aggressive, quick, least accurate.
4130 Possibly useful when higher levels
4131 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4132 false negatives.  However, it has many false positives.
4133 Warns for all pointer conversions between possibly incompatible types,
4134 even if never dereferenced.  Runs in the front end only.
4136 Level 2: Aggressive, quick, not too precise.
4137 May still have many false positives (not as many as level 1 though),
4138 and few false negatives (but possibly more than level 1).
4139 Unlike level 1, it only warns when an address is taken.  Warns about
4140 incomplete types.  Runs in the front end only.
4142 Level 3 (default for @option{-Wstrict-aliasing}):
4143 Should have very few false positives and few false
4144 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4145 Takes care of the common pun+dereference pattern in the front end:
4146 @code{*(int*)&some_float}.
4147 If optimization is enabled, it also runs in the back end, where it deals
4148 with multiple statement cases using flow-sensitive points-to information.
4149 Only warns when the converted pointer is dereferenced.
4150 Does not warn about incomplete types.
4152 @item -Wstrict-overflow
4153 @itemx -Wstrict-overflow=@var{n}
4154 @opindex Wstrict-overflow
4155 @opindex Wno-strict-overflow
4156 This option is only active when @option{-fstrict-overflow} is active.
4157 It warns about cases where the compiler optimizes based on the
4158 assumption that signed overflow does not occur.  Note that it does not
4159 warn about all cases where the code might overflow: it only warns
4160 about cases where the compiler implements some optimization.  Thus
4161 this warning depends on the optimization level.
4163 An optimization that assumes that signed overflow does not occur is
4164 perfectly safe if the values of the variables involved are such that
4165 overflow never does, in fact, occur.  Therefore this warning can
4166 easily give a false positive: a warning about code that is not
4167 actually a problem.  To help focus on important issues, several
4168 warning levels are defined.  No warnings are issued for the use of
4169 undefined signed overflow when estimating how many iterations a loop
4170 requires, in particular when determining whether a loop will be
4171 executed at all.
4173 @table @gcctabopt
4174 @item -Wstrict-overflow=1
4175 Warn about cases that are both questionable and easy to avoid.  For
4176 example,  with @option{-fstrict-overflow}, the compiler simplifies
4177 @code{x + 1 > x} to @code{1}.  This level of
4178 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4179 are not, and must be explicitly requested.
4181 @item -Wstrict-overflow=2
4182 Also warn about other cases where a comparison is simplified to a
4183 constant.  For example: @code{abs (x) >= 0}.  This can only be
4184 simplified when @option{-fstrict-overflow} is in effect, because
4185 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4186 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4187 @option{-Wstrict-overflow=2}.
4189 @item -Wstrict-overflow=3
4190 Also warn about other cases where a comparison is simplified.  For
4191 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4193 @item -Wstrict-overflow=4
4194 Also warn about other simplifications not covered by the above cases.
4195 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4197 @item -Wstrict-overflow=5
4198 Also warn about cases where the compiler reduces the magnitude of a
4199 constant involved in a comparison.  For example: @code{x + 2 > y} is
4200 simplified to @code{x + 1 >= y}.  This is reported only at the
4201 highest warning level because this simplification applies to many
4202 comparisons, so this warning level gives a very large number of
4203 false positives.
4204 @end table
4206 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4207 @opindex Wsuggest-attribute=
4208 @opindex Wno-suggest-attribute=
4209 Warn for cases where adding an attribute may be beneficial. The
4210 attributes currently supported are listed below.
4212 @table @gcctabopt
4213 @item -Wsuggest-attribute=pure
4214 @itemx -Wsuggest-attribute=const
4215 @itemx -Wsuggest-attribute=noreturn
4216 @opindex Wsuggest-attribute=pure
4217 @opindex Wno-suggest-attribute=pure
4218 @opindex Wsuggest-attribute=const
4219 @opindex Wno-suggest-attribute=const
4220 @opindex Wsuggest-attribute=noreturn
4221 @opindex Wno-suggest-attribute=noreturn
4223 Warn about functions that might be candidates for attributes
4224 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4225 functions visible in other compilation units or (in the case of @code{pure} and
4226 @code{const}) if it cannot prove that the function returns normally. A function
4227 returns normally if it doesn't contain an infinite loop or return abnormally
4228 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4229 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4230 higher.  Higher optimization levels improve the accuracy of the analysis.
4232 @item -Wsuggest-attribute=format
4233 @itemx -Wmissing-format-attribute
4234 @opindex Wsuggest-attribute=format
4235 @opindex Wmissing-format-attribute
4236 @opindex Wno-suggest-attribute=format
4237 @opindex Wno-missing-format-attribute
4238 @opindex Wformat
4239 @opindex Wno-format
4241 Warn about function pointers that might be candidates for @code{format}
4242 attributes.  Note these are only possible candidates, not absolute ones.
4243 GCC guesses that function pointers with @code{format} attributes that
4244 are used in assignment, initialization, parameter passing or return
4245 statements should have a corresponding @code{format} attribute in the
4246 resulting type.  I.e.@: the left-hand side of the assignment or
4247 initialization, the type of the parameter variable, or the return type
4248 of the containing function respectively should also have a @code{format}
4249 attribute to avoid the warning.
4251 GCC also warns about function definitions that might be
4252 candidates for @code{format} attributes.  Again, these are only
4253 possible candidates.  GCC guesses that @code{format} attributes
4254 might be appropriate for any function that calls a function like
4255 @code{vprintf} or @code{vscanf}, but this might not always be the
4256 case, and some functions for which @code{format} attributes are
4257 appropriate may not be detected.
4258 @end table
4260 @item -Wsuggest-final-types
4261 @opindex Wno-suggest-final-types
4262 @opindex Wsuggest-final-types
4263 Warn about types with virtual methods where code quality would be improved
4264 if the type was declared with the C++11 final specifier, or, if possible,
4265 declared in an anonymous namespace. This allows GCC to more aggressively
4266 devirtualize the polymorphic calls. This warning is more effective with link
4267 time optimization, where the information about the class hierarchy graph is
4268 more complete.
4270 @item -Wsuggest-final-methods
4271 @opindex Wno-suggest-final-methods
4272 @opindex Wsuggest-final-methods
4273 Warn about virtual methods where code quality would be improved if the method
4274 was declared with the C++11 final specifier, or, if possible, its type was
4275 declared in an anonymous namespace or with the final specifier. This warning is
4276 more effective with link time optimization, where the information about the
4277 class hierarchy graph is more complete. It is recommended to first consider
4278 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4279 annotations.
4281 @item -Warray-bounds
4282 @opindex Wno-array-bounds
4283 @opindex Warray-bounds
4284 This option is only active when @option{-ftree-vrp} is active
4285 (default for @option{-O2} and above). It warns about subscripts to arrays
4286 that are always out of bounds. This warning is enabled by @option{-Wall}.
4288 @item -Wbool-compare
4289 @opindex Wno-bool-compare
4290 @opindex Wbool-compare
4291 Warn about boolean expression compared with an integer value different from
4292 @code{true}/@code{false}.  For instance, the following comparison is
4293 always false:
4294 @smallexample
4295 int n = 5;
4296 @dots{}
4297 if ((n > 1) == 2) @{ @dots{} @}
4298 @end smallexample
4299 This warning is enabled by @option{-Wall}.
4301 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4302 @opindex Wno-discarded-qualifiers
4303 @opindex Wdiscarded-qualifiers
4304 Do not warn if type qualifiers on pointers are being discarded.
4305 Typically, the compiler will warn if a @code{const char *} variable is
4306 passed to a function that takes a @code{char *} parameter.  This option
4307 can be used to suppress such a warning.
4309 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4310 @opindex Wno-discarded-array-qualifiers
4311 @opindex Wdiscarded-array-qualifiers
4312 Do not warn if type qualifiers on arrays which are pointer targets
4313 are being discarded. Typically, the compiler will warn if a
4314 @code{const int (*)[]} variable is passed to a function that
4315 takes a @code{int (*)[]} parameter.  This option can be used to
4316 suppress such a warning.
4318 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4319 @opindex Wno-incompatible-pointer-types
4320 @opindex Wincompatible-pointer-types
4321 Do not warn when there is a conversion between pointers that have incompatible
4322 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4323 which warns for pointer argument passing or assignment with different
4324 signedness.
4326 @item -Wno-int-conversion @r{(C and Objective-C only)}
4327 @opindex Wno-int-conversion
4328 @opindex Wint-conversion
4329 Do not warn about incompatible integer to pointer and pointer to integer
4330 conversions.  This warning is about implicit conversions; for explicit
4331 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4332 @option{-Wno-pointer-to-int-cast} may be used.
4334 @item -Wno-div-by-zero
4335 @opindex Wno-div-by-zero
4336 @opindex Wdiv-by-zero
4337 Do not warn about compile-time integer division by zero.  Floating-point
4338 division by zero is not warned about, as it can be a legitimate way of
4339 obtaining infinities and NaNs.
4341 @item -Wsystem-headers
4342 @opindex Wsystem-headers
4343 @opindex Wno-system-headers
4344 @cindex warnings from system headers
4345 @cindex system headers, warnings from
4346 Print warning messages for constructs found in system header files.
4347 Warnings from system headers are normally suppressed, on the assumption
4348 that they usually do not indicate real problems and would only make the
4349 compiler output harder to read.  Using this command-line option tells
4350 GCC to emit warnings from system headers as if they occurred in user
4351 code.  However, note that using @option{-Wall} in conjunction with this
4352 option does @emph{not} warn about unknown pragmas in system
4353 headers---for that, @option{-Wunknown-pragmas} must also be used.
4355 @item -Wtrampolines
4356 @opindex Wtrampolines
4357 @opindex Wno-trampolines
4358 Warn about trampolines generated for pointers to nested functions.
4359 A trampoline is a small piece of data or code that is created at run
4360 time on the stack when the address of a nested function is taken, and is
4361 used to call the nested function indirectly.  For some targets, it is
4362 made up of data only and thus requires no special treatment.  But, for
4363 most targets, it is made up of code and thus requires the stack to be
4364 made executable in order for the program to work properly.
4366 @item -Wfloat-equal
4367 @opindex Wfloat-equal
4368 @opindex Wno-float-equal
4369 Warn if floating-point values are used in equality comparisons.
4371 The idea behind this is that sometimes it is convenient (for the
4372 programmer) to consider floating-point values as approximations to
4373 infinitely precise real numbers.  If you are doing this, then you need
4374 to compute (by analyzing the code, or in some other way) the maximum or
4375 likely maximum error that the computation introduces, and allow for it
4376 when performing comparisons (and when producing output, but that's a
4377 different problem).  In particular, instead of testing for equality, you
4378 should check to see whether the two values have ranges that overlap; and
4379 this is done with the relational operators, so equality comparisons are
4380 probably mistaken.
4382 @item -Wtraditional @r{(C and Objective-C only)}
4383 @opindex Wtraditional
4384 @opindex Wno-traditional
4385 Warn about certain constructs that behave differently in traditional and
4386 ISO C@.  Also warn about ISO C constructs that have no traditional C
4387 equivalent, and/or problematic constructs that should be avoided.
4389 @itemize @bullet
4390 @item
4391 Macro parameters that appear within string literals in the macro body.
4392 In traditional C macro replacement takes place within string literals,
4393 but in ISO C it does not.
4395 @item
4396 In traditional C, some preprocessor directives did not exist.
4397 Traditional preprocessors only considered a line to be a directive
4398 if the @samp{#} appeared in column 1 on the line.  Therefore
4399 @option{-Wtraditional} warns about directives that traditional C
4400 understands but ignores because the @samp{#} does not appear as the
4401 first character on the line.  It also suggests you hide directives like
4402 @samp{#pragma} not understood by traditional C by indenting them.  Some
4403 traditional implementations do not recognize @samp{#elif}, so this option
4404 suggests avoiding it altogether.
4406 @item
4407 A function-like macro that appears without arguments.
4409 @item
4410 The unary plus operator.
4412 @item
4413 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4414 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4415 constants.)  Note, these suffixes appear in macros defined in the system
4416 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4417 Use of these macros in user code might normally lead to spurious
4418 warnings, however GCC's integrated preprocessor has enough context to
4419 avoid warning in these cases.
4421 @item
4422 A function declared external in one block and then used after the end of
4423 the block.
4425 @item
4426 A @code{switch} statement has an operand of type @code{long}.
4428 @item
4429 A non-@code{static} function declaration follows a @code{static} one.
4430 This construct is not accepted by some traditional C compilers.
4432 @item
4433 The ISO type of an integer constant has a different width or
4434 signedness from its traditional type.  This warning is only issued if
4435 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4436 typically represent bit patterns, are not warned about.
4438 @item
4439 Usage of ISO string concatenation is detected.
4441 @item
4442 Initialization of automatic aggregates.
4444 @item
4445 Identifier conflicts with labels.  Traditional C lacks a separate
4446 namespace for labels.
4448 @item
4449 Initialization of unions.  If the initializer is zero, the warning is
4450 omitted.  This is done under the assumption that the zero initializer in
4451 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4452 initializer warnings and relies on default initialization to zero in the
4453 traditional C case.
4455 @item
4456 Conversions by prototypes between fixed/floating-point values and vice
4457 versa.  The absence of these prototypes when compiling with traditional
4458 C causes serious problems.  This is a subset of the possible
4459 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4461 @item
4462 Use of ISO C style function definitions.  This warning intentionally is
4463 @emph{not} issued for prototype declarations or variadic functions
4464 because these ISO C features appear in your code when using
4465 libiberty's traditional C compatibility macros, @code{PARAMS} and
4466 @code{VPARAMS}.  This warning is also bypassed for nested functions
4467 because that feature is already a GCC extension and thus not relevant to
4468 traditional C compatibility.
4469 @end itemize
4471 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4472 @opindex Wtraditional-conversion
4473 @opindex Wno-traditional-conversion
4474 Warn if a prototype causes a type conversion that is different from what
4475 would happen to the same argument in the absence of a prototype.  This
4476 includes conversions of fixed point to floating and vice versa, and
4477 conversions changing the width or signedness of a fixed-point argument
4478 except when the same as the default promotion.
4480 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4481 @opindex Wdeclaration-after-statement
4482 @opindex Wno-declaration-after-statement
4483 Warn when a declaration is found after a statement in a block.  This
4484 construct, known from C++, was introduced with ISO C99 and is by default
4485 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4486 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4488 @item -Wundef
4489 @opindex Wundef
4490 @opindex Wno-undef
4491 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4493 @item -Wno-endif-labels
4494 @opindex Wno-endif-labels
4495 @opindex Wendif-labels
4496 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4498 @item -Wshadow
4499 @opindex Wshadow
4500 @opindex Wno-shadow
4501 Warn whenever a local variable or type declaration shadows another
4502 variable, parameter, type, class member (in C++), or instance variable
4503 (in Objective-C) or whenever a built-in function is shadowed. Note
4504 that in C++, the compiler warns if a local variable shadows an
4505 explicit typedef, but not if it shadows a struct/class/enum.
4507 @item -Wno-shadow-ivar @r{(Objective-C only)}
4508 @opindex Wno-shadow-ivar
4509 @opindex Wshadow-ivar
4510 Do not warn whenever a local variable shadows an instance variable in an
4511 Objective-C method.
4513 @item -Wlarger-than=@var{len}
4514 @opindex Wlarger-than=@var{len}
4515 @opindex Wlarger-than-@var{len}
4516 Warn whenever an object of larger than @var{len} bytes is defined.
4518 @item -Wframe-larger-than=@var{len}
4519 @opindex Wframe-larger-than
4520 Warn if the size of a function frame is larger than @var{len} bytes.
4521 The computation done to determine the stack frame size is approximate
4522 and not conservative.
4523 The actual requirements may be somewhat greater than @var{len}
4524 even if you do not get a warning.  In addition, any space allocated
4525 via @code{alloca}, variable-length arrays, or related constructs
4526 is not included by the compiler when determining
4527 whether or not to issue a warning.
4529 @item -Wno-free-nonheap-object
4530 @opindex Wno-free-nonheap-object
4531 @opindex Wfree-nonheap-object
4532 Do not warn when attempting to free an object that was not allocated
4533 on the heap.
4535 @item -Wstack-usage=@var{len}
4536 @opindex Wstack-usage
4537 Warn if the stack usage of a function might be larger than @var{len} bytes.
4538 The computation done to determine the stack usage is conservative.
4539 Any space allocated via @code{alloca}, variable-length arrays, or related
4540 constructs is included by the compiler when determining whether or not to
4541 issue a warning.
4543 The message is in keeping with the output of @option{-fstack-usage}.
4545 @itemize
4546 @item
4547 If the stack usage is fully static but exceeds the specified amount, it's:
4549 @smallexample
4550   warning: stack usage is 1120 bytes
4551 @end smallexample
4552 @item
4553 If the stack usage is (partly) dynamic but bounded, it's:
4555 @smallexample
4556   warning: stack usage might be 1648 bytes
4557 @end smallexample
4558 @item
4559 If the stack usage is (partly) dynamic and not bounded, it's:
4561 @smallexample
4562   warning: stack usage might be unbounded
4563 @end smallexample
4564 @end itemize
4566 @item -Wunsafe-loop-optimizations
4567 @opindex Wunsafe-loop-optimizations
4568 @opindex Wno-unsafe-loop-optimizations
4569 Warn if the loop cannot be optimized because the compiler cannot
4570 assume anything on the bounds of the loop indices.  With
4571 @option{-funsafe-loop-optimizations} warn if the compiler makes
4572 such assumptions.
4574 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4575 @opindex Wno-pedantic-ms-format
4576 @opindex Wpedantic-ms-format
4577 When used in combination with @option{-Wformat}
4578 and @option{-pedantic} without GNU extensions, this option
4579 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4580 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4581 which depend on the MS runtime.
4583 @item -Wpointer-arith
4584 @opindex Wpointer-arith
4585 @opindex Wno-pointer-arith
4586 Warn about anything that depends on the ``size of'' a function type or
4587 of @code{void}.  GNU C assigns these types a size of 1, for
4588 convenience in calculations with @code{void *} pointers and pointers
4589 to functions.  In C++, warn also when an arithmetic operation involves
4590 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4592 @item -Wtype-limits
4593 @opindex Wtype-limits
4594 @opindex Wno-type-limits
4595 Warn if a comparison is always true or always false due to the limited
4596 range of the data type, but do not warn for constant expressions.  For
4597 example, warn if an unsigned variable is compared against zero with
4598 @samp{<} or @samp{>=}.  This warning is also enabled by
4599 @option{-Wextra}.
4601 @item -Wbad-function-cast @r{(C and Objective-C only)}
4602 @opindex Wbad-function-cast
4603 @opindex Wno-bad-function-cast
4604 Warn whenever a function call is cast to a non-matching type.
4605 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4607 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4608 @opindex Wc90-c99-compat
4609 @opindex Wno-c90-c99-compat
4610 Warn about features not present in ISO C90, but present in ISO C99.
4611 For instance, warn about use of variable length arrays, @code{long long}
4612 type, @code{bool} type, compound literals, designated initializers, and so
4613 on.  This option is independent of the standards mode.  Warnings are disabled
4614 in the expression that follows @code{__extension__}.
4616 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4617 @opindex Wc99-c11-compat
4618 @opindex Wno-c99-c11-compat
4619 Warn about features not present in ISO C99, but present in ISO C11.
4620 For instance, warn about use of anonymous structures and unions,
4621 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4622 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4623 and so on.  This option is independent of the standards mode.  Warnings are
4624 disabled in the expression that follows @code{__extension__}.
4626 @item -Wc++-compat @r{(C and Objective-C only)}
4627 @opindex Wc++-compat
4628 Warn about ISO C constructs that are outside of the common subset of
4629 ISO C and ISO C++, e.g.@: request for implicit conversion from
4630 @code{void *} to a pointer to non-@code{void} type.
4632 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4633 @opindex Wc++11-compat
4634 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4635 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4636 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4637 enabled by @option{-Wall}.
4639 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4640 @opindex Wc++14-compat
4641 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4642 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4644 @item -Wcast-qual
4645 @opindex Wcast-qual
4646 @opindex Wno-cast-qual
4647 Warn whenever a pointer is cast so as to remove a type qualifier from
4648 the target type.  For example, warn if a @code{const char *} is cast
4649 to an ordinary @code{char *}.
4651 Also warn when making a cast that introduces a type qualifier in an
4652 unsafe way.  For example, casting @code{char **} to @code{const char **}
4653 is unsafe, as in this example:
4655 @smallexample
4656   /* p is char ** value.  */
4657   const char **q = (const char **) p;
4658   /* Assignment of readonly string to const char * is OK.  */
4659   *q = "string";
4660   /* Now char** pointer points to read-only memory.  */
4661   **p = 'b';
4662 @end smallexample
4664 @item -Wcast-align
4665 @opindex Wcast-align
4666 @opindex Wno-cast-align
4667 Warn whenever a pointer is cast such that the required alignment of the
4668 target is increased.  For example, warn if a @code{char *} is cast to
4669 an @code{int *} on machines where integers can only be accessed at
4670 two- or four-byte boundaries.
4672 @item -Wwrite-strings
4673 @opindex Wwrite-strings
4674 @opindex Wno-write-strings
4675 When compiling C, give string constants the type @code{const
4676 char[@var{length}]} so that copying the address of one into a
4677 non-@code{const} @code{char *} pointer produces a warning.  These
4678 warnings help you find at compile time code that can try to write
4679 into a string constant, but only if you have been very careful about
4680 using @code{const} in declarations and prototypes.  Otherwise, it is
4681 just a nuisance. This is why we did not make @option{-Wall} request
4682 these warnings.
4684 When compiling C++, warn about the deprecated conversion from string
4685 literals to @code{char *}.  This warning is enabled by default for C++
4686 programs.
4688 @item -Wclobbered
4689 @opindex Wclobbered
4690 @opindex Wno-clobbered
4691 Warn for variables that might be changed by @samp{longjmp} or
4692 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4694 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4695 @opindex Wconditionally-supported
4696 @opindex Wno-conditionally-supported
4697 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4699 @item -Wconversion
4700 @opindex Wconversion
4701 @opindex Wno-conversion
4702 Warn for implicit conversions that may alter a value. This includes
4703 conversions between real and integer, like @code{abs (x)} when
4704 @code{x} is @code{double}; conversions between signed and unsigned,
4705 like @code{unsigned ui = -1}; and conversions to smaller types, like
4706 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4707 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4708 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4709 conversions between signed and unsigned integers can be disabled by
4710 using @option{-Wno-sign-conversion}.
4712 For C++, also warn for confusing overload resolution for user-defined
4713 conversions; and conversions that never use a type conversion
4714 operator: conversions to @code{void}, the same type, a base class or a
4715 reference to them. Warnings about conversions between signed and
4716 unsigned integers are disabled by default in C++ unless
4717 @option{-Wsign-conversion} is explicitly enabled.
4719 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4720 @opindex Wconversion-null
4721 @opindex Wno-conversion-null
4722 Do not warn for conversions between @code{NULL} and non-pointer
4723 types. @option{-Wconversion-null} is enabled by default.
4725 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4726 @opindex Wzero-as-null-pointer-constant
4727 @opindex Wno-zero-as-null-pointer-constant
4728 Warn when a literal '0' is used as null pointer constant.  This can
4729 be useful to facilitate the conversion to @code{nullptr} in C++11.
4731 @item -Wdate-time
4732 @opindex Wdate-time
4733 @opindex Wno-date-time
4734 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4735 are encountered as they might prevent bit-wise-identical reproducible
4736 compilations.
4738 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4739 @opindex Wdelete-incomplete
4740 @opindex Wno-delete-incomplete
4741 Warn when deleting a pointer to incomplete type, which may cause
4742 undefined behavior at runtime.  This warning is enabled by default.
4744 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4745 @opindex Wuseless-cast
4746 @opindex Wno-useless-cast
4747 Warn when an expression is casted to its own type.
4749 @item -Wempty-body
4750 @opindex Wempty-body
4751 @opindex Wno-empty-body
4752 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4753 while} statement.  This warning is also enabled by @option{-Wextra}.
4755 @item -Wenum-compare
4756 @opindex Wenum-compare
4757 @opindex Wno-enum-compare
4758 Warn about a comparison between values of different enumerated types.
4759 In C++ enumeral mismatches in conditional expressions are also
4760 diagnosed and the warning is enabled by default.  In C this warning is 
4761 enabled by @option{-Wall}.
4763 @item -Wjump-misses-init @r{(C, Objective-C only)}
4764 @opindex Wjump-misses-init
4765 @opindex Wno-jump-misses-init
4766 Warn if a @code{goto} statement or a @code{switch} statement jumps
4767 forward across the initialization of a variable, or jumps backward to a
4768 label after the variable has been initialized.  This only warns about
4769 variables that are initialized when they are declared.  This warning is
4770 only supported for C and Objective-C; in C++ this sort of branch is an
4771 error in any case.
4773 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4774 can be disabled with the @option{-Wno-jump-misses-init} option.
4776 @item -Wsign-compare
4777 @opindex Wsign-compare
4778 @opindex Wno-sign-compare
4779 @cindex warning for comparison of signed and unsigned values
4780 @cindex comparison of signed and unsigned values, warning
4781 @cindex signed and unsigned values, comparison warning
4782 Warn when a comparison between signed and unsigned values could produce
4783 an incorrect result when the signed value is converted to unsigned.
4784 This warning is also enabled by @option{-Wextra}; to get the other warnings
4785 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4787 @item -Wsign-conversion
4788 @opindex Wsign-conversion
4789 @opindex Wno-sign-conversion
4790 Warn for implicit conversions that may change the sign of an integer
4791 value, like assigning a signed integer expression to an unsigned
4792 integer variable. An explicit cast silences the warning. In C, this
4793 option is enabled also by @option{-Wconversion}.
4795 @item -Wfloat-conversion
4796 @opindex Wfloat-conversion
4797 @opindex Wno-float-conversion
4798 Warn for implicit conversions that reduce the precision of a real value.
4799 This includes conversions from real to integer, and from higher precision
4800 real to lower precision real values.  This option is also enabled by
4801 @option{-Wconversion}.
4803 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4804 @opindex Wsized-deallocation
4805 @opindex Wno-sized-deallocation
4806 Warn about a definition of an unsized deallocation function
4807 @smallexample
4808 void operator delete (void *) noexcept;
4809 void operator delete[] (void *) noexcept;
4810 @end smallexample
4811 without a definition of the corresponding sized deallocation function
4812 @smallexample
4813 void operator delete (void *, std::size_t) noexcept;
4814 void operator delete[] (void *, std::size_t) noexcept;
4815 @end smallexample
4816 or vice versa.  Enabled by @option{-Wextra} along with
4817 @option{-fsized-deallocation}.
4819 @item -Wsizeof-pointer-memaccess
4820 @opindex Wsizeof-pointer-memaccess
4821 @opindex Wno-sizeof-pointer-memaccess
4822 Warn for suspicious length parameters to certain string and memory built-in
4823 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4824 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4825 but a pointer, and suggests a possible fix, or about
4826 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4827 @option{-Wall}.
4829 @item -Wsizeof-array-argument
4830 @opindex Wsizeof-array-argument
4831 @opindex Wno-sizeof-array-argument
4832 Warn when the @code{sizeof} operator is applied to a parameter that is
4833 declared as an array in a function definition.  This warning is enabled by
4834 default for C and C++ programs.
4836 @item -Wmemset-transposed-args
4837 @opindex Wmemset-transposed-args
4838 @opindex Wno-memset-transposed-args
4839 Warn for suspicious calls to the @code{memset} built-in function, if the
4840 second argument is not zero and the third argument is zero.  This warns e.g.@
4841 about @code{memset (buf, sizeof buf, 0)} where most probably
4842 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4843 is only emitted if the third argument is literal zero, if it is some expression
4844 that is folded to zero, or e.g. a cast of zero to some type etc., it
4845 is far less likely that user has mistakenly exchanged the arguments and
4846 no warning is emitted.  This warning is enabled by @option{-Wall}.
4848 @item -Waddress
4849 @opindex Waddress
4850 @opindex Wno-address
4851 Warn about suspicious uses of memory addresses. These include using
4852 the address of a function in a conditional expression, such as
4853 @code{void func(void); if (func)}, and comparisons against the memory
4854 address of a string literal, such as @code{if (x == "abc")}.  Such
4855 uses typically indicate a programmer error: the address of a function
4856 always evaluates to true, so their use in a conditional usually
4857 indicate that the programmer forgot the parentheses in a function
4858 call; and comparisons against string literals result in unspecified
4859 behavior and are not portable in C, so they usually indicate that the
4860 programmer intended to use @code{strcmp}.  This warning is enabled by
4861 @option{-Wall}.
4863 @item -Wlogical-op
4864 @opindex Wlogical-op
4865 @opindex Wno-logical-op
4866 Warn about suspicious uses of logical operators in expressions.
4867 This includes using logical operators in contexts where a
4868 bit-wise operator is likely to be expected.
4870 @item -Wlogical-not-parentheses
4871 @opindex Wlogical-not-parentheses
4872 @opindex Wno-logical-not-parentheses
4873 Warn about logical not used on the left hand side operand of a comparison.
4874 This option does not warn if the RHS operand is of a boolean type.  Its
4875 purpose is to detect suspicious code like the following:
4876 @smallexample
4877 int a;
4878 @dots{}
4879 if (!a > 1) @{ @dots{} @}
4880 @end smallexample
4882 It is possible to suppress the warning by wrapping the LHS into
4883 parentheses:
4884 @smallexample
4885 if ((!a) > 1) @{ @dots{} @}
4886 @end smallexample
4888 This warning is enabled by @option{-Wall}.
4890 @item -Waggregate-return
4891 @opindex Waggregate-return
4892 @opindex Wno-aggregate-return
4893 Warn if any functions that return structures or unions are defined or
4894 called.  (In languages where you can return an array, this also elicits
4895 a warning.)
4897 @item -Wno-aggressive-loop-optimizations
4898 @opindex Wno-aggressive-loop-optimizations
4899 @opindex Waggressive-loop-optimizations
4900 Warn if in a loop with constant number of iterations the compiler detects
4901 undefined behavior in some statement during one or more of the iterations.
4903 @item -Wno-attributes
4904 @opindex Wno-attributes
4905 @opindex Wattributes
4906 Do not warn if an unexpected @code{__attribute__} is used, such as
4907 unrecognized attributes, function attributes applied to variables,
4908 etc.  This does not stop errors for incorrect use of supported
4909 attributes.
4911 @item -Wno-builtin-macro-redefined
4912 @opindex Wno-builtin-macro-redefined
4913 @opindex Wbuiltin-macro-redefined
4914 Do not warn if certain built-in macros are redefined.  This suppresses
4915 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4916 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4918 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4919 @opindex Wstrict-prototypes
4920 @opindex Wno-strict-prototypes
4921 Warn if a function is declared or defined without specifying the
4922 argument types.  (An old-style function definition is permitted without
4923 a warning if preceded by a declaration that specifies the argument
4924 types.)
4926 @item -Wold-style-declaration @r{(C and Objective-C only)}
4927 @opindex Wold-style-declaration
4928 @opindex Wno-old-style-declaration
4929 Warn for obsolescent usages, according to the C Standard, in a
4930 declaration. For example, warn if storage-class specifiers like
4931 @code{static} are not the first things in a declaration.  This warning
4932 is also enabled by @option{-Wextra}.
4934 @item -Wold-style-definition @r{(C and Objective-C only)}
4935 @opindex Wold-style-definition
4936 @opindex Wno-old-style-definition
4937 Warn if an old-style function definition is used.  A warning is given
4938 even if there is a previous prototype.
4940 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4941 @opindex Wmissing-parameter-type
4942 @opindex Wno-missing-parameter-type
4943 A function parameter is declared without a type specifier in K&R-style
4944 functions:
4946 @smallexample
4947 void foo(bar) @{ @}
4948 @end smallexample
4950 This warning is also enabled by @option{-Wextra}.
4952 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4953 @opindex Wmissing-prototypes
4954 @opindex Wno-missing-prototypes
4955 Warn if a global function is defined without a previous prototype
4956 declaration.  This warning is issued even if the definition itself
4957 provides a prototype.  Use this option to detect global functions
4958 that do not have a matching prototype declaration in a header file.
4959 This option is not valid for C++ because all function declarations
4960 provide prototypes and a non-matching declaration will declare an
4961 overload rather than conflict with an earlier declaration.
4962 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4964 @item -Wmissing-declarations
4965 @opindex Wmissing-declarations
4966 @opindex Wno-missing-declarations
4967 Warn if a global function is defined without a previous declaration.
4968 Do so even if the definition itself provides a prototype.
4969 Use this option to detect global functions that are not declared in
4970 header files.  In C, no warnings are issued for functions with previous
4971 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4972 missing prototypes.  In C++, no warnings are issued for function templates,
4973 or for inline functions, or for functions in anonymous namespaces.
4975 @item -Wmissing-field-initializers
4976 @opindex Wmissing-field-initializers
4977 @opindex Wno-missing-field-initializers
4978 @opindex W
4979 @opindex Wextra
4980 @opindex Wno-extra
4981 Warn if a structure's initializer has some fields missing.  For
4982 example, the following code causes such a warning, because
4983 @code{x.h} is implicitly zero:
4985 @smallexample
4986 struct s @{ int f, g, h; @};
4987 struct s x = @{ 3, 4 @};
4988 @end smallexample
4990 This option does not warn about designated initializers, so the following
4991 modification does not trigger a warning:
4993 @smallexample
4994 struct s @{ int f, g, h; @};
4995 struct s x = @{ .f = 3, .g = 4 @};
4996 @end smallexample
4998 In C++ this option does not warn either about the empty @{ @}
4999 initializer, for example:
5001 @smallexample
5002 struct s @{ int f, g, h; @};
5003 s x = @{ @};
5004 @end smallexample
5006 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5007 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5009 @item -Wno-multichar
5010 @opindex Wno-multichar
5011 @opindex Wmultichar
5012 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5013 Usually they indicate a typo in the user's code, as they have
5014 implementation-defined values, and should not be used in portable code.
5016 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5017 @opindex Wnormalized=
5018 @opindex Wnormalized
5019 @opindex Wno-normalized
5020 @cindex NFC
5021 @cindex NFKC
5022 @cindex character set, input normalization
5023 In ISO C and ISO C++, two identifiers are different if they are
5024 different sequences of characters.  However, sometimes when characters
5025 outside the basic ASCII character set are used, you can have two
5026 different character sequences that look the same.  To avoid confusion,
5027 the ISO 10646 standard sets out some @dfn{normalization rules} which
5028 when applied ensure that two sequences that look the same are turned into
5029 the same sequence.  GCC can warn you if you are using identifiers that
5030 have not been normalized; this option controls that warning.
5032 There are four levels of warning supported by GCC@.  The default is
5033 @option{-Wnormalized=nfc}, which warns about any identifier that is
5034 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5035 recommended form for most uses.  It is equivalent to
5036 @option{-Wnormalized}.
5038 Unfortunately, there are some characters allowed in identifiers by
5039 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5040 identifiers.  That is, there's no way to use these symbols in portable
5041 ISO C or C++ and have all your identifiers in NFC@.
5042 @option{-Wnormalized=id} suppresses the warning for these characters.
5043 It is hoped that future versions of the standards involved will correct
5044 this, which is why this option is not the default.
5046 You can switch the warning off for all characters by writing
5047 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5048 only do this if you are using some other normalization scheme (like
5049 ``D''), because otherwise you can easily create bugs that are
5050 literally impossible to see.
5052 Some characters in ISO 10646 have distinct meanings but look identical
5053 in some fonts or display methodologies, especially once formatting has
5054 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5055 LETTER N'', displays just like a regular @code{n} that has been
5056 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5057 normalization scheme to convert all these into a standard form as
5058 well, and GCC warns if your code is not in NFKC if you use
5059 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5060 about every identifier that contains the letter O because it might be
5061 confused with the digit 0, and so is not the default, but may be
5062 useful as a local coding convention if the programming environment 
5063 cannot be fixed to display these characters distinctly.
5065 @item -Wno-deprecated
5066 @opindex Wno-deprecated
5067 @opindex Wdeprecated
5068 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5070 @item -Wno-deprecated-declarations
5071 @opindex Wno-deprecated-declarations
5072 @opindex Wdeprecated-declarations
5073 Do not warn about uses of functions (@pxref{Function Attributes}),
5074 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5075 Attributes}) marked as deprecated by using the @code{deprecated}
5076 attribute.
5078 @item -Wno-overflow
5079 @opindex Wno-overflow
5080 @opindex Woverflow
5081 Do not warn about compile-time overflow in constant expressions.
5083 @item -Wno-odr
5084 @opindex Wno-odr
5085 @opindex Wodr
5086 Warn about One Definition Rule violations during link-time optimization.
5087 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5089 @item -Wopenmp-simd
5090 @opindex Wopenm-simd
5091 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5092 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5093 be used to relax the cost model.
5095 @item -Woverride-init @r{(C and Objective-C only)}
5096 @opindex Woverride-init
5097 @opindex Wno-override-init
5098 @opindex W
5099 @opindex Wextra
5100 @opindex Wno-extra
5101 Warn if an initialized field without side effects is overridden when
5102 using designated initializers (@pxref{Designated Inits, , Designated
5103 Initializers}).
5105 This warning is included in @option{-Wextra}.  To get other
5106 @option{-Wextra} warnings without this one, use @option{-Wextra
5107 -Wno-override-init}.
5109 @item -Wpacked
5110 @opindex Wpacked
5111 @opindex Wno-packed
5112 Warn if a structure is given the packed attribute, but the packed
5113 attribute has no effect on the layout or size of the structure.
5114 Such structures may be mis-aligned for little benefit.  For
5115 instance, in this code, the variable @code{f.x} in @code{struct bar}
5116 is misaligned even though @code{struct bar} does not itself
5117 have the packed attribute:
5119 @smallexample
5120 @group
5121 struct foo @{
5122   int x;
5123   char a, b, c, d;
5124 @} __attribute__((packed));
5125 struct bar @{
5126   char z;
5127   struct foo f;
5129 @end group
5130 @end smallexample
5132 @item -Wpacked-bitfield-compat
5133 @opindex Wpacked-bitfield-compat
5134 @opindex Wno-packed-bitfield-compat
5135 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5136 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5137 the change can lead to differences in the structure layout.  GCC
5138 informs you when the offset of such a field has changed in GCC 4.4.
5139 For example there is no longer a 4-bit padding between field @code{a}
5140 and @code{b} in this structure:
5142 @smallexample
5143 struct foo
5145   char a:4;
5146   char b:8;
5147 @} __attribute__ ((packed));
5148 @end smallexample
5150 This warning is enabled by default.  Use
5151 @option{-Wno-packed-bitfield-compat} to disable this warning.
5153 @item -Wpadded
5154 @opindex Wpadded
5155 @opindex Wno-padded
5156 Warn if padding is included in a structure, either to align an element
5157 of the structure or to align the whole structure.  Sometimes when this
5158 happens it is possible to rearrange the fields of the structure to
5159 reduce the padding and so make the structure smaller.
5161 @item -Wredundant-decls
5162 @opindex Wredundant-decls
5163 @opindex Wno-redundant-decls
5164 Warn if anything is declared more than once in the same scope, even in
5165 cases where multiple declaration is valid and changes nothing.
5167 @item -Wnested-externs @r{(C and Objective-C only)}
5168 @opindex Wnested-externs
5169 @opindex Wno-nested-externs
5170 Warn if an @code{extern} declaration is encountered within a function.
5172 @item -Wno-inherited-variadic-ctor
5173 @opindex Winherited-variadic-ctor
5174 @opindex Wno-inherited-variadic-ctor
5175 Suppress warnings about use of C++11 inheriting constructors when the
5176 base class inherited from has a C variadic constructor; the warning is
5177 on by default because the ellipsis is not inherited.
5179 @item -Winline
5180 @opindex Winline
5181 @opindex Wno-inline
5182 Warn if a function that is declared as inline cannot be inlined.
5183 Even with this option, the compiler does not warn about failures to
5184 inline functions declared in system headers.
5186 The compiler uses a variety of heuristics to determine whether or not
5187 to inline a function.  For example, the compiler takes into account
5188 the size of the function being inlined and the amount of inlining
5189 that has already been done in the current function.  Therefore,
5190 seemingly insignificant changes in the source program can cause the
5191 warnings produced by @option{-Winline} to appear or disappear.
5193 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5194 @opindex Wno-invalid-offsetof
5195 @opindex Winvalid-offsetof
5196 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5197 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5198 to a non-standard-layout type is undefined.  In existing C++ implementations,
5199 however, @samp{offsetof} typically gives meaningful results.
5200 This flag is for users who are aware that they are
5201 writing nonportable code and who have deliberately chosen to ignore the
5202 warning about it.
5204 The restrictions on @samp{offsetof} may be relaxed in a future version
5205 of the C++ standard.
5207 @item -Wno-int-to-pointer-cast
5208 @opindex Wno-int-to-pointer-cast
5209 @opindex Wint-to-pointer-cast
5210 Suppress warnings from casts to pointer type of an integer of a
5211 different size. In C++, casting to a pointer type of smaller size is
5212 an error. @option{Wint-to-pointer-cast} is enabled by default.
5215 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5216 @opindex Wno-pointer-to-int-cast
5217 @opindex Wpointer-to-int-cast
5218 Suppress warnings from casts from a pointer to an integer type of a
5219 different size.
5221 @item -Winvalid-pch
5222 @opindex Winvalid-pch
5223 @opindex Wno-invalid-pch
5224 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5225 the search path but can't be used.
5227 @item -Wlong-long
5228 @opindex Wlong-long
5229 @opindex Wno-long-long
5230 Warn if @samp{long long} type is used.  This is enabled by either
5231 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5232 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5234 @item -Wvariadic-macros
5235 @opindex Wvariadic-macros
5236 @opindex Wno-variadic-macros
5237 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5238 alternate syntax is used in ISO C99 mode.  This is enabled by either
5239 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5240 messages, use @option{-Wno-variadic-macros}.
5242 @item -Wvarargs
5243 @opindex Wvarargs
5244 @opindex Wno-varargs
5245 Warn upon questionable usage of the macros used to handle variable
5246 arguments like @samp{va_start}.  This is default.  To inhibit the
5247 warning messages, use @option{-Wno-varargs}.
5249 @item -Wvector-operation-performance
5250 @opindex Wvector-operation-performance
5251 @opindex Wno-vector-operation-performance
5252 Warn if vector operation is not implemented via SIMD capabilities of the
5253 architecture.  Mainly useful for the performance tuning.
5254 Vector operation can be implemented @code{piecewise}, which means that the
5255 scalar operation is performed on every vector element; 
5256 @code{in parallel}, which means that the vector operation is implemented
5257 using scalars of wider type, which normally is more performance efficient;
5258 and @code{as a single scalar}, which means that vector fits into a
5259 scalar type.
5261 @item -Wno-virtual-move-assign
5262 @opindex Wvirtual-move-assign
5263 @opindex Wno-virtual-move-assign
5264 Suppress warnings about inheriting from a virtual base with a
5265 non-trivial C++11 move assignment operator.  This is dangerous because
5266 if the virtual base is reachable along more than one path, it will be
5267 moved multiple times, which can mean both objects end up in the
5268 moved-from state.  If the move assignment operator is written to avoid
5269 moving from a moved-from object, this warning can be disabled.
5271 @item -Wvla
5272 @opindex Wvla
5273 @opindex Wno-vla
5274 Warn if variable length array is used in the code.
5275 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5276 the variable length array.
5278 @item -Wvolatile-register-var
5279 @opindex Wvolatile-register-var
5280 @opindex Wno-volatile-register-var
5281 Warn if a register variable is declared volatile.  The volatile
5282 modifier does not inhibit all optimizations that may eliminate reads
5283 and/or writes to register variables.  This warning is enabled by
5284 @option{-Wall}.
5286 @item -Wdisabled-optimization
5287 @opindex Wdisabled-optimization
5288 @opindex Wno-disabled-optimization
5289 Warn if a requested optimization pass is disabled.  This warning does
5290 not generally indicate that there is anything wrong with your code; it
5291 merely indicates that GCC's optimizers are unable to handle the code
5292 effectively.  Often, the problem is that your code is too big or too
5293 complex; GCC refuses to optimize programs when the optimization
5294 itself is likely to take inordinate amounts of time.
5296 @item -Wpointer-sign @r{(C and Objective-C only)}
5297 @opindex Wpointer-sign
5298 @opindex Wno-pointer-sign
5299 Warn for pointer argument passing or assignment with different signedness.
5300 This option is only supported for C and Objective-C@.  It is implied by
5301 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5302 @option{-Wno-pointer-sign}.
5304 @item -Wstack-protector
5305 @opindex Wstack-protector
5306 @opindex Wno-stack-protector
5307 This option is only active when @option{-fstack-protector} is active.  It
5308 warns about functions that are not protected against stack smashing.
5310 @item -Woverlength-strings
5311 @opindex Woverlength-strings
5312 @opindex Wno-overlength-strings
5313 Warn about string constants that are longer than the ``minimum
5314 maximum'' length specified in the C standard.  Modern compilers
5315 generally allow string constants that are much longer than the
5316 standard's minimum limit, but very portable programs should avoid
5317 using longer strings.
5319 The limit applies @emph{after} string constant concatenation, and does
5320 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5321 C99, it was raised to 4095.  C++98 does not specify a normative
5322 minimum maximum, so we do not diagnose overlength strings in C++@.
5324 This option is implied by @option{-Wpedantic}, and can be disabled with
5325 @option{-Wno-overlength-strings}.
5327 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5328 @opindex Wunsuffixed-float-constants
5330 Issue a warning for any floating constant that does not have
5331 a suffix.  When used together with @option{-Wsystem-headers} it
5332 warns about such constants in system header files.  This can be useful
5333 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5334 from the decimal floating-point extension to C99.
5336 @item -Wno-designated-init @r{(C and Objective-C only)}
5337 Suppress warnings when a positional initializer is used to initialize
5338 a structure that has been marked with the @code{designated_init}
5339 attribute.
5341 @end table
5343 @node Debugging Options
5344 @section Options for Debugging Your Program or GCC
5345 @cindex options, debugging
5346 @cindex debugging information options
5348 GCC has various special options that are used for debugging
5349 either your program or GCC:
5351 @table @gcctabopt
5352 @item -g
5353 @opindex g
5354 Produce debugging information in the operating system's native format
5355 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5356 information.
5358 On most systems that use stabs format, @option{-g} enables use of extra
5359 debugging information that only GDB can use; this extra information
5360 makes debugging work better in GDB but probably makes other debuggers
5361 crash or
5362 refuse to read the program.  If you want to control for certain whether
5363 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5364 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5366 GCC allows you to use @option{-g} with
5367 @option{-O}.  The shortcuts taken by optimized code may occasionally
5368 produce surprising results: some variables you declared may not exist
5369 at all; flow of control may briefly move where you did not expect it;
5370 some statements may not be executed because they compute constant
5371 results or their values are already at hand; some statements may
5372 execute in different places because they have been moved out of loops.
5374 Nevertheless it proves possible to debug optimized output.  This makes
5375 it reasonable to use the optimizer for programs that might have bugs.
5377 The following options are useful when GCC is generated with the
5378 capability for more than one debugging format.
5380 @item -gsplit-dwarf
5381 @opindex gsplit-dwarf
5382 Separate as much dwarf debugging information as possible into a
5383 separate output file with the extension .dwo.  This option allows
5384 the build system to avoid linking files with debug information.  To
5385 be useful, this option requires a debugger capable of reading .dwo
5386 files.
5388 @item -ggdb
5389 @opindex ggdb
5390 Produce debugging information for use by GDB@.  This means to use the
5391 most expressive format available (DWARF 2, stabs, or the native format
5392 if neither of those are supported), including GDB extensions if at all
5393 possible.
5395 @item -gpubnames
5396 @opindex gpubnames
5397 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5399 @item -ggnu-pubnames
5400 @opindex ggnu-pubnames
5401 Generate .debug_pubnames and .debug_pubtypes sections in a format
5402 suitable for conversion into a GDB@ index.  This option is only useful
5403 with a linker that can produce GDB@ index version 7.
5405 @item -gstabs
5406 @opindex gstabs
5407 Produce debugging information in stabs format (if that is supported),
5408 without GDB extensions.  This is the format used by DBX on most BSD
5409 systems.  On MIPS, Alpha and System V Release 4 systems this option
5410 produces stabs debugging output that is not understood by DBX or SDB@.
5411 On System V Release 4 systems this option requires the GNU assembler.
5413 @item -feliminate-unused-debug-symbols
5414 @opindex feliminate-unused-debug-symbols
5415 Produce debugging information in stabs format (if that is supported),
5416 for only symbols that are actually used.
5418 @item -femit-class-debug-always
5419 @opindex femit-class-debug-always
5420 Instead of emitting debugging information for a C++ class in only one
5421 object file, emit it in all object files using the class.  This option
5422 should be used only with debuggers that are unable to handle the way GCC
5423 normally emits debugging information for classes because using this
5424 option increases the size of debugging information by as much as a
5425 factor of two.
5427 @item -fdebug-types-section
5428 @opindex fdebug-types-section
5429 @opindex fno-debug-types-section
5430 When using DWARF Version 4 or higher, type DIEs can be put into
5431 their own @code{.debug_types} section instead of making them part of the
5432 @code{.debug_info} section.  It is more efficient to put them in a separate
5433 comdat sections since the linker can then remove duplicates.
5434 But not all DWARF consumers support @code{.debug_types} sections yet
5435 and on some objects @code{.debug_types} produces larger instead of smaller
5436 debugging information.
5438 @item -gstabs+
5439 @opindex gstabs+
5440 Produce debugging information in stabs format (if that is supported),
5441 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5442 use of these extensions is likely to make other debuggers crash or
5443 refuse to read the program.
5445 @item -gcoff
5446 @opindex gcoff
5447 Produce debugging information in COFF format (if that is supported).
5448 This is the format used by SDB on most System V systems prior to
5449 System V Release 4.
5451 @item -gxcoff
5452 @opindex gxcoff
5453 Produce debugging information in XCOFF format (if that is supported).
5454 This is the format used by the DBX debugger on IBM RS/6000 systems.
5456 @item -gxcoff+
5457 @opindex gxcoff+
5458 Produce debugging information in XCOFF format (if that is supported),
5459 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5460 use of these extensions is likely to make other debuggers crash or
5461 refuse to read the program, and may cause assemblers other than the GNU
5462 assembler (GAS) to fail with an error.
5464 @item -gdwarf-@var{version}
5465 @opindex gdwarf-@var{version}
5466 Produce debugging information in DWARF format (if that is supported).
5467 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5468 for most targets is 4.  DWARF Version 5 is only experimental.
5470 Note that with DWARF Version 2, some ports require and always
5471 use some non-conflicting DWARF 3 extensions in the unwind tables.
5473 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5474 for maximum benefit.
5476 @item -grecord-gcc-switches
5477 @opindex grecord-gcc-switches
5478 This switch causes the command-line options used to invoke the
5479 compiler that may affect code generation to be appended to the
5480 DW_AT_producer attribute in DWARF debugging information.  The options
5481 are concatenated with spaces separating them from each other and from
5482 the compiler version.  See also @option{-frecord-gcc-switches} for another
5483 way of storing compiler options into the object file.  This is the default.
5485 @item -gno-record-gcc-switches
5486 @opindex gno-record-gcc-switches
5487 Disallow appending command-line options to the DW_AT_producer attribute
5488 in DWARF debugging information.
5490 @item -gstrict-dwarf
5491 @opindex gstrict-dwarf
5492 Disallow using extensions of later DWARF standard version than selected
5493 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5494 DWARF extensions from later standard versions is allowed.
5496 @item -gno-strict-dwarf
5497 @opindex gno-strict-dwarf
5498 Allow using extensions of later DWARF standard version than selected with
5499 @option{-gdwarf-@var{version}}.
5501 @item -gz@r{[}=@var{type}@r{]}
5502 @opindex gz
5503 Produce compressed debug sections in DWARF format, if that is supported.
5504 If @var{type} is not given, the default type depends on the capabilities
5505 of the assembler and linker used.  @var{type} may be one of
5506 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5507 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5508 compression in traditional GNU format).  If the linker doesn't support
5509 writing compressed debug sections, the option is rejected.  Otherwise,
5510 if the assembler does not support them, @option{-gz} is silently ignored
5511 when producing object files.
5513 @item -gvms
5514 @opindex gvms
5515 Produce debugging information in Alpha/VMS debug format (if that is
5516 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5518 @item -g@var{level}
5519 @itemx -ggdb@var{level}
5520 @itemx -gstabs@var{level}
5521 @itemx -gcoff@var{level}
5522 @itemx -gxcoff@var{level}
5523 @itemx -gvms@var{level}
5524 Request debugging information and also use @var{level} to specify how
5525 much information.  The default level is 2.
5527 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5528 @option{-g}.
5530 Level 1 produces minimal information, enough for making backtraces in
5531 parts of the program that you don't plan to debug.  This includes
5532 descriptions of functions and external variables, and line number
5533 tables, but no information about local variables.
5535 Level 3 includes extra information, such as all the macro definitions
5536 present in the program.  Some debuggers support macro expansion when
5537 you use @option{-g3}.
5539 @option{-gdwarf-2} does not accept a concatenated debug level, because
5540 GCC used to support an option @option{-gdwarf} that meant to generate
5541 debug information in version 1 of the DWARF format (which is very
5542 different from version 2), and it would have been too confusing.  That
5543 debug format is long obsolete, but the option cannot be changed now.
5544 Instead use an additional @option{-g@var{level}} option to change the
5545 debug level for DWARF.
5547 @item -gtoggle
5548 @opindex gtoggle
5549 Turn off generation of debug info, if leaving out this option
5550 generates it, or turn it on at level 2 otherwise.  The position of this
5551 argument in the command line does not matter; it takes effect after all
5552 other options are processed, and it does so only once, no matter how
5553 many times it is given.  This is mainly intended to be used with
5554 @option{-fcompare-debug}.
5556 @item -fsanitize=address
5557 @opindex fsanitize=address
5558 Enable AddressSanitizer, a fast memory error detector.
5559 Memory access instructions will be instrumented to detect
5560 out-of-bounds and use-after-free bugs.
5561 See @uref{http://code.google.com/p/address-sanitizer/} for
5562 more details.  The run-time behavior can be influenced using the
5563 @env{ASAN_OPTIONS} environment variable; see
5564 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5565 a list of supported options.
5567 @item -fsanitize=kernel-address
5568 @opindex fsanitize=kernel-address
5569 Enable AddressSanitizer for Linux kernel.
5570 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5572 @item -fsanitize=thread
5573 @opindex fsanitize=thread
5574 Enable ThreadSanitizer, a fast data race detector.
5575 Memory access instructions will be instrumented to detect
5576 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5577 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5578 environment variable; see
5579 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5580 supported options.
5582 @item -fsanitize=leak
5583 @opindex fsanitize=leak
5584 Enable LeakSanitizer, a memory leak detector.
5585 This option only matters for linking of executables and if neither
5586 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5587 case it will link the executable against a library that overrides @code{malloc}
5588 and other allocator functions.  See
5589 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5590 details.  The run-time behavior can be influenced using the
5591 @env{LSAN_OPTIONS} environment variable.
5593 @item -fsanitize=undefined
5594 @opindex fsanitize=undefined
5595 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5596 Various computations will be instrumented to detect undefined behavior
5597 at runtime.  Current suboptions are:
5599 @table @gcctabopt
5601 @item -fsanitize=shift
5602 @opindex fsanitize=shift
5603 This option enables checking that the result of a shift operation is
5604 not undefined.  Note that what exactly is considered undefined differs
5605 slightly between C and C++, as well as between ISO C90 and C99, etc.
5607 @item -fsanitize=integer-divide-by-zero
5608 @opindex fsanitize=integer-divide-by-zero
5609 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5611 @item -fsanitize=unreachable
5612 @opindex fsanitize=unreachable
5613 With this option, the compiler will turn the @code{__builtin_unreachable}
5614 call into a diagnostics message call instead.  When reaching the
5615 @code{__builtin_unreachable} call, the behavior is undefined.
5617 @item -fsanitize=vla-bound
5618 @opindex fsanitize=vla-bound
5619 This option instructs the compiler to check that the size of a variable
5620 length array is positive.  This option does not have any effect in
5621 @option{-std=c++14} mode, as the standard requires the exception be thrown
5622 instead.
5624 @item -fsanitize=null
5625 @opindex fsanitize=null
5626 This option enables pointer checking.  Particularly, the application
5627 built with this option turned on will issue an error message when it
5628 tries to dereference a NULL pointer, or if a reference (possibly an
5629 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5630 on an object pointed by a NULL pointer.
5632 @item -fsanitize=return
5633 @opindex fsanitize=return
5634 This option enables return statement checking.  Programs
5635 built with this option turned on will issue an error message
5636 when the end of a non-void function is reached without actually
5637 returning a value.  This option works in C++ only.
5639 @item -fsanitize=signed-integer-overflow
5640 @opindex fsanitize=signed-integer-overflow
5641 This option enables signed integer overflow checking.  We check that
5642 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5643 does not overflow in the signed arithmetics.  Note, integer promotion
5644 rules must be taken into account.  That is, the following is not an
5645 overflow:
5646 @smallexample
5647 signed char a = SCHAR_MAX;
5648 a++;
5649 @end smallexample
5651 @item -fsanitize=bounds
5652 @opindex fsanitize=bounds
5653 This option enables instrumentation of array bounds.  Various out of bounds
5654 accesses are detected.  Flexible array members and initializers of variables
5655 with static storage are not instrumented.
5657 @item -fsanitize=alignment
5658 @opindex fsanitize=alignment
5660 This option enables checking of alignment of pointers when they are
5661 dereferenced, or when a reference is bound to insufficiently aligned target,
5662 or when a method or constructor is invoked on insufficiently aligned object.
5664 @item -fsanitize=object-size
5665 @opindex fsanitize=object-size
5666 This option enables instrumentation of memory references using the
5667 @code{__builtin_object_size} function.  Various out of bounds pointer
5668 accesses are detected.
5670 @item -fsanitize=float-divide-by-zero
5671 @opindex fsanitize=float-divide-by-zero
5672 Detect floating-point division by zero.  Unlike other similar options,
5673 @option{-fsanitize=float-divide-by-zero} is not enabled by
5674 @option{-fsanitize=undefined}, since floating-point division by zero can
5675 be a legitimate way of obtaining infinities and NaNs.
5677 @item -fsanitize=float-cast-overflow
5678 @opindex fsanitize=float-cast-overflow
5679 This option enables floating-point type to integer conversion checking.
5680 We check that the result of the conversion does not overflow.
5681 This option does not work well with @code{FE_INVALID} exceptions enabled.
5683 @item -fsanitize=nonnull-attribute
5684 @opindex fsanitize=nonnull-attribute
5686 This option enables instrumentation of calls, checking whether null values
5687 are not passed to arguments marked as requiring a non-null value by the
5688 @code{nonnull} function attribute.
5690 @item -fsanitize=returns-nonnull-attribute
5691 @opindex fsanitize=returns-nonnull-attribute
5693 This option enables instrumentation of return statements in functions
5694 marked with @code{returns_nonnull} function attribute, to detect returning
5695 of null values from such functions.
5697 @item -fsanitize=bool
5698 @opindex fsanitize=bool
5700 This option enables instrumentation of loads from bool.  If a value other
5701 than 0/1 is loaded, a run-time error is issued.
5703 @item -fsanitize=enum
5704 @opindex fsanitize=enum
5706 This option enables instrumentation of loads from an enum type.  If
5707 a value outside the range of values for the enum type is loaded,
5708 a run-time error is issued.
5710 @end table
5712 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5713 @option{-fsanitize=undefined} gives a diagnostic message.
5714 This currently works only for the C family of languages.
5716 @item -fasan-shadow-offset=@var{number}
5717 @opindex fasan-shadow-offset
5718 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5719 It is useful for experimenting with different shadow memory layouts in
5720 Kernel AddressSanitizer.
5722 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5723 @opindex fsanitize-recover
5724 @opindex fno-sanitize-recover
5725 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5726 mentioned in comma-separated list of @var{opts}.  Enabling this option
5727 for a sanitizer component would cause it to attempt to continue
5728 running the program as if no error happened.  This means multiple
5729 runtime errors can be reported in a single program run, and the exit
5730 code of the program may indicate success even when errors
5731 have been reported.  The @option{-fno-sanitize-recover=} can be used to alter
5732 this behavior, only the first detected error will be reported
5733 and program will exit after that with non-zero exit code.
5735 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5736 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5737 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5738 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5740 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5741 @option{-fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5742 Similarly @option{-fno-sanitize-recover} is equivalent to
5743 @option{-fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5745 @item -fsanitize-undefined-trap-on-error
5746 @opindex fsanitize-undefined-trap-on-error
5747 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5748 report undefined behavior using @code{__builtin_trap ()} rather than
5749 a @code{libubsan} library routine.  The advantage of this is that the
5750 @code{libubsan} library is not needed and will not be linked in, so this
5751 is usable even for use in freestanding environments.
5753 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5754 @opindex fdump-final-insns
5755 Dump the final internal representation (RTL) to @var{file}.  If the
5756 optional argument is omitted (or if @var{file} is @code{.}), the name
5757 of the dump file is determined by appending @code{.gkd} to the
5758 compilation output file name.
5760 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5761 @opindex fcompare-debug
5762 @opindex fno-compare-debug
5763 If no error occurs during compilation, run the compiler a second time,
5764 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5765 passed to the second compilation.  Dump the final internal
5766 representation in both compilations, and print an error if they differ.
5768 If the equal sign is omitted, the default @option{-gtoggle} is used.
5770 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5771 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5772 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5773 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5774 is used.
5776 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5777 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5778 of the final representation and the second compilation, preventing even
5779 @env{GCC_COMPARE_DEBUG} from taking effect.
5781 To verify full coverage during @option{-fcompare-debug} testing, set
5782 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5783 which GCC rejects as an invalid option in any actual compilation
5784 (rather than preprocessing, assembly or linking).  To get just a
5785 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5786 not overridden} will do.
5788 @item -fcompare-debug-second
5789 @opindex fcompare-debug-second
5790 This option is implicitly passed to the compiler for the second
5791 compilation requested by @option{-fcompare-debug}, along with options to
5792 silence warnings, and omitting other options that would cause
5793 side-effect compiler outputs to files or to the standard output.  Dump
5794 files and preserved temporary files are renamed so as to contain the
5795 @code{.gk} additional extension during the second compilation, to avoid
5796 overwriting those generated by the first.
5798 When this option is passed to the compiler driver, it causes the
5799 @emph{first} compilation to be skipped, which makes it useful for little
5800 other than debugging the compiler proper.
5802 @item -feliminate-dwarf2-dups
5803 @opindex feliminate-dwarf2-dups
5804 Compress DWARF 2 debugging information by eliminating duplicated
5805 information about each symbol.  This option only makes sense when
5806 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5808 @item -femit-struct-debug-baseonly
5809 @opindex femit-struct-debug-baseonly
5810 Emit debug information for struct-like types
5811 only when the base name of the compilation source file
5812 matches the base name of file in which the struct is defined.
5814 This option substantially reduces the size of debugging information,
5815 but at significant potential loss in type information to the debugger.
5816 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5817 See @option{-femit-struct-debug-detailed} for more detailed control.
5819 This option works only with DWARF 2.
5821 @item -femit-struct-debug-reduced
5822 @opindex femit-struct-debug-reduced
5823 Emit debug information for struct-like types
5824 only when the base name of the compilation source file
5825 matches the base name of file in which the type is defined,
5826 unless the struct is a template or defined in a system header.
5828 This option significantly reduces the size of debugging information,
5829 with some potential loss in type information to the debugger.
5830 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5831 See @option{-femit-struct-debug-detailed} for more detailed control.
5833 This option works only with DWARF 2.
5835 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5836 @opindex femit-struct-debug-detailed
5837 Specify the struct-like types
5838 for which the compiler generates debug information.
5839 The intent is to reduce duplicate struct debug information
5840 between different object files within the same program.
5842 This option is a detailed version of
5843 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5844 which serves for most needs.
5846 A specification has the syntax@*
5847 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5849 The optional first word limits the specification to
5850 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5851 A struct type is used directly when it is the type of a variable, member.
5852 Indirect uses arise through pointers to structs.
5853 That is, when use of an incomplete struct is valid, the use is indirect.
5854 An example is
5855 @samp{struct one direct; struct two * indirect;}.
5857 The optional second word limits the specification to
5858 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5859 Generic structs are a bit complicated to explain.
5860 For C++, these are non-explicit specializations of template classes,
5861 or non-template classes within the above.
5862 Other programming languages have generics,
5863 but @option{-femit-struct-debug-detailed} does not yet implement them.
5865 The third word specifies the source files for those
5866 structs for which the compiler should emit debug information.
5867 The values @samp{none} and @samp{any} have the normal meaning.
5868 The value @samp{base} means that
5869 the base of name of the file in which the type declaration appears
5870 must match the base of the name of the main compilation file.
5871 In practice, this means that when compiling @file{foo.c}, debug information
5872 is generated for types declared in that file and @file{foo.h},
5873 but not other header files.
5874 The value @samp{sys} means those types satisfying @samp{base}
5875 or declared in system or compiler headers.
5877 You may need to experiment to determine the best settings for your application.
5879 The default is @option{-femit-struct-debug-detailed=all}.
5881 This option works only with DWARF 2.
5883 @item -fno-merge-debug-strings
5884 @opindex fmerge-debug-strings
5885 @opindex fno-merge-debug-strings
5886 Direct the linker to not merge together strings in the debugging
5887 information that are identical in different object files.  Merging is
5888 not supported by all assemblers or linkers.  Merging decreases the size
5889 of the debug information in the output file at the cost of increasing
5890 link processing time.  Merging is enabled by default.
5892 @item -fdebug-prefix-map=@var{old}=@var{new}
5893 @opindex fdebug-prefix-map
5894 When compiling files in directory @file{@var{old}}, record debugging
5895 information describing them as in @file{@var{new}} instead.
5897 @item -fno-dwarf2-cfi-asm
5898 @opindex fdwarf2-cfi-asm
5899 @opindex fno-dwarf2-cfi-asm
5900 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5901 instead of using GAS @code{.cfi_*} directives.
5903 @cindex @command{prof}
5904 @item -p
5905 @opindex p
5906 Generate extra code to write profile information suitable for the
5907 analysis program @command{prof}.  You must use this option when compiling
5908 the source files you want data about, and you must also use it when
5909 linking.
5911 @cindex @command{gprof}
5912 @item -pg
5913 @opindex pg
5914 Generate extra code to write profile information suitable for the
5915 analysis program @command{gprof}.  You must use this option when compiling
5916 the source files you want data about, and you must also use it when
5917 linking.
5919 @item -Q
5920 @opindex Q
5921 Makes the compiler print out each function name as it is compiled, and
5922 print some statistics about each pass when it finishes.
5924 @item -ftime-report
5925 @opindex ftime-report
5926 Makes the compiler print some statistics about the time consumed by each
5927 pass when it finishes.
5929 @item -fmem-report
5930 @opindex fmem-report
5931 Makes the compiler print some statistics about permanent memory
5932 allocation when it finishes.
5934 @item -fmem-report-wpa
5935 @opindex fmem-report-wpa
5936 Makes the compiler print some statistics about permanent memory
5937 allocation for the WPA phase only.
5939 @item -fpre-ipa-mem-report
5940 @opindex fpre-ipa-mem-report
5941 @item -fpost-ipa-mem-report
5942 @opindex fpost-ipa-mem-report
5943 Makes the compiler print some statistics about permanent memory
5944 allocation before or after interprocedural optimization.
5946 @item -fprofile-report
5947 @opindex fprofile-report
5948 Makes the compiler print some statistics about consistency of the
5949 (estimated) profile and effect of individual passes.
5951 @item -fstack-usage
5952 @opindex fstack-usage
5953 Makes the compiler output stack usage information for the program, on a
5954 per-function basis.  The filename for the dump is made by appending
5955 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5956 the output file, if explicitly specified and it is not an executable,
5957 otherwise it is the basename of the source file.  An entry is made up
5958 of three fields:
5960 @itemize
5961 @item
5962 The name of the function.
5963 @item
5964 A number of bytes.
5965 @item
5966 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5967 @end itemize
5969 The qualifier @code{static} means that the function manipulates the stack
5970 statically: a fixed number of bytes are allocated for the frame on function
5971 entry and released on function exit; no stack adjustments are otherwise made
5972 in the function.  The second field is this fixed number of bytes.
5974 The qualifier @code{dynamic} means that the function manipulates the stack
5975 dynamically: in addition to the static allocation described above, stack
5976 adjustments are made in the body of the function, for example to push/pop
5977 arguments around function calls.  If the qualifier @code{bounded} is also
5978 present, the amount of these adjustments is bounded at compile time and
5979 the second field is an upper bound of the total amount of stack used by
5980 the function.  If it is not present, the amount of these adjustments is
5981 not bounded at compile time and the second field only represents the
5982 bounded part.
5984 @item -fprofile-arcs
5985 @opindex fprofile-arcs
5986 Add code so that program flow @dfn{arcs} are instrumented.  During
5987 execution the program records how many times each branch and call is
5988 executed and how many times it is taken or returns.  When the compiled
5989 program exits it saves this data to a file called
5990 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5991 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5992 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5993 @var{auxname} is generated from the name of the output file, if
5994 explicitly specified and it is not the final executable, otherwise it is
5995 the basename of the source file.  In both cases any suffix is removed
5996 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5997 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5998 @xref{Cross-profiling}.
6000 @cindex @command{gcov}
6001 @item --coverage
6002 @opindex coverage
6004 This option is used to compile and link code instrumented for coverage
6005 analysis.  The option is a synonym for @option{-fprofile-arcs}
6006 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6007 linking).  See the documentation for those options for more details.
6009 @itemize
6011 @item
6012 Compile the source files with @option{-fprofile-arcs} plus optimization
6013 and code generation options.  For test coverage analysis, use the
6014 additional @option{-ftest-coverage} option.  You do not need to profile
6015 every source file in a program.
6017 @item
6018 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6019 (the latter implies the former).
6021 @item
6022 Run the program on a representative workload to generate the arc profile
6023 information.  This may be repeated any number of times.  You can run
6024 concurrent instances of your program, and provided that the file system
6025 supports locking, the data files will be correctly updated.  Also
6026 @code{fork} calls are detected and correctly handled (double counting
6027 will not happen).
6029 @item
6030 For profile-directed optimizations, compile the source files again with
6031 the same optimization and code generation options plus
6032 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6033 Control Optimization}).
6035 @item
6036 For test coverage analysis, use @command{gcov} to produce human readable
6037 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6038 @command{gcov} documentation for further information.
6040 @end itemize
6042 With @option{-fprofile-arcs}, for each function of your program GCC
6043 creates a program flow graph, then finds a spanning tree for the graph.
6044 Only arcs that are not on the spanning tree have to be instrumented: the
6045 compiler adds code to count the number of times that these arcs are
6046 executed.  When an arc is the only exit or only entrance to a block, the
6047 instrumentation code can be added to the block; otherwise, a new basic
6048 block must be created to hold the instrumentation code.
6050 @need 2000
6051 @item -ftest-coverage
6052 @opindex ftest-coverage
6053 Produce a notes file that the @command{gcov} code-coverage utility
6054 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6055 show program coverage.  Each source file's note file is called
6056 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6057 above for a description of @var{auxname} and instructions on how to
6058 generate test coverage data.  Coverage data matches the source files
6059 more closely if you do not optimize.
6061 @item -fdbg-cnt-list
6062 @opindex fdbg-cnt-list
6063 Print the name and the counter upper bound for all debug counters.
6066 @item -fdbg-cnt=@var{counter-value-list}
6067 @opindex fdbg-cnt
6068 Set the internal debug counter upper bound.  @var{counter-value-list}
6069 is a comma-separated list of @var{name}:@var{value} pairs
6070 which sets the upper bound of each debug counter @var{name} to @var{value}.
6071 All debug counters have the initial upper bound of @code{UINT_MAX};
6072 thus @code{dbg_cnt()} returns true always unless the upper bound
6073 is set by this option.
6074 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6075 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6077 @item -fenable-@var{kind}-@var{pass}
6078 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6079 @opindex fdisable-
6080 @opindex fenable-
6082 This is a set of options that are used to explicitly disable/enable
6083 optimization passes.  These options are intended for use for debugging GCC.
6084 Compiler users should use regular options for enabling/disabling
6085 passes instead.
6087 @table @gcctabopt
6089 @item -fdisable-ipa-@var{pass}
6090 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6091 statically invoked in the compiler multiple times, the pass name should be
6092 appended with a sequential number starting from 1.
6094 @item -fdisable-rtl-@var{pass}
6095 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6096 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6097 statically invoked in the compiler multiple times, the pass name should be
6098 appended with a sequential number starting from 1.  @var{range-list} is a 
6099 comma-separated list of function ranges or assembler names.  Each range is a number
6100 pair separated by a colon.  The range is inclusive in both ends.  If the range
6101 is trivial, the number pair can be simplified as a single number.  If the
6102 function's call graph node's @var{uid} falls within one of the specified ranges,
6103 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6104 function header of a dump file, and the pass names can be dumped by using
6105 option @option{-fdump-passes}.
6107 @item -fdisable-tree-@var{pass}
6108 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6109 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6110 option arguments.
6112 @item -fenable-ipa-@var{pass}
6113 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6114 statically invoked in the compiler multiple times, the pass name should be
6115 appended with a sequential number starting from 1.
6117 @item -fenable-rtl-@var{pass}
6118 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6119 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6120 description and examples.
6122 @item -fenable-tree-@var{pass}
6123 @itemx -fenable-tree-@var{pass}=@var{range-list}
6124 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6125 of option arguments.
6127 @end table
6129 Here are some examples showing uses of these options.
6131 @smallexample
6133 # disable ccp1 for all functions
6134    -fdisable-tree-ccp1
6135 # disable complete unroll for function whose cgraph node uid is 1
6136    -fenable-tree-cunroll=1
6137 # disable gcse2 for functions at the following ranges [1,1],
6138 # [300,400], and [400,1000]
6139 # disable gcse2 for functions foo and foo2
6140    -fdisable-rtl-gcse2=foo,foo2
6141 # disable early inlining
6142    -fdisable-tree-einline
6143 # disable ipa inlining
6144    -fdisable-ipa-inline
6145 # enable tree full unroll
6146    -fenable-tree-unroll
6148 @end smallexample
6150 @item -d@var{letters}
6151 @itemx -fdump-rtl-@var{pass}
6152 @itemx -fdump-rtl-@var{pass}=@var{filename}
6153 @opindex d
6154 @opindex fdump-rtl-@var{pass}
6155 Says to make debugging dumps during compilation at times specified by
6156 @var{letters}.  This is used for debugging the RTL-based passes of the
6157 compiler.  The file names for most of the dumps are made by appending
6158 a pass number and a word to the @var{dumpname}, and the files are
6159 created in the directory of the output file. In case of
6160 @option{=@var{filename}} option, the dump is output on the given file
6161 instead of the pass numbered dump files. Note that the pass number is
6162 computed statically as passes get registered into the pass manager.
6163 Thus the numbering is not related to the dynamic order of execution of
6164 passes.  In particular, a pass installed by a plugin could have a
6165 number over 200 even if it executed quite early.  @var{dumpname} is
6166 generated from the name of the output file, if explicitly specified
6167 and it is not an executable, otherwise it is the basename of the
6168 source file. These switches may have different effects when
6169 @option{-E} is used for preprocessing.
6171 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6172 @option{-d} option @var{letters}.  Here are the possible
6173 letters for use in @var{pass} and @var{letters}, and their meanings:
6175 @table @gcctabopt
6177 @item -fdump-rtl-alignments
6178 @opindex fdump-rtl-alignments
6179 Dump after branch alignments have been computed.
6181 @item -fdump-rtl-asmcons
6182 @opindex fdump-rtl-asmcons
6183 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6185 @item -fdump-rtl-auto_inc_dec
6186 @opindex fdump-rtl-auto_inc_dec
6187 Dump after auto-inc-dec discovery.  This pass is only run on
6188 architectures that have auto inc or auto dec instructions.
6190 @item -fdump-rtl-barriers
6191 @opindex fdump-rtl-barriers
6192 Dump after cleaning up the barrier instructions.
6194 @item -fdump-rtl-bbpart
6195 @opindex fdump-rtl-bbpart
6196 Dump after partitioning hot and cold basic blocks.
6198 @item -fdump-rtl-bbro
6199 @opindex fdump-rtl-bbro
6200 Dump after block reordering.
6202 @item -fdump-rtl-btl1
6203 @itemx -fdump-rtl-btl2
6204 @opindex fdump-rtl-btl2
6205 @opindex fdump-rtl-btl2
6206 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6207 after the two branch
6208 target load optimization passes.
6210 @item -fdump-rtl-bypass
6211 @opindex fdump-rtl-bypass
6212 Dump after jump bypassing and control flow optimizations.
6214 @item -fdump-rtl-combine
6215 @opindex fdump-rtl-combine
6216 Dump after the RTL instruction combination pass.
6218 @item -fdump-rtl-compgotos
6219 @opindex fdump-rtl-compgotos
6220 Dump after duplicating the computed gotos.
6222 @item -fdump-rtl-ce1
6223 @itemx -fdump-rtl-ce2
6224 @itemx -fdump-rtl-ce3
6225 @opindex fdump-rtl-ce1
6226 @opindex fdump-rtl-ce2
6227 @opindex fdump-rtl-ce3
6228 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6229 @option{-fdump-rtl-ce3} enable dumping after the three
6230 if conversion passes.
6232 @item -fdump-rtl-cprop_hardreg
6233 @opindex fdump-rtl-cprop_hardreg
6234 Dump after hard register copy propagation.
6236 @item -fdump-rtl-csa
6237 @opindex fdump-rtl-csa
6238 Dump after combining stack adjustments.
6240 @item -fdump-rtl-cse1
6241 @itemx -fdump-rtl-cse2
6242 @opindex fdump-rtl-cse1
6243 @opindex fdump-rtl-cse2
6244 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6245 the two common subexpression elimination passes.
6247 @item -fdump-rtl-dce
6248 @opindex fdump-rtl-dce
6249 Dump after the standalone dead code elimination passes.
6251 @item -fdump-rtl-dbr
6252 @opindex fdump-rtl-dbr
6253 Dump after delayed branch scheduling.
6255 @item -fdump-rtl-dce1
6256 @itemx -fdump-rtl-dce2
6257 @opindex fdump-rtl-dce1
6258 @opindex fdump-rtl-dce2
6259 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6260 the two dead store elimination passes.
6262 @item -fdump-rtl-eh
6263 @opindex fdump-rtl-eh
6264 Dump after finalization of EH handling code.
6266 @item -fdump-rtl-eh_ranges
6267 @opindex fdump-rtl-eh_ranges
6268 Dump after conversion of EH handling range regions.
6270 @item -fdump-rtl-expand
6271 @opindex fdump-rtl-expand
6272 Dump after RTL generation.
6274 @item -fdump-rtl-fwprop1
6275 @itemx -fdump-rtl-fwprop2
6276 @opindex fdump-rtl-fwprop1
6277 @opindex fdump-rtl-fwprop2
6278 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6279 dumping after the two forward propagation passes.
6281 @item -fdump-rtl-gcse1
6282 @itemx -fdump-rtl-gcse2
6283 @opindex fdump-rtl-gcse1
6284 @opindex fdump-rtl-gcse2
6285 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6286 after global common subexpression elimination.
6288 @item -fdump-rtl-init-regs
6289 @opindex fdump-rtl-init-regs
6290 Dump after the initialization of the registers.
6292 @item -fdump-rtl-initvals
6293 @opindex fdump-rtl-initvals
6294 Dump after the computation of the initial value sets.
6296 @item -fdump-rtl-into_cfglayout
6297 @opindex fdump-rtl-into_cfglayout
6298 Dump after converting to cfglayout mode.
6300 @item -fdump-rtl-ira
6301 @opindex fdump-rtl-ira
6302 Dump after iterated register allocation.
6304 @item -fdump-rtl-jump
6305 @opindex fdump-rtl-jump
6306 Dump after the second jump optimization.
6308 @item -fdump-rtl-loop2
6309 @opindex fdump-rtl-loop2
6310 @option{-fdump-rtl-loop2} enables dumping after the rtl
6311 loop optimization passes.
6313 @item -fdump-rtl-mach
6314 @opindex fdump-rtl-mach
6315 Dump after performing the machine dependent reorganization pass, if that
6316 pass exists.
6318 @item -fdump-rtl-mode_sw
6319 @opindex fdump-rtl-mode_sw
6320 Dump after removing redundant mode switches.
6322 @item -fdump-rtl-rnreg
6323 @opindex fdump-rtl-rnreg
6324 Dump after register renumbering.
6326 @item -fdump-rtl-outof_cfglayout
6327 @opindex fdump-rtl-outof_cfglayout
6328 Dump after converting from cfglayout mode.
6330 @item -fdump-rtl-peephole2
6331 @opindex fdump-rtl-peephole2
6332 Dump after the peephole pass.
6334 @item -fdump-rtl-postreload
6335 @opindex fdump-rtl-postreload
6336 Dump after post-reload optimizations.
6338 @item -fdump-rtl-pro_and_epilogue
6339 @opindex fdump-rtl-pro_and_epilogue
6340 Dump after generating the function prologues and epilogues.
6342 @item -fdump-rtl-sched1
6343 @itemx -fdump-rtl-sched2
6344 @opindex fdump-rtl-sched1
6345 @opindex fdump-rtl-sched2
6346 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6347 after the basic block scheduling passes.
6349 @item -fdump-rtl-ree
6350 @opindex fdump-rtl-ree
6351 Dump after sign/zero extension elimination.
6353 @item -fdump-rtl-seqabstr
6354 @opindex fdump-rtl-seqabstr
6355 Dump after common sequence discovery.
6357 @item -fdump-rtl-shorten
6358 @opindex fdump-rtl-shorten
6359 Dump after shortening branches.
6361 @item -fdump-rtl-sibling
6362 @opindex fdump-rtl-sibling
6363 Dump after sibling call optimizations.
6365 @item -fdump-rtl-split1
6366 @itemx -fdump-rtl-split2
6367 @itemx -fdump-rtl-split3
6368 @itemx -fdump-rtl-split4
6369 @itemx -fdump-rtl-split5
6370 @opindex fdump-rtl-split1
6371 @opindex fdump-rtl-split2
6372 @opindex fdump-rtl-split3
6373 @opindex fdump-rtl-split4
6374 @opindex fdump-rtl-split5
6375 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6376 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6377 @option{-fdump-rtl-split5} enable dumping after five rounds of
6378 instruction splitting.
6380 @item -fdump-rtl-sms
6381 @opindex fdump-rtl-sms
6382 Dump after modulo scheduling.  This pass is only run on some
6383 architectures.
6385 @item -fdump-rtl-stack
6386 @opindex fdump-rtl-stack
6387 Dump after conversion from GCC's ``flat register file'' registers to the
6388 x87's stack-like registers.  This pass is only run on x86 variants.
6390 @item -fdump-rtl-subreg1
6391 @itemx -fdump-rtl-subreg2
6392 @opindex fdump-rtl-subreg1
6393 @opindex fdump-rtl-subreg2
6394 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6395 the two subreg expansion passes.
6397 @item -fdump-rtl-unshare
6398 @opindex fdump-rtl-unshare
6399 Dump after all rtl has been unshared.
6401 @item -fdump-rtl-vartrack
6402 @opindex fdump-rtl-vartrack
6403 Dump after variable tracking.
6405 @item -fdump-rtl-vregs
6406 @opindex fdump-rtl-vregs
6407 Dump after converting virtual registers to hard registers.
6409 @item -fdump-rtl-web
6410 @opindex fdump-rtl-web
6411 Dump after live range splitting.
6413 @item -fdump-rtl-regclass
6414 @itemx -fdump-rtl-subregs_of_mode_init
6415 @itemx -fdump-rtl-subregs_of_mode_finish
6416 @itemx -fdump-rtl-dfinit
6417 @itemx -fdump-rtl-dfinish
6418 @opindex fdump-rtl-regclass
6419 @opindex fdump-rtl-subregs_of_mode_init
6420 @opindex fdump-rtl-subregs_of_mode_finish
6421 @opindex fdump-rtl-dfinit
6422 @opindex fdump-rtl-dfinish
6423 These dumps are defined but always produce empty files.
6425 @item -da
6426 @itemx -fdump-rtl-all
6427 @opindex da
6428 @opindex fdump-rtl-all
6429 Produce all the dumps listed above.
6431 @item -dA
6432 @opindex dA
6433 Annotate the assembler output with miscellaneous debugging information.
6435 @item -dD
6436 @opindex dD
6437 Dump all macro definitions, at the end of preprocessing, in addition to
6438 normal output.
6440 @item -dH
6441 @opindex dH
6442 Produce a core dump whenever an error occurs.
6444 @item -dp
6445 @opindex dp
6446 Annotate the assembler output with a comment indicating which
6447 pattern and alternative is used.  The length of each instruction is
6448 also printed.
6450 @item -dP
6451 @opindex dP
6452 Dump the RTL in the assembler output as a comment before each instruction.
6453 Also turns on @option{-dp} annotation.
6455 @item -dx
6456 @opindex dx
6457 Just generate RTL for a function instead of compiling it.  Usually used
6458 with @option{-fdump-rtl-expand}.
6459 @end table
6461 @item -fdump-noaddr
6462 @opindex fdump-noaddr
6463 When doing debugging dumps, suppress address output.  This makes it more
6464 feasible to use diff on debugging dumps for compiler invocations with
6465 different compiler binaries and/or different
6466 text / bss / data / heap / stack / dso start locations.
6468 @item -freport-bug
6469 @opindex freport-bug
6470 Collect and dump debug information into temporary file if ICE in C/C++
6471 compiler occured.
6473 @item -fdump-unnumbered
6474 @opindex fdump-unnumbered
6475 When doing debugging dumps, suppress instruction numbers and address output.
6476 This makes it more feasible to use diff on debugging dumps for compiler
6477 invocations with different options, in particular with and without
6478 @option{-g}.
6480 @item -fdump-unnumbered-links
6481 @opindex fdump-unnumbered-links
6482 When doing debugging dumps (see @option{-d} option above), suppress
6483 instruction numbers for the links to the previous and next instructions
6484 in a sequence.
6486 @item -fdump-translation-unit @r{(C++ only)}
6487 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6488 @opindex fdump-translation-unit
6489 Dump a representation of the tree structure for the entire translation
6490 unit to a file.  The file name is made by appending @file{.tu} to the
6491 source file name, and the file is created in the same directory as the
6492 output file.  If the @samp{-@var{options}} form is used, @var{options}
6493 controls the details of the dump as described for the
6494 @option{-fdump-tree} options.
6496 @item -fdump-class-hierarchy @r{(C++ only)}
6497 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6498 @opindex fdump-class-hierarchy
6499 Dump a representation of each class's hierarchy and virtual function
6500 table layout to a file.  The file name is made by appending
6501 @file{.class} to the source file name, and the file is created in the
6502 same directory as the output file.  If the @samp{-@var{options}} form
6503 is used, @var{options} controls the details of the dump as described
6504 for the @option{-fdump-tree} options.
6506 @item -fdump-ipa-@var{switch}
6507 @opindex fdump-ipa
6508 Control the dumping at various stages of inter-procedural analysis
6509 language tree to a file.  The file name is generated by appending a
6510 switch specific suffix to the source file name, and the file is created
6511 in the same directory as the output file.  The following dumps are
6512 possible:
6514 @table @samp
6515 @item all
6516 Enables all inter-procedural analysis dumps.
6518 @item cgraph
6519 Dumps information about call-graph optimization, unused function removal,
6520 and inlining decisions.
6522 @item inline
6523 Dump after function inlining.
6525 @end table
6527 @item -fdump-passes
6528 @opindex fdump-passes
6529 Dump the list of optimization passes that are turned on and off by
6530 the current command-line options.
6532 @item -fdump-statistics-@var{option}
6533 @opindex fdump-statistics
6534 Enable and control dumping of pass statistics in a separate file.  The
6535 file name is generated by appending a suffix ending in
6536 @samp{.statistics} to the source file name, and the file is created in
6537 the same directory as the output file.  If the @samp{-@var{option}}
6538 form is used, @samp{-stats} causes counters to be summed over the
6539 whole compilation unit while @samp{-details} dumps every event as
6540 the passes generate them.  The default with no option is to sum
6541 counters for each function compiled.
6543 @item -fdump-tree-@var{switch}
6544 @itemx -fdump-tree-@var{switch}-@var{options}
6545 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6546 @opindex fdump-tree
6547 Control the dumping at various stages of processing the intermediate
6548 language tree to a file.  The file name is generated by appending a
6549 switch-specific suffix to the source file name, and the file is
6550 created in the same directory as the output file. In case of
6551 @option{=@var{filename}} option, the dump is output on the given file
6552 instead of the auto named dump files.  If the @samp{-@var{options}}
6553 form is used, @var{options} is a list of @samp{-} separated options
6554 which control the details of the dump.  Not all options are applicable
6555 to all dumps; those that are not meaningful are ignored.  The
6556 following options are available
6558 @table @samp
6559 @item address
6560 Print the address of each node.  Usually this is not meaningful as it
6561 changes according to the environment and source file.  Its primary use
6562 is for tying up a dump file with a debug environment.
6563 @item asmname
6564 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6565 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6566 use working backward from mangled names in the assembly file.
6567 @item slim
6568 When dumping front-end intermediate representations, inhibit dumping
6569 of members of a scope or body of a function merely because that scope
6570 has been reached.  Only dump such items when they are directly reachable
6571 by some other path.
6573 When dumping pretty-printed trees, this option inhibits dumping the
6574 bodies of control structures.
6576 When dumping RTL, print the RTL in slim (condensed) form instead of
6577 the default LISP-like representation.
6578 @item raw
6579 Print a raw representation of the tree.  By default, trees are
6580 pretty-printed into a C-like representation.
6581 @item details
6582 Enable more detailed dumps (not honored by every dump option). Also
6583 include information from the optimization passes.
6584 @item stats
6585 Enable dumping various statistics about the pass (not honored by every dump
6586 option).
6587 @item blocks
6588 Enable showing basic block boundaries (disabled in raw dumps).
6589 @item graph
6590 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6591 dump a representation of the control flow graph suitable for viewing with
6592 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6593 the file is pretty-printed as a subgraph, so that GraphViz can render them
6594 all in a single plot.
6596 This option currently only works for RTL dumps, and the RTL is always
6597 dumped in slim form.
6598 @item vops
6599 Enable showing virtual operands for every statement.
6600 @item lineno
6601 Enable showing line numbers for statements.
6602 @item uid
6603 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6604 @item verbose
6605 Enable showing the tree dump for each statement.
6606 @item eh
6607 Enable showing the EH region number holding each statement.
6608 @item scev
6609 Enable showing scalar evolution analysis details.
6610 @item optimized
6611 Enable showing optimization information (only available in certain
6612 passes).
6613 @item missed
6614 Enable showing missed optimization information (only available in certain
6615 passes).
6616 @item note
6617 Enable other detailed optimization information (only available in
6618 certain passes).
6619 @item =@var{filename}
6620 Instead of an auto named dump file, output into the given file
6621 name. The file names @file{stdout} and @file{stderr} are treated
6622 specially and are considered already open standard streams. For
6623 example,
6625 @smallexample
6626 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6627      -fdump-tree-pre=stderr file.c
6628 @end smallexample
6630 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6631 output on to @file{stderr}. If two conflicting dump filenames are
6632 given for the same pass, then the latter option overrides the earlier
6633 one.
6635 @item all
6636 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6637 and @option{lineno}.
6639 @item optall
6640 Turn on all optimization options, i.e., @option{optimized},
6641 @option{missed}, and @option{note}.
6642 @end table
6644 The following tree dumps are possible:
6645 @table @samp
6647 @item original
6648 @opindex fdump-tree-original
6649 Dump before any tree based optimization, to @file{@var{file}.original}.
6651 @item optimized
6652 @opindex fdump-tree-optimized
6653 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6655 @item gimple
6656 @opindex fdump-tree-gimple
6657 Dump each function before and after the gimplification pass to a file.  The
6658 file name is made by appending @file{.gimple} to the source file name.
6660 @item cfg
6661 @opindex fdump-tree-cfg
6662 Dump the control flow graph of each function to a file.  The file name is
6663 made by appending @file{.cfg} to the source file name.
6665 @item ch
6666 @opindex fdump-tree-ch
6667 Dump each function after copying loop headers.  The file name is made by
6668 appending @file{.ch} to the source file name.
6670 @item ssa
6671 @opindex fdump-tree-ssa
6672 Dump SSA related information to a file.  The file name is made by appending
6673 @file{.ssa} to the source file name.
6675 @item alias
6676 @opindex fdump-tree-alias
6677 Dump aliasing information for each function.  The file name is made by
6678 appending @file{.alias} to the source file name.
6680 @item ccp
6681 @opindex fdump-tree-ccp
6682 Dump each function after CCP@.  The file name is made by appending
6683 @file{.ccp} to the source file name.
6685 @item storeccp
6686 @opindex fdump-tree-storeccp
6687 Dump each function after STORE-CCP@.  The file name is made by appending
6688 @file{.storeccp} to the source file name.
6690 @item pre
6691 @opindex fdump-tree-pre
6692 Dump trees after partial redundancy elimination.  The file name is made
6693 by appending @file{.pre} to the source file name.
6695 @item fre
6696 @opindex fdump-tree-fre
6697 Dump trees after full redundancy elimination.  The file name is made
6698 by appending @file{.fre} to the source file name.
6700 @item copyprop
6701 @opindex fdump-tree-copyprop
6702 Dump trees after copy propagation.  The file name is made
6703 by appending @file{.copyprop} to the source file name.
6705 @item store_copyprop
6706 @opindex fdump-tree-store_copyprop
6707 Dump trees after store copy-propagation.  The file name is made
6708 by appending @file{.store_copyprop} to the source file name.
6710 @item dce
6711 @opindex fdump-tree-dce
6712 Dump each function after dead code elimination.  The file name is made by
6713 appending @file{.dce} to the source file name.
6715 @item sra
6716 @opindex fdump-tree-sra
6717 Dump each function after performing scalar replacement of aggregates.  The
6718 file name is made by appending @file{.sra} to the source file name.
6720 @item sink
6721 @opindex fdump-tree-sink
6722 Dump each function after performing code sinking.  The file name is made
6723 by appending @file{.sink} to the source file name.
6725 @item dom
6726 @opindex fdump-tree-dom
6727 Dump each function after applying dominator tree optimizations.  The file
6728 name is made by appending @file{.dom} to the source file name.
6730 @item dse
6731 @opindex fdump-tree-dse
6732 Dump each function after applying dead store elimination.  The file
6733 name is made by appending @file{.dse} to the source file name.
6735 @item phiopt
6736 @opindex fdump-tree-phiopt
6737 Dump each function after optimizing PHI nodes into straightline code.  The file
6738 name is made by appending @file{.phiopt} to the source file name.
6740 @item forwprop
6741 @opindex fdump-tree-forwprop
6742 Dump each function after forward propagating single use variables.  The file
6743 name is made by appending @file{.forwprop} to the source file name.
6745 @item copyrename
6746 @opindex fdump-tree-copyrename
6747 Dump each function after applying the copy rename optimization.  The file
6748 name is made by appending @file{.copyrename} to the source file name.
6750 @item nrv
6751 @opindex fdump-tree-nrv
6752 Dump each function after applying the named return value optimization on
6753 generic trees.  The file name is made by appending @file{.nrv} to the source
6754 file name.
6756 @item vect
6757 @opindex fdump-tree-vect
6758 Dump each function after applying vectorization of loops.  The file name is
6759 made by appending @file{.vect} to the source file name.
6761 @item slp
6762 @opindex fdump-tree-slp
6763 Dump each function after applying vectorization of basic blocks.  The file name
6764 is made by appending @file{.slp} to the source file name.
6766 @item vrp
6767 @opindex fdump-tree-vrp
6768 Dump each function after Value Range Propagation (VRP).  The file name
6769 is made by appending @file{.vrp} to the source file name.
6771 @item all
6772 @opindex fdump-tree-all
6773 Enable all the available tree dumps with the flags provided in this option.
6774 @end table
6776 @item -fopt-info
6777 @itemx -fopt-info-@var{options}
6778 @itemx -fopt-info-@var{options}=@var{filename}
6779 @opindex fopt-info
6780 Controls optimization dumps from various optimization passes. If the
6781 @samp{-@var{options}} form is used, @var{options} is a list of
6782 @samp{-} separated option keywords to select the dump details and
6783 optimizations.  
6785 The @var{options} can be divided into two groups: options describing the
6786 verbosity of the dump, and options describing which optimizations
6787 should be included. The options from both the groups can be freely
6788 mixed as they are non-overlapping. However, in case of any conflicts,
6789 the later options override the earlier options on the command
6790 line. 
6792 The following options control the dump verbosity:
6794 @table @samp
6795 @item optimized
6796 Print information when an optimization is successfully applied. It is
6797 up to a pass to decide which information is relevant. For example, the
6798 vectorizer passes print the source location of loops which are
6799 successfully vectorized.
6800 @item missed
6801 Print information about missed optimizations. Individual passes
6802 control which information to include in the output. 
6803 @item note
6804 Print verbose information about optimizations, such as certain
6805 transformations, more detailed messages about decisions etc.
6806 @item all
6807 Print detailed optimization information. This includes
6808 @samp{optimized}, @samp{missed}, and @samp{note}.
6809 @end table
6811 One or more of the following option keywords can be used to describe a
6812 group of optimizations:
6814 @table @samp
6815 @item ipa
6816 Enable dumps from all interprocedural optimizations.
6817 @item loop
6818 Enable dumps from all loop optimizations.
6819 @item inline
6820 Enable dumps from all inlining optimizations.
6821 @item vec
6822 Enable dumps from all vectorization optimizations.
6823 @item optall
6824 Enable dumps from all optimizations. This is a superset of
6825 the optimization groups listed above.
6826 @end table
6828 If @var{options} is
6829 omitted, it defaults to @samp{optimized-optall}, which means to dump all
6830 info about successful optimizations from all the passes.  
6832 If the @var{filename} is provided, then the dumps from all the
6833 applicable optimizations are concatenated into the @var{filename}.
6834 Otherwise the dump is output onto @file{stderr}. Though multiple
6835 @option{-fopt-info} options are accepted, only one of them can include
6836 a @var{filename}. If other filenames are provided then all but the
6837 first such option are ignored.
6839 Note that the output @var{filename} is overwritten
6840 in case of multiple translation units. If a combined output from
6841 multiple translation units is desired, @file{stderr} should be used
6842 instead.
6844 In the following example, the optimization info is output to
6845 @file{stderr}:
6847 @smallexample
6848 gcc -O3 -fopt-info
6849 @end smallexample
6851 This example:
6852 @smallexample
6853 gcc -O3 -fopt-info-missed=missed.all
6854 @end smallexample
6856 @noindent
6857 outputs missed optimization report from all the passes into
6858 @file{missed.all}, and this one:
6860 @smallexample
6861 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6862 @end smallexample
6864 @noindent
6865 prints information about missed optimization opportunities from
6866 vectorization passes on @file{stderr}.  
6867 Note that @option{-fopt-info-vec-missed} is equivalent to 
6868 @option{-fopt-info-missed-vec}.
6870 As another example,
6871 @smallexample
6872 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6873 @end smallexample
6875 @noindent
6876 outputs information about missed optimizations as well as
6877 optimized locations from all the inlining passes into
6878 @file{inline.txt}.
6880 Finally, consider:
6882 @smallexample
6883 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6884 @end smallexample
6886 @noindent
6887 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6888 in conflict since only one output file is allowed. In this case, only
6889 the first option takes effect and the subsequent options are
6890 ignored. Thus only @file{vec.miss} is produced which contains
6891 dumps from the vectorizer about missed opportunities.
6893 @item -frandom-seed=@var{number}
6894 @opindex frandom-seed
6895 This option provides a seed that GCC uses in place of
6896 random numbers in generating certain symbol names
6897 that have to be different in every compiled file.  It is also used to
6898 place unique stamps in coverage data files and the object files that
6899 produce them.  You can use the @option{-frandom-seed} option to produce
6900 reproducibly identical object files.
6902 The @var{number} should be different for every file you compile.
6904 @item -fsched-verbose=@var{n}
6905 @opindex fsched-verbose
6906 On targets that use instruction scheduling, this option controls the
6907 amount of debugging output the scheduler prints.  This information is
6908 written to standard error, unless @option{-fdump-rtl-sched1} or
6909 @option{-fdump-rtl-sched2} is specified, in which case it is output
6910 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6911 respectively.  However for @var{n} greater than nine, the output is
6912 always printed to standard error.
6914 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6915 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6916 For @var{n} greater than one, it also output basic block probabilities,
6917 detailed ready list information and unit/insn info.  For @var{n} greater
6918 than two, it includes RTL at abort point, control-flow and regions info.
6919 And for @var{n} over four, @option{-fsched-verbose} also includes
6920 dependence info.
6922 @item -save-temps
6923 @itemx -save-temps=cwd
6924 @opindex save-temps
6925 Store the usual ``temporary'' intermediate files permanently; place them
6926 in the current directory and name them based on the source file.  Thus,
6927 compiling @file{foo.c} with @option{-c -save-temps} produces files
6928 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6929 preprocessed @file{foo.i} output file even though the compiler now
6930 normally uses an integrated preprocessor.
6932 When used in combination with the @option{-x} command-line option,
6933 @option{-save-temps} is sensible enough to avoid over writing an
6934 input source file with the same extension as an intermediate file.
6935 The corresponding intermediate file may be obtained by renaming the
6936 source file before using @option{-save-temps}.
6938 If you invoke GCC in parallel, compiling several different source
6939 files that share a common base name in different subdirectories or the
6940 same source file compiled for multiple output destinations, it is
6941 likely that the different parallel compilers will interfere with each
6942 other, and overwrite the temporary files.  For instance:
6944 @smallexample
6945 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6946 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6947 @end smallexample
6949 may result in @file{foo.i} and @file{foo.o} being written to
6950 simultaneously by both compilers.
6952 @item -save-temps=obj
6953 @opindex save-temps=obj
6954 Store the usual ``temporary'' intermediate files permanently.  If the
6955 @option{-o} option is used, the temporary files are based on the
6956 object file.  If the @option{-o} option is not used, the
6957 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6959 For example:
6961 @smallexample
6962 gcc -save-temps=obj -c foo.c
6963 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6964 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6965 @end smallexample
6967 @noindent
6968 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6969 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6970 @file{dir2/yfoobar.o}.
6972 @item -time@r{[}=@var{file}@r{]}
6973 @opindex time
6974 Report the CPU time taken by each subprocess in the compilation
6975 sequence.  For C source files, this is the compiler proper and assembler
6976 (plus the linker if linking is done).
6978 Without the specification of an output file, the output looks like this:
6980 @smallexample
6981 # cc1 0.12 0.01
6982 # as 0.00 0.01
6983 @end smallexample
6985 The first number on each line is the ``user time'', that is time spent
6986 executing the program itself.  The second number is ``system time'',
6987 time spent executing operating system routines on behalf of the program.
6988 Both numbers are in seconds.
6990 With the specification of an output file, the output is appended to the
6991 named file, and it looks like this:
6993 @smallexample
6994 0.12 0.01 cc1 @var{options}
6995 0.00 0.01 as @var{options}
6996 @end smallexample
6998 The ``user time'' and the ``system time'' are moved before the program
6999 name, and the options passed to the program are displayed, so that one
7000 can later tell what file was being compiled, and with which options.
7002 @item -fvar-tracking
7003 @opindex fvar-tracking
7004 Run variable tracking pass.  It computes where variables are stored at each
7005 position in code.  Better debugging information is then generated
7006 (if the debugging information format supports this information).
7008 It is enabled by default when compiling with optimization (@option{-Os},
7009 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7010 the debug info format supports it.
7012 @item -fvar-tracking-assignments
7013 @opindex fvar-tracking-assignments
7014 @opindex fno-var-tracking-assignments
7015 Annotate assignments to user variables early in the compilation and
7016 attempt to carry the annotations over throughout the compilation all the
7017 way to the end, in an attempt to improve debug information while
7018 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7020 It can be enabled even if var-tracking is disabled, in which case
7021 annotations are created and maintained, but discarded at the end.
7023 @item -fvar-tracking-assignments-toggle
7024 @opindex fvar-tracking-assignments-toggle
7025 @opindex fno-var-tracking-assignments-toggle
7026 Toggle @option{-fvar-tracking-assignments}, in the same way that
7027 @option{-gtoggle} toggles @option{-g}.
7029 @item -print-file-name=@var{library}
7030 @opindex print-file-name
7031 Print the full absolute name of the library file @var{library} that
7032 would be used when linking---and don't do anything else.  With this
7033 option, GCC does not compile or link anything; it just prints the
7034 file name.
7036 @item -print-multi-directory
7037 @opindex print-multi-directory
7038 Print the directory name corresponding to the multilib selected by any
7039 other switches present in the command line.  This directory is supposed
7040 to exist in @env{GCC_EXEC_PREFIX}.
7042 @item -print-multi-lib
7043 @opindex print-multi-lib
7044 Print the mapping from multilib directory names to compiler switches
7045 that enable them.  The directory name is separated from the switches by
7046 @samp{;}, and each switch starts with an @samp{@@} instead of the
7047 @samp{-}, without spaces between multiple switches.  This is supposed to
7048 ease shell processing.
7050 @item -print-multi-os-directory
7051 @opindex print-multi-os-directory
7052 Print the path to OS libraries for the selected
7053 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7054 present in the @file{lib} subdirectory and no multilibs are used, this is
7055 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7056 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7057 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7058 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7060 @item -print-multiarch
7061 @opindex print-multiarch
7062 Print the path to OS libraries for the selected multiarch,
7063 relative to some @file{lib} subdirectory.
7065 @item -print-prog-name=@var{program}
7066 @opindex print-prog-name
7067 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
7069 @item -print-libgcc-file-name
7070 @opindex print-libgcc-file-name
7071 Same as @option{-print-file-name=libgcc.a}.
7073 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7074 but you do want to link with @file{libgcc.a}.  You can do:
7076 @smallexample
7077 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7078 @end smallexample
7080 @item -print-search-dirs
7081 @opindex print-search-dirs
7082 Print the name of the configured installation directory and a list of
7083 program and library directories @command{gcc} searches---and don't do anything else.
7085 This is useful when @command{gcc} prints the error message
7086 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7087 To resolve this you either need to put @file{cpp0} and the other compiler
7088 components where @command{gcc} expects to find them, or you can set the environment
7089 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7090 Don't forget the trailing @samp{/}.
7091 @xref{Environment Variables}.
7093 @item -print-sysroot
7094 @opindex print-sysroot
7095 Print the target sysroot directory that is used during
7096 compilation.  This is the target sysroot specified either at configure
7097 time or using the @option{--sysroot} option, possibly with an extra
7098 suffix that depends on compilation options.  If no target sysroot is
7099 specified, the option prints nothing.
7101 @item -print-sysroot-headers-suffix
7102 @opindex print-sysroot-headers-suffix
7103 Print the suffix added to the target sysroot when searching for
7104 headers, or give an error if the compiler is not configured with such
7105 a suffix---and don't do anything else.
7107 @item -dumpmachine
7108 @opindex dumpmachine
7109 Print the compiler's target machine (for example,
7110 @samp{i686-pc-linux-gnu})---and don't do anything else.
7112 @item -dumpversion
7113 @opindex dumpversion
7114 Print the compiler version (for example, @samp{3.0})---and don't do
7115 anything else.
7117 @item -dumpspecs
7118 @opindex dumpspecs
7119 Print the compiler's built-in specs---and don't do anything else.  (This
7120 is used when GCC itself is being built.)  @xref{Spec Files}.
7122 @item -fno-eliminate-unused-debug-types
7123 @opindex feliminate-unused-debug-types
7124 @opindex fno-eliminate-unused-debug-types
7125 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7126 output for types that are nowhere used in the source file being compiled.
7127 Sometimes it is useful to have GCC emit debugging
7128 information for all types declared in a compilation
7129 unit, regardless of whether or not they are actually used
7130 in that compilation unit, for example 
7131 if, in the debugger, you want to cast a value to a type that is
7132 not actually used in your program (but is declared).  More often,
7133 however, this results in a significant amount of wasted space.
7134 @end table
7136 @node Optimize Options
7137 @section Options That Control Optimization
7138 @cindex optimize options
7139 @cindex options, optimization
7141 These options control various sorts of optimizations.
7143 Without any optimization option, the compiler's goal is to reduce the
7144 cost of compilation and to make debugging produce the expected
7145 results.  Statements are independent: if you stop the program with a
7146 breakpoint between statements, you can then assign a new value to any
7147 variable or change the program counter to any other statement in the
7148 function and get exactly the results you expect from the source
7149 code.
7151 Turning on optimization flags makes the compiler attempt to improve
7152 the performance and/or code size at the expense of compilation time
7153 and possibly the ability to debug the program.
7155 The compiler performs optimization based on the knowledge it has of the
7156 program.  Compiling multiple files at once to a single output file mode allows
7157 the compiler to use information gained from all of the files when compiling
7158 each of them.
7160 Not all optimizations are controlled directly by a flag.  Only
7161 optimizations that have a flag are listed in this section.
7163 Most optimizations are only enabled if an @option{-O} level is set on
7164 the command line.  Otherwise they are disabled, even if individual
7165 optimization flags are specified.
7167 Depending on the target and how GCC was configured, a slightly different
7168 set of optimizations may be enabled at each @option{-O} level than
7169 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7170 to find out the exact set of optimizations that are enabled at each level.
7171 @xref{Overall Options}, for examples.
7173 @table @gcctabopt
7174 @item -O
7175 @itemx -O1
7176 @opindex O
7177 @opindex O1
7178 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7179 more memory for a large function.
7181 With @option{-O}, the compiler tries to reduce code size and execution
7182 time, without performing any optimizations that take a great deal of
7183 compilation time.
7185 @option{-O} turns on the following optimization flags:
7186 @gccoptlist{
7187 -fauto-inc-dec @gol
7188 -fbranch-count-reg @gol
7189 -fcombine-stack-adjustments @gol
7190 -fcompare-elim @gol
7191 -fcprop-registers @gol
7192 -fdce @gol
7193 -fdefer-pop @gol
7194 -fdelayed-branch @gol
7195 -fdse @gol
7196 -fforward-propagate @gol
7197 -fguess-branch-probability @gol
7198 -fif-conversion2 @gol
7199 -fif-conversion @gol
7200 -finline-functions-called-once @gol
7201 -fipa-pure-const @gol
7202 -fipa-profile @gol
7203 -fipa-reference @gol
7204 -fmerge-constants @gol
7205 -fmove-loop-invariants @gol
7206 -fshrink-wrap @gol
7207 -fsplit-wide-types @gol
7208 -ftree-bit-ccp @gol
7209 -ftree-ccp @gol
7210 -fssa-phiopt @gol
7211 -ftree-ch @gol
7212 -ftree-copy-prop @gol
7213 -ftree-copyrename @gol
7214 -ftree-dce @gol
7215 -ftree-dominator-opts @gol
7216 -ftree-dse @gol
7217 -ftree-forwprop @gol
7218 -ftree-fre @gol
7219 -ftree-phiprop @gol
7220 -ftree-sink @gol
7221 -ftree-slsr @gol
7222 -ftree-sra @gol
7223 -ftree-pta @gol
7224 -ftree-ter @gol
7225 -funit-at-a-time}
7227 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7228 where doing so does not interfere with debugging.
7230 @item -O2
7231 @opindex O2
7232 Optimize even more.  GCC performs nearly all supported optimizations
7233 that do not involve a space-speed tradeoff.
7234 As compared to @option{-O}, this option increases both compilation time
7235 and the performance of the generated code.
7237 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7238 also turns on the following optimization flags:
7239 @gccoptlist{-fthread-jumps @gol
7240 -falign-functions  -falign-jumps @gol
7241 -falign-loops  -falign-labels @gol
7242 -fcaller-saves @gol
7243 -fcrossjumping @gol
7244 -fcse-follow-jumps  -fcse-skip-blocks @gol
7245 -fdelete-null-pointer-checks @gol
7246 -fdevirtualize -fdevirtualize-speculatively @gol
7247 -fexpensive-optimizations @gol
7248 -fgcse  -fgcse-lm  @gol
7249 -fhoist-adjacent-loads @gol
7250 -finline-small-functions @gol
7251 -findirect-inlining @gol
7252 -fipa-cp @gol
7253 -fipa-sra @gol
7254 -fipa-icf @gol
7255 -fisolate-erroneous-paths-dereference @gol
7256 -flra-remat @gol
7257 -foptimize-sibling-calls @gol
7258 -foptimize-strlen @gol
7259 -fpartial-inlining @gol
7260 -fpeephole2 @gol
7261 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7262 -frerun-cse-after-loop  @gol
7263 -fsched-interblock  -fsched-spec @gol
7264 -fschedule-insns  -fschedule-insns2 @gol
7265 -fstrict-aliasing -fstrict-overflow @gol
7266 -ftree-builtin-call-dce @gol
7267 -ftree-switch-conversion -ftree-tail-merge @gol
7268 -ftree-pre @gol
7269 -ftree-vrp @gol
7270 -fipa-ra}
7272 Please note the warning under @option{-fgcse} about
7273 invoking @option{-O2} on programs that use computed gotos.
7275 @item -O3
7276 @opindex O3
7277 Optimize yet more.  @option{-O3} turns on all optimizations specified
7278 by @option{-O2} and also turns on the @option{-finline-functions},
7279 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7280 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7281 @option{-ftree-loop-distribute-patterns},
7282 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7283 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7285 @item -O0
7286 @opindex O0
7287 Reduce compilation time and make debugging produce the expected
7288 results.  This is the default.
7290 @item -Os
7291 @opindex Os
7292 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7293 do not typically increase code size.  It also performs further
7294 optimizations designed to reduce code size.
7296 @option{-Os} disables the following optimization flags:
7297 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7298 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7299 -fprefetch-loop-arrays}
7301 @item -Ofast
7302 @opindex Ofast
7303 Disregard strict standards compliance.  @option{-Ofast} enables all
7304 @option{-O3} optimizations.  It also enables optimizations that are not
7305 valid for all standard-compliant programs.
7306 It turns on @option{-ffast-math} and the Fortran-specific
7307 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7309 @item -Og
7310 @opindex Og
7311 Optimize debugging experience.  @option{-Og} enables optimizations
7312 that do not interfere with debugging. It should be the optimization
7313 level of choice for the standard edit-compile-debug cycle, offering
7314 a reasonable level of optimization while maintaining fast compilation
7315 and a good debugging experience.
7317 If you use multiple @option{-O} options, with or without level numbers,
7318 the last such option is the one that is effective.
7319 @end table
7321 Options of the form @option{-f@var{flag}} specify machine-independent
7322 flags.  Most flags have both positive and negative forms; the negative
7323 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7324 below, only one of the forms is listed---the one you typically 
7325 use.  You can figure out the other form by either removing @samp{no-}
7326 or adding it.
7328 The following options control specific optimizations.  They are either
7329 activated by @option{-O} options or are related to ones that are.  You
7330 can use the following flags in the rare cases when ``fine-tuning'' of
7331 optimizations to be performed is desired.
7333 @table @gcctabopt
7334 @item -fno-defer-pop
7335 @opindex fno-defer-pop
7336 Always pop the arguments to each function call as soon as that function
7337 returns.  For machines that must pop arguments after a function call,
7338 the compiler normally lets arguments accumulate on the stack for several
7339 function calls and pops them all at once.
7341 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7343 @item -fforward-propagate
7344 @opindex fforward-propagate
7345 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7346 instructions and checks if the result can be simplified.  If loop unrolling
7347 is active, two passes are performed and the second is scheduled after
7348 loop unrolling.
7350 This option is enabled by default at optimization levels @option{-O},
7351 @option{-O2}, @option{-O3}, @option{-Os}.
7353 @item -ffp-contract=@var{style}
7354 @opindex ffp-contract
7355 @option{-ffp-contract=off} disables floating-point expression contraction.
7356 @option{-ffp-contract=fast} enables floating-point expression contraction
7357 such as forming of fused multiply-add operations if the target has
7358 native support for them.
7359 @option{-ffp-contract=on} enables floating-point expression contraction
7360 if allowed by the language standard.  This is currently not implemented
7361 and treated equal to @option{-ffp-contract=off}.
7363 The default is @option{-ffp-contract=fast}.
7365 @item -fomit-frame-pointer
7366 @opindex fomit-frame-pointer
7367 Don't keep the frame pointer in a register for functions that
7368 don't need one.  This avoids the instructions to save, set up and
7369 restore frame pointers; it also makes an extra register available
7370 in many functions.  @strong{It also makes debugging impossible on
7371 some machines.}
7373 On some machines, such as the VAX, this flag has no effect, because
7374 the standard calling sequence automatically handles the frame pointer
7375 and nothing is saved by pretending it doesn't exist.  The
7376 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7377 whether a target machine supports this flag.  @xref{Registers,,Register
7378 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7380 Starting with GCC version 4.6, the default setting (when not optimizing for
7381 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7382 @option{-fomit-frame-pointer}.  The default can be reverted to
7383 @option{-fno-omit-frame-pointer} by configuring GCC with the
7384 @option{--enable-frame-pointer} configure option.
7386 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7388 @item -foptimize-sibling-calls
7389 @opindex foptimize-sibling-calls
7390 Optimize sibling and tail recursive calls.
7392 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7394 @item -foptimize-strlen
7395 @opindex foptimize-strlen
7396 Optimize various standard C string functions (e.g. @code{strlen},
7397 @code{strchr} or @code{strcpy}) and
7398 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7400 Enabled at levels @option{-O2}, @option{-O3}.
7402 @item -fno-inline
7403 @opindex fno-inline
7404 Do not expand any functions inline apart from those marked with
7405 the @code{always_inline} attribute.  This is the default when not
7406 optimizing.
7408 Single functions can be exempted from inlining by marking them
7409 with the @code{noinline} attribute.
7411 @item -finline-small-functions
7412 @opindex finline-small-functions
7413 Integrate functions into their callers when their body is smaller than expected
7414 function call code (so overall size of program gets smaller).  The compiler
7415 heuristically decides which functions are simple enough to be worth integrating
7416 in this way.  This inlining applies to all functions, even those not declared
7417 inline.
7419 Enabled at level @option{-O2}.
7421 @item -findirect-inlining
7422 @opindex findirect-inlining
7423 Inline also indirect calls that are discovered to be known at compile
7424 time thanks to previous inlining.  This option has any effect only
7425 when inlining itself is turned on by the @option{-finline-functions}
7426 or @option{-finline-small-functions} options.
7428 Enabled at level @option{-O2}.
7430 @item -finline-functions
7431 @opindex finline-functions
7432 Consider all functions for inlining, even if they are not declared inline.
7433 The compiler heuristically decides which functions are worth integrating
7434 in this way.
7436 If all calls to a given function are integrated, and the function is
7437 declared @code{static}, then the function is normally not output as
7438 assembler code in its own right.
7440 Enabled at level @option{-O3}.
7442 @item -finline-functions-called-once
7443 @opindex finline-functions-called-once
7444 Consider all @code{static} functions called once for inlining into their
7445 caller even if they are not marked @code{inline}.  If a call to a given
7446 function is integrated, then the function is not output as assembler code
7447 in its own right.
7449 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7451 @item -fearly-inlining
7452 @opindex fearly-inlining
7453 Inline functions marked by @code{always_inline} and functions whose body seems
7454 smaller than the function call overhead early before doing
7455 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7456 makes profiling significantly cheaper and usually inlining faster on programs
7457 having large chains of nested wrapper functions.
7459 Enabled by default.
7461 @item -fipa-sra
7462 @opindex fipa-sra
7463 Perform interprocedural scalar replacement of aggregates, removal of
7464 unused parameters and replacement of parameters passed by reference
7465 by parameters passed by value.
7467 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7469 @item -finline-limit=@var{n}
7470 @opindex finline-limit
7471 By default, GCC limits the size of functions that can be inlined.  This flag
7472 allows coarse control of this limit.  @var{n} is the size of functions that
7473 can be inlined in number of pseudo instructions.
7475 Inlining is actually controlled by a number of parameters, which may be
7476 specified individually by using @option{--param @var{name}=@var{value}}.
7477 The @option{-finline-limit=@var{n}} option sets some of these parameters
7478 as follows:
7480 @table @gcctabopt
7481 @item max-inline-insns-single
7482 is set to @var{n}/2.
7483 @item max-inline-insns-auto
7484 is set to @var{n}/2.
7485 @end table
7487 See below for a documentation of the individual
7488 parameters controlling inlining and for the defaults of these parameters.
7490 @emph{Note:} there may be no value to @option{-finline-limit} that results
7491 in default behavior.
7493 @emph{Note:} pseudo instruction represents, in this particular context, an
7494 abstract measurement of function's size.  In no way does it represent a count
7495 of assembly instructions and as such its exact meaning might change from one
7496 release to an another.
7498 @item -fno-keep-inline-dllexport
7499 @opindex fno-keep-inline-dllexport
7500 This is a more fine-grained version of @option{-fkeep-inline-functions},
7501 which applies only to functions that are declared using the @code{dllexport}
7502 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7503 Functions}.)
7505 @item -fkeep-inline-functions
7506 @opindex fkeep-inline-functions
7507 In C, emit @code{static} functions that are declared @code{inline}
7508 into the object file, even if the function has been inlined into all
7509 of its callers.  This switch does not affect functions using the
7510 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7511 inline functions into the object file.
7513 @item -fkeep-static-consts
7514 @opindex fkeep-static-consts
7515 Emit variables declared @code{static const} when optimization isn't turned
7516 on, even if the variables aren't referenced.
7518 GCC enables this option by default.  If you want to force the compiler to
7519 check if a variable is referenced, regardless of whether or not
7520 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7522 @item -fmerge-constants
7523 @opindex fmerge-constants
7524 Attempt to merge identical constants (string constants and floating-point
7525 constants) across compilation units.
7527 This option is the default for optimized compilation if the assembler and
7528 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7529 behavior.
7531 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7533 @item -fmerge-all-constants
7534 @opindex fmerge-all-constants
7535 Attempt to merge identical constants and identical variables.
7537 This option implies @option{-fmerge-constants}.  In addition to
7538 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7539 arrays or initialized constant variables with integral or floating-point
7540 types.  Languages like C or C++ require each variable, including multiple
7541 instances of the same variable in recursive calls, to have distinct locations,
7542 so using this option results in non-conforming
7543 behavior.
7545 @item -fmodulo-sched
7546 @opindex fmodulo-sched
7547 Perform swing modulo scheduling immediately before the first scheduling
7548 pass.  This pass looks at innermost loops and reorders their
7549 instructions by overlapping different iterations.
7551 @item -fmodulo-sched-allow-regmoves
7552 @opindex fmodulo-sched-allow-regmoves
7553 Perform more aggressive SMS-based modulo scheduling with register moves
7554 allowed.  By setting this flag certain anti-dependences edges are
7555 deleted, which triggers the generation of reg-moves based on the
7556 life-range analysis.  This option is effective only with
7557 @option{-fmodulo-sched} enabled.
7559 @item -fno-branch-count-reg
7560 @opindex fno-branch-count-reg
7561 Do not use ``decrement and branch'' instructions on a count register,
7562 but instead generate a sequence of instructions that decrement a
7563 register, compare it against zero, then branch based upon the result.
7564 This option is only meaningful on architectures that support such
7565 instructions, which include x86, PowerPC, IA-64 and S/390.
7567 Enabled by default at @option{-O1} and higher.
7569 The default is @option{-fbranch-count-reg}.
7571 @item -fno-function-cse
7572 @opindex fno-function-cse
7573 Do not put function addresses in registers; make each instruction that
7574 calls a constant function contain the function's address explicitly.
7576 This option results in less efficient code, but some strange hacks
7577 that alter the assembler output may be confused by the optimizations
7578 performed when this option is not used.
7580 The default is @option{-ffunction-cse}
7582 @item -fno-zero-initialized-in-bss
7583 @opindex fno-zero-initialized-in-bss
7584 If the target supports a BSS section, GCC by default puts variables that
7585 are initialized to zero into BSS@.  This can save space in the resulting
7586 code.
7588 This option turns off this behavior because some programs explicitly
7589 rely on variables going to the data section---e.g., so that the
7590 resulting executable can find the beginning of that section and/or make
7591 assumptions based on that.
7593 The default is @option{-fzero-initialized-in-bss}.
7595 @item -fthread-jumps
7596 @opindex fthread-jumps
7597 Perform optimizations that check to see if a jump branches to a
7598 location where another comparison subsumed by the first is found.  If
7599 so, the first branch is redirected to either the destination of the
7600 second branch or a point immediately following it, depending on whether
7601 the condition is known to be true or false.
7603 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7605 @item -fsplit-wide-types
7606 @opindex fsplit-wide-types
7607 When using a type that occupies multiple registers, such as @code{long
7608 long} on a 32-bit system, split the registers apart and allocate them
7609 independently.  This normally generates better code for those types,
7610 but may make debugging more difficult.
7612 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7613 @option{-Os}.
7615 @item -fcse-follow-jumps
7616 @opindex fcse-follow-jumps
7617 In common subexpression elimination (CSE), scan through jump instructions
7618 when the target of the jump is not reached by any other path.  For
7619 example, when CSE encounters an @code{if} statement with an
7620 @code{else} clause, CSE follows the jump when the condition
7621 tested is false.
7623 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7625 @item -fcse-skip-blocks
7626 @opindex fcse-skip-blocks
7627 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7628 follow jumps that conditionally skip over blocks.  When CSE
7629 encounters a simple @code{if} statement with no else clause,
7630 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7631 body of the @code{if}.
7633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7635 @item -frerun-cse-after-loop
7636 @opindex frerun-cse-after-loop
7637 Re-run common subexpression elimination after loop optimizations are
7638 performed.
7640 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7642 @item -fgcse
7643 @opindex fgcse
7644 Perform a global common subexpression elimination pass.
7645 This pass also performs global constant and copy propagation.
7647 @emph{Note:} When compiling a program using computed gotos, a GCC
7648 extension, you may get better run-time performance if you disable
7649 the global common subexpression elimination pass by adding
7650 @option{-fno-gcse} to the command line.
7652 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7654 @item -fgcse-lm
7655 @opindex fgcse-lm
7656 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7657 attempts to move loads that are only killed by stores into themselves.  This
7658 allows a loop containing a load/store sequence to be changed to a load outside
7659 the loop, and a copy/store within the loop.
7661 Enabled by default when @option{-fgcse} is enabled.
7663 @item -fgcse-sm
7664 @opindex fgcse-sm
7665 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7666 global common subexpression elimination.  This pass attempts to move
7667 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7668 loops containing a load/store sequence can be changed to a load before
7669 the loop and a store after the loop.
7671 Not enabled at any optimization level.
7673 @item -fgcse-las
7674 @opindex fgcse-las
7675 When @option{-fgcse-las} is enabled, the global common subexpression
7676 elimination pass eliminates redundant loads that come after stores to the
7677 same memory location (both partial and full redundancies).
7679 Not enabled at any optimization level.
7681 @item -fgcse-after-reload
7682 @opindex fgcse-after-reload
7683 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7684 pass is performed after reload.  The purpose of this pass is to clean up
7685 redundant spilling.
7687 @item -faggressive-loop-optimizations
7688 @opindex faggressive-loop-optimizations
7689 This option tells the loop optimizer to use language constraints to
7690 derive bounds for the number of iterations of a loop.  This assumes that
7691 loop code does not invoke undefined behavior by for example causing signed
7692 integer overflows or out-of-bound array accesses.  The bounds for the
7693 number of iterations of a loop are used to guide loop unrolling and peeling
7694 and loop exit test optimizations.
7695 This option is enabled by default.
7697 @item -funsafe-loop-optimizations
7698 @opindex funsafe-loop-optimizations
7699 This option tells the loop optimizer to assume that loop indices do not
7700 overflow, and that loops with nontrivial exit condition are not
7701 infinite.  This enables a wider range of loop optimizations even if
7702 the loop optimizer itself cannot prove that these assumptions are valid.
7703 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7704 if it finds this kind of loop.
7706 @item -fcrossjumping
7707 @opindex fcrossjumping
7708 Perform cross-jumping transformation.
7709 This transformation unifies equivalent code and saves code size.  The
7710 resulting code may or may not perform better than without cross-jumping.
7712 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7714 @item -fauto-inc-dec
7715 @opindex fauto-inc-dec
7716 Combine increments or decrements of addresses with memory accesses.
7717 This pass is always skipped on architectures that do not have
7718 instructions to support this.  Enabled by default at @option{-O} and
7719 higher on architectures that support this.
7721 @item -fdce
7722 @opindex fdce
7723 Perform dead code elimination (DCE) on RTL@.
7724 Enabled by default at @option{-O} and higher.
7726 @item -fdse
7727 @opindex fdse
7728 Perform dead store elimination (DSE) on RTL@.
7729 Enabled by default at @option{-O} and higher.
7731 @item -fif-conversion
7732 @opindex fif-conversion
7733 Attempt to transform conditional jumps into branch-less equivalents.  This
7734 includes use of conditional moves, min, max, set flags and abs instructions, and
7735 some tricks doable by standard arithmetics.  The use of conditional execution
7736 on chips where it is available is controlled by @code{if-conversion2}.
7738 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7740 @item -fif-conversion2
7741 @opindex fif-conversion2
7742 Use conditional execution (where available) to transform conditional jumps into
7743 branch-less equivalents.
7745 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7747 @item -fdeclone-ctor-dtor
7748 @opindex fdeclone-ctor-dtor
7749 The C++ ABI requires multiple entry points for constructors and
7750 destructors: one for a base subobject, one for a complete object, and
7751 one for a virtual destructor that calls operator delete afterwards.
7752 For a hierarchy with virtual bases, the base and complete variants are
7753 clones, which means two copies of the function.  With this option, the
7754 base and complete variants are changed to be thunks that call a common
7755 implementation.
7757 Enabled by @option{-Os}.
7759 @item -fdelete-null-pointer-checks
7760 @opindex fdelete-null-pointer-checks
7761 Assume that programs cannot safely dereference null pointers, and that
7762 no code or data element resides there.  This enables simple constant
7763 folding optimizations at all optimization levels.  In addition, other
7764 optimization passes in GCC use this flag to control global dataflow
7765 analyses that eliminate useless checks for null pointers; these assume
7766 that if a pointer is checked after it has already been dereferenced,
7767 it cannot be null.
7769 Note however that in some environments this assumption is not true.
7770 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7771 for programs that depend on that behavior.
7773 Some targets, especially embedded ones, disable this option at all levels.
7774 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7775 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7776 are enabled independently at different optimization levels.
7778 @item -fdevirtualize
7779 @opindex fdevirtualize
7780 Attempt to convert calls to virtual functions to direct calls.  This
7781 is done both within a procedure and interprocedurally as part of
7782 indirect inlining (@option{-findirect-inlining}) and interprocedural constant
7783 propagation (@option{-fipa-cp}).
7784 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7786 @item -fdevirtualize-speculatively
7787 @opindex fdevirtualize-speculatively
7788 Attempt to convert calls to virtual functions to speculative direct calls.
7789 Based on the analysis of the type inheritance graph, determine for a given call
7790 the set of likely targets. If the set is small, preferably of size 1, change
7791 the call into a conditional deciding between direct and indirect calls.  The
7792 speculative calls enable more optimizations, such as inlining.  When they seem
7793 useless after further optimization, they are converted back into original form.
7795 @item -fdevirtualize-at-ltrans
7796 @opindex fdevirtualize-at-ltrans
7797 Stream extra information needed for aggressive devirtualization when running
7798 the link-time optimizer in local transformation mode.  
7799 This option enables more devirtualization but
7800 significantly increases the size of streamed data. For this reason it is
7801 disabled by default.
7803 @item -fexpensive-optimizations
7804 @opindex fexpensive-optimizations
7805 Perform a number of minor optimizations that are relatively expensive.
7807 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7809 @item -free
7810 @opindex free
7811 Attempt to remove redundant extension instructions.  This is especially
7812 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7813 registers after writing to their lower 32-bit half.
7815 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7816 @option{-O3}, @option{-Os}.
7818 @item -flive-range-shrinkage
7819 @opindex flive-range-shrinkage
7820 Attempt to decrease register pressure through register live range
7821 shrinkage.  This is helpful for fast processors with small or moderate
7822 size register sets.
7824 @item -fira-algorithm=@var{algorithm}
7825 @opindex fira-algorithm
7826 Use the specified coloring algorithm for the integrated register
7827 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7828 specifies Chow's priority coloring, or @samp{CB}, which specifies
7829 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7830 for all architectures, but for those targets that do support it, it is
7831 the default because it generates better code.
7833 @item -fira-region=@var{region}
7834 @opindex fira-region
7835 Use specified regions for the integrated register allocator.  The
7836 @var{region} argument should be one of the following:
7838 @table @samp
7840 @item all
7841 Use all loops as register allocation regions.
7842 This can give the best results for machines with a small and/or
7843 irregular register set.
7845 @item mixed
7846 Use all loops except for loops with small register pressure 
7847 as the regions.  This value usually gives
7848 the best results in most cases and for most architectures,
7849 and is enabled by default when compiling with optimization for speed
7850 (@option{-O}, @option{-O2}, @dots{}).
7852 @item one
7853 Use all functions as a single region.  
7854 This typically results in the smallest code size, and is enabled by default for
7855 @option{-Os} or @option{-O0}.
7857 @end table
7859 @item -fira-hoist-pressure
7860 @opindex fira-hoist-pressure
7861 Use IRA to evaluate register pressure in the code hoisting pass for
7862 decisions to hoist expressions.  This option usually results in smaller
7863 code, but it can slow the compiler down.
7865 This option is enabled at level @option{-Os} for all targets.
7867 @item -fira-loop-pressure
7868 @opindex fira-loop-pressure
7869 Use IRA to evaluate register pressure in loops for decisions to move
7870 loop invariants.  This option usually results in generation
7871 of faster and smaller code on machines with large register files (>= 32
7872 registers), but it can slow the compiler down.
7874 This option is enabled at level @option{-O3} for some targets.
7876 @item -fno-ira-share-save-slots
7877 @opindex fno-ira-share-save-slots
7878 Disable sharing of stack slots used for saving call-used hard
7879 registers living through a call.  Each hard register gets a
7880 separate stack slot, and as a result function stack frames are
7881 larger.
7883 @item -fno-ira-share-spill-slots
7884 @opindex fno-ira-share-spill-slots
7885 Disable sharing of stack slots allocated for pseudo-registers.  Each
7886 pseudo-register that does not get a hard register gets a separate
7887 stack slot, and as a result function stack frames are larger.
7889 @item -fira-verbose=@var{n}
7890 @opindex fira-verbose
7891 Control the verbosity of the dump file for the integrated register allocator.
7892 The default value is 5.  If the value @var{n} is greater or equal to 10,
7893 the dump output is sent to stderr using the same format as @var{n} minus 10.
7895 @item -flra-remat
7896 @opindex flra-remat
7897 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7898 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7899 values if it is profitable.
7901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7903 @item -fdelayed-branch
7904 @opindex fdelayed-branch
7905 If supported for the target machine, attempt to reorder instructions
7906 to exploit instruction slots available after delayed branch
7907 instructions.
7909 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7911 @item -fschedule-insns
7912 @opindex fschedule-insns
7913 If supported for the target machine, attempt to reorder instructions to
7914 eliminate execution stalls due to required data being unavailable.  This
7915 helps machines that have slow floating point or memory load instructions
7916 by allowing other instructions to be issued until the result of the load
7917 or floating-point instruction is required.
7919 Enabled at levels @option{-O2}, @option{-O3}.
7921 @item -fschedule-insns2
7922 @opindex fschedule-insns2
7923 Similar to @option{-fschedule-insns}, but requests an additional pass of
7924 instruction scheduling after register allocation has been done.  This is
7925 especially useful on machines with a relatively small number of
7926 registers and where memory load instructions take more than one cycle.
7928 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7930 @item -fno-sched-interblock
7931 @opindex fno-sched-interblock
7932 Don't schedule instructions across basic blocks.  This is normally
7933 enabled by default when scheduling before register allocation, i.e.@:
7934 with @option{-fschedule-insns} or at @option{-O2} or higher.
7936 @item -fno-sched-spec
7937 @opindex fno-sched-spec
7938 Don't allow speculative motion of non-load instructions.  This is normally
7939 enabled by default when scheduling before register allocation, i.e.@:
7940 with @option{-fschedule-insns} or at @option{-O2} or higher.
7942 @item -fsched-pressure
7943 @opindex fsched-pressure
7944 Enable register pressure sensitive insn scheduling before register
7945 allocation.  This only makes sense when scheduling before register
7946 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7947 @option{-O2} or higher.  Usage of this option can improve the
7948 generated code and decrease its size by preventing register pressure
7949 increase above the number of available hard registers and subsequent
7950 spills in register allocation.
7952 @item -fsched-spec-load
7953 @opindex fsched-spec-load
7954 Allow speculative motion of some load instructions.  This only makes
7955 sense when scheduling before register allocation, i.e.@: with
7956 @option{-fschedule-insns} or at @option{-O2} or higher.
7958 @item -fsched-spec-load-dangerous
7959 @opindex fsched-spec-load-dangerous
7960 Allow speculative motion of more load instructions.  This only makes
7961 sense when scheduling before register allocation, i.e.@: with
7962 @option{-fschedule-insns} or at @option{-O2} or higher.
7964 @item -fsched-stalled-insns
7965 @itemx -fsched-stalled-insns=@var{n}
7966 @opindex fsched-stalled-insns
7967 Define how many insns (if any) can be moved prematurely from the queue
7968 of stalled insns into the ready list during the second scheduling pass.
7969 @option{-fno-sched-stalled-insns} means that no insns are moved
7970 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7971 on how many queued insns can be moved prematurely.
7972 @option{-fsched-stalled-insns} without a value is equivalent to
7973 @option{-fsched-stalled-insns=1}.
7975 @item -fsched-stalled-insns-dep
7976 @itemx -fsched-stalled-insns-dep=@var{n}
7977 @opindex fsched-stalled-insns-dep
7978 Define how many insn groups (cycles) are examined for a dependency
7979 on a stalled insn that is a candidate for premature removal from the queue
7980 of stalled insns.  This has an effect only during the second scheduling pass,
7981 and only if @option{-fsched-stalled-insns} is used.
7982 @option{-fno-sched-stalled-insns-dep} is equivalent to
7983 @option{-fsched-stalled-insns-dep=0}.
7984 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7985 @option{-fsched-stalled-insns-dep=1}.
7987 @item -fsched2-use-superblocks
7988 @opindex fsched2-use-superblocks
7989 When scheduling after register allocation, use superblock scheduling.
7990 This allows motion across basic block boundaries,
7991 resulting in faster schedules.  This option is experimental, as not all machine
7992 descriptions used by GCC model the CPU closely enough to avoid unreliable
7993 results from the algorithm.
7995 This only makes sense when scheduling after register allocation, i.e.@: with
7996 @option{-fschedule-insns2} or at @option{-O2} or higher.
7998 @item -fsched-group-heuristic
7999 @opindex fsched-group-heuristic
8000 Enable the group heuristic in the scheduler.  This heuristic favors
8001 the instruction that belongs to a schedule group.  This is enabled
8002 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8003 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8005 @item -fsched-critical-path-heuristic
8006 @opindex fsched-critical-path-heuristic
8007 Enable the critical-path heuristic in the scheduler.  This heuristic favors
8008 instructions on the critical path.  This is enabled by default when
8009 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8010 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8012 @item -fsched-spec-insn-heuristic
8013 @opindex fsched-spec-insn-heuristic
8014 Enable the speculative instruction heuristic in the scheduler.  This
8015 heuristic favors speculative instructions with greater dependency weakness.
8016 This is enabled by default when scheduling is enabled, i.e.@:
8017 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8018 or at @option{-O2} or higher.
8020 @item -fsched-rank-heuristic
8021 @opindex fsched-rank-heuristic
8022 Enable the rank heuristic in the scheduler.  This heuristic favors
8023 the instruction belonging to a basic block with greater size or frequency.
8024 This is enabled by default when scheduling is enabled, i.e.@:
8025 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8026 at @option{-O2} or higher.
8028 @item -fsched-last-insn-heuristic
8029 @opindex fsched-last-insn-heuristic
8030 Enable the last-instruction heuristic in the scheduler.  This heuristic
8031 favors the instruction that is less dependent on the last instruction
8032 scheduled.  This is enabled by default when scheduling is enabled,
8033 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8034 at @option{-O2} or higher.
8036 @item -fsched-dep-count-heuristic
8037 @opindex fsched-dep-count-heuristic
8038 Enable the dependent-count heuristic in the scheduler.  This heuristic
8039 favors the instruction that has more instructions depending on it.
8040 This is enabled by default when scheduling is enabled, i.e.@:
8041 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8042 at @option{-O2} or higher.
8044 @item -freschedule-modulo-scheduled-loops
8045 @opindex freschedule-modulo-scheduled-loops
8046 Modulo scheduling is performed before traditional scheduling.  If a loop
8047 is modulo scheduled, later scheduling passes may change its schedule.  
8048 Use this option to control that behavior.
8050 @item -fselective-scheduling
8051 @opindex fselective-scheduling
8052 Schedule instructions using selective scheduling algorithm.  Selective
8053 scheduling runs instead of the first scheduler pass.
8055 @item -fselective-scheduling2
8056 @opindex fselective-scheduling2
8057 Schedule instructions using selective scheduling algorithm.  Selective
8058 scheduling runs instead of the second scheduler pass.
8060 @item -fsel-sched-pipelining
8061 @opindex fsel-sched-pipelining
8062 Enable software pipelining of innermost loops during selective scheduling.
8063 This option has no effect unless one of @option{-fselective-scheduling} or
8064 @option{-fselective-scheduling2} is turned on.
8066 @item -fsel-sched-pipelining-outer-loops
8067 @opindex fsel-sched-pipelining-outer-loops
8068 When pipelining loops during selective scheduling, also pipeline outer loops.
8069 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8071 @item -fsemantic-interposition
8072 @opindex fsemantic-interposition
8073 Some object formats, like ELF, allow interposing of symbols by the 
8074 dynamic linker.
8075 This means that for symbols exported from the DSO, the compiler cannot perform
8076 interprocedural propagation, inlining and other optimizations in anticipation
8077 that the function or variable in question may change. While this feature is
8078 useful, for example, to rewrite memory allocation functions by a debugging
8079 implementation, it is expensive in the terms of code quality.
8080 With @option{-fno-semantic-interposition} the compiler assumes that 
8081 if interposition happens for functions the overwriting function will have 
8082 precisely the same semantics (and side effects). 
8083 Similarly if interposition happens
8084 for variables, the constructor of the variable will be the same. The flag
8085 has no effect for functions explicitly declared inline 
8086 (where it is never allowed for interposition to change semantics) 
8087 and for symbols explicitly declared weak.
8089 @item -fshrink-wrap
8090 @opindex fshrink-wrap
8091 Emit function prologues only before parts of the function that need it,
8092 rather than at the top of the function.  This flag is enabled by default at
8093 @option{-O} and higher.
8095 @item -fcaller-saves
8096 @opindex fcaller-saves
8097 Enable allocation of values to registers that are clobbered by
8098 function calls, by emitting extra instructions to save and restore the
8099 registers around such calls.  Such allocation is done only when it
8100 seems to result in better code.
8102 This option is always enabled by default on certain machines, usually
8103 those which have no call-preserved registers to use instead.
8105 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8107 @item -fcombine-stack-adjustments
8108 @opindex fcombine-stack-adjustments
8109 Tracks stack adjustments (pushes and pops) and stack memory references
8110 and then tries to find ways to combine them.
8112 Enabled by default at @option{-O1} and higher.
8114 @item -fipa-ra
8115 @opindex fipa-ra
8116 Use caller save registers for allocation if those registers are not used by
8117 any called function.  In that case it is not necessary to save and restore
8118 them around calls.  This is only possible if called functions are part of
8119 same compilation unit as current function and they are compiled before it.
8121 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8123 @item -fconserve-stack
8124 @opindex fconserve-stack
8125 Attempt to minimize stack usage.  The compiler attempts to use less
8126 stack space, even if that makes the program slower.  This option
8127 implies setting the @option{large-stack-frame} parameter to 100
8128 and the @option{large-stack-frame-growth} parameter to 400.
8130 @item -ftree-reassoc
8131 @opindex ftree-reassoc
8132 Perform reassociation on trees.  This flag is enabled by default
8133 at @option{-O} and higher.
8135 @item -ftree-pre
8136 @opindex ftree-pre
8137 Perform partial redundancy elimination (PRE) on trees.  This flag is
8138 enabled by default at @option{-O2} and @option{-O3}.
8140 @item -ftree-partial-pre
8141 @opindex ftree-partial-pre
8142 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8143 enabled by default at @option{-O3}.
8145 @item -ftree-forwprop
8146 @opindex ftree-forwprop
8147 Perform forward propagation on trees.  This flag is enabled by default
8148 at @option{-O} and higher.
8150 @item -ftree-fre
8151 @opindex ftree-fre
8152 Perform full redundancy elimination (FRE) on trees.  The difference
8153 between FRE and PRE is that FRE only considers expressions
8154 that are computed on all paths leading to the redundant computation.
8155 This analysis is faster than PRE, though it exposes fewer redundancies.
8156 This flag is enabled by default at @option{-O} and higher.
8158 @item -ftree-phiprop
8159 @opindex ftree-phiprop
8160 Perform hoisting of loads from conditional pointers on trees.  This
8161 pass is enabled by default at @option{-O} and higher.
8163 @item -fhoist-adjacent-loads
8164 @opindex fhoist-adjacent-loads
8165 Speculatively hoist loads from both branches of an if-then-else if the
8166 loads are from adjacent locations in the same structure and the target
8167 architecture has a conditional move instruction.  This flag is enabled
8168 by default at @option{-O2} and higher.
8170 @item -ftree-copy-prop
8171 @opindex ftree-copy-prop
8172 Perform copy propagation on trees.  This pass eliminates unnecessary
8173 copy operations.  This flag is enabled by default at @option{-O} and
8174 higher.
8176 @item -fipa-pure-const
8177 @opindex fipa-pure-const
8178 Discover which functions are pure or constant.
8179 Enabled by default at @option{-O} and higher.
8181 @item -fipa-reference
8182 @opindex fipa-reference
8183 Discover which static variables do not escape the
8184 compilation unit.
8185 Enabled by default at @option{-O} and higher.
8187 @item -fipa-pta
8188 @opindex fipa-pta
8189 Perform interprocedural pointer analysis and interprocedural modification
8190 and reference analysis.  This option can cause excessive memory and
8191 compile-time usage on large compilation units.  It is not enabled by
8192 default at any optimization level.
8194 @item -fipa-profile
8195 @opindex fipa-profile
8196 Perform interprocedural profile propagation.  The functions called only from
8197 cold functions are marked as cold. Also functions executed once (such as
8198 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8199 functions and loop less parts of functions executed once are then optimized for
8200 size.
8201 Enabled by default at @option{-O} and higher.
8203 @item -fipa-cp
8204 @opindex fipa-cp
8205 Perform interprocedural constant propagation.
8206 This optimization analyzes the program to determine when values passed
8207 to functions are constants and then optimizes accordingly.
8208 This optimization can substantially increase performance
8209 if the application has constants passed to functions.
8210 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8212 @item -fipa-cp-clone
8213 @opindex fipa-cp-clone
8214 Perform function cloning to make interprocedural constant propagation stronger.
8215 When enabled, interprocedural constant propagation performs function cloning
8216 when externally visible function can be called with constant arguments.
8217 Because this optimization can create multiple copies of functions,
8218 it may significantly increase code size
8219 (see @option{--param ipcp-unit-growth=@var{value}}).
8220 This flag is enabled by default at @option{-O3}.
8222 @item -fipa-icf
8223 @opindex fipa-icf
8224 Perform Identical Code Folding for functions and read-only variables.
8225 The optimization reduces code size and may disturb unwind stacks by replacing
8226 a function by equivalent one with a different name. The optimization works
8227 more effectively with link time optimization enabled.
8229 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8230 works on different levels and thus the optimizations are not same - there are
8231 equivalences that are found only by GCC and equivalences found only by Gold.
8233 This flag is enabled by default at @option{-O2} and @option{-Os}.
8235 @item -fisolate-erroneous-paths-dereference
8236 @opindex fisolate-erroneous-paths-dereference
8237 Detect paths which trigger erroneous or undefined behaviour due to
8238 dereferencing a NULL pointer.  Isolate those paths from the main control
8239 flow and turn the statement with erroneous or undefined behaviour into a trap.
8241 @item -fisolate-erroneous-paths-attribute
8242 @opindex fisolate-erroneous-paths-attribute
8243 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8244 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8245 attribute.  Isolate those paths from the main control flow and turn the
8246 statement with erroneous or undefined behaviour into a trap.  This is not
8247 currently enabled, but may be enabled by @code{-O2} in the future.
8249 @item -ftree-sink
8250 @opindex ftree-sink
8251 Perform forward store motion  on trees.  This flag is
8252 enabled by default at @option{-O} and higher.
8254 @item -ftree-bit-ccp
8255 @opindex ftree-bit-ccp
8256 Perform sparse conditional bit constant propagation on trees and propagate
8257 pointer alignment information.
8258 This pass only operates on local scalar variables and is enabled by default
8259 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8261 @item -ftree-ccp
8262 @opindex ftree-ccp
8263 Perform sparse conditional constant propagation (CCP) on trees.  This
8264 pass only operates on local scalar variables and is enabled by default
8265 at @option{-O} and higher.
8267 @item -fssa-phiopt
8268 @opindex fssa-phiopt
8269 Perform pattern matching on SSA PHI nodes to optimize conditional
8270 code.  This pass is enabled by default at @option{-O} and higher.
8272 @item -ftree-switch-conversion
8273 @opindex ftree-switch-conversion
8274 Perform conversion of simple initializations in a switch to
8275 initializations from a scalar array.  This flag is enabled by default
8276 at @option{-O2} and higher.
8278 @item -ftree-tail-merge
8279 @opindex ftree-tail-merge
8280 Look for identical code sequences.  When found, replace one with a jump to the
8281 other.  This optimization is known as tail merging or cross jumping.  This flag
8282 is enabled by default at @option{-O2} and higher.  The compilation time
8283 in this pass can
8284 be limited using @option{max-tail-merge-comparisons} parameter and
8285 @option{max-tail-merge-iterations} parameter.
8287 @item -ftree-dce
8288 @opindex ftree-dce
8289 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8290 default at @option{-O} and higher.
8292 @item -ftree-builtin-call-dce
8293 @opindex ftree-builtin-call-dce
8294 Perform conditional dead code elimination (DCE) for calls to built-in functions
8295 that may set @code{errno} but are otherwise side-effect free.  This flag is
8296 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8297 specified.
8299 @item -ftree-dominator-opts
8300 @opindex ftree-dominator-opts
8301 Perform a variety of simple scalar cleanups (constant/copy
8302 propagation, redundancy elimination, range propagation and expression
8303 simplification) based on a dominator tree traversal.  This also
8304 performs jump threading (to reduce jumps to jumps). This flag is
8305 enabled by default at @option{-O} and higher.
8307 @item -ftree-dse
8308 @opindex ftree-dse
8309 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8310 a memory location that is later overwritten by another store without
8311 any intervening loads.  In this case the earlier store can be deleted.  This
8312 flag is enabled by default at @option{-O} and higher.
8314 @item -ftree-ch
8315 @opindex ftree-ch
8316 Perform loop header copying on trees.  This is beneficial since it increases
8317 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8318 is enabled by default at @option{-O} and higher.  It is not enabled
8319 for @option{-Os}, since it usually increases code size.
8321 @item -ftree-loop-optimize
8322 @opindex ftree-loop-optimize
8323 Perform loop optimizations on trees.  This flag is enabled by default
8324 at @option{-O} and higher.
8326 @item -ftree-loop-linear
8327 @opindex ftree-loop-linear
8328 Perform loop interchange transformations on tree.  Same as
8329 @option{-floop-interchange}.  To use this code transformation, GCC has
8330 to be configured with @option{--with-isl} to enable the Graphite loop
8331 transformation infrastructure.
8333 @item -floop-interchange
8334 @opindex floop-interchange
8335 Perform loop interchange transformations on loops.  Interchanging two
8336 nested loops switches the inner and outer loops.  For example, given a
8337 loop like:
8338 @smallexample
8339 DO J = 1, M
8340   DO I = 1, N
8341     A(J, I) = A(J, I) * C
8342   ENDDO
8343 ENDDO
8344 @end smallexample
8345 loop interchange transforms the loop as if it were written:
8346 @smallexample
8347 DO I = 1, N
8348   DO J = 1, M
8349     A(J, I) = A(J, I) * C
8350   ENDDO
8351 ENDDO
8352 @end smallexample
8353 which can be beneficial when @code{N} is larger than the caches,
8354 because in Fortran, the elements of an array are stored in memory
8355 contiguously by column, and the original loop iterates over rows,
8356 potentially creating at each access a cache miss.  This optimization
8357 applies to all the languages supported by GCC and is not limited to
8358 Fortran.  To use this code transformation, GCC has to be configured
8359 with @option{--with-isl} to enable the Graphite loop transformation
8360 infrastructure.
8362 @item -floop-strip-mine
8363 @opindex floop-strip-mine
8364 Perform loop strip mining transformations on loops.  Strip mining
8365 splits a loop into two nested loops.  The outer loop has strides
8366 equal to the strip size and the inner loop has strides of the
8367 original loop within a strip.  The strip length can be changed
8368 using the @option{loop-block-tile-size} parameter.  For example,
8369 given a loop like:
8370 @smallexample
8371 DO I = 1, N
8372   A(I) = A(I) + C
8373 ENDDO
8374 @end smallexample
8375 loop strip mining transforms the loop as if it were written:
8376 @smallexample
8377 DO II = 1, N, 51
8378   DO I = II, min (II + 50, N)
8379     A(I) = A(I) + C
8380   ENDDO
8381 ENDDO
8382 @end smallexample
8383 This optimization applies to all the languages supported by GCC and is
8384 not limited to Fortran.  To use this code transformation, GCC has to
8385 be configured with @option{--with-isl} to enable the Graphite loop
8386 transformation infrastructure.
8388 @item -floop-block
8389 @opindex floop-block
8390 Perform loop blocking transformations on loops.  Blocking strip mines
8391 each loop in the loop nest such that the memory accesses of the
8392 element loops fit inside caches.  The strip length can be changed
8393 using the @option{loop-block-tile-size} parameter.  For example, given
8394 a loop like:
8395 @smallexample
8396 DO I = 1, N
8397   DO J = 1, M
8398     A(J, I) = B(I) + C(J)
8399   ENDDO
8400 ENDDO
8401 @end smallexample
8402 loop blocking transforms the loop as if it were written:
8403 @smallexample
8404 DO II = 1, N, 51
8405   DO JJ = 1, M, 51
8406     DO I = II, min (II + 50, N)
8407       DO J = JJ, min (JJ + 50, M)
8408         A(J, I) = B(I) + C(J)
8409       ENDDO
8410     ENDDO
8411   ENDDO
8412 ENDDO
8413 @end smallexample
8414 which can be beneficial when @code{M} is larger than the caches,
8415 because the innermost loop iterates over a smaller amount of data
8416 which can be kept in the caches.  This optimization applies to all the
8417 languages supported by GCC and is not limited to Fortran.  To use this
8418 code transformation, GCC has to be configured with @option{--with-isl}
8419 to enable the Graphite loop transformation infrastructure.
8421 @item -fgraphite-identity
8422 @opindex fgraphite-identity
8423 Enable the identity transformation for graphite.  For every SCoP we generate
8424 the polyhedral representation and transform it back to gimple.  Using
8425 @option{-fgraphite-identity} we can check the costs or benefits of the
8426 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8427 are also performed by the code generator ISL, like index splitting and
8428 dead code elimination in loops.
8430 @item -floop-nest-optimize
8431 @opindex floop-nest-optimize
8432 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8433 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8434 structure optimized for data-locality and parallelism.  This option
8435 is experimental.
8437 @item -floop-unroll-and-jam
8438 @opindex floop-unroll-and-jam
8439 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8440 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8441 The unrolled dimension (counting from the most inner one) can be changed 
8442 using the @option{loop-unroll-jam-depth} parameter.                 .
8444 @item -floop-parallelize-all
8445 @opindex floop-parallelize-all
8446 Use the Graphite data dependence analysis to identify loops that can
8447 be parallelized.  Parallelize all the loops that can be analyzed to
8448 not contain loop carried dependences without checking that it is
8449 profitable to parallelize the loops.
8451 @item -fcheck-data-deps
8452 @opindex fcheck-data-deps
8453 Compare the results of several data dependence analyzers.  This option
8454 is used for debugging the data dependence analyzers.
8456 @item -ftree-loop-if-convert
8457 @opindex ftree-loop-if-convert
8458 Attempt to transform conditional jumps in the innermost loops to
8459 branch-less equivalents.  The intent is to remove control-flow from
8460 the innermost loops in order to improve the ability of the
8461 vectorization pass to handle these loops.  This is enabled by default
8462 if vectorization is enabled.
8464 @item -ftree-loop-if-convert-stores
8465 @opindex ftree-loop-if-convert-stores
8466 Attempt to also if-convert conditional jumps containing memory writes.
8467 This transformation can be unsafe for multi-threaded programs as it
8468 transforms conditional memory writes into unconditional memory writes.
8469 For example,
8470 @smallexample
8471 for (i = 0; i < N; i++)
8472   if (cond)
8473     A[i] = expr;
8474 @end smallexample
8475 is transformed to
8476 @smallexample
8477 for (i = 0; i < N; i++)
8478   A[i] = cond ? expr : A[i];
8479 @end smallexample
8480 potentially producing data races.
8482 @item -ftree-loop-distribution
8483 @opindex ftree-loop-distribution
8484 Perform loop distribution.  This flag can improve cache performance on
8485 big loop bodies and allow further loop optimizations, like
8486 parallelization or vectorization, to take place.  For example, the loop
8487 @smallexample
8488 DO I = 1, N
8489   A(I) = B(I) + C
8490   D(I) = E(I) * F
8491 ENDDO
8492 @end smallexample
8493 is transformed to
8494 @smallexample
8495 DO I = 1, N
8496    A(I) = B(I) + C
8497 ENDDO
8498 DO I = 1, N
8499    D(I) = E(I) * F
8500 ENDDO
8501 @end smallexample
8503 @item -ftree-loop-distribute-patterns
8504 @opindex ftree-loop-distribute-patterns
8505 Perform loop distribution of patterns that can be code generated with
8506 calls to a library.  This flag is enabled by default at @option{-O3}.
8508 This pass distributes the initialization loops and generates a call to
8509 memset zero.  For example, the loop
8510 @smallexample
8511 DO I = 1, N
8512   A(I) = 0
8513   B(I) = A(I) + I
8514 ENDDO
8515 @end smallexample
8516 is transformed to
8517 @smallexample
8518 DO I = 1, N
8519    A(I) = 0
8520 ENDDO
8521 DO I = 1, N
8522    B(I) = A(I) + I
8523 ENDDO
8524 @end smallexample
8525 and the initialization loop is transformed into a call to memset zero.
8527 @item -ftree-loop-im
8528 @opindex ftree-loop-im
8529 Perform loop invariant motion on trees.  This pass moves only invariants that
8530 are hard to handle at RTL level (function calls, operations that expand to
8531 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8532 operands of conditions that are invariant out of the loop, so that we can use
8533 just trivial invariantness analysis in loop unswitching.  The pass also includes
8534 store motion.
8536 @item -ftree-loop-ivcanon
8537 @opindex ftree-loop-ivcanon
8538 Create a canonical counter for number of iterations in loops for which
8539 determining number of iterations requires complicated analysis.  Later
8540 optimizations then may determine the number easily.  Useful especially
8541 in connection with unrolling.
8543 @item -fivopts
8544 @opindex fivopts
8545 Perform induction variable optimizations (strength reduction, induction
8546 variable merging and induction variable elimination) on trees.
8548 @item -ftree-parallelize-loops=n
8549 @opindex ftree-parallelize-loops
8550 Parallelize loops, i.e., split their iteration space to run in n threads.
8551 This is only possible for loops whose iterations are independent
8552 and can be arbitrarily reordered.  The optimization is only
8553 profitable on multiprocessor machines, for loops that are CPU-intensive,
8554 rather than constrained e.g.@: by memory bandwidth.  This option
8555 implies @option{-pthread}, and thus is only supported on targets
8556 that have support for @option{-pthread}.
8558 @item -ftree-pta
8559 @opindex ftree-pta
8560 Perform function-local points-to analysis on trees.  This flag is
8561 enabled by default at @option{-O} and higher.
8563 @item -ftree-sra
8564 @opindex ftree-sra
8565 Perform scalar replacement of aggregates.  This pass replaces structure
8566 references with scalars to prevent committing structures to memory too
8567 early.  This flag is enabled by default at @option{-O} and higher.
8569 @item -ftree-copyrename
8570 @opindex ftree-copyrename
8571 Perform copy renaming on trees.  This pass attempts to rename compiler
8572 temporaries to other variables at copy locations, usually resulting in
8573 variable names which more closely resemble the original variables.  This flag
8574 is enabled by default at @option{-O} and higher.
8576 @item -ftree-coalesce-inlined-vars
8577 @opindex ftree-coalesce-inlined-vars
8578 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8579 combine small user-defined variables too, but only if they were inlined
8580 from other functions.  It is a more limited form of
8581 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8582 inlined variables, but it will keep variables of the inlined-into
8583 function apart from each other, such that they are more likely to
8584 contain the expected values in a debugging session.  This was the
8585 default in GCC versions older than 4.7.
8587 @item -ftree-coalesce-vars
8588 @opindex ftree-coalesce-vars
8589 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8590 combine small user-defined variables too, instead of just compiler
8591 temporaries.  This may severely limit the ability to debug an optimized
8592 program compiled with @option{-fno-var-tracking-assignments}.  In the
8593 negated form, this flag prevents SSA coalescing of user variables,
8594 including inlined ones.  This option is enabled by default.
8596 @item -ftree-ter
8597 @opindex ftree-ter
8598 Perform temporary expression replacement during the SSA->normal phase.  Single
8599 use/single def temporaries are replaced at their use location with their
8600 defining expression.  This results in non-GIMPLE code, but gives the expanders
8601 much more complex trees to work on resulting in better RTL generation.  This is
8602 enabled by default at @option{-O} and higher.
8604 @item -ftree-slsr
8605 @opindex ftree-slsr
8606 Perform straight-line strength reduction on trees.  This recognizes related
8607 expressions involving multiplications and replaces them by less expensive
8608 calculations when possible.  This is enabled by default at @option{-O} and
8609 higher.
8611 @item -ftree-vectorize
8612 @opindex ftree-vectorize
8613 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8614 and @option{-ftree-slp-vectorize} if not explicitly specified.
8616 @item -ftree-loop-vectorize
8617 @opindex ftree-loop-vectorize
8618 Perform loop vectorization on trees. This flag is enabled by default at
8619 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8621 @item -ftree-slp-vectorize
8622 @opindex ftree-slp-vectorize
8623 Perform basic block vectorization on trees. This flag is enabled by default at
8624 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8626 @item -fvect-cost-model=@var{model}
8627 @opindex fvect-cost-model
8628 Alter the cost model used for vectorization.  The @var{model} argument
8629 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8630 With the @code{unlimited} model the vectorized code-path is assumed
8631 to be profitable while with the @code{dynamic} model a runtime check
8632 will guard the vectorized code-path to enable it only for iteration
8633 counts that will likely execute faster than when executing the original
8634 scalar loop.  The @code{cheap} model will disable vectorization of
8635 loops where doing so would be cost prohibitive for example due to
8636 required runtime checks for data dependence or alignment but otherwise
8637 is equal to the @code{dynamic} model.
8638 The default cost model depends on other optimization flags and is
8639 either @code{dynamic} or @code{cheap}.
8641 @item -fsimd-cost-model=@var{model}
8642 @opindex fsimd-cost-model
8643 Alter the cost model used for vectorization of loops marked with the OpenMP
8644 or Cilk Plus simd directive.  The @var{model} argument should be one of
8645 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8646 have the same meaning as described in @option{-fvect-cost-model} and by
8647 default a cost model defined with @option{-fvect-cost-model} is used.
8649 @item -ftree-vrp
8650 @opindex ftree-vrp
8651 Perform Value Range Propagation on trees.  This is similar to the
8652 constant propagation pass, but instead of values, ranges of values are
8653 propagated.  This allows the optimizers to remove unnecessary range
8654 checks like array bound checks and null pointer checks.  This is
8655 enabled by default at @option{-O2} and higher.  Null pointer check
8656 elimination is only done if @option{-fdelete-null-pointer-checks} is
8657 enabled.
8659 @item -ftracer
8660 @opindex ftracer
8661 Perform tail duplication to enlarge superblock size.  This transformation
8662 simplifies the control flow of the function allowing other optimizations to do
8663 a better job.
8665 @item -funroll-loops
8666 @opindex funroll-loops
8667 Unroll loops whose number of iterations can be determined at compile
8668 time or upon entry to the loop.  @option{-funroll-loops} implies
8669 @option{-frerun-cse-after-loop}.  This option makes code larger,
8670 and may or may not make it run faster.
8672 @item -funroll-all-loops
8673 @opindex funroll-all-loops
8674 Unroll all loops, even if their number of iterations is uncertain when
8675 the loop is entered.  This usually makes programs run more slowly.
8676 @option{-funroll-all-loops} implies the same options as
8677 @option{-funroll-loops},
8679 @item -fsplit-ivs-in-unroller
8680 @opindex fsplit-ivs-in-unroller
8681 Enables expression of values of induction variables in later iterations
8682 of the unrolled loop using the value in the first iteration.  This breaks
8683 long dependency chains, thus improving efficiency of the scheduling passes.
8685 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8686 same effect.  However, that is not reliable in cases where the loop body
8687 is more complicated than a single basic block.  It also does not work at all
8688 on some architectures due to restrictions in the CSE pass.
8690 This optimization is enabled by default.
8692 @item -fvariable-expansion-in-unroller
8693 @opindex fvariable-expansion-in-unroller
8694 With this option, the compiler creates multiple copies of some
8695 local variables when unrolling a loop, which can result in superior code.
8697 @item -fpartial-inlining
8698 @opindex fpartial-inlining
8699 Inline parts of functions.  This option has any effect only
8700 when inlining itself is turned on by the @option{-finline-functions}
8701 or @option{-finline-small-functions} options.
8703 Enabled at level @option{-O2}.
8705 @item -fpredictive-commoning
8706 @opindex fpredictive-commoning
8707 Perform predictive commoning optimization, i.e., reusing computations
8708 (especially memory loads and stores) performed in previous
8709 iterations of loops.
8711 This option is enabled at level @option{-O3}.
8713 @item -fprefetch-loop-arrays
8714 @opindex fprefetch-loop-arrays
8715 If supported by the target machine, generate instructions to prefetch
8716 memory to improve the performance of loops that access large arrays.
8718 This option may generate better or worse code; results are highly
8719 dependent on the structure of loops within the source code.
8721 Disabled at level @option{-Os}.
8723 @item -fno-peephole
8724 @itemx -fno-peephole2
8725 @opindex fno-peephole
8726 @opindex fno-peephole2
8727 Disable any machine-specific peephole optimizations.  The difference
8728 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8729 are implemented in the compiler; some targets use one, some use the
8730 other, a few use both.
8732 @option{-fpeephole} is enabled by default.
8733 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8735 @item -fno-guess-branch-probability
8736 @opindex fno-guess-branch-probability
8737 Do not guess branch probabilities using heuristics.
8739 GCC uses heuristics to guess branch probabilities if they are
8740 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8741 heuristics are based on the control flow graph.  If some branch probabilities
8742 are specified by @samp{__builtin_expect}, then the heuristics are
8743 used to guess branch probabilities for the rest of the control flow graph,
8744 taking the @samp{__builtin_expect} info into account.  The interactions
8745 between the heuristics and @samp{__builtin_expect} can be complex, and in
8746 some cases, it may be useful to disable the heuristics so that the effects
8747 of @samp{__builtin_expect} are easier to understand.
8749 The default is @option{-fguess-branch-probability} at levels
8750 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8752 @item -freorder-blocks
8753 @opindex freorder-blocks
8754 Reorder basic blocks in the compiled function in order to reduce number of
8755 taken branches and improve code locality.
8757 Enabled at levels @option{-O2}, @option{-O3}.
8759 @item -freorder-blocks-and-partition
8760 @opindex freorder-blocks-and-partition
8761 In addition to reordering basic blocks in the compiled function, in order
8762 to reduce number of taken branches, partitions hot and cold basic blocks
8763 into separate sections of the assembly and .o files, to improve
8764 paging and cache locality performance.
8766 This optimization is automatically turned off in the presence of
8767 exception handling, for linkonce sections, for functions with a user-defined
8768 section attribute and on any architecture that does not support named
8769 sections.
8771 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8773 @item -freorder-functions
8774 @opindex freorder-functions
8775 Reorder functions in the object file in order to
8776 improve code locality.  This is implemented by using special
8777 subsections @code{.text.hot} for most frequently executed functions and
8778 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8779 the linker so object file format must support named sections and linker must
8780 place them in a reasonable way.
8782 Also profile feedback must be available to make this option effective.  See
8783 @option{-fprofile-arcs} for details.
8785 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8787 @item -fstrict-aliasing
8788 @opindex fstrict-aliasing
8789 Allow the compiler to assume the strictest aliasing rules applicable to
8790 the language being compiled.  For C (and C++), this activates
8791 optimizations based on the type of expressions.  In particular, an
8792 object of one type is assumed never to reside at the same address as an
8793 object of a different type, unless the types are almost the same.  For
8794 example, an @code{unsigned int} can alias an @code{int}, but not a
8795 @code{void*} or a @code{double}.  A character type may alias any other
8796 type.
8798 @anchor{Type-punning}Pay special attention to code like this:
8799 @smallexample
8800 union a_union @{
8801   int i;
8802   double d;
8805 int f() @{
8806   union a_union t;
8807   t.d = 3.0;
8808   return t.i;
8810 @end smallexample
8811 The practice of reading from a different union member than the one most
8812 recently written to (called ``type-punning'') is common.  Even with
8813 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8814 is accessed through the union type.  So, the code above works as
8815 expected.  @xref{Structures unions enumerations and bit-fields
8816 implementation}.  However, this code might not:
8817 @smallexample
8818 int f() @{
8819   union a_union t;
8820   int* ip;
8821   t.d = 3.0;
8822   ip = &t.i;
8823   return *ip;
8825 @end smallexample
8827 Similarly, access by taking the address, casting the resulting pointer
8828 and dereferencing the result has undefined behavior, even if the cast
8829 uses a union type, e.g.:
8830 @smallexample
8831 int f() @{
8832   double d = 3.0;
8833   return ((union a_union *) &d)->i;
8835 @end smallexample
8837 The @option{-fstrict-aliasing} option is enabled at levels
8838 @option{-O2}, @option{-O3}, @option{-Os}.
8840 @item -fstrict-overflow
8841 @opindex fstrict-overflow
8842 Allow the compiler to assume strict signed overflow rules, depending
8843 on the language being compiled.  For C (and C++) this means that
8844 overflow when doing arithmetic with signed numbers is undefined, which
8845 means that the compiler may assume that it does not happen.  This
8846 permits various optimizations.  For example, the compiler assumes
8847 that an expression like @code{i + 10 > i} is always true for
8848 signed @code{i}.  This assumption is only valid if signed overflow is
8849 undefined, as the expression is false if @code{i + 10} overflows when
8850 using twos complement arithmetic.  When this option is in effect any
8851 attempt to determine whether an operation on signed numbers 
8852 overflows must be written carefully to not actually involve overflow.
8854 This option also allows the compiler to assume strict pointer
8855 semantics: given a pointer to an object, if adding an offset to that
8856 pointer does not produce a pointer to the same object, the addition is
8857 undefined.  This permits the compiler to conclude that @code{p + u >
8858 p} is always true for a pointer @code{p} and unsigned integer
8859 @code{u}.  This assumption is only valid because pointer wraparound is
8860 undefined, as the expression is false if @code{p + u} overflows using
8861 twos complement arithmetic.
8863 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8864 that integer signed overflow is fully defined: it wraps.  When
8865 @option{-fwrapv} is used, there is no difference between
8866 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8867 integers.  With @option{-fwrapv} certain types of overflow are
8868 permitted.  For example, if the compiler gets an overflow when doing
8869 arithmetic on constants, the overflowed value can still be used with
8870 @option{-fwrapv}, but not otherwise.
8872 The @option{-fstrict-overflow} option is enabled at levels
8873 @option{-O2}, @option{-O3}, @option{-Os}.
8875 @item -falign-functions
8876 @itemx -falign-functions=@var{n}
8877 @opindex falign-functions
8878 Align the start of functions to the next power-of-two greater than
8879 @var{n}, skipping up to @var{n} bytes.  For instance,
8880 @option{-falign-functions=32} aligns functions to the next 32-byte
8881 boundary, but @option{-falign-functions=24} aligns to the next
8882 32-byte boundary only if this can be done by skipping 23 bytes or less.
8884 @option{-fno-align-functions} and @option{-falign-functions=1} are
8885 equivalent and mean that functions are not aligned.
8887 Some assemblers only support this flag when @var{n} is a power of two;
8888 in that case, it is rounded up.
8890 If @var{n} is not specified or is zero, use a machine-dependent default.
8892 Enabled at levels @option{-O2}, @option{-O3}.
8894 @item -falign-labels
8895 @itemx -falign-labels=@var{n}
8896 @opindex falign-labels
8897 Align all branch targets to a power-of-two boundary, skipping up to
8898 @var{n} bytes like @option{-falign-functions}.  This option can easily
8899 make code slower, because it must insert dummy operations for when the
8900 branch target is reached in the usual flow of the code.
8902 @option{-fno-align-labels} and @option{-falign-labels=1} are
8903 equivalent and mean that labels are not aligned.
8905 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8906 are greater than this value, then their values are used instead.
8908 If @var{n} is not specified or is zero, use a machine-dependent default
8909 which is very likely to be @samp{1}, meaning no alignment.
8911 Enabled at levels @option{-O2}, @option{-O3}.
8913 @item -falign-loops
8914 @itemx -falign-loops=@var{n}
8915 @opindex falign-loops
8916 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8917 like @option{-falign-functions}.  If the loops are
8918 executed many times, this makes up for any execution of the dummy
8919 operations.
8921 @option{-fno-align-loops} and @option{-falign-loops=1} are
8922 equivalent and mean that loops are not aligned.
8924 If @var{n} is not specified or is zero, use a machine-dependent default.
8926 Enabled at levels @option{-O2}, @option{-O3}.
8928 @item -falign-jumps
8929 @itemx -falign-jumps=@var{n}
8930 @opindex falign-jumps
8931 Align branch targets to a power-of-two boundary, for branch targets
8932 where the targets can only be reached by jumping, skipping up to @var{n}
8933 bytes like @option{-falign-functions}.  In this case, no dummy operations
8934 need be executed.
8936 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8937 equivalent and mean that loops are not aligned.
8939 If @var{n} is not specified or is zero, use a machine-dependent default.
8941 Enabled at levels @option{-O2}, @option{-O3}.
8943 @item -funit-at-a-time
8944 @opindex funit-at-a-time
8945 This option is left for compatibility reasons. @option{-funit-at-a-time}
8946 has no effect, while @option{-fno-unit-at-a-time} implies
8947 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8949 Enabled by default.
8951 @item -fno-toplevel-reorder
8952 @opindex fno-toplevel-reorder
8953 Do not reorder top-level functions, variables, and @code{asm}
8954 statements.  Output them in the same order that they appear in the
8955 input file.  When this option is used, unreferenced static variables
8956 are not removed.  This option is intended to support existing code
8957 that relies on a particular ordering.  For new code, it is better to
8958 use attributes when possible.
8960 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8961 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8962 targets.
8964 @item -fweb
8965 @opindex fweb
8966 Constructs webs as commonly used for register allocation purposes and assign
8967 each web individual pseudo register.  This allows the register allocation pass
8968 to operate on pseudos directly, but also strengthens several other optimization
8969 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8970 however, make debugging impossible, since variables no longer stay in a
8971 ``home register''.
8973 Enabled by default with @option{-funroll-loops}.
8975 @item -fwhole-program
8976 @opindex fwhole-program
8977 Assume that the current compilation unit represents the whole program being
8978 compiled.  All public functions and variables with the exception of @code{main}
8979 and those merged by attribute @code{externally_visible} become static functions
8980 and in effect are optimized more aggressively by interprocedural optimizers.
8982 This option should not be used in combination with @code{-flto}.
8983 Instead relying on a linker plugin should provide safer and more precise
8984 information.
8986 @item -flto[=@var{n}]
8987 @opindex flto
8988 This option runs the standard link-time optimizer.  When invoked
8989 with source code, it generates GIMPLE (one of GCC's internal
8990 representations) and writes it to special ELF sections in the object
8991 file.  When the object files are linked together, all the function
8992 bodies are read from these ELF sections and instantiated as if they
8993 had been part of the same translation unit.
8995 To use the link-time optimizer, @option{-flto} and optimization
8996 options should be specified at compile time and during the final link.
8997 For example:
8999 @smallexample
9000 gcc -c -O2 -flto foo.c
9001 gcc -c -O2 -flto bar.c
9002 gcc -o myprog -flto -O2 foo.o bar.o
9003 @end smallexample
9005 The first two invocations to GCC save a bytecode representation
9006 of GIMPLE into special ELF sections inside @file{foo.o} and
9007 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
9008 @file{foo.o} and @file{bar.o}, merges the two files into a single
9009 internal image, and compiles the result as usual.  Since both
9010 @file{foo.o} and @file{bar.o} are merged into a single image, this
9011 causes all the interprocedural analyses and optimizations in GCC to
9012 work across the two files as if they were a single one.  This means,
9013 for example, that the inliner is able to inline functions in
9014 @file{bar.o} into functions in @file{foo.o} and vice-versa.
9016 Another (simpler) way to enable link-time optimization is:
9018 @smallexample
9019 gcc -o myprog -flto -O2 foo.c bar.c
9020 @end smallexample
9022 The above generates bytecode for @file{foo.c} and @file{bar.c},
9023 merges them together into a single GIMPLE representation and optimizes
9024 them as usual to produce @file{myprog}.
9026 The only important thing to keep in mind is that to enable link-time
9027 optimizations you need to use the GCC driver to perform the link-step.
9028 GCC then automatically performs link-time optimization if any of the
9029 objects involved were compiled with the @option{-flto}.  You generally
9030 should specify the optimization options to be used for link-time
9031 optimization though GCC will try to be clever at guessing an
9032 optimization level to use from the options used at compile-time
9033 if you fail to specify one at link-time.  You can always override
9034 the automatic decision to do link-time optimization at link-time
9035 by passing @option{-fno-lto} to the link command.
9037 To make whole program optimization effective, it is necessary to make
9038 certain whole program assumptions.  The compiler needs to know
9039 what functions and variables can be accessed by libraries and runtime
9040 outside of the link-time optimized unit.  When supported by the linker,
9041 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9042 to the compiler about used and externally visible symbols.  When
9043 the linker plugin is not available, @option{-fwhole-program} should be
9044 used to allow the compiler to make these assumptions, which leads
9045 to more aggressive optimization decisions.
9047 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9048 compiled with @option{-flto}, the generated object file is larger than
9049 a regular object file because it contains GIMPLE bytecodes and the usual
9050 final code (see @option{-ffat-lto-objects}.  This means that
9051 object files with LTO information can be linked as normal object
9052 files; if @option{-fno-lto} is passed to the linker, no
9053 interprocedural optimizations are applied.  Note that when
9054 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9055 but you cannot perform a regular, non-LTO link on them.
9057 Additionally, the optimization flags used to compile individual files
9058 are not necessarily related to those used at link time.  For instance,
9060 @smallexample
9061 gcc -c -O0 -ffat-lto-objects -flto foo.c
9062 gcc -c -O0 -ffat-lto-objects -flto bar.c
9063 gcc -o myprog -O3 foo.o bar.o
9064 @end smallexample
9066 This produces individual object files with unoptimized assembler
9067 code, but the resulting binary @file{myprog} is optimized at
9068 @option{-O3}.  If, instead, the final binary is generated with
9069 @option{-fno-lto}, then @file{myprog} is not optimized.
9071 When producing the final binary, GCC only
9072 applies link-time optimizations to those files that contain bytecode.
9073 Therefore, you can mix and match object files and libraries with
9074 GIMPLE bytecodes and final object code.  GCC automatically selects
9075 which files to optimize in LTO mode and which files to link without
9076 further processing.
9078 There are some code generation flags preserved by GCC when
9079 generating bytecodes, as they need to be used during the final link
9080 stage.  Generally options specified at link-time override those
9081 specified at compile-time.
9083 If you do not specify an optimization level option @option{-O} at
9084 link-time then GCC will compute one based on the optimization levels
9085 used when compiling the object files.  The highest optimization
9086 level will win here.
9088 Currently, the following options and their setting are take from
9089 the first object file that explicitely specified it: 
9090 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9091 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9092 and all the @option{-m} target flags.
9094 Certain ABI changing flags are required to match in all compilation-units
9095 and trying to override this at link-time with a conflicting value
9096 is ignored.  This includes options such as @option{-freg-struct-return}
9097 and @option{-fpcc-struct-return}. 
9099 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9100 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9101 are passed through to the link stage and merged conservatively for
9102 conflicting translation units.  Specifically
9103 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9104 precedence and for example @option{-ffp-contract=off} takes precedence
9105 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9107 It is recommended that you compile all the files participating in the
9108 same link with the same options and also specify those options at
9109 link time.
9111 If LTO encounters objects with C linkage declared with incompatible
9112 types in separate translation units to be linked together (undefined
9113 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9114 issued.  The behavior is still undefined at run time.  Similar
9115 diagnostics may be raised for other languages.
9117 Another feature of LTO is that it is possible to apply interprocedural
9118 optimizations on files written in different languages:
9120 @smallexample
9121 gcc -c -flto foo.c
9122 g++ -c -flto bar.cc
9123 gfortran -c -flto baz.f90
9124 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9125 @end smallexample
9127 Notice that the final link is done with @command{g++} to get the C++
9128 runtime libraries and @option{-lgfortran} is added to get the Fortran
9129 runtime libraries.  In general, when mixing languages in LTO mode, you
9130 should use the same link command options as when mixing languages in a
9131 regular (non-LTO) compilation.
9133 If object files containing GIMPLE bytecode are stored in a library archive, say
9134 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9135 are using a linker with plugin support.  To create static libraries suitable
9136 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9137 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
9138 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9139 and @command{nm} have been compiled with plugin support.  At link time, use the the
9140 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9141 the LTO optimization process:
9143 @smallexample
9144 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9145 @end smallexample
9147 With the linker plugin enabled, the linker extracts the needed
9148 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9149 to make them part of the aggregated GIMPLE image to be optimized.
9151 If you are not using a linker with plugin support and/or do not
9152 enable the linker plugin, then the objects inside @file{libfoo.a}
9153 are extracted and linked as usual, but they do not participate
9154 in the LTO optimization process.  In order to make a static library suitable
9155 for both LTO optimization and usual linkage, compile its object files with
9156 @option{-flto} @code{-ffat-lto-objects}.
9158 Link-time optimizations do not require the presence of the whole program to
9159 operate.  If the program does not require any symbols to be exported, it is
9160 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9161 the interprocedural optimizers to use more aggressive assumptions which may
9162 lead to improved optimization opportunities.
9163 Use of @option{-fwhole-program} is not needed when linker plugin is
9164 active (see @option{-fuse-linker-plugin}).
9166 The current implementation of LTO makes no
9167 attempt to generate bytecode that is portable between different
9168 types of hosts.  The bytecode files are versioned and there is a
9169 strict version check, so bytecode files generated in one version of
9170 GCC will not work with an older or newer version of GCC.
9172 Link-time optimization does not work well with generation of debugging
9173 information.  Combining @option{-flto} with
9174 @option{-g} is currently experimental and expected to produce unexpected
9175 results.
9177 If you specify the optional @var{n}, the optimization and code
9178 generation done at link time is executed in parallel using @var{n}
9179 parallel jobs by utilizing an installed @command{make} program.  The
9180 environment variable @env{MAKE} may be used to override the program
9181 used.  The default value for @var{n} is 1.
9183 You can also specify @option{-flto=jobserver} to use GNU make's
9184 job server mode to determine the number of parallel jobs. This
9185 is useful when the Makefile calling GCC is already executing in parallel.
9186 You must prepend a @samp{+} to the command recipe in the parent Makefile
9187 for this to work.  This option likely only works if @env{MAKE} is
9188 GNU make.
9190 @item -flto-partition=@var{alg}
9191 @opindex flto-partition
9192 Specify the partitioning algorithm used by the link-time optimizer.
9193 The value is either @code{1to1} to specify a partitioning mirroring
9194 the original source files or @code{balanced} to specify partitioning
9195 into equally sized chunks (whenever possible) or @code{max} to create
9196 new partition for every symbol where possible.  Specifying @code{none}
9197 as an algorithm disables partitioning and streaming completely. 
9198 The default value is @code{balanced}. While @code{1to1} can be used
9199 as an workaround for various code ordering issues, the @code{max}
9200 partitioning is intended for internal testing only.
9201 The value @code{one} specifies that exactly one partition should be
9202 used while the value @code{none} bypasses partitioning and executes
9203 the link-time optimization step directly from the WPA phase.
9205 @item -flto-odr-type-merging
9206 @opindex flto-odr-type-merging
9207 Enable streaming of mangled types names of C++ types and their unification
9208 at linktime.  This increases size of LTO object files, but enable
9209 diagnostics about One Definition Rule violations.
9211 @item -flto-compression-level=@var{n}
9212 @opindex flto-compression-level
9213 This option specifies the level of compression used for intermediate
9214 language written to LTO object files, and is only meaningful in
9215 conjunction with LTO mode (@option{-flto}).  Valid
9216 values are 0 (no compression) to 9 (maximum compression).  Values
9217 outside this range are clamped to either 0 or 9.  If the option is not
9218 given, a default balanced compression setting is used.
9220 @item -flto-report
9221 @opindex flto-report
9222 Prints a report with internal details on the workings of the link-time
9223 optimizer.  The contents of this report vary from version to version.
9224 It is meant to be useful to GCC developers when processing object
9225 files in LTO mode (via @option{-flto}).
9227 Disabled by default.
9229 @item -flto-report-wpa
9230 @opindex flto-report-wpa
9231 Like @option{-flto-report}, but only print for the WPA phase of Link
9232 Time Optimization.
9234 @item -fuse-linker-plugin
9235 @opindex fuse-linker-plugin
9236 Enables the use of a linker plugin during link-time optimization.  This
9237 option relies on plugin support in the linker, which is available in gold
9238 or in GNU ld 2.21 or newer.
9240 This option enables the extraction of object files with GIMPLE bytecode out
9241 of library archives. This improves the quality of optimization by exposing
9242 more code to the link-time optimizer.  This information specifies what
9243 symbols can be accessed externally (by non-LTO object or during dynamic
9244 linking).  Resulting code quality improvements on binaries (and shared
9245 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9246 See @option{-flto} for a description of the effect of this flag and how to
9247 use it.
9249 This option is enabled by default when LTO support in GCC is enabled
9250 and GCC was configured for use with
9251 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9253 @item -ffat-lto-objects
9254 @opindex ffat-lto-objects
9255 Fat LTO objects are object files that contain both the intermediate language
9256 and the object code. This makes them usable for both LTO linking and normal
9257 linking. This option is effective only when compiling with @option{-flto}
9258 and is ignored at link time.
9260 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9261 requires the complete toolchain to be aware of LTO. It requires a linker with
9262 linker plugin support for basic functionality.  Additionally,
9263 @command{nm}, @command{ar} and @command{ranlib}
9264 need to support linker plugins to allow a full-featured build environment
9265 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9266 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9267 to these tools. With non fat LTO makefiles need to be modified to use them.
9269 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9270 support.
9272 @item -fcompare-elim
9273 @opindex fcompare-elim
9274 After register allocation and post-register allocation instruction splitting,
9275 identify arithmetic instructions that compute processor flags similar to a
9276 comparison operation based on that arithmetic.  If possible, eliminate the
9277 explicit comparison operation.
9279 This pass only applies to certain targets that cannot explicitly represent
9280 the comparison operation before register allocation is complete.
9282 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9284 @item -fuse-ld=bfd
9285 @opindex fuse-ld=bfd
9286 Use the @command{bfd} linker instead of the default linker.
9288 @item -fuse-ld=gold
9289 @opindex fuse-ld=gold
9290 Use the @command{gold} linker instead of the default linker.
9292 @item -fcprop-registers
9293 @opindex fcprop-registers
9294 After register allocation and post-register allocation instruction splitting,
9295 perform a copy-propagation pass to try to reduce scheduling dependencies
9296 and occasionally eliminate the copy.
9298 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9300 @item -fprofile-correction
9301 @opindex fprofile-correction
9302 Profiles collected using an instrumented binary for multi-threaded programs may
9303 be inconsistent due to missed counter updates. When this option is specified,
9304 GCC uses heuristics to correct or smooth out such inconsistencies. By
9305 default, GCC emits an error message when an inconsistent profile is detected.
9307 @item -fprofile-dir=@var{path}
9308 @opindex fprofile-dir
9310 Set the directory to search for the profile data files in to @var{path}.
9311 This option affects only the profile data generated by
9312 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9313 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9314 and its related options.  Both absolute and relative paths can be used.
9315 By default, GCC uses the current directory as @var{path}, thus the
9316 profile data file appears in the same directory as the object file.
9318 @item -fprofile-generate
9319 @itemx -fprofile-generate=@var{path}
9320 @opindex fprofile-generate
9322 Enable options usually used for instrumenting application to produce
9323 profile useful for later recompilation with profile feedback based
9324 optimization.  You must use @option{-fprofile-generate} both when
9325 compiling and when linking your program.
9327 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9329 If @var{path} is specified, GCC looks at the @var{path} to find
9330 the profile feedback data files. See @option{-fprofile-dir}.
9332 @item -fprofile-use
9333 @itemx -fprofile-use=@var{path}
9334 @opindex fprofile-use
9335 Enable profile feedback directed optimizations, and optimizations
9336 generally profitable only with profile feedback available.
9338 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9339 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9340 @code{ftree-loop-distribute-patterns}
9342 By default, GCC emits an error message if the feedback profiles do not
9343 match the source code.  This error can be turned into a warning by using
9344 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9345 code.
9347 If @var{path} is specified, GCC looks at the @var{path} to find
9348 the profile feedback data files. See @option{-fprofile-dir}.
9350 @item -fauto-profile
9351 @itemx -fauto-profile=@var{path}
9352 @opindex fauto-profile
9353 Enable sampling based feedback directed optimizations, and optimizations
9354 generally profitable only with profile feedback available.
9356 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9357 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9358 @code{-finline-functions}, @code{-fipa-cp}, @code{-fipa-cp-clone},
9359 @code{-fpredictive-commoning}, @code{-funswitch-loops},
9360 @code{-fgcse-after-reload}, @code{-ftree-loop-distribute-patterns},
9362 If @var{path} is specified, GCC looks at the @var{path} to find
9363 the profile feedback data files.
9365 In order to collect AutoFDO profile, you need to have:
9367 1. A linux system with linux perf support
9368 2. (optional) An Intel processor with last branch record (LBR) support. This is
9369    to guarantee accurate instruction level profile, which is important for
9370    AutoFDO performance.
9372 To collect the profile, first use linux perf to collect raw profile
9373 (see @uref{https://perf.wiki.kernel.org/}).
9375 E.g.
9376 @code{perf record -e br_inst_retired:near_taken -b -o perf.data -- your_program}
9378 Then use create_gcov tool, which takes raw profile and unstripped binary to
9379 generate AutoFDO profile that can be used by GCC.
9380 (see @uref{https://github.com/google/autofdo}).
9382 E.g.
9383 @code{create_gcov --binary=your_program.unstripped --profile=perf.data --gcov=profile.afdo}
9384 @end table
9386 The following options control compiler behavior regarding floating-point 
9387 arithmetic.  These options trade off between speed and
9388 correctness.  All must be specifically enabled.
9390 @table @gcctabopt
9391 @item -ffloat-store
9392 @opindex ffloat-store
9393 Do not store floating-point variables in registers, and inhibit other
9394 options that might change whether a floating-point value is taken from a
9395 register or memory.
9397 @cindex floating-point precision
9398 This option prevents undesirable excess precision on machines such as
9399 the 68000 where the floating registers (of the 68881) keep more
9400 precision than a @code{double} is supposed to have.  Similarly for the
9401 x86 architecture.  For most programs, the excess precision does only
9402 good, but a few programs rely on the precise definition of IEEE floating
9403 point.  Use @option{-ffloat-store} for such programs, after modifying
9404 them to store all pertinent intermediate computations into variables.
9406 @item -fexcess-precision=@var{style}
9407 @opindex fexcess-precision
9408 This option allows further control over excess precision on machines
9409 where floating-point registers have more precision than the IEEE
9410 @code{float} and @code{double} types and the processor does not
9411 support operations rounding to those types.  By default,
9412 @option{-fexcess-precision=fast} is in effect; this means that
9413 operations are carried out in the precision of the registers and that
9414 it is unpredictable when rounding to the types specified in the source
9415 code takes place.  When compiling C, if
9416 @option{-fexcess-precision=standard} is specified then excess
9417 precision follows the rules specified in ISO C99; in particular,
9418 both casts and assignments cause values to be rounded to their
9419 semantic types (whereas @option{-ffloat-store} only affects
9420 assignments).  This option is enabled by default for C if a strict
9421 conformance option such as @option{-std=c99} is used.
9423 @opindex mfpmath
9424 @option{-fexcess-precision=standard} is not implemented for languages
9425 other than C, and has no effect if
9426 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9427 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9428 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9429 semantics apply without excess precision, and in the latter, rounding
9430 is unpredictable.
9432 @item -ffast-math
9433 @opindex ffast-math
9434 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9435 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9436 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9438 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9440 This option is not turned on by any @option{-O} option besides
9441 @option{-Ofast} since it can result in incorrect output for programs
9442 that depend on an exact implementation of IEEE or ISO rules/specifications
9443 for math functions. It may, however, yield faster code for programs
9444 that do not require the guarantees of these specifications.
9446 @item -fno-math-errno
9447 @opindex fno-math-errno
9448 Do not set @code{errno} after calling math functions that are executed
9449 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9450 IEEE exceptions for math error handling may want to use this flag
9451 for speed while maintaining IEEE arithmetic compatibility.
9453 This option is not turned on by any @option{-O} option since
9454 it can result in incorrect output for programs that depend on
9455 an exact implementation of IEEE or ISO rules/specifications for
9456 math functions. It may, however, yield faster code for programs
9457 that do not require the guarantees of these specifications.
9459 The default is @option{-fmath-errno}.
9461 On Darwin systems, the math library never sets @code{errno}.  There is
9462 therefore no reason for the compiler to consider the possibility that
9463 it might, and @option{-fno-math-errno} is the default.
9465 @item -funsafe-math-optimizations
9466 @opindex funsafe-math-optimizations
9468 Allow optimizations for floating-point arithmetic that (a) assume
9469 that arguments and results are valid and (b) may violate IEEE or
9470 ANSI standards.  When used at link-time, it may include libraries
9471 or startup files that change the default FPU control word or other
9472 similar optimizations.
9474 This option is not turned on by any @option{-O} option since
9475 it can result in incorrect output for programs that depend on
9476 an exact implementation of IEEE or ISO rules/specifications for
9477 math functions. It may, however, yield faster code for programs
9478 that do not require the guarantees of these specifications.
9479 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9480 @option{-fassociative-math} and @option{-freciprocal-math}.
9482 The default is @option{-fno-unsafe-math-optimizations}.
9484 @item -fassociative-math
9485 @opindex fassociative-math
9487 Allow re-association of operands in series of floating-point operations.
9488 This violates the ISO C and C++ language standard by possibly changing
9489 computation result.  NOTE: re-ordering may change the sign of zero as
9490 well as ignore NaNs and inhibit or create underflow or overflow (and
9491 thus cannot be used on code that relies on rounding behavior like
9492 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9493 and thus may not be used when ordered comparisons are required.
9494 This option requires that both @option{-fno-signed-zeros} and
9495 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9496 much sense with @option{-frounding-math}. For Fortran the option
9497 is automatically enabled when both @option{-fno-signed-zeros} and
9498 @option{-fno-trapping-math} are in effect.
9500 The default is @option{-fno-associative-math}.
9502 @item -freciprocal-math
9503 @opindex freciprocal-math
9505 Allow the reciprocal of a value to be used instead of dividing by
9506 the value if this enables optimizations.  For example @code{x / y}
9507 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9508 is subject to common subexpression elimination.  Note that this loses
9509 precision and increases the number of flops operating on the value.
9511 The default is @option{-fno-reciprocal-math}.
9513 @item -ffinite-math-only
9514 @opindex ffinite-math-only
9515 Allow optimizations for floating-point arithmetic that assume
9516 that arguments and results are not NaNs or +-Infs.
9518 This option is not turned on by any @option{-O} option since
9519 it can result in incorrect output for programs that depend on
9520 an exact implementation of IEEE or ISO rules/specifications for
9521 math functions. It may, however, yield faster code for programs
9522 that do not require the guarantees of these specifications.
9524 The default is @option{-fno-finite-math-only}.
9526 @item -fno-signed-zeros
9527 @opindex fno-signed-zeros
9528 Allow optimizations for floating-point arithmetic that ignore the
9529 signedness of zero.  IEEE arithmetic specifies the behavior of
9530 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9531 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9532 This option implies that the sign of a zero result isn't significant.
9534 The default is @option{-fsigned-zeros}.
9536 @item -fno-trapping-math
9537 @opindex fno-trapping-math
9538 Compile code assuming that floating-point operations cannot generate
9539 user-visible traps.  These traps include division by zero, overflow,
9540 underflow, inexact result and invalid operation.  This option requires
9541 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9542 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9544 This option should never be turned on by any @option{-O} option since
9545 it can result in incorrect output for programs that depend on
9546 an exact implementation of IEEE or ISO rules/specifications for
9547 math functions.
9549 The default is @option{-ftrapping-math}.
9551 @item -frounding-math
9552 @opindex frounding-math
9553 Disable transformations and optimizations that assume default floating-point
9554 rounding behavior.  This is round-to-zero for all floating point
9555 to integer conversions, and round-to-nearest for all other arithmetic
9556 truncations.  This option should be specified for programs that change
9557 the FP rounding mode dynamically, or that may be executed with a
9558 non-default rounding mode.  This option disables constant folding of
9559 floating-point expressions at compile time (which may be affected by
9560 rounding mode) and arithmetic transformations that are unsafe in the
9561 presence of sign-dependent rounding modes.
9563 The default is @option{-fno-rounding-math}.
9565 This option is experimental and does not currently guarantee to
9566 disable all GCC optimizations that are affected by rounding mode.
9567 Future versions of GCC may provide finer control of this setting
9568 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9569 will be used to specify the default state for @code{FENV_ACCESS}.
9571 @item -fsignaling-nans
9572 @opindex fsignaling-nans
9573 Compile code assuming that IEEE signaling NaNs may generate user-visible
9574 traps during floating-point operations.  Setting this option disables
9575 optimizations that may change the number of exceptions visible with
9576 signaling NaNs.  This option implies @option{-ftrapping-math}.
9578 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9579 be defined.
9581 The default is @option{-fno-signaling-nans}.
9583 This option is experimental and does not currently guarantee to
9584 disable all GCC optimizations that affect signaling NaN behavior.
9586 @item -fsingle-precision-constant
9587 @opindex fsingle-precision-constant
9588 Treat floating-point constants as single precision instead of
9589 implicitly converting them to double-precision constants.
9591 @item -fcx-limited-range
9592 @opindex fcx-limited-range
9593 When enabled, this option states that a range reduction step is not
9594 needed when performing complex division.  Also, there is no checking
9595 whether the result of a complex multiplication or division is @code{NaN
9596 + I*NaN}, with an attempt to rescue the situation in that case.  The
9597 default is @option{-fno-cx-limited-range}, but is enabled by
9598 @option{-ffast-math}.
9600 This option controls the default setting of the ISO C99
9601 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9602 all languages.
9604 @item -fcx-fortran-rules
9605 @opindex fcx-fortran-rules
9606 Complex multiplication and division follow Fortran rules.  Range
9607 reduction is done as part of complex division, but there is no checking
9608 whether the result of a complex multiplication or division is @code{NaN
9609 + I*NaN}, with an attempt to rescue the situation in that case.
9611 The default is @option{-fno-cx-fortran-rules}.
9613 @end table
9615 The following options control optimizations that may improve
9616 performance, but are not enabled by any @option{-O} options.  This
9617 section includes experimental options that may produce broken code.
9619 @table @gcctabopt
9620 @item -fbranch-probabilities
9621 @opindex fbranch-probabilities
9622 After running a program compiled with @option{-fprofile-arcs}
9623 (@pxref{Debugging Options,, Options for Debugging Your Program or
9624 @command{gcc}}), you can compile it a second time using
9625 @option{-fbranch-probabilities}, to improve optimizations based on
9626 the number of times each branch was taken.  When a program
9627 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9628 counts to a file called @file{@var{sourcename}.gcda} for each source
9629 file.  The information in this data file is very dependent on the
9630 structure of the generated code, so you must use the same source code
9631 and the same optimization options for both compilations.
9633 With @option{-fbranch-probabilities}, GCC puts a
9634 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9635 These can be used to improve optimization.  Currently, they are only
9636 used in one place: in @file{reorg.c}, instead of guessing which path a
9637 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9638 exactly determine which path is taken more often.
9640 @item -fprofile-values
9641 @opindex fprofile-values
9642 If combined with @option{-fprofile-arcs}, it adds code so that some
9643 data about values of expressions in the program is gathered.
9645 With @option{-fbranch-probabilities}, it reads back the data gathered
9646 from profiling values of expressions for usage in optimizations.
9648 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9650 @item -fprofile-reorder-functions
9651 @opindex fprofile-reorder-functions
9652 Function reordering based on profile instrumentation collects
9653 first time of execution of a function and orders these functions
9654 in ascending order.
9656 Enabled with @option{-fprofile-use}.
9658 @item -fvpt
9659 @opindex fvpt
9660 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9661 to add code to gather information about values of expressions.
9663 With @option{-fbranch-probabilities}, it reads back the data gathered
9664 and actually performs the optimizations based on them.
9665 Currently the optimizations include specialization of division operations
9666 using the knowledge about the value of the denominator.
9668 @item -frename-registers
9669 @opindex frename-registers
9670 Attempt to avoid false dependencies in scheduled code by making use
9671 of registers left over after register allocation.  This optimization
9672 most benefits processors with lots of registers.  Depending on the
9673 debug information format adopted by the target, however, it can
9674 make debugging impossible, since variables no longer stay in
9675 a ``home register''.
9677 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9679 @item -fschedule-fusion
9680 @opindex fschedule-fusion
9681 Performs a target dependent pass over the instruction stream to schedule
9682 instructions of same type together because target machine can execute them
9683 more efficiently if they are adjacent to each other in the instruction flow.
9685 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9687 @item -ftracer
9688 @opindex ftracer
9689 Perform tail duplication to enlarge superblock size.  This transformation
9690 simplifies the control flow of the function allowing other optimizations to do
9691 a better job.
9693 Enabled with @option{-fprofile-use}.
9695 @item -funroll-loops
9696 @opindex funroll-loops
9697 Unroll loops whose number of iterations can be determined at compile time or
9698 upon entry to the loop.  @option{-funroll-loops} implies
9699 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9700 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9701 a small constant number of iterations).  This option makes code larger, and may
9702 or may not make it run faster.
9704 Enabled with @option{-fprofile-use}.
9706 @item -funroll-all-loops
9707 @opindex funroll-all-loops
9708 Unroll all loops, even if their number of iterations is uncertain when
9709 the loop is entered.  This usually makes programs run more slowly.
9710 @option{-funroll-all-loops} implies the same options as
9711 @option{-funroll-loops}.
9713 @item -fpeel-loops
9714 @opindex fpeel-loops
9715 Peels loops for which there is enough information that they do not
9716 roll much (from profile feedback).  It also turns on complete loop peeling
9717 (i.e.@: complete removal of loops with small constant number of iterations).
9719 Enabled with @option{-fprofile-use}.
9721 @item -fmove-loop-invariants
9722 @opindex fmove-loop-invariants
9723 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9724 at level @option{-O1}
9726 @item -funswitch-loops
9727 @opindex funswitch-loops
9728 Move branches with loop invariant conditions out of the loop, with duplicates
9729 of the loop on both branches (modified according to result of the condition).
9731 @item -ffunction-sections
9732 @itemx -fdata-sections
9733 @opindex ffunction-sections
9734 @opindex fdata-sections
9735 Place each function or data item into its own section in the output
9736 file if the target supports arbitrary sections.  The name of the
9737 function or the name of the data item determines the section's name
9738 in the output file.
9740 Use these options on systems where the linker can perform optimizations
9741 to improve locality of reference in the instruction space.  Most systems
9742 using the ELF object format and SPARC processors running Solaris 2 have
9743 linkers with such optimizations.  AIX may have these optimizations in
9744 the future.
9746 Only use these options when there are significant benefits from doing
9747 so.  When you specify these options, the assembler and linker
9748 create larger object and executable files and are also slower.
9749 You cannot use @code{gprof} on all systems if you
9750 specify this option, and you may have problems with debugging if
9751 you specify both this option and @option{-g}.
9753 @item -fbranch-target-load-optimize
9754 @opindex fbranch-target-load-optimize
9755 Perform branch target register load optimization before prologue / epilogue
9756 threading.
9757 The use of target registers can typically be exposed only during reload,
9758 thus hoisting loads out of loops and doing inter-block scheduling needs
9759 a separate optimization pass.
9761 @item -fbranch-target-load-optimize2
9762 @opindex fbranch-target-load-optimize2
9763 Perform branch target register load optimization after prologue / epilogue
9764 threading.
9766 @item -fbtr-bb-exclusive
9767 @opindex fbtr-bb-exclusive
9768 When performing branch target register load optimization, don't reuse
9769 branch target registers within any basic block.
9771 @item -fstack-protector
9772 @opindex fstack-protector
9773 Emit extra code to check for buffer overflows, such as stack smashing
9774 attacks.  This is done by adding a guard variable to functions with
9775 vulnerable objects.  This includes functions that call @code{alloca}, and
9776 functions with buffers larger than 8 bytes.  The guards are initialized
9777 when a function is entered and then checked when the function exits.
9778 If a guard check fails, an error message is printed and the program exits.
9780 @item -fstack-protector-all
9781 @opindex fstack-protector-all
9782 Like @option{-fstack-protector} except that all functions are protected.
9784 @item -fstack-protector-strong
9785 @opindex fstack-protector-strong
9786 Like @option{-fstack-protector} but includes additional functions to
9787 be protected --- those that have local array definitions, or have
9788 references to local frame addresses.
9790 @item -fsection-anchors
9791 @opindex fsection-anchors
9792 Try to reduce the number of symbolic address calculations by using
9793 shared ``anchor'' symbols to address nearby objects.  This transformation
9794 can help to reduce the number of GOT entries and GOT accesses on some
9795 targets.
9797 For example, the implementation of the following function @code{foo}:
9799 @smallexample
9800 static int a, b, c;
9801 int foo (void) @{ return a + b + c; @}
9802 @end smallexample
9804 @noindent
9805 usually calculates the addresses of all three variables, but if you
9806 compile it with @option{-fsection-anchors}, it accesses the variables
9807 from a common anchor point instead.  The effect is similar to the
9808 following pseudocode (which isn't valid C):
9810 @smallexample
9811 int foo (void)
9813   register int *xr = &x;
9814   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9816 @end smallexample
9818 Not all targets support this option.
9820 @item --param @var{name}=@var{value}
9821 @opindex param
9822 In some places, GCC uses various constants to control the amount of
9823 optimization that is done.  For example, GCC does not inline functions
9824 that contain more than a certain number of instructions.  You can
9825 control some of these constants on the command line using the
9826 @option{--param} option.
9828 The names of specific parameters, and the meaning of the values, are
9829 tied to the internals of the compiler, and are subject to change
9830 without notice in future releases.
9832 In each case, the @var{value} is an integer.  The allowable choices for
9833 @var{name} are:
9835 @table @gcctabopt
9836 @item predictable-branch-outcome
9837 When branch is predicted to be taken with probability lower than this threshold
9838 (in percent), then it is considered well predictable. The default is 10.
9840 @item max-crossjump-edges
9841 The maximum number of incoming edges to consider for cross-jumping.
9842 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9843 the number of edges incoming to each block.  Increasing values mean
9844 more aggressive optimization, making the compilation time increase with
9845 probably small improvement in executable size.
9847 @item min-crossjump-insns
9848 The minimum number of instructions that must be matched at the end
9849 of two blocks before cross-jumping is performed on them.  This
9850 value is ignored in the case where all instructions in the block being
9851 cross-jumped from are matched.  The default value is 5.
9853 @item max-grow-copy-bb-insns
9854 The maximum code size expansion factor when copying basic blocks
9855 instead of jumping.  The expansion is relative to a jump instruction.
9856 The default value is 8.
9858 @item max-goto-duplication-insns
9859 The maximum number of instructions to duplicate to a block that jumps
9860 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9861 passes, GCC factors computed gotos early in the compilation process,
9862 and unfactors them as late as possible.  Only computed jumps at the
9863 end of a basic blocks with no more than max-goto-duplication-insns are
9864 unfactored.  The default value is 8.
9866 @item max-delay-slot-insn-search
9867 The maximum number of instructions to consider when looking for an
9868 instruction to fill a delay slot.  If more than this arbitrary number of
9869 instructions are searched, the time savings from filling the delay slot
9870 are minimal, so stop searching.  Increasing values mean more
9871 aggressive optimization, making the compilation time increase with probably
9872 small improvement in execution time.
9874 @item max-delay-slot-live-search
9875 When trying to fill delay slots, the maximum number of instructions to
9876 consider when searching for a block with valid live register
9877 information.  Increasing this arbitrarily chosen value means more
9878 aggressive optimization, increasing the compilation time.  This parameter
9879 should be removed when the delay slot code is rewritten to maintain the
9880 control-flow graph.
9882 @item max-gcse-memory
9883 The approximate maximum amount of memory that can be allocated in
9884 order to perform the global common subexpression elimination
9885 optimization.  If more memory than specified is required, the
9886 optimization is not done.
9888 @item max-gcse-insertion-ratio
9889 If the ratio of expression insertions to deletions is larger than this value
9890 for any expression, then RTL PRE inserts or removes the expression and thus
9891 leaves partially redundant computations in the instruction stream.  The default value is 20.
9893 @item max-pending-list-length
9894 The maximum number of pending dependencies scheduling allows
9895 before flushing the current state and starting over.  Large functions
9896 with few branches or calls can create excessively large lists which
9897 needlessly consume memory and resources.
9899 @item max-modulo-backtrack-attempts
9900 The maximum number of backtrack attempts the scheduler should make
9901 when modulo scheduling a loop.  Larger values can exponentially increase
9902 compilation time.
9904 @item max-inline-insns-single
9905 Several parameters control the tree inliner used in GCC@.
9906 This number sets the maximum number of instructions (counted in GCC's
9907 internal representation) in a single function that the tree inliner
9908 considers for inlining.  This only affects functions declared
9909 inline and methods implemented in a class declaration (C++).
9910 The default value is 400.
9912 @item max-inline-insns-auto
9913 When you use @option{-finline-functions} (included in @option{-O3}),
9914 a lot of functions that would otherwise not be considered for inlining
9915 by the compiler are investigated.  To those functions, a different
9916 (more restrictive) limit compared to functions declared inline can
9917 be applied.
9918 The default value is 40.
9920 @item inline-min-speedup
9921 When estimated performance improvement of caller + callee runtime exceeds this
9922 threshold (in precent), the function can be inlined regardless the limit on
9923 @option{--param max-inline-insns-single} and @option{--param
9924 max-inline-insns-auto}.
9926 @item large-function-insns
9927 The limit specifying really large functions.  For functions larger than this
9928 limit after inlining, inlining is constrained by
9929 @option{--param large-function-growth}.  This parameter is useful primarily
9930 to avoid extreme compilation time caused by non-linear algorithms used by the
9931 back end.
9932 The default value is 2700.
9934 @item large-function-growth
9935 Specifies maximal growth of large function caused by inlining in percents.
9936 The default value is 100 which limits large function growth to 2.0 times
9937 the original size.
9939 @item large-unit-insns
9940 The limit specifying large translation unit.  Growth caused by inlining of
9941 units larger than this limit is limited by @option{--param inline-unit-growth}.
9942 For small units this might be too tight.
9943 For example, consider a unit consisting of function A
9944 that is inline and B that just calls A three times.  If B is small relative to
9945 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9946 large units consisting of small inlineable functions, however, the overall unit
9947 growth limit is needed to avoid exponential explosion of code size.  Thus for
9948 smaller units, the size is increased to @option{--param large-unit-insns}
9949 before applying @option{--param inline-unit-growth}.  The default is 10000.
9951 @item inline-unit-growth
9952 Specifies maximal overall growth of the compilation unit caused by inlining.
9953 The default value is 30 which limits unit growth to 1.3 times the original
9954 size. Cold functions (either marked cold via an attribute or by profile
9955 feedback) are not accounted into the unit size.
9957 @item ipcp-unit-growth
9958 Specifies maximal overall growth of the compilation unit caused by
9959 interprocedural constant propagation.  The default value is 10 which limits
9960 unit growth to 1.1 times the original size.
9962 @item large-stack-frame
9963 The limit specifying large stack frames.  While inlining the algorithm is trying
9964 to not grow past this limit too much.  The default value is 256 bytes.
9966 @item large-stack-frame-growth
9967 Specifies maximal growth of large stack frames caused by inlining in percents.
9968 The default value is 1000 which limits large stack frame growth to 11 times
9969 the original size.
9971 @item max-inline-insns-recursive
9972 @itemx max-inline-insns-recursive-auto
9973 Specifies the maximum number of instructions an out-of-line copy of a
9974 self-recursive inline
9975 function can grow into by performing recursive inlining.
9977 For functions declared inline, @option{--param max-inline-insns-recursive} is
9978 taken into account.  For functions not declared inline, recursive inlining
9979 happens only when @option{-finline-functions} (included in @option{-O3}) is
9980 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9981 default value is 450.
9983 @item max-inline-recursive-depth
9984 @itemx max-inline-recursive-depth-auto
9985 Specifies the maximum recursion depth used for recursive inlining.
9987 For functions declared inline, @option{--param max-inline-recursive-depth} is
9988 taken into account.  For functions not declared inline, recursive inlining
9989 happens only when @option{-finline-functions} (included in @option{-O3}) is
9990 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9991 default value is 8.
9993 @item min-inline-recursive-probability
9994 Recursive inlining is profitable only for function having deep recursion
9995 in average and can hurt for function having little recursion depth by
9996 increasing the prologue size or complexity of function body to other
9997 optimizers.
9999 When profile feedback is available (see @option{-fprofile-generate}) the actual
10000 recursion depth can be guessed from probability that function recurses via a
10001 given call expression.  This parameter limits inlining only to call expressions
10002 whose probability exceeds the given threshold (in percents).
10003 The default value is 10.
10005 @item early-inlining-insns
10006 Specify growth that the early inliner can make.  In effect it increases
10007 the amount of inlining for code having a large abstraction penalty.
10008 The default value is 10.
10010 @item max-early-inliner-iterations
10011 @itemx max-early-inliner-iterations
10012 Limit of iterations of the early inliner.  This basically bounds
10013 the number of nested indirect calls the early inliner can resolve.
10014 Deeper chains are still handled by late inlining.
10016 @item comdat-sharing-probability
10017 @itemx comdat-sharing-probability
10018 Probability (in percent) that C++ inline function with comdat visibility
10019 are shared across multiple compilation units.  The default value is 20.
10021 @item profile-func-internal-id
10022 @itemx profile-func-internal-id
10023 A parameter to control whether to use function internal id in profile
10024 database lookup. If the value is 0, the compiler will use id that
10025 is based on function assembler name and filename, which makes old profile
10026 data more tolerant to source changes such as function reordering etc.
10027 The default value is 0.
10029 @item min-vect-loop-bound
10030 The minimum number of iterations under which loops are not vectorized
10031 when @option{-ftree-vectorize} is used.  The number of iterations after
10032 vectorization needs to be greater than the value specified by this option
10033 to allow vectorization.  The default value is 0.
10035 @item gcse-cost-distance-ratio
10036 Scaling factor in calculation of maximum distance an expression
10037 can be moved by GCSE optimizations.  This is currently supported only in the
10038 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10039 is with simple expressions, i.e., the expressions that have cost
10040 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10041 hoisting of simple expressions.  The default value is 10.
10043 @item gcse-unrestricted-cost
10044 Cost, roughly measured as the cost of a single typical machine
10045 instruction, at which GCSE optimizations do not constrain
10046 the distance an expression can travel.  This is currently
10047 supported only in the code hoisting pass.  The lesser the cost,
10048 the more aggressive code hoisting is.  Specifying 0 
10049 allows all expressions to travel unrestricted distances.
10050 The default value is 3.
10052 @item max-hoist-depth
10053 The depth of search in the dominator tree for expressions to hoist.
10054 This is used to avoid quadratic behavior in hoisting algorithm.
10055 The value of 0 does not limit on the search, but may slow down compilation
10056 of huge functions.  The default value is 30.
10058 @item max-tail-merge-comparisons
10059 The maximum amount of similar bbs to compare a bb with.  This is used to
10060 avoid quadratic behavior in tree tail merging.  The default value is 10.
10062 @item max-tail-merge-iterations
10063 The maximum amount of iterations of the pass over the function.  This is used to
10064 limit compilation time in tree tail merging.  The default value is 2.
10066 @item max-unrolled-insns
10067 The maximum number of instructions that a loop may have to be unrolled.
10068 If a loop is unrolled, this parameter also determines how many times
10069 the loop code is unrolled.
10071 @item max-average-unrolled-insns
10072 The maximum number of instructions biased by probabilities of their execution
10073 that a loop may have to be unrolled.  If a loop is unrolled,
10074 this parameter also determines how many times the loop code is unrolled.
10076 @item max-unroll-times
10077 The maximum number of unrollings of a single loop.
10079 @item max-peeled-insns
10080 The maximum number of instructions that a loop may have to be peeled.
10081 If a loop is peeled, this parameter also determines how many times
10082 the loop code is peeled.
10084 @item max-peel-times
10085 The maximum number of peelings of a single loop.
10087 @item max-peel-branches
10088 The maximum number of branches on the hot path through the peeled sequence.
10090 @item max-completely-peeled-insns
10091 The maximum number of insns of a completely peeled loop.
10093 @item max-completely-peel-times
10094 The maximum number of iterations of a loop to be suitable for complete peeling.
10096 @item max-completely-peel-loop-nest-depth
10097 The maximum depth of a loop nest suitable for complete peeling.
10099 @item max-unswitch-insns
10100 The maximum number of insns of an unswitched loop.
10102 @item max-unswitch-level
10103 The maximum number of branches unswitched in a single loop.
10105 @item lim-expensive
10106 The minimum cost of an expensive expression in the loop invariant motion.
10108 @item iv-consider-all-candidates-bound
10109 Bound on number of candidates for induction variables, below which
10110 all candidates are considered for each use in induction variable
10111 optimizations.  If there are more candidates than this,
10112 only the most relevant ones are considered to avoid quadratic time complexity.
10114 @item iv-max-considered-uses
10115 The induction variable optimizations give up on loops that contain more
10116 induction variable uses.
10118 @item iv-always-prune-cand-set-bound
10119 If the number of candidates in the set is smaller than this value,
10120 always try to remove unnecessary ivs from the set
10121 when adding a new one.
10123 @item scev-max-expr-size
10124 Bound on size of expressions used in the scalar evolutions analyzer.
10125 Large expressions slow the analyzer.
10127 @item scev-max-expr-complexity
10128 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10129 Complex expressions slow the analyzer.
10131 @item omega-max-vars
10132 The maximum number of variables in an Omega constraint system.
10133 The default value is 128.
10135 @item omega-max-geqs
10136 The maximum number of inequalities in an Omega constraint system.
10137 The default value is 256.
10139 @item omega-max-eqs
10140 The maximum number of equalities in an Omega constraint system.
10141 The default value is 128.
10143 @item omega-max-wild-cards
10144 The maximum number of wildcard variables that the Omega solver is
10145 able to insert.  The default value is 18.
10147 @item omega-hash-table-size
10148 The size of the hash table in the Omega solver.  The default value is
10149 550.
10151 @item omega-max-keys
10152 The maximal number of keys used by the Omega solver.  The default
10153 value is 500.
10155 @item omega-eliminate-redundant-constraints
10156 When set to 1, use expensive methods to eliminate all redundant
10157 constraints.  The default value is 0.
10159 @item vect-max-version-for-alignment-checks
10160 The maximum number of run-time checks that can be performed when
10161 doing loop versioning for alignment in the vectorizer.
10163 @item vect-max-version-for-alias-checks
10164 The maximum number of run-time checks that can be performed when
10165 doing loop versioning for alias in the vectorizer.
10167 @item vect-max-peeling-for-alignment
10168 The maximum number of loop peels to enhance access alignment
10169 for vectorizer. Value -1 means 'no limit'.
10171 @item max-iterations-to-track
10172 The maximum number of iterations of a loop the brute-force algorithm
10173 for analysis of the number of iterations of the loop tries to evaluate.
10175 @item hot-bb-count-ws-permille
10176 A basic block profile count is considered hot if it contributes to 
10177 the given permillage (i.e. 0...1000) of the entire profiled execution.
10179 @item hot-bb-frequency-fraction
10180 Select fraction of the entry block frequency of executions of basic block in
10181 function given basic block needs to have to be considered hot.
10183 @item max-predicted-iterations
10184 The maximum number of loop iterations we predict statically.  This is useful
10185 in cases where a function contains a single loop with known bound and
10186 another loop with unknown bound.
10187 The known number of iterations is predicted correctly, while
10188 the unknown number of iterations average to roughly 10.  This means that the
10189 loop without bounds appears artificially cold relative to the other one.
10191 @item builtin-expect-probability
10192 Control the probability of the expression having the specified value. This
10193 parameter takes a percentage (i.e. 0 ... 100) as input.
10194 The default probability of 90 is obtained empirically.
10196 @item align-threshold
10198 Select fraction of the maximal frequency of executions of a basic block in
10199 a function to align the basic block.
10201 @item align-loop-iterations
10203 A loop expected to iterate at least the selected number of iterations is
10204 aligned.
10206 @item tracer-dynamic-coverage
10207 @itemx tracer-dynamic-coverage-feedback
10209 This value is used to limit superblock formation once the given percentage of
10210 executed instructions is covered.  This limits unnecessary code size
10211 expansion.
10213 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10214 feedback is available.  The real profiles (as opposed to statically estimated
10215 ones) are much less balanced allowing the threshold to be larger value.
10217 @item tracer-max-code-growth
10218 Stop tail duplication once code growth has reached given percentage.  This is
10219 a rather artificial limit, as most of the duplicates are eliminated later in
10220 cross jumping, so it may be set to much higher values than is the desired code
10221 growth.
10223 @item tracer-min-branch-ratio
10225 Stop reverse growth when the reverse probability of best edge is less than this
10226 threshold (in percent).
10228 @item tracer-min-branch-ratio
10229 @itemx tracer-min-branch-ratio-feedback
10231 Stop forward growth if the best edge has probability lower than this
10232 threshold.
10234 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10235 compilation for profile feedback and one for compilation without.  The value
10236 for compilation with profile feedback needs to be more conservative (higher) in
10237 order to make tracer effective.
10239 @item max-cse-path-length
10241 The maximum number of basic blocks on path that CSE considers.
10242 The default is 10.
10244 @item max-cse-insns
10245 The maximum number of instructions CSE processes before flushing.
10246 The default is 1000.
10248 @item ggc-min-expand
10250 GCC uses a garbage collector to manage its own memory allocation.  This
10251 parameter specifies the minimum percentage by which the garbage
10252 collector's heap should be allowed to expand between collections.
10253 Tuning this may improve compilation speed; it has no effect on code
10254 generation.
10256 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10257 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10258 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10259 GCC is not able to calculate RAM on a particular platform, the lower
10260 bound of 30% is used.  Setting this parameter and
10261 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10262 every opportunity.  This is extremely slow, but can be useful for
10263 debugging.
10265 @item ggc-min-heapsize
10267 Minimum size of the garbage collector's heap before it begins bothering
10268 to collect garbage.  The first collection occurs after the heap expands
10269 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10270 tuning this may improve compilation speed, and has no effect on code
10271 generation.
10273 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10274 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10275 with a lower bound of 4096 (four megabytes) and an upper bound of
10276 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10277 particular platform, the lower bound is used.  Setting this parameter
10278 very large effectively disables garbage collection.  Setting this
10279 parameter and @option{ggc-min-expand} to zero causes a full collection
10280 to occur at every opportunity.
10282 @item max-reload-search-insns
10283 The maximum number of instruction reload should look backward for equivalent
10284 register.  Increasing values mean more aggressive optimization, making the
10285 compilation time increase with probably slightly better performance.
10286 The default value is 100.
10288 @item max-cselib-memory-locations
10289 The maximum number of memory locations cselib should take into account.
10290 Increasing values mean more aggressive optimization, making the compilation time
10291 increase with probably slightly better performance.  The default value is 500.
10293 @item reorder-blocks-duplicate
10294 @itemx reorder-blocks-duplicate-feedback
10296 Used by the basic block reordering pass to decide whether to use unconditional
10297 branch or duplicate the code on its destination.  Code is duplicated when its
10298 estimated size is smaller than this value multiplied by the estimated size of
10299 unconditional jump in the hot spots of the program.
10301 The @option{reorder-block-duplicate-feedback} is used only when profile
10302 feedback is available.  It may be set to higher values than
10303 @option{reorder-block-duplicate} since information about the hot spots is more
10304 accurate.
10306 @item max-sched-ready-insns
10307 The maximum number of instructions ready to be issued the scheduler should
10308 consider at any given time during the first scheduling pass.  Increasing
10309 values mean more thorough searches, making the compilation time increase
10310 with probably little benefit.  The default value is 100.
10312 @item max-sched-region-blocks
10313 The maximum number of blocks in a region to be considered for
10314 interblock scheduling.  The default value is 10.
10316 @item max-pipeline-region-blocks
10317 The maximum number of blocks in a region to be considered for
10318 pipelining in the selective scheduler.  The default value is 15.
10320 @item max-sched-region-insns
10321 The maximum number of insns in a region to be considered for
10322 interblock scheduling.  The default value is 100.
10324 @item max-pipeline-region-insns
10325 The maximum number of insns in a region to be considered for
10326 pipelining in the selective scheduler.  The default value is 200.
10328 @item min-spec-prob
10329 The minimum probability (in percents) of reaching a source block
10330 for interblock speculative scheduling.  The default value is 40.
10332 @item max-sched-extend-regions-iters
10333 The maximum number of iterations through CFG to extend regions.
10334 A value of 0 (the default) disables region extensions.
10336 @item max-sched-insn-conflict-delay
10337 The maximum conflict delay for an insn to be considered for speculative motion.
10338 The default value is 3.
10340 @item sched-spec-prob-cutoff
10341 The minimal probability of speculation success (in percents), so that
10342 speculative insns are scheduled.
10343 The default value is 40.
10345 @item sched-spec-state-edge-prob-cutoff
10346 The minimum probability an edge must have for the scheduler to save its
10347 state across it.
10348 The default value is 10.
10350 @item sched-mem-true-dep-cost
10351 Minimal distance (in CPU cycles) between store and load targeting same
10352 memory locations.  The default value is 1.
10354 @item selsched-max-lookahead
10355 The maximum size of the lookahead window of selective scheduling.  It is a
10356 depth of search for available instructions.
10357 The default value is 50.
10359 @item selsched-max-sched-times
10360 The maximum number of times that an instruction is scheduled during
10361 selective scheduling.  This is the limit on the number of iterations
10362 through which the instruction may be pipelined.  The default value is 2.
10364 @item selsched-max-insns-to-rename
10365 The maximum number of best instructions in the ready list that are considered
10366 for renaming in the selective scheduler.  The default value is 2.
10368 @item sms-min-sc
10369 The minimum value of stage count that swing modulo scheduler
10370 generates.  The default value is 2.
10372 @item max-last-value-rtl
10373 The maximum size measured as number of RTLs that can be recorded in an expression
10374 in combiner for a pseudo register as last known value of that register.  The default
10375 is 10000.
10377 @item max-combine-insns
10378 The maximum number of instructions the RTL combiner tries to combine.
10379 The default value is 2 at @option{-Og} and 4 otherwise.
10381 @item integer-share-limit
10382 Small integer constants can use a shared data structure, reducing the
10383 compiler's memory usage and increasing its speed.  This sets the maximum
10384 value of a shared integer constant.  The default value is 256.
10386 @item ssp-buffer-size
10387 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10388 protection when @option{-fstack-protection} is used.
10390 @item min-size-for-stack-sharing
10391 The minimum size of variables taking part in stack slot sharing when not
10392 optimizing. The default value is 32.
10394 @item max-jump-thread-duplication-stmts
10395 Maximum number of statements allowed in a block that needs to be
10396 duplicated when threading jumps.
10398 @item max-fields-for-field-sensitive
10399 Maximum number of fields in a structure treated in
10400 a field sensitive manner during pointer analysis.  The default is zero
10401 for @option{-O0} and @option{-O1},
10402 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10404 @item prefetch-latency
10405 Estimate on average number of instructions that are executed before
10406 prefetch finishes.  The distance prefetched ahead is proportional
10407 to this constant.  Increasing this number may also lead to less
10408 streams being prefetched (see @option{simultaneous-prefetches}).
10410 @item simultaneous-prefetches
10411 Maximum number of prefetches that can run at the same time.
10413 @item l1-cache-line-size
10414 The size of cache line in L1 cache, in bytes.
10416 @item l1-cache-size
10417 The size of L1 cache, in kilobytes.
10419 @item l2-cache-size
10420 The size of L2 cache, in kilobytes.
10422 @item min-insn-to-prefetch-ratio
10423 The minimum ratio between the number of instructions and the
10424 number of prefetches to enable prefetching in a loop.
10426 @item prefetch-min-insn-to-mem-ratio
10427 The minimum ratio between the number of instructions and the
10428 number of memory references to enable prefetching in a loop.
10430 @item use-canonical-types
10431 Whether the compiler should use the ``canonical'' type system.  By
10432 default, this should always be 1, which uses a more efficient internal
10433 mechanism for comparing types in C++ and Objective-C++.  However, if
10434 bugs in the canonical type system are causing compilation failures,
10435 set this value to 0 to disable canonical types.
10437 @item switch-conversion-max-branch-ratio
10438 Switch initialization conversion refuses to create arrays that are
10439 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10440 branches in the switch.
10442 @item max-partial-antic-length
10443 Maximum length of the partial antic set computed during the tree
10444 partial redundancy elimination optimization (@option{-ftree-pre}) when
10445 optimizing at @option{-O3} and above.  For some sorts of source code
10446 the enhanced partial redundancy elimination optimization can run away,
10447 consuming all of the memory available on the host machine.  This
10448 parameter sets a limit on the length of the sets that are computed,
10449 which prevents the runaway behavior.  Setting a value of 0 for
10450 this parameter allows an unlimited set length.
10452 @item sccvn-max-scc-size
10453 Maximum size of a strongly connected component (SCC) during SCCVN
10454 processing.  If this limit is hit, SCCVN processing for the whole
10455 function is not done and optimizations depending on it are
10456 disabled.  The default maximum SCC size is 10000.
10458 @item sccvn-max-alias-queries-per-access
10459 Maximum number of alias-oracle queries we perform when looking for
10460 redundancies for loads and stores.  If this limit is hit the search
10461 is aborted and the load or store is not considered redundant.  The
10462 number of queries is algorithmically limited to the number of
10463 stores on all paths from the load to the function entry.
10464 The default maxmimum number of queries is 1000.
10466 @item ira-max-loops-num
10467 IRA uses regional register allocation by default.  If a function
10468 contains more loops than the number given by this parameter, only at most
10469 the given number of the most frequently-executed loops form regions
10470 for regional register allocation.  The default value of the
10471 parameter is 100.
10473 @item ira-max-conflict-table-size 
10474 Although IRA uses a sophisticated algorithm to compress the conflict
10475 table, the table can still require excessive amounts of memory for
10476 huge functions.  If the conflict table for a function could be more
10477 than the size in MB given by this parameter, the register allocator
10478 instead uses a faster, simpler, and lower-quality
10479 algorithm that does not require building a pseudo-register conflict table.  
10480 The default value of the parameter is 2000.
10482 @item ira-loop-reserved-regs
10483 IRA can be used to evaluate more accurate register pressure in loops
10484 for decisions to move loop invariants (see @option{-O3}).  The number
10485 of available registers reserved for some other purposes is given
10486 by this parameter.  The default value of the parameter is 2, which is
10487 the minimal number of registers needed by typical instructions.
10488 This value is the best found from numerous experiments.
10490 @item loop-invariant-max-bbs-in-loop
10491 Loop invariant motion can be very expensive, both in compilation time and
10492 in amount of needed compile-time memory, with very large loops.  Loops
10493 with more basic blocks than this parameter won't have loop invariant
10494 motion optimization performed on them.  The default value of the
10495 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10497 @item loop-max-datarefs-for-datadeps
10498 Building data dapendencies is expensive for very large loops.  This
10499 parameter limits the number of data references in loops that are
10500 considered for data dependence analysis.  These large loops are no
10501 handled by the optimizations using loop data dependencies.
10502 The default value is 1000.
10504 @item max-vartrack-size
10505 Sets a maximum number of hash table slots to use during variable
10506 tracking dataflow analysis of any function.  If this limit is exceeded
10507 with variable tracking at assignments enabled, analysis for that
10508 function is retried without it, after removing all debug insns from
10509 the function.  If the limit is exceeded even without debug insns, var
10510 tracking analysis is completely disabled for the function.  Setting
10511 the parameter to zero makes it unlimited.
10513 @item max-vartrack-expr-depth
10514 Sets a maximum number of recursion levels when attempting to map
10515 variable names or debug temporaries to value expressions.  This trades
10516 compilation time for more complete debug information.  If this is set too
10517 low, value expressions that are available and could be represented in
10518 debug information may end up not being used; setting this higher may
10519 enable the compiler to find more complex debug expressions, but compile
10520 time and memory use may grow.  The default is 12.
10522 @item min-nondebug-insn-uid
10523 Use uids starting at this parameter for nondebug insns.  The range below
10524 the parameter is reserved exclusively for debug insns created by
10525 @option{-fvar-tracking-assignments}, but debug insns may get
10526 (non-overlapping) uids above it if the reserved range is exhausted.
10528 @item ipa-sra-ptr-growth-factor
10529 IPA-SRA replaces a pointer to an aggregate with one or more new
10530 parameters only when their cumulative size is less or equal to
10531 @option{ipa-sra-ptr-growth-factor} times the size of the original
10532 pointer parameter.
10534 @item sra-max-scalarization-size-Ospeed
10535 @item sra-max-scalarization-size-Osize
10536 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10537 replace scalar parts of aggregates with uses of independent scalar
10538 variables.  These parameters control the maximum size, in storage units,
10539 of aggregate which will be considered for replacement when compiling for
10540 speed
10541 (@option{sra-max-scalarization-size-Ospeed}) or size
10542 (@option{sra-max-scalarization-size-Osize}) respectively.
10544 @item tm-max-aggregate-size
10545 When making copies of thread-local variables in a transaction, this
10546 parameter specifies the size in bytes after which variables are
10547 saved with the logging functions as opposed to save/restore code
10548 sequence pairs.  This option only applies when using
10549 @option{-fgnu-tm}.
10551 @item graphite-max-nb-scop-params
10552 To avoid exponential effects in the Graphite loop transforms, the
10553 number of parameters in a Static Control Part (SCoP) is bounded.  The
10554 default value is 10 parameters.  A variable whose value is unknown at
10555 compilation time and defined outside a SCoP is a parameter of the SCoP.
10557 @item graphite-max-bbs-per-function
10558 To avoid exponential effects in the detection of SCoPs, the size of
10559 the functions analyzed by Graphite is bounded.  The default value is
10560 100 basic blocks.
10562 @item loop-block-tile-size
10563 Loop blocking or strip mining transforms, enabled with
10564 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10565 loop in the loop nest by a given number of iterations.  The strip
10566 length can be changed using the @option{loop-block-tile-size}
10567 parameter.  The default value is 51 iterations.
10569 @item loop-unroll-jam-size
10570 Specify the unroll factor for the @option{-floop-unroll-and-jam}.  The 
10571 default value is 4.
10573 @item loop-unroll-jam-depth
10574 Specify the dimension to be unrolled (counting from the most inner loop)
10575 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10577 @item ipa-cp-value-list-size
10578 IPA-CP attempts to track all possible values and types passed to a function's
10579 parameter in order to propagate them and perform devirtualization.
10580 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10581 stores per one formal parameter of a function.
10583 @item ipa-cp-eval-threshold
10584 IPA-CP calculates its own score of cloning profitability heuristics
10585 and performs those cloning opportunities with scores that exceed
10586 @option{ipa-cp-eval-threshold}.
10588 @item ipa-max-agg-items
10589 IPA-CP is also capable to propagate a number of scalar values passed
10590 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10591 number of such values per one parameter.
10593 @item ipa-cp-loop-hint-bonus
10594 When IPA-CP determines that a cloning candidate would make the number
10595 of iterations of a loop known, it adds a bonus of
10596 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10597 the candidate.
10599 @item ipa-cp-array-index-hint-bonus
10600 When IPA-CP determines that a cloning candidate would make the index of
10601 an array access known, it adds a bonus of
10602 @option{ipa-cp-array-index-hint-bonus} to the profitability
10603 score of the candidate.
10605 @item ipa-max-aa-steps
10606 During its analysis of function bodies, IPA-CP employs alias analysis
10607 in order to track values pointed to by function parameters.  In order
10608 not spend too much time analyzing huge functions, it will give up and
10609 consider all memory clobbered after examining
10610 @option{ipa-max-aa-steps} statements modifying memory.
10612 @item lto-partitions
10613 Specify desired number of partitions produced during WHOPR compilation.
10614 The number of partitions should exceed the number of CPUs used for compilation.
10615 The default value is 32.
10617 @item lto-minpartition
10618 Size of minimal partition for WHOPR (in estimated instructions).
10619 This prevents expenses of splitting very small programs into too many
10620 partitions.
10622 @item cxx-max-namespaces-for-diagnostic-help
10623 The maximum number of namespaces to consult for suggestions when C++
10624 name lookup fails for an identifier.  The default is 1000.
10626 @item sink-frequency-threshold
10627 The maximum relative execution frequency (in percents) of the target block
10628 relative to a statement's original block to allow statement sinking of a
10629 statement.  Larger numbers result in more aggressive statement sinking.
10630 The default value is 75.  A small positive adjustment is applied for
10631 statements with memory operands as those are even more profitable so sink.
10633 @item max-stores-to-sink
10634 The maximum number of conditional stores paires that can be sunk.  Set to 0
10635 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10636 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10638 @item allow-store-data-races
10639 Allow optimizers to introduce new data races on stores.
10640 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10641 at optimization level @option{-Ofast}.
10643 @item case-values-threshold
10644 The smallest number of different values for which it is best to use a
10645 jump-table instead of a tree of conditional branches.  If the value is
10646 0, use the default for the machine.  The default is 0.
10648 @item tree-reassoc-width
10649 Set the maximum number of instructions executed in parallel in
10650 reassociated tree. This parameter overrides target dependent
10651 heuristics used by default if has non zero value.
10653 @item sched-pressure-algorithm
10654 Choose between the two available implementations of
10655 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10656 and is the more likely to prevent instructions from being reordered.
10657 Algorithm 2 was designed to be a compromise between the relatively
10658 conservative approach taken by algorithm 1 and the rather aggressive
10659 approach taken by the default scheduler.  It relies more heavily on
10660 having a regular register file and accurate register pressure classes.
10661 See @file{haifa-sched.c} in the GCC sources for more details.
10663 The default choice depends on the target.
10665 @item max-slsr-cand-scan
10666 Set the maximum number of existing candidates that will be considered when
10667 seeking a basis for a new straight-line strength reduction candidate.
10669 @item asan-globals
10670 Enable buffer overflow detection for global objects.  This kind
10671 of protection is enabled by default if you are using
10672 @option{-fsanitize=address} option.
10673 To disable global objects protection use @option{--param asan-globals=0}.
10675 @item asan-stack
10676 Enable buffer overflow detection for stack objects.  This kind of
10677 protection is enabled by default when using@option{-fsanitize=address}.
10678 To disable stack protection use @option{--param asan-stack=0} option.
10680 @item asan-instrument-reads
10681 Enable buffer overflow detection for memory reads.  This kind of
10682 protection is enabled by default when using @option{-fsanitize=address}.
10683 To disable memory reads protection use
10684 @option{--param asan-instrument-reads=0}.
10686 @item asan-instrument-writes
10687 Enable buffer overflow detection for memory writes.  This kind of
10688 protection is enabled by default when using @option{-fsanitize=address}.
10689 To disable memory writes protection use
10690 @option{--param asan-instrument-writes=0} option.
10692 @item asan-memintrin
10693 Enable detection for built-in functions.  This kind of protection
10694 is enabled by default when using @option{-fsanitize=address}.
10695 To disable built-in functions protection use
10696 @option{--param asan-memintrin=0}.
10698 @item asan-use-after-return
10699 Enable detection of use-after-return.  This kind of protection
10700 is enabled by default when using @option{-fsanitize=address} option.
10701 To disable use-after-return detection use 
10702 @option{--param asan-use-after-return=0}.
10704 @item asan-instrumentation-with-call-threshold
10705 If number of memory accesses in function being instrumented
10706 is greater or equal to this number, use callbacks instead of inline checks.
10707 E.g. to disable inline code use
10708 @option{--param asan-instrumentation-with-call-threshold=0}.
10710 @item chkp-max-ctor-size
10711 Static constructors generated by Pointer Bounds Checker may become very
10712 large and significantly increase compile time at optimization level
10713 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10714 in a single generated constructor.  Default value is 5000.
10716 @item max-fsm-thread-path-insns
10717 Maximum number of instructions to copy when duplicating blocks on a
10718 finite state automaton jump thread path.  The default is 100.
10720 @item max-fsm-thread-length
10721 Maximum number of basic blocks on a finite state automaton jump thread
10722 path.  The default is 10.
10724 @item max-fsm-thread-paths
10725 Maximum number of new jump thread paths to create for a finite state
10726 automaton.  The default is 50.
10728 @end table
10729 @end table
10731 @node Preprocessor Options
10732 @section Options Controlling the Preprocessor
10733 @cindex preprocessor options
10734 @cindex options, preprocessor
10736 These options control the C preprocessor, which is run on each C source
10737 file before actual compilation.
10739 If you use the @option{-E} option, nothing is done except preprocessing.
10740 Some of these options make sense only together with @option{-E} because
10741 they cause the preprocessor output to be unsuitable for actual
10742 compilation.
10744 @table @gcctabopt
10745 @item -Wp,@var{option}
10746 @opindex Wp
10747 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10748 and pass @var{option} directly through to the preprocessor.  If
10749 @var{option} contains commas, it is split into multiple options at the
10750 commas.  However, many options are modified, translated or interpreted
10751 by the compiler driver before being passed to the preprocessor, and
10752 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10753 interface is undocumented and subject to change, so whenever possible
10754 you should avoid using @option{-Wp} and let the driver handle the
10755 options instead.
10757 @item -Xpreprocessor @var{option}
10758 @opindex Xpreprocessor
10759 Pass @var{option} as an option to the preprocessor.  You can use this to
10760 supply system-specific preprocessor options that GCC does not 
10761 recognize.
10763 If you want to pass an option that takes an argument, you must use
10764 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10766 @item -no-integrated-cpp
10767 @opindex no-integrated-cpp
10768 Perform preprocessing as a separate pass before compilation.
10769 By default, GCC performs preprocessing as an integrated part of
10770 input tokenization and parsing.
10771 If this option is provided, the appropriate language front end
10772 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10773 and Objective-C, respectively) is instead invoked twice,
10774 once for preprocessing only and once for actual compilation
10775 of the preprocessed input.
10776 This option may be useful in conjunction with the @option{-B} or
10777 @option{-wrapper} options to specify an alternate preprocessor or
10778 perform additional processing of the program source between
10779 normal preprocessing and compilation.
10780 @end table
10782 @include cppopts.texi
10784 @node Assembler Options
10785 @section Passing Options to the Assembler
10787 @c prevent bad page break with this line
10788 You can pass options to the assembler.
10790 @table @gcctabopt
10791 @item -Wa,@var{option}
10792 @opindex Wa
10793 Pass @var{option} as an option to the assembler.  If @var{option}
10794 contains commas, it is split into multiple options at the commas.
10796 @item -Xassembler @var{option}
10797 @opindex Xassembler
10798 Pass @var{option} as an option to the assembler.  You can use this to
10799 supply system-specific assembler options that GCC does not
10800 recognize.
10802 If you want to pass an option that takes an argument, you must use
10803 @option{-Xassembler} twice, once for the option and once for the argument.
10805 @end table
10807 @node Link Options
10808 @section Options for Linking
10809 @cindex link options
10810 @cindex options, linking
10812 These options come into play when the compiler links object files into
10813 an executable output file.  They are meaningless if the compiler is
10814 not doing a link step.
10816 @table @gcctabopt
10817 @cindex file names
10818 @item @var{object-file-name}
10819 A file name that does not end in a special recognized suffix is
10820 considered to name an object file or library.  (Object files are
10821 distinguished from libraries by the linker according to the file
10822 contents.)  If linking is done, these object files are used as input
10823 to the linker.
10825 @item -c
10826 @itemx -S
10827 @itemx -E
10828 @opindex c
10829 @opindex S
10830 @opindex E
10831 If any of these options is used, then the linker is not run, and
10832 object file names should not be used as arguments.  @xref{Overall
10833 Options}.
10835 @cindex Libraries
10836 @item -l@var{library}
10837 @itemx -l @var{library}
10838 @opindex l
10839 Search the library named @var{library} when linking.  (The second
10840 alternative with the library as a separate argument is only for
10841 POSIX compliance and is not recommended.)
10843 It makes a difference where in the command you write this option; the
10844 linker searches and processes libraries and object files in the order they
10845 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10846 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10847 to functions in @samp{z}, those functions may not be loaded.
10849 The linker searches a standard list of directories for the library,
10850 which is actually a file named @file{lib@var{library}.a}.  The linker
10851 then uses this file as if it had been specified precisely by name.
10853 The directories searched include several standard system directories
10854 plus any that you specify with @option{-L}.
10856 Normally the files found this way are library files---archive files
10857 whose members are object files.  The linker handles an archive file by
10858 scanning through it for members which define symbols that have so far
10859 been referenced but not defined.  But if the file that is found is an
10860 ordinary object file, it is linked in the usual fashion.  The only
10861 difference between using an @option{-l} option and specifying a file name
10862 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10863 and searches several directories.
10865 @item -lobjc
10866 @opindex lobjc
10867 You need this special case of the @option{-l} option in order to
10868 link an Objective-C or Objective-C++ program.
10870 @item -nostartfiles
10871 @opindex nostartfiles
10872 Do not use the standard system startup files when linking.
10873 The standard system libraries are used normally, unless @option{-nostdlib}
10874 or @option{-nodefaultlibs} is used.
10876 @item -nodefaultlibs
10877 @opindex nodefaultlibs
10878 Do not use the standard system libraries when linking.
10879 Only the libraries you specify are passed to the linker, and options
10880 specifying linkage of the system libraries, such as @code{-static-libgcc}
10881 or @code{-shared-libgcc}, are ignored.  
10882 The standard startup files are used normally, unless @option{-nostartfiles}
10883 is used.  
10885 The compiler may generate calls to @code{memcmp},
10886 @code{memset}, @code{memcpy} and @code{memmove}.
10887 These entries are usually resolved by entries in
10888 libc.  These entry points should be supplied through some other
10889 mechanism when this option is specified.
10891 @item -nostdlib
10892 @opindex nostdlib
10893 Do not use the standard system startup files or libraries when linking.
10894 No startup files and only the libraries you specify are passed to
10895 the linker, and options specifying linkage of the system libraries, such as
10896 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10898 The compiler may generate calls to @code{memcmp}, @code{memset},
10899 @code{memcpy} and @code{memmove}.
10900 These entries are usually resolved by entries in
10901 libc.  These entry points should be supplied through some other
10902 mechanism when this option is specified.
10904 @cindex @option{-lgcc}, use with @option{-nostdlib}
10905 @cindex @option{-nostdlib} and unresolved references
10906 @cindex unresolved references and @option{-nostdlib}
10907 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10908 @cindex @option{-nodefaultlibs} and unresolved references
10909 @cindex unresolved references and @option{-nodefaultlibs}
10910 One of the standard libraries bypassed by @option{-nostdlib} and
10911 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10912 which GCC uses to overcome shortcomings of particular machines, or special
10913 needs for some languages.
10914 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10915 Collection (GCC) Internals},
10916 for more discussion of @file{libgcc.a}.)
10917 In most cases, you need @file{libgcc.a} even when you want to avoid
10918 other standard libraries.  In other words, when you specify @option{-nostdlib}
10919 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10920 This ensures that you have no unresolved references to internal GCC
10921 library subroutines.
10922 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10923 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10924 GNU Compiler Collection (GCC) Internals}.)
10926 @item -pie
10927 @opindex pie
10928 Produce a position independent executable on targets that support it.
10929 For predictable results, you must also specify the same set of options
10930 used for compilation (@option{-fpie}, @option{-fPIE},
10931 or model suboptions) when you specify this linker option.
10933 @item -rdynamic
10934 @opindex rdynamic
10935 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10936 that support it. This instructs the linker to add all symbols, not
10937 only used ones, to the dynamic symbol table. This option is needed
10938 for some uses of @code{dlopen} or to allow obtaining backtraces
10939 from within a program.
10941 @item -s
10942 @opindex s
10943 Remove all symbol table and relocation information from the executable.
10945 @item -static
10946 @opindex static
10947 On systems that support dynamic linking, this prevents linking with the shared
10948 libraries.  On other systems, this option has no effect.
10950 @item -shared
10951 @opindex shared
10952 Produce a shared object which can then be linked with other objects to
10953 form an executable.  Not all systems support this option.  For predictable
10954 results, you must also specify the same set of options used for compilation
10955 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10956 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10957 needs to build supplementary stub code for constructors to work.  On
10958 multi-libbed systems, @samp{gcc -shared} must select the correct support
10959 libraries to link against.  Failing to supply the correct flags may lead
10960 to subtle defects.  Supplying them in cases where they are not necessary
10961 is innocuous.}
10963 @item -shared-libgcc
10964 @itemx -static-libgcc
10965 @opindex shared-libgcc
10966 @opindex static-libgcc
10967 On systems that provide @file{libgcc} as a shared library, these options
10968 force the use of either the shared or static version, respectively.
10969 If no shared version of @file{libgcc} was built when the compiler was
10970 configured, these options have no effect.
10972 There are several situations in which an application should use the
10973 shared @file{libgcc} instead of the static version.  The most common
10974 of these is when the application wishes to throw and catch exceptions
10975 across different shared libraries.  In that case, each of the libraries
10976 as well as the application itself should use the shared @file{libgcc}.
10978 Therefore, the G++ and GCJ drivers automatically add
10979 @option{-shared-libgcc} whenever you build a shared library or a main
10980 executable, because C++ and Java programs typically use exceptions, so
10981 this is the right thing to do.
10983 If, instead, you use the GCC driver to create shared libraries, you may
10984 find that they are not always linked with the shared @file{libgcc}.
10985 If GCC finds, at its configuration time, that you have a non-GNU linker
10986 or a GNU linker that does not support option @option{--eh-frame-hdr},
10987 it links the shared version of @file{libgcc} into shared libraries
10988 by default.  Otherwise, it takes advantage of the linker and optimizes
10989 away the linking with the shared version of @file{libgcc}, linking with
10990 the static version of libgcc by default.  This allows exceptions to
10991 propagate through such shared libraries, without incurring relocation
10992 costs at library load time.
10994 However, if a library or main executable is supposed to throw or catch
10995 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10996 for the languages used in the program, or using the option
10997 @option{-shared-libgcc}, such that it is linked with the shared
10998 @file{libgcc}.
11000 @item -static-libasan
11001 @opindex static-libasan
11002 When the @option{-fsanitize=address} option is used to link a program,
11003 the GCC driver automatically links against @option{libasan}.  If
11004 @file{libasan} is available as a shared library, and the @option{-static}
11005 option is not used, then this links against the shared version of
11006 @file{libasan}.  The @option{-static-libasan} option directs the GCC
11007 driver to link @file{libasan} statically, without necessarily linking
11008 other libraries statically.
11010 @item -static-libtsan
11011 @opindex static-libtsan
11012 When the @option{-fsanitize=thread} option is used to link a program,
11013 the GCC driver automatically links against @option{libtsan}.  If
11014 @file{libtsan} is available as a shared library, and the @option{-static}
11015 option is not used, then this links against the shared version of
11016 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
11017 driver to link @file{libtsan} statically, without necessarily linking
11018 other libraries statically.
11020 @item -static-liblsan
11021 @opindex static-liblsan
11022 When the @option{-fsanitize=leak} option is used to link a program,
11023 the GCC driver automatically links against @option{liblsan}.  If
11024 @file{liblsan} is available as a shared library, and the @option{-static}
11025 option is not used, then this links against the shared version of
11026 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11027 driver to link @file{liblsan} statically, without necessarily linking
11028 other libraries statically.
11030 @item -static-libubsan
11031 @opindex static-libubsan
11032 When the @option{-fsanitize=undefined} option is used to link a program,
11033 the GCC driver automatically links against @option{libubsan}.  If
11034 @file{libubsan} is available as a shared library, and the @option{-static}
11035 option is not used, then this links against the shared version of
11036 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11037 driver to link @file{libubsan} statically, without necessarily linking
11038 other libraries statically.
11040 @item -static-libstdc++
11041 @opindex static-libstdc++
11042 When the @command{g++} program is used to link a C++ program, it
11043 normally automatically links against @option{libstdc++}.  If
11044 @file{libstdc++} is available as a shared library, and the
11045 @option{-static} option is not used, then this links against the
11046 shared version of @file{libstdc++}.  That is normally fine.  However, it
11047 is sometimes useful to freeze the version of @file{libstdc++} used by
11048 the program without going all the way to a fully static link.  The
11049 @option{-static-libstdc++} option directs the @command{g++} driver to
11050 link @file{libstdc++} statically, without necessarily linking other
11051 libraries statically.
11053 @item -symbolic
11054 @opindex symbolic
11055 Bind references to global symbols when building a shared object.  Warn
11056 about any unresolved references (unless overridden by the link editor
11057 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11058 this option.
11060 @item -T @var{script}
11061 @opindex T
11062 @cindex linker script
11063 Use @var{script} as the linker script.  This option is supported by most
11064 systems using the GNU linker.  On some targets, such as bare-board
11065 targets without an operating system, the @option{-T} option may be required
11066 when linking to avoid references to undefined symbols.
11068 @item -Xlinker @var{option}
11069 @opindex Xlinker
11070 Pass @var{option} as an option to the linker.  You can use this to
11071 supply system-specific linker options that GCC does not recognize.
11073 If you want to pass an option that takes a separate argument, you must use
11074 @option{-Xlinker} twice, once for the option and once for the argument.
11075 For example, to pass @option{-assert definitions}, you must write
11076 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11077 @option{-Xlinker "-assert definitions"}, because this passes the entire
11078 string as a single argument, which is not what the linker expects.
11080 When using the GNU linker, it is usually more convenient to pass
11081 arguments to linker options using the @option{@var{option}=@var{value}}
11082 syntax than as separate arguments.  For example, you can specify
11083 @option{-Xlinker -Map=output.map} rather than
11084 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11085 this syntax for command-line options.
11087 @item -Wl,@var{option}
11088 @opindex Wl
11089 Pass @var{option} as an option to the linker.  If @var{option} contains
11090 commas, it is split into multiple options at the commas.  You can use this
11091 syntax to pass an argument to the option.
11092 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11093 linker.  When using the GNU linker, you can also get the same effect with
11094 @option{-Wl,-Map=output.map}.
11096 @item -u @var{symbol}
11097 @opindex u
11098 Pretend the symbol @var{symbol} is undefined, to force linking of
11099 library modules to define it.  You can use @option{-u} multiple times with
11100 different symbols to force loading of additional library modules.
11102 @item -z @var{keyword}
11103 @opindex z
11104 @option{-z} is passed directly on to the linker along with the keyword
11105 @var{keyword}. See the section in the documentation of your linker for
11106 permitted values and their meanings.
11107 @end table
11109 @node Directory Options
11110 @section Options for Directory Search
11111 @cindex directory options
11112 @cindex options, directory search
11113 @cindex search path
11115 These options specify directories to search for header files, for
11116 libraries and for parts of the compiler:
11118 @table @gcctabopt
11119 @item -I@var{dir}
11120 @opindex I
11121 Add the directory @var{dir} to the head of the list of directories to be
11122 searched for header files.  This can be used to override a system header
11123 file, substituting your own version, since these directories are
11124 searched before the system header file directories.  However, you should
11125 not use this option to add directories that contain vendor-supplied
11126 system header files (use @option{-isystem} for that).  If you use more than
11127 one @option{-I} option, the directories are scanned in left-to-right
11128 order; the standard system directories come after.
11130 If a standard system include directory, or a directory specified with
11131 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11132 option is ignored.  The directory is still searched but as a
11133 system directory at its normal position in the system include chain.
11134 This is to ensure that GCC's procedure to fix buggy system headers and
11135 the ordering for the @code{include_next} directive are not inadvertently changed.
11136 If you really need to change the search order for system directories,
11137 use the @option{-nostdinc} and/or @option{-isystem} options.
11139 @item -iplugindir=@var{dir}
11140 @opindex iplugindir=
11141 Set the directory to search for plugins that are passed
11142 by @option{-fplugin=@var{name}} instead of
11143 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11144 to be used by the user, but only passed by the driver.
11146 @item -iquote@var{dir}
11147 @opindex iquote
11148 Add the directory @var{dir} to the head of the list of directories to
11149 be searched for header files only for the case of @samp{#include
11150 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
11151 otherwise just like @option{-I}.
11153 @item -L@var{dir}
11154 @opindex L
11155 Add directory @var{dir} to the list of directories to be searched
11156 for @option{-l}.
11158 @item -B@var{prefix}
11159 @opindex B
11160 This option specifies where to find the executables, libraries,
11161 include files, and data files of the compiler itself.
11163 The compiler driver program runs one or more of the subprograms
11164 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11165 @var{prefix} as a prefix for each program it tries to run, both with and
11166 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11168 For each subprogram to be run, the compiler driver first tries the
11169 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11170 is not specified, the driver tries two standard prefixes, 
11171 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11172 those results in a file name that is found, the unmodified program
11173 name is searched for using the directories specified in your
11174 @env{PATH} environment variable.
11176 The compiler checks to see if the path provided by the @option{-B}
11177 refers to a directory, and if necessary it adds a directory
11178 separator character at the end of the path.
11180 @option{-B} prefixes that effectively specify directory names also apply
11181 to libraries in the linker, because the compiler translates these
11182 options into @option{-L} options for the linker.  They also apply to
11183 include files in the preprocessor, because the compiler translates these
11184 options into @option{-isystem} options for the preprocessor.  In this case,
11185 the compiler appends @samp{include} to the prefix.
11187 The runtime support file @file{libgcc.a} can also be searched for using
11188 the @option{-B} prefix, if needed.  If it is not found there, the two
11189 standard prefixes above are tried, and that is all.  The file is left
11190 out of the link if it is not found by those means.
11192 Another way to specify a prefix much like the @option{-B} prefix is to use
11193 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11194 Variables}.
11196 As a special kludge, if the path provided by @option{-B} is
11197 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11198 9, then it is replaced by @file{[dir/]include}.  This is to help
11199 with boot-strapping the compiler.
11201 @item -specs=@var{file}
11202 @opindex specs
11203 Process @var{file} after the compiler reads in the standard @file{specs}
11204 file, in order to override the defaults which the @command{gcc} driver
11205 program uses when determining what switches to pass to @command{cc1},
11206 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11207 @option{-specs=@var{file}} can be specified on the command line, and they
11208 are processed in order, from left to right.
11210 @item --sysroot=@var{dir}
11211 @opindex sysroot
11212 Use @var{dir} as the logical root directory for headers and libraries.
11213 For example, if the compiler normally searches for headers in
11214 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11215 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11217 If you use both this option and the @option{-isysroot} option, then
11218 the @option{--sysroot} option applies to libraries, but the
11219 @option{-isysroot} option applies to header files.
11221 The GNU linker (beginning with version 2.16) has the necessary support
11222 for this option.  If your linker does not support this option, the
11223 header file aspect of @option{--sysroot} still works, but the
11224 library aspect does not.
11226 @item --no-sysroot-suffix
11227 @opindex no-sysroot-suffix
11228 For some targets, a suffix is added to the root directory specified
11229 with @option{--sysroot}, depending on the other options used, so that
11230 headers may for example be found in
11231 @file{@var{dir}/@var{suffix}/usr/include} instead of
11232 @file{@var{dir}/usr/include}.  This option disables the addition of
11233 such a suffix.
11235 @item -I-
11236 @opindex I-
11237 This option has been deprecated.  Please use @option{-iquote} instead for
11238 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
11239 Any directories you specify with @option{-I} options before the @option{-I-}
11240 option are searched only for the case of @samp{#include "@var{file}"};
11241 they are not searched for @samp{#include <@var{file}>}.
11243 If additional directories are specified with @option{-I} options after
11244 the @option{-I-}, these directories are searched for all @samp{#include}
11245 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11246 this way.)
11248 In addition, the @option{-I-} option inhibits the use of the current
11249 directory (where the current input file came from) as the first search
11250 directory for @samp{#include "@var{file}"}.  There is no way to
11251 override this effect of @option{-I-}.  With @option{-I.} you can specify
11252 searching the directory that is current when the compiler is
11253 invoked.  That is not exactly the same as what the preprocessor does
11254 by default, but it is often satisfactory.
11256 @option{-I-} does not inhibit the use of the standard system directories
11257 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11258 independent.
11259 @end table
11261 @c man end
11263 @node Spec Files
11264 @section Specifying subprocesses and the switches to pass to them
11265 @cindex Spec Files
11267 @command{gcc} is a driver program.  It performs its job by invoking a
11268 sequence of other programs to do the work of compiling, assembling and
11269 linking.  GCC interprets its command-line parameters and uses these to
11270 deduce which programs it should invoke, and which command-line options
11271 it ought to place on their command lines.  This behavior is controlled
11272 by @dfn{spec strings}.  In most cases there is one spec string for each
11273 program that GCC can invoke, but a few programs have multiple spec
11274 strings to control their behavior.  The spec strings built into GCC can
11275 be overridden by using the @option{-specs=} command-line switch to specify
11276 a spec file.
11278 @dfn{Spec files} are plaintext files that are used to construct spec
11279 strings.  They consist of a sequence of directives separated by blank
11280 lines.  The type of directive is determined by the first non-whitespace
11281 character on the line, which can be one of the following:
11283 @table @code
11284 @item %@var{command}
11285 Issues a @var{command} to the spec file processor.  The commands that can
11286 appear here are:
11288 @table @code
11289 @item %include <@var{file}>
11290 @cindex @code{%include}
11291 Search for @var{file} and insert its text at the current point in the
11292 specs file.
11294 @item %include_noerr <@var{file}>
11295 @cindex @code{%include_noerr}
11296 Just like @samp{%include}, but do not generate an error message if the include
11297 file cannot be found.
11299 @item %rename @var{old_name} @var{new_name}
11300 @cindex @code{%rename}
11301 Rename the spec string @var{old_name} to @var{new_name}.
11303 @end table
11305 @item *[@var{spec_name}]:
11306 This tells the compiler to create, override or delete the named spec
11307 string.  All lines after this directive up to the next directive or
11308 blank line are considered to be the text for the spec string.  If this
11309 results in an empty string then the spec is deleted.  (Or, if the
11310 spec did not exist, then nothing happens.)  Otherwise, if the spec
11311 does not currently exist a new spec is created.  If the spec does
11312 exist then its contents are overridden by the text of this
11313 directive, unless the first character of that text is the @samp{+}
11314 character, in which case the text is appended to the spec.
11316 @item [@var{suffix}]:
11317 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11318 and up to the next directive or blank line are considered to make up the
11319 spec string for the indicated suffix.  When the compiler encounters an
11320 input file with the named suffix, it processes the spec string in
11321 order to work out how to compile that file.  For example:
11323 @smallexample
11324 .ZZ:
11325 z-compile -input %i
11326 @end smallexample
11328 This says that any input file whose name ends in @samp{.ZZ} should be
11329 passed to the program @samp{z-compile}, which should be invoked with the
11330 command-line switch @option{-input} and with the result of performing the
11331 @samp{%i} substitution.  (See below.)
11333 As an alternative to providing a spec string, the text following a
11334 suffix directive can be one of the following:
11336 @table @code
11337 @item @@@var{language}
11338 This says that the suffix is an alias for a known @var{language}.  This is
11339 similar to using the @option{-x} command-line switch to GCC to specify a
11340 language explicitly.  For example:
11342 @smallexample
11343 .ZZ:
11344 @@c++
11345 @end smallexample
11347 Says that .ZZ files are, in fact, C++ source files.
11349 @item #@var{name}
11350 This causes an error messages saying:
11352 @smallexample
11353 @var{name} compiler not installed on this system.
11354 @end smallexample
11355 @end table
11357 GCC already has an extensive list of suffixes built into it.
11358 This directive adds an entry to the end of the list of suffixes, but
11359 since the list is searched from the end backwards, it is effectively
11360 possible to override earlier entries using this technique.
11362 @end table
11364 GCC has the following spec strings built into it.  Spec files can
11365 override these strings or create their own.  Note that individual
11366 targets can also add their own spec strings to this list.
11368 @smallexample
11369 asm          Options to pass to the assembler
11370 asm_final    Options to pass to the assembler post-processor
11371 cpp          Options to pass to the C preprocessor
11372 cc1          Options to pass to the C compiler
11373 cc1plus      Options to pass to the C++ compiler
11374 endfile      Object files to include at the end of the link
11375 link         Options to pass to the linker
11376 lib          Libraries to include on the command line to the linker
11377 libgcc       Decides which GCC support library to pass to the linker
11378 linker       Sets the name of the linker
11379 predefines   Defines to be passed to the C preprocessor
11380 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11381              by default
11382 startfile    Object files to include at the start of the link
11383 @end smallexample
11385 Here is a small example of a spec file:
11387 @smallexample
11388 %rename lib                 old_lib
11390 *lib:
11391 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11392 @end smallexample
11394 This example renames the spec called @samp{lib} to @samp{old_lib} and
11395 then overrides the previous definition of @samp{lib} with a new one.
11396 The new definition adds in some extra command-line options before
11397 including the text of the old definition.
11399 @dfn{Spec strings} are a list of command-line options to be passed to their
11400 corresponding program.  In addition, the spec strings can contain
11401 @samp{%}-prefixed sequences to substitute variable text or to
11402 conditionally insert text into the command line.  Using these constructs
11403 it is possible to generate quite complex command lines.
11405 Here is a table of all defined @samp{%}-sequences for spec
11406 strings.  Note that spaces are not generated automatically around the
11407 results of expanding these sequences.  Therefore you can concatenate them
11408 together or combine them with constant text in a single argument.
11410 @table @code
11411 @item %%
11412 Substitute one @samp{%} into the program name or argument.
11414 @item %i
11415 Substitute the name of the input file being processed.
11417 @item %b
11418 Substitute the basename of the input file being processed.
11419 This is the substring up to (and not including) the last period
11420 and not including the directory.
11422 @item %B
11423 This is the same as @samp{%b}, but include the file suffix (text after
11424 the last period).
11426 @item %d
11427 Marks the argument containing or following the @samp{%d} as a
11428 temporary file name, so that that file is deleted if GCC exits
11429 successfully.  Unlike @samp{%g}, this contributes no text to the
11430 argument.
11432 @item %g@var{suffix}
11433 Substitute a file name that has suffix @var{suffix} and is chosen
11434 once per compilation, and mark the argument in the same way as
11435 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11436 name is now chosen in a way that is hard to predict even when previously
11437 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11438 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11439 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11440 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11441 was simply substituted with a file name chosen once per compilation,
11442 without regard to any appended suffix (which was therefore treated
11443 just like ordinary text), making such attacks more likely to succeed.
11445 @item %u@var{suffix}
11446 Like @samp{%g}, but generates a new temporary file name
11447 each time it appears instead of once per compilation.
11449 @item %U@var{suffix}
11450 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11451 new one if there is no such last file name.  In the absence of any
11452 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11453 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11454 involves the generation of two distinct file names, one
11455 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11456 simply substituted with a file name chosen for the previous @samp{%u},
11457 without regard to any appended suffix.
11459 @item %j@var{suffix}
11460 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11461 writable, and if @option{-save-temps} is not used; 
11462 otherwise, substitute the name
11463 of a temporary file, just like @samp{%u}.  This temporary file is not
11464 meant for communication between processes, but rather as a junk
11465 disposal mechanism.
11467 @item %|@var{suffix}
11468 @itemx %m@var{suffix}
11469 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11470 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11471 all.  These are the two most common ways to instruct a program that it
11472 should read from standard input or write to standard output.  If you
11473 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11474 construct: see for example @file{f/lang-specs.h}.
11476 @item %.@var{SUFFIX}
11477 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11478 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11479 terminated by the next space or %.
11481 @item %w
11482 Marks the argument containing or following the @samp{%w} as the
11483 designated output file of this compilation.  This puts the argument
11484 into the sequence of arguments that @samp{%o} substitutes.
11486 @item %o
11487 Substitutes the names of all the output files, with spaces
11488 automatically placed around them.  You should write spaces
11489 around the @samp{%o} as well or the results are undefined.
11490 @samp{%o} is for use in the specs for running the linker.
11491 Input files whose names have no recognized suffix are not compiled
11492 at all, but they are included among the output files, so they are
11493 linked.
11495 @item %O
11496 Substitutes the suffix for object files.  Note that this is
11497 handled specially when it immediately follows @samp{%g, %u, or %U},
11498 because of the need for those to form complete file names.  The
11499 handling is such that @samp{%O} is treated exactly as if it had already
11500 been substituted, except that @samp{%g, %u, and %U} do not currently
11501 support additional @var{suffix} characters following @samp{%O} as they do
11502 following, for example, @samp{.o}.
11504 @item %p
11505 Substitutes the standard macro predefinitions for the
11506 current target machine.  Use this when running @code{cpp}.
11508 @item %P
11509 Like @samp{%p}, but puts @samp{__} before and after the name of each
11510 predefined macro, except for macros that start with @samp{__} or with
11511 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11514 @item %I
11515 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11516 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11517 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11518 and @option{-imultilib} as necessary.
11520 @item %s
11521 Current argument is the name of a library or startup file of some sort.
11522 Search for that file in a standard list of directories and substitute
11523 the full name found.  The current working directory is included in the
11524 list of directories scanned.
11526 @item %T
11527 Current argument is the name of a linker script.  Search for that file
11528 in the current list of directories to scan for libraries. If the file
11529 is located insert a @option{--script} option into the command line
11530 followed by the full path name found.  If the file is not found then
11531 generate an error message.  Note: the current working directory is not
11532 searched.
11534 @item %e@var{str}
11535 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11536 Use this when inconsistent options are detected.
11538 @item %(@var{name})
11539 Substitute the contents of spec string @var{name} at this point.
11541 @item %x@{@var{option}@}
11542 Accumulate an option for @samp{%X}.
11544 @item %X
11545 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11546 spec string.
11548 @item %Y
11549 Output the accumulated assembler options specified by @option{-Wa}.
11551 @item %Z
11552 Output the accumulated preprocessor options specified by @option{-Wp}.
11554 @item %a
11555 Process the @code{asm} spec.  This is used to compute the
11556 switches to be passed to the assembler.
11558 @item %A
11559 Process the @code{asm_final} spec.  This is a spec string for
11560 passing switches to an assembler post-processor, if such a program is
11561 needed.
11563 @item %l
11564 Process the @code{link} spec.  This is the spec for computing the
11565 command line passed to the linker.  Typically it makes use of the
11566 @samp{%L %G %S %D and %E} sequences.
11568 @item %D
11569 Dump out a @option{-L} option for each directory that GCC believes might
11570 contain startup files.  If the target supports multilibs then the
11571 current multilib directory is prepended to each of these paths.
11573 @item %L
11574 Process the @code{lib} spec.  This is a spec string for deciding which
11575 libraries are included on the command line to the linker.
11577 @item %G
11578 Process the @code{libgcc} spec.  This is a spec string for deciding
11579 which GCC support library is included on the command line to the linker.
11581 @item %S
11582 Process the @code{startfile} spec.  This is a spec for deciding which
11583 object files are the first ones passed to the linker.  Typically
11584 this might be a file named @file{crt0.o}.
11586 @item %E
11587 Process the @code{endfile} spec.  This is a spec string that specifies
11588 the last object files that are passed to the linker.
11590 @item %C
11591 Process the @code{cpp} spec.  This is used to construct the arguments
11592 to be passed to the C preprocessor.
11594 @item %1
11595 Process the @code{cc1} spec.  This is used to construct the options to be
11596 passed to the actual C compiler (@samp{cc1}).
11598 @item %2
11599 Process the @code{cc1plus} spec.  This is used to construct the options to be
11600 passed to the actual C++ compiler (@samp{cc1plus}).
11602 @item %*
11603 Substitute the variable part of a matched option.  See below.
11604 Note that each comma in the substituted string is replaced by
11605 a single space.
11607 @item %<@code{S}
11608 Remove all occurrences of @code{-S} from the command line.  Note---this
11609 command is position dependent.  @samp{%} commands in the spec string
11610 before this one see @code{-S}, @samp{%} commands in the spec string
11611 after this one do not.
11613 @item %:@var{function}(@var{args})
11614 Call the named function @var{function}, passing it @var{args}.
11615 @var{args} is first processed as a nested spec string, then split
11616 into an argument vector in the usual fashion.  The function returns
11617 a string which is processed as if it had appeared literally as part
11618 of the current spec.
11620 The following built-in spec functions are provided:
11622 @table @code
11623 @item @code{getenv}
11624 The @code{getenv} spec function takes two arguments: an environment
11625 variable name and a string.  If the environment variable is not
11626 defined, a fatal error is issued.  Otherwise, the return value is the
11627 value of the environment variable concatenated with the string.  For
11628 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11630 @smallexample
11631 %:getenv(TOPDIR /include)
11632 @end smallexample
11634 expands to @file{/path/to/top/include}.
11636 @item @code{if-exists}
11637 The @code{if-exists} spec function takes one argument, an absolute
11638 pathname to a file.  If the file exists, @code{if-exists} returns the
11639 pathname.  Here is a small example of its usage:
11641 @smallexample
11642 *startfile:
11643 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11644 @end smallexample
11646 @item @code{if-exists-else}
11647 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11648 spec function, except that it takes two arguments.  The first argument is
11649 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11650 returns the pathname.  If it does not exist, it returns the second argument.
11651 This way, @code{if-exists-else} can be used to select one file or another,
11652 based on the existence of the first.  Here is a small example of its usage:
11654 @smallexample
11655 *startfile:
11656 crt0%O%s %:if-exists(crti%O%s) \
11657 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11658 @end smallexample
11660 @item @code{replace-outfile}
11661 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11662 first argument in the outfiles array and replaces it with the second argument.  Here
11663 is a small example of its usage:
11665 @smallexample
11666 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11667 @end smallexample
11669 @item @code{remove-outfile}
11670 The @code{remove-outfile} spec function takes one argument.  It looks for the
11671 first argument in the outfiles array and removes it.  Here is a small example
11672 its usage:
11674 @smallexample
11675 %:remove-outfile(-lm)
11676 @end smallexample
11678 @item @code{pass-through-libs}
11679 The @code{pass-through-libs} spec function takes any number of arguments.  It
11680 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11681 assumes are the names of linker input library archive files) and returns a
11682 result containing all the found arguments each prepended by
11683 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11684 intended to be passed to the LTO linker plugin.
11686 @smallexample
11687 %:pass-through-libs(%G %L %G)
11688 @end smallexample
11690 @item @code{print-asm-header}
11691 The @code{print-asm-header} function takes no arguments and simply
11692 prints a banner like:
11694 @smallexample
11695 Assembler options
11696 =================
11698 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11699 @end smallexample
11701 It is used to separate compiler options from assembler options
11702 in the @option{--target-help} output.
11703 @end table
11705 @item %@{@code{S}@}
11706 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11707 If that switch is not specified, this substitutes nothing.  Note that
11708 the leading dash is omitted when specifying this option, and it is
11709 automatically inserted if the substitution is performed.  Thus the spec
11710 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11711 and outputs the command-line option @option{-foo}.
11713 @item %W@{@code{S}@}
11714 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11715 deleted on failure.
11717 @item %@{@code{S}*@}
11718 Substitutes all the switches specified to GCC whose names start
11719 with @code{-S}, but which also take an argument.  This is used for
11720 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11721 GCC considers @option{-o foo} as being
11722 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11723 text, including the space.  Thus two arguments are generated.
11725 @item %@{@code{S}*&@code{T}*@}
11726 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11727 (the order of @code{S} and @code{T} in the spec is not significant).
11728 There can be any number of ampersand-separated variables; for each the
11729 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11731 @item %@{@code{S}:@code{X}@}
11732 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11734 @item %@{!@code{S}:@code{X}@}
11735 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11737 @item %@{@code{S}*:@code{X}@}
11738 Substitutes @code{X} if one or more switches whose names start with
11739 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11740 once, no matter how many such switches appeared.  However, if @code{%*}
11741 appears somewhere in @code{X}, then @code{X} is substituted once
11742 for each matching switch, with the @code{%*} replaced by the part of
11743 that switch matching the @code{*}.
11745 If @code{%*} appears as the last part of a spec sequence then a space
11746 will be added after the end of the last substitution.  If there is more
11747 text in the sequence however then a space will not be generated.  This
11748 allows the @code{%*} substitution to be used as part of a larger
11749 string.  For example, a spec string like this:
11751 @smallexample
11752 %@{mcu=*:--script=%*/memory.ld@}
11753 @end smallexample
11755 when matching an option like @code{-mcu=newchip} will produce:
11757 @smallexample
11758 --script=newchip/memory.ld
11759 @end smallexample
11761 @item %@{.@code{S}:@code{X}@}
11762 Substitutes @code{X}, if processing a file with suffix @code{S}.
11764 @item %@{!.@code{S}:@code{X}@}
11765 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11767 @item %@{,@code{S}:@code{X}@}
11768 Substitutes @code{X}, if processing a file for language @code{S}.
11770 @item %@{!,@code{S}:@code{X}@}
11771 Substitutes @code{X}, if not processing a file for language @code{S}.
11773 @item %@{@code{S}|@code{P}:@code{X}@}
11774 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11775 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11776 @code{*} sequences as well, although they have a stronger binding than
11777 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11778 alternatives must be starred, and only the first matching alternative
11779 is substituted.
11781 For example, a spec string like this:
11783 @smallexample
11784 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11785 @end smallexample
11787 @noindent
11788 outputs the following command-line options from the following input
11789 command-line options:
11791 @smallexample
11792 fred.c        -foo -baz
11793 jim.d         -bar -boggle
11794 -d fred.c     -foo -baz -boggle
11795 -d jim.d      -bar -baz -boggle
11796 @end smallexample
11798 @item %@{S:X; T:Y; :D@}
11800 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11801 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11802 be as many clauses as you need.  This may be combined with @code{.},
11803 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11806 @end table
11808 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11809 construct may contain other nested @samp{%} constructs or spaces, or
11810 even newlines.  They are processed as usual, as described above.
11811 Trailing white space in @code{X} is ignored.  White space may also
11812 appear anywhere on the left side of the colon in these constructs,
11813 except between @code{.} or @code{*} and the corresponding word.
11815 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11816 handled specifically in these constructs.  If another value of
11817 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11818 @option{-W} switch is found later in the command line, the earlier
11819 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11820 just one letter, which passes all matching options.
11822 The character @samp{|} at the beginning of the predicate text is used to
11823 indicate that a command should be piped to the following command, but
11824 only if @option{-pipe} is specified.
11826 It is built into GCC which switches take arguments and which do not.
11827 (You might think it would be useful to generalize this to allow each
11828 compiler's spec to say which switches take arguments.  But this cannot
11829 be done in a consistent fashion.  GCC cannot even decide which input
11830 files have been specified without knowing which switches take arguments,
11831 and it must know which input files to compile in order to tell which
11832 compilers to run).
11834 GCC also knows implicitly that arguments starting in @option{-l} are to be
11835 treated as compiler output files, and passed to the linker in their
11836 proper position among the other output files.
11838 @c man begin OPTIONS
11840 @node Target Options
11841 @section Specifying Target Machine and Compiler Version
11842 @cindex target options
11843 @cindex cross compiling
11844 @cindex specifying machine version
11845 @cindex specifying compiler version and target machine
11846 @cindex compiler version, specifying
11847 @cindex target machine, specifying
11849 The usual way to run GCC is to run the executable called @command{gcc}, or
11850 @command{@var{machine}-gcc} when cross-compiling, or
11851 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11852 one that was installed last.
11854 @node Submodel Options
11855 @section Hardware Models and Configurations
11856 @cindex submodel options
11857 @cindex specifying hardware config
11858 @cindex hardware models and configurations, specifying
11859 @cindex machine dependent options
11861 Each target machine types can have its own
11862 special options, starting with @samp{-m}, to choose among various
11863 hardware models or configurations---for example, 68010 vs 68020,
11864 floating coprocessor or none.  A single installed version of the
11865 compiler can compile for any model or configuration, according to the
11866 options specified.
11868 Some configurations of the compiler also support additional special
11869 options, usually for compatibility with other compilers on the same
11870 platform.
11872 @c This list is ordered alphanumerically by subsection name.
11873 @c It should be the same order and spelling as these options are listed
11874 @c in Machine Dependent Options
11876 @menu
11877 * AArch64 Options::
11878 * Adapteva Epiphany Options::
11879 * ARC Options::
11880 * ARM Options::
11881 * AVR Options::
11882 * Blackfin Options::
11883 * C6X Options::
11884 * CRIS Options::
11885 * CR16 Options::
11886 * Darwin Options::
11887 * DEC Alpha Options::
11888 * FR30 Options::
11889 * FRV Options::
11890 * GNU/Linux Options::
11891 * H8/300 Options::
11892 * HPPA Options::
11893 * i386 and x86-64 Options::
11894 * i386 and x86-64 Windows Options::
11895 * IA-64 Options::
11896 * LM32 Options::
11897 * M32C Options::
11898 * M32R/D Options::
11899 * M680x0 Options::
11900 * MCore Options::
11901 * MeP Options::
11902 * MicroBlaze Options::
11903 * MIPS Options::
11904 * MMIX Options::
11905 * MN10300 Options::
11906 * Moxie Options::
11907 * MSP430 Options::
11908 * NDS32 Options::
11909 * Nios II Options::
11910 * PDP-11 Options::
11911 * picoChip Options::
11912 * PowerPC Options::
11913 * RL78 Options::
11914 * RS/6000 and PowerPC Options::
11915 * RX Options::
11916 * S/390 and zSeries Options::
11917 * Score Options::
11918 * SH Options::
11919 * Solaris 2 Options::
11920 * SPARC Options::
11921 * SPU Options::
11922 * System V Options::
11923 * TILE-Gx Options::
11924 * TILEPro Options::
11925 * V850 Options::
11926 * VAX Options::
11927 * VMS Options::
11928 * VxWorks Options::
11929 * x86-64 Options::
11930 * Xstormy16 Options::
11931 * Xtensa Options::
11932 * zSeries Options::
11933 @end menu
11935 @node AArch64 Options
11936 @subsection AArch64 Options
11937 @cindex AArch64 Options
11939 These options are defined for AArch64 implementations:
11941 @table @gcctabopt
11943 @item -mabi=@var{name}
11944 @opindex mabi
11945 Generate code for the specified data model.  Permissible values
11946 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11947 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11948 but long int and pointer are 64-bit.
11950 The default depends on the specific target configuration.  Note that
11951 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11952 entire program with the same ABI, and link with a compatible set of libraries.
11954 @item -mbig-endian
11955 @opindex mbig-endian
11956 Generate big-endian code.  This is the default when GCC is configured for an
11957 @samp{aarch64_be-*-*} target.
11959 @item -mgeneral-regs-only
11960 @opindex mgeneral-regs-only
11961 Generate code which uses only the general registers.
11963 @item -mlittle-endian
11964 @opindex mlittle-endian
11965 Generate little-endian code.  This is the default when GCC is configured for an
11966 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11968 @item -mcmodel=tiny
11969 @opindex mcmodel=tiny
11970 Generate code for the tiny code model.  The program and its statically defined
11971 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11972 be statically or dynamically linked.  This model is not fully implemented and
11973 mostly treated as @samp{small}.
11975 @item -mcmodel=small
11976 @opindex mcmodel=small
11977 Generate code for the small code model.  The program and its statically defined
11978 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11979 be statically or dynamically linked.  This is the default code model.
11981 @item -mcmodel=large
11982 @opindex mcmodel=large
11983 Generate code for the large code model.  This makes no assumptions about
11984 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11985 statically linked only.
11987 @item -mstrict-align
11988 @opindex mstrict-align
11989 Do not assume that unaligned memory references will be handled by the system.
11991 @item -momit-leaf-frame-pointer
11992 @itemx -mno-omit-leaf-frame-pointer
11993 @opindex momit-leaf-frame-pointer
11994 @opindex mno-omit-leaf-frame-pointer
11995 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11996 default.
11998 @item -mtls-dialect=desc
11999 @opindex mtls-dialect=desc
12000 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
12001 of TLS variables.  This is the default.
12003 @item -mtls-dialect=traditional
12004 @opindex mtls-dialect=traditional
12005 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
12006 of TLS variables.
12008 @item -mfix-cortex-a53-835769
12009 @itemx -mno-fix-cortex-a53-835769
12010 @opindex mfix-cortex-a53-835769
12011 @opindex mno-fix-cortex-a53-835769
12012 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
12013 This will involve inserting a NOP instruction between memory instructions and
12014 64-bit integer multiply-accumulate instructions.
12016 @item -march=@var{name}
12017 @opindex march
12018 Specify the name of the target architecture, optionally suffixed by one or
12019 more feature modifiers.  This option has the form
12020 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12021 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
12022 values for @var{feature} are documented in the sub-section below.
12024 Where conflicting feature modifiers are specified, the right-most feature is
12025 used.
12027 GCC uses this name to determine what kind of instructions it can emit when
12028 generating assembly code.
12030 Where @option{-march} is specified without either of @option{-mtune}
12031 or @option{-mcpu} also being specified, the code will be tuned to perform
12032 well across a range of target processors implementing the target
12033 architecture.
12035 @item -mtune=@var{name}
12036 @opindex mtune
12037 Specify the name of the target processor for which GCC should tune the
12038 performance of the code.  Permissible values for this option are:
12039 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{thunderx}.
12041 Additionally, this option can specify that GCC should tune the performance
12042 of the code for a big.LITTLE system.  The only permissible value is
12043 @samp{cortex-a57.cortex-a53}.
12045 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12046 are specified, the code will be tuned to perform well across a range
12047 of target processors.
12049 This option cannot be suffixed by feature modifiers.
12051 @item -mcpu=@var{name}
12052 @opindex mcpu
12053 Specify the name of the target processor, optionally suffixed by one or more
12054 feature modifiers.  This option has the form
12055 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12056 permissible values for @var{cpu} are the same as those available for
12057 @option{-mtune}.
12059 The permissible values for @var{feature} are documented in the sub-section
12060 below.
12062 Where conflicting feature modifiers are specified, the right-most feature is
12063 used.
12065 GCC uses this name to determine what kind of instructions it can emit when
12066 generating assembly code (as if by @option{-march}) and to determine
12067 the target processor for which to tune for performance (as if
12068 by @option{-mtune}).  Where this option is used in conjunction
12069 with @option{-march} or @option{-mtune}, those options take precedence
12070 over the appropriate part of this option.
12071 @end table
12073 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
12074 @cindex @option{-march} feature modifiers
12075 @cindex @option{-mcpu} feature modifiers
12076 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12077 the following:
12079 @table @samp
12080 @item crc
12081 Enable CRC extension.
12082 @item crypto
12083 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12084 @item fp
12085 Enable floating-point instructions.
12086 @item simd
12087 Enable Advanced SIMD instructions.  This implies floating-point instructions
12088 are enabled.  This is the default for all current possible values for options
12089 @option{-march} and @option{-mcpu=}.
12090 @end table
12092 @node Adapteva Epiphany Options
12093 @subsection Adapteva Epiphany Options
12095 These @samp{-m} options are defined for Adapteva Epiphany:
12097 @table @gcctabopt
12098 @item -mhalf-reg-file
12099 @opindex mhalf-reg-file
12100 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12101 That allows code to run on hardware variants that lack these registers.
12103 @item -mprefer-short-insn-regs
12104 @opindex mprefer-short-insn-regs
12105 Preferrentially allocate registers that allow short instruction generation.
12106 This can result in increased instruction count, so this may either reduce or
12107 increase overall code size.
12109 @item -mbranch-cost=@var{num}
12110 @opindex mbranch-cost
12111 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12112 This cost is only a heuristic and is not guaranteed to produce
12113 consistent results across releases.
12115 @item -mcmove
12116 @opindex mcmove
12117 Enable the generation of conditional moves.
12119 @item -mnops=@var{num}
12120 @opindex mnops
12121 Emit @var{num} NOPs before every other generated instruction.
12123 @item -mno-soft-cmpsf
12124 @opindex mno-soft-cmpsf
12125 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12126 and test the flags.  This is faster than a software comparison, but can
12127 get incorrect results in the presence of NaNs, or when two different small
12128 numbers are compared such that their difference is calculated as zero.
12129 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12130 software comparisons.
12132 @item -mstack-offset=@var{num}
12133 @opindex mstack-offset
12134 Set the offset between the top of the stack and the stack pointer.
12135 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12136 can be used by leaf functions without stack allocation.
12137 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12138 Note also that this option changes the ABI; compiling a program with a
12139 different stack offset than the libraries have been compiled with
12140 generally does not work.
12141 This option can be useful if you want to evaluate if a different stack
12142 offset would give you better code, but to actually use a different stack
12143 offset to build working programs, it is recommended to configure the
12144 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12146 @item -mno-round-nearest
12147 @opindex mno-round-nearest
12148 Make the scheduler assume that the rounding mode has been set to
12149 truncating.  The default is @option{-mround-nearest}.
12151 @item -mlong-calls
12152 @opindex mlong-calls
12153 If not otherwise specified by an attribute, assume all calls might be beyond
12154 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12155 function address into a register before performing a (otherwise direct) call.
12156 This is the default.
12158 @item -mshort-calls
12159 @opindex short-calls
12160 If not otherwise specified by an attribute, assume all direct calls are
12161 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12162 for direct calls.  The default is @option{-mlong-calls}.
12164 @item -msmall16
12165 @opindex msmall16
12166 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12167 apply to function addresses for which @option{-mlong-calls} semantics
12168 are in effect.
12170 @item -mfp-mode=@var{mode}
12171 @opindex mfp-mode
12172 Set the prevailing mode of the floating-point unit.
12173 This determines the floating-point mode that is provided and expected
12174 at function call and return time.  Making this mode match the mode you
12175 predominantly need at function start can make your programs smaller and
12176 faster by avoiding unnecessary mode switches.
12178 @var{mode} can be set to one the following values:
12180 @table @samp
12181 @item caller
12182 Any mode at function entry is valid, and retained or restored when
12183 the function returns, and when it calls other functions.
12184 This mode is useful for compiling libraries or other compilation units
12185 you might want to incorporate into different programs with different
12186 prevailing FPU modes, and the convenience of being able to use a single
12187 object file outweighs the size and speed overhead for any extra
12188 mode switching that might be needed, compared with what would be needed
12189 with a more specific choice of prevailing FPU mode.
12191 @item truncate
12192 This is the mode used for floating-point calculations with
12193 truncating (i.e.@: round towards zero) rounding mode.  That includes
12194 conversion from floating point to integer.
12196 @item round-nearest
12197 This is the mode used for floating-point calculations with
12198 round-to-nearest-or-even rounding mode.
12200 @item int
12201 This is the mode used to perform integer calculations in the FPU, e.g.@:
12202 integer multiply, or integer multiply-and-accumulate.
12203 @end table
12205 The default is @option{-mfp-mode=caller}
12207 @item -mnosplit-lohi
12208 @itemx -mno-postinc
12209 @itemx -mno-postmodify
12210 @opindex mnosplit-lohi
12211 @opindex mno-postinc
12212 @opindex mno-postmodify
12213 Code generation tweaks that disable, respectively, splitting of 32-bit
12214 loads, generation of post-increment addresses, and generation of
12215 post-modify addresses.  The defaults are @option{msplit-lohi},
12216 @option{-mpost-inc}, and @option{-mpost-modify}.
12218 @item -mnovect-double
12219 @opindex mno-vect-double
12220 Change the preferred SIMD mode to SImode.  The default is
12221 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12223 @item -max-vect-align=@var{num}
12224 @opindex max-vect-align
12225 The maximum alignment for SIMD vector mode types.
12226 @var{num} may be 4 or 8.  The default is 8.
12227 Note that this is an ABI change, even though many library function
12228 interfaces are unaffected if they don't use SIMD vector modes
12229 in places that affect size and/or alignment of relevant types.
12231 @item -msplit-vecmove-early
12232 @opindex msplit-vecmove-early
12233 Split vector moves into single word moves before reload.  In theory this
12234 can give better register allocation, but so far the reverse seems to be
12235 generally the case.
12237 @item -m1reg-@var{reg}
12238 @opindex m1reg-
12239 Specify a register to hold the constant @minus{}1, which makes loading small negative
12240 constants and certain bitmasks faster.
12241 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12242 which specify use of that register as a fixed register,
12243 and @samp{none}, which means that no register is used for this
12244 purpose.  The default is @option{-m1reg-none}.
12246 @end table
12248 @node ARC Options
12249 @subsection ARC Options
12250 @cindex ARC options
12252 The following options control the architecture variant for which code
12253 is being compiled:
12255 @c architecture variants
12256 @table @gcctabopt
12258 @item -mbarrel-shifter
12259 @opindex mbarrel-shifter
12260 Generate instructions supported by barrel shifter.  This is the default
12261 unless @samp{-mcpu=ARC601} is in effect.
12263 @item -mcpu=@var{cpu}
12264 @opindex mcpu
12265 Set architecture type, register usage, and instruction scheduling
12266 parameters for @var{cpu}.  There are also shortcut alias options
12267 available for backward compatibility and convenience.  Supported
12268 values for @var{cpu} are
12270 @table @samp
12271 @opindex mA6
12272 @opindex mARC600
12273 @item ARC600
12274 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12276 @item ARC601
12277 @opindex mARC601
12278 Compile for ARC601.  Alias: @option{-mARC601}.
12280 @item ARC700
12281 @opindex mA7
12282 @opindex mARC700
12283 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12284 This is the default when configured with @samp{--with-cpu=arc700}@.
12285 @end table
12287 @item -mdpfp
12288 @opindex mdpfp
12289 @itemx -mdpfp-compact
12290 @opindex mdpfp-compact
12291 FPX: Generate Double Precision FPX instructions, tuned for the compact
12292 implementation.
12294 @item -mdpfp-fast
12295 @opindex mdpfp-fast
12296 FPX: Generate Double Precision FPX instructions, tuned for the fast
12297 implementation.
12299 @item -mno-dpfp-lrsr
12300 @opindex mno-dpfp-lrsr
12301 Disable LR and SR instructions from using FPX extension aux registers.
12303 @item -mea
12304 @opindex mea
12305 Generate Extended arithmetic instructions.  Currently only
12306 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12307 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12309 @item -mno-mpy
12310 @opindex mno-mpy
12311 Do not generate mpy instructions for ARC700.
12313 @item -mmul32x16
12314 @opindex mmul32x16
12315 Generate 32x16 bit multiply and mac instructions.
12317 @item -mmul64
12318 @opindex mmul64
12319 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12321 @item -mnorm
12322 @opindex mnorm
12323 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12324 is in effect.
12326 @item -mspfp
12327 @opindex mspfp
12328 @itemx -mspfp-compact
12329 @opindex mspfp-compact
12330 FPX: Generate Single Precision FPX instructions, tuned for the compact
12331 implementation.
12333 @item -mspfp-fast
12334 @opindex mspfp-fast
12335 FPX: Generate Single Precision FPX instructions, tuned for the fast
12336 implementation.
12338 @item -msimd
12339 @opindex msimd
12340 Enable generation of ARC SIMD instructions via target-specific
12341 builtins.  Only valid for @samp{-mcpu=ARC700}.
12343 @item -msoft-float
12344 @opindex msoft-float
12345 This option ignored; it is provided for compatibility purposes only.
12346 Software floating point code is emitted by default, and this default
12347 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12348 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12349 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12351 @item -mswap
12352 @opindex mswap
12353 Generate swap instructions.
12355 @end table
12357 The following options are passed through to the assembler, and also
12358 define preprocessor macro symbols.
12360 @c Flags used by the assembler, but for which we define preprocessor
12361 @c macro symbols as well.
12362 @table @gcctabopt
12363 @item -mdsp-packa
12364 @opindex mdsp-packa
12365 Passed down to the assembler to enable the DSP Pack A extensions.
12366 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12368 @item -mdvbf
12369 @opindex mdvbf
12370 Passed down to the assembler to enable the dual viterbi butterfly
12371 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12373 @c ARC700 4.10 extension instruction
12374 @item -mlock
12375 @opindex mlock
12376 Passed down to the assembler to enable the Locked Load/Store
12377 Conditional extension.  Also sets the preprocessor symbol
12378 @code{__Xlock}.
12380 @item -mmac-d16
12381 @opindex mmac-d16
12382 Passed down to the assembler.  Also sets the preprocessor symbol
12383 @code{__Xxmac_d16}.
12385 @item -mmac-24
12386 @opindex mmac-24
12387 Passed down to the assembler.  Also sets the preprocessor symbol
12388 @code{__Xxmac_24}.
12390 @c ARC700 4.10 extension instruction
12391 @item -mrtsc
12392 @opindex mrtsc
12393 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12394 extension instruction.  Also sets the preprocessor symbol
12395 @code{__Xrtsc}.
12397 @c ARC700 4.10 extension instruction
12398 @item -mswape
12399 @opindex mswape
12400 Passed down to the assembler to enable the swap byte ordering
12401 extension instruction.  Also sets the preprocessor symbol
12402 @code{__Xswape}.
12404 @item -mtelephony
12405 @opindex mtelephony
12406 Passed down to the assembler to enable dual and single operand
12407 instructions for telephony.  Also sets the preprocessor symbol
12408 @code{__Xtelephony}.
12410 @item -mxy
12411 @opindex mxy
12412 Passed down to the assembler to enable the XY Memory extension.  Also
12413 sets the preprocessor symbol @code{__Xxy}.
12415 @end table
12417 The following options control how the assembly code is annotated:
12419 @c Assembly annotation options
12420 @table @gcctabopt
12421 @item -misize
12422 @opindex misize
12423 Annotate assembler instructions with estimated addresses.
12425 @item -mannotate-align
12426 @opindex mannotate-align
12427 Explain what alignment considerations lead to the decision to make an
12428 instruction short or long.
12430 @end table
12432 The following options are passed through to the linker:
12434 @c options passed through to the linker
12435 @table @gcctabopt
12436 @item -marclinux
12437 @opindex marclinux
12438 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12439 This option is enabled by default in tool chains built for
12440 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12441 when profiling is not requested.
12443 @item -marclinux_prof
12444 @opindex marclinux_prof
12445 Passed through to the linker, to specify use of the
12446 @code{arclinux_prof} emulation.  This option is enabled by default in
12447 tool chains built for @w{@code{arc-linux-uclibc}} and
12448 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12450 @end table
12452 The following options control the semantics of generated code:
12454 @c semantically relevant code generation options
12455 @table @gcctabopt
12456 @item -mepilogue-cfi
12457 @opindex mepilogue-cfi
12458 Enable generation of call frame information for epilogues.
12460 @item -mno-epilogue-cfi
12461 @opindex mno-epilogue-cfi
12462 Disable generation of call frame information for epilogues.
12464 @item -mlong-calls
12465 @opindex mlong-calls
12466 Generate call insns as register indirect calls, thus providing access
12467 to the full 32-bit address range.
12469 @item -mmedium-calls
12470 @opindex mmedium-calls
12471 Don't use less than 25 bit addressing range for calls, which is the
12472 offset available for an unconditional branch-and-link
12473 instruction.  Conditional execution of function calls is suppressed, to
12474 allow use of the 25-bit range, rather than the 21-bit range with
12475 conditional branch-and-link.  This is the default for tool chains built
12476 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12478 @item -mno-sdata
12479 @opindex mno-sdata
12480 Do not generate sdata references.  This is the default for tool chains
12481 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12482 targets.
12484 @item -mucb-mcount
12485 @opindex mucb-mcount
12486 Instrument with mcount calls as used in UCB code.  I.e. do the
12487 counting in the callee, not the caller.  By default ARC instrumentation
12488 counts in the caller.
12490 @item -mvolatile-cache
12491 @opindex mvolatile-cache
12492 Use ordinarily cached memory accesses for volatile references.  This is the
12493 default.
12495 @item -mno-volatile-cache
12496 @opindex mno-volatile-cache
12497 Enable cache bypass for volatile references.
12499 @end table
12501 The following options fine tune code generation:
12502 @c code generation tuning options
12503 @table @gcctabopt
12504 @item -malign-call
12505 @opindex malign-call
12506 Do alignment optimizations for call instructions.
12508 @item -mauto-modify-reg
12509 @opindex mauto-modify-reg
12510 Enable the use of pre/post modify with register displacement.
12512 @item -mbbit-peephole
12513 @opindex mbbit-peephole
12514 Enable bbit peephole2.
12516 @item -mno-brcc
12517 @opindex mno-brcc
12518 This option disables a target-specific pass in @file{arc_reorg} to
12519 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12520 generation driven by the combiner pass.
12522 @item -mcase-vector-pcrel
12523 @opindex mcase-vector-pcrel
12524 Use pc-relative switch case tables - this enables case table shortening.
12525 This is the default for @option{-Os}.
12527 @item -mcompact-casesi
12528 @opindex mcompact-casesi
12529 Enable compact casesi pattern.
12530 This is the default for @option{-Os}.
12532 @item -mno-cond-exec
12533 @opindex mno-cond-exec
12534 Disable ARCompact specific pass to generate conditional execution instructions.
12535 Due to delay slot scheduling and interactions between operand numbers,
12536 literal sizes, instruction lengths, and the support for conditional execution,
12537 the target-independent pass to generate conditional execution is often lacking,
12538 so the ARC port has kept a special pass around that tries to find more
12539 conditional execution generating opportunities after register allocation,
12540 branch shortening, and delay slot scheduling have been done.  This pass
12541 generally, but not always, improves performance and code size, at the cost of
12542 extra compilation time, which is why there is an option to switch it off.
12543 If you have a problem with call instructions exceeding their allowable
12544 offset range because they are conditionalized, you should consider using
12545 @option{-mmedium-calls} instead.
12547 @item -mearly-cbranchsi
12548 @opindex mearly-cbranchsi
12549 Enable pre-reload use of the cbranchsi pattern.
12551 @item -mexpand-adddi
12552 @opindex mexpand-adddi
12553 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12554 @code{add.f}, @code{adc} etc.
12556 @item -mindexed-loads
12557 @opindex mindexed-loads
12558 Enable the use of indexed loads.  This can be problematic because some
12559 optimizers will then assume the that indexed stores exist, which is not
12560 the case.
12562 @item -mlra
12563 @opindex mlra
12564 Enable Local Register Allocation.  This is still experimental for ARC,
12565 so by default the compiler uses standard reload
12566 (i.e. @samp{-mno-lra}).
12568 @item -mlra-priority-none
12569 @opindex mlra-priority-none
12570 Don't indicate any priority for target registers.
12572 @item -mlra-priority-compact
12573 @opindex mlra-priority-compact
12574 Indicate target register priority for r0..r3 / r12..r15.
12576 @item -mlra-priority-noncompact
12577 @opindex mlra-priority-noncompact
12578 Reduce target regsiter priority for r0..r3 / r12..r15.
12580 @item -mno-millicode
12581 @opindex mno-millicode
12582 When optimizing for size (using @option{-Os}), prologues and epilogues
12583 that have to save or restore a large number of registers are often
12584 shortened by using call to a special function in libgcc; this is
12585 referred to as a @emph{millicode} call.  As these calls can pose
12586 performance issues, and/or cause linking issues when linking in a
12587 nonstandard way, this option is provided to turn off millicode call
12588 generation.
12590 @item -mmixed-code
12591 @opindex mmixed-code
12592 Tweak register allocation to help 16-bit instruction generation.
12593 This generally has the effect of decreasing the average instruction size
12594 while increasing the instruction count.
12596 @item -mq-class
12597 @opindex mq-class
12598 Enable 'q' instruction alternatives.
12599 This is the default for @option{-Os}.
12601 @item -mRcq
12602 @opindex mRcq
12603 Enable Rcq constraint handling - most short code generation depends on this.
12604 This is the default.
12606 @item -mRcw
12607 @opindex mRcw
12608 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12609 This is the default.
12611 @item -msize-level=@var{level}
12612 @opindex msize-level
12613 Fine-tune size optimization with regards to instruction lengths and alignment.
12614 The recognized values for @var{level} are:
12615 @table @samp
12616 @item 0
12617 No size optimization.  This level is deprecated and treated like @samp{1}.
12619 @item 1
12620 Short instructions are used opportunistically.
12622 @item 2
12623 In addition, alignment of loops and of code after barriers are dropped.
12625 @item 3
12626 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12628 @end table
12630 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12631 the behavior when this is not set is equivalent to level @samp{1}.
12633 @item -mtune=@var{cpu}
12634 @opindex mtune
12635 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12636 by @option{-mcpu=}.
12638 Supported values for @var{cpu} are
12640 @table @samp
12641 @item ARC600
12642 Tune for ARC600 cpu.
12644 @item ARC601
12645 Tune for ARC601 cpu.
12647 @item ARC700
12648 Tune for ARC700 cpu with standard multiplier block.
12650 @item ARC700-xmac
12651 Tune for ARC700 cpu with XMAC block.
12653 @item ARC725D
12654 Tune for ARC725D cpu.
12656 @item ARC750D
12657 Tune for ARC750D cpu.
12659 @end table
12661 @item -mmultcost=@var{num}
12662 @opindex mmultcost
12663 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12664 normal instruction.
12666 @item -munalign-prob-threshold=@var{probability}
12667 @opindex munalign-prob-threshold
12668 Set probability threshold for unaligning branches.
12669 When tuning for @samp{ARC700} and optimizing for speed, branches without
12670 filled delay slot are preferably emitted unaligned and long, unless
12671 profiling indicates that the probability for the branch to be taken
12672 is below @var{probability}.  @xref{Cross-profiling}.
12673 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12675 @end table
12677 The following options are maintained for backward compatibility, but
12678 are now deprecated and will be removed in a future release:
12680 @c Deprecated options
12681 @table @gcctabopt
12683 @item -margonaut
12684 @opindex margonaut
12685 Obsolete FPX.
12687 @item -mbig-endian
12688 @opindex mbig-endian
12689 @itemx -EB
12690 @opindex EB
12691 Compile code for big endian targets.  Use of these options is now
12692 deprecated.  Users wanting big-endian code, should use the
12693 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12694 building the tool chain, for which big-endian is the default.
12696 @item -mlittle-endian
12697 @opindex mlittle-endian
12698 @itemx -EL
12699 @opindex EL
12700 Compile code for little endian targets.  Use of these options is now
12701 deprecated.  Users wanting little-endian code should use the
12702 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12703 building the tool chain, for which little-endian is the default.
12705 @item -mbarrel_shifter
12706 @opindex mbarrel_shifter
12707 Replaced by @samp{-mbarrel-shifter}
12709 @item -mdpfp_compact
12710 @opindex mdpfp_compact
12711 Replaced by @samp{-mdpfp-compact}
12713 @item -mdpfp_fast
12714 @opindex mdpfp_fast
12715 Replaced by @samp{-mdpfp-fast}
12717 @item -mdsp_packa
12718 @opindex mdsp_packa
12719 Replaced by @samp{-mdsp-packa}
12721 @item -mEA
12722 @opindex mEA
12723 Replaced by @samp{-mea}
12725 @item -mmac_24
12726 @opindex mmac_24
12727 Replaced by @samp{-mmac-24}
12729 @item -mmac_d16
12730 @opindex mmac_d16
12731 Replaced by @samp{-mmac-d16}
12733 @item -mspfp_compact
12734 @opindex mspfp_compact
12735 Replaced by @samp{-mspfp-compact}
12737 @item -mspfp_fast
12738 @opindex mspfp_fast
12739 Replaced by @samp{-mspfp-fast}
12741 @item -mtune=@var{cpu}
12742 @opindex mtune
12743 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12744 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12745 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12747 @item -multcost=@var{num}
12748 @opindex multcost
12749 Replaced by @samp{-mmultcost}.
12751 @end table
12753 @node ARM Options
12754 @subsection ARM Options
12755 @cindex ARM options
12757 These @samp{-m} options are defined for the ARM port:
12759 @table @gcctabopt
12760 @item -mabi=@var{name}
12761 @opindex mabi
12762 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12763 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12765 @item -mapcs-frame
12766 @opindex mapcs-frame
12767 Generate a stack frame that is compliant with the ARM Procedure Call
12768 Standard for all functions, even if this is not strictly necessary for
12769 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12770 with this option causes the stack frames not to be generated for
12771 leaf functions.  The default is @option{-mno-apcs-frame}.
12773 @item -mapcs
12774 @opindex mapcs
12775 This is a synonym for @option{-mapcs-frame}.
12777 @ignore
12778 @c not currently implemented
12779 @item -mapcs-stack-check
12780 @opindex mapcs-stack-check
12781 Generate code to check the amount of stack space available upon entry to
12782 every function (that actually uses some stack space).  If there is
12783 insufficient space available then either the function
12784 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12785 called, depending upon the amount of stack space required.  The runtime
12786 system is required to provide these functions.  The default is
12787 @option{-mno-apcs-stack-check}, since this produces smaller code.
12789 @c not currently implemented
12790 @item -mapcs-float
12791 @opindex mapcs-float
12792 Pass floating-point arguments using the floating-point registers.  This is
12793 one of the variants of the APCS@.  This option is recommended if the
12794 target hardware has a floating-point unit or if a lot of floating-point
12795 arithmetic is going to be performed by the code.  The default is
12796 @option{-mno-apcs-float}, since the size of integer-only code is 
12797 slightly increased if @option{-mapcs-float} is used.
12799 @c not currently implemented
12800 @item -mapcs-reentrant
12801 @opindex mapcs-reentrant
12802 Generate reentrant, position-independent code.  The default is
12803 @option{-mno-apcs-reentrant}.
12804 @end ignore
12806 @item -mthumb-interwork
12807 @opindex mthumb-interwork
12808 Generate code that supports calling between the ARM and Thumb
12809 instruction sets.  Without this option, on pre-v5 architectures, the
12810 two instruction sets cannot be reliably used inside one program.  The
12811 default is @option{-mno-thumb-interwork}, since slightly larger code
12812 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12813 configurations this option is meaningless.
12815 @item -mno-sched-prolog
12816 @opindex mno-sched-prolog
12817 Prevent the reordering of instructions in the function prologue, or the
12818 merging of those instruction with the instructions in the function's
12819 body.  This means that all functions start with a recognizable set
12820 of instructions (or in fact one of a choice from a small set of
12821 different function prologues), and this information can be used to
12822 locate the start of functions inside an executable piece of code.  The
12823 default is @option{-msched-prolog}.
12825 @item -mfloat-abi=@var{name}
12826 @opindex mfloat-abi
12827 Specifies which floating-point ABI to use.  Permissible values
12828 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12830 Specifying @samp{soft} causes GCC to generate output containing
12831 library calls for floating-point operations.
12832 @samp{softfp} allows the generation of code using hardware floating-point
12833 instructions, but still uses the soft-float calling conventions.
12834 @samp{hard} allows generation of floating-point instructions
12835 and uses FPU-specific calling conventions.
12837 The default depends on the specific target configuration.  Note that
12838 the hard-float and soft-float ABIs are not link-compatible; you must
12839 compile your entire program with the same ABI, and link with a
12840 compatible set of libraries.
12842 @item -mlittle-endian
12843 @opindex mlittle-endian
12844 Generate code for a processor running in little-endian mode.  This is
12845 the default for all standard configurations.
12847 @item -mbig-endian
12848 @opindex mbig-endian
12849 Generate code for a processor running in big-endian mode; the default is
12850 to compile code for a little-endian processor.
12852 @item -march=@var{name}
12853 @opindex march
12854 This specifies the name of the target ARM architecture.  GCC uses this
12855 name to determine what kind of instructions it can emit when generating
12856 assembly code.  This option can be used in conjunction with or instead
12857 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12858 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12859 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12860 @samp{armv6}, @samp{armv6j},
12861 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12862 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12863 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12864 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12866 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12867 extensions.
12869 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12870 architecture together with the optional CRC32 extensions.
12872 @option{-march=native} causes the compiler to auto-detect the architecture
12873 of the build computer.  At present, this feature is only supported on
12874 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12875 is unsuccessful the option has no effect.
12877 @item -mtune=@var{name}
12878 @opindex mtune
12879 This option specifies the name of the target ARM processor for
12880 which GCC should tune the performance of the code.
12881 For some ARM implementations better performance can be obtained by using
12882 this option.
12883 Permissible names are: @samp{arm2}, @samp{arm250},
12884 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12885 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12886 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12887 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12888 @samp{arm720},
12889 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12890 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12891 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12892 @samp{strongarm1110},
12893 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12894 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12895 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12896 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12897 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12898 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12899 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12900 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12901 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12902 @samp{cortex-r4},
12903 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12904 @samp{cortex-m4},
12905 @samp{cortex-m3},
12906 @samp{cortex-m1},
12907 @samp{cortex-m0},
12908 @samp{cortex-m0plus},
12909 @samp{cortex-m1.small-multiply},
12910 @samp{cortex-m0.small-multiply},
12911 @samp{cortex-m0plus.small-multiply},
12912 @samp{marvell-pj4},
12913 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12914 @samp{fa526}, @samp{fa626},
12915 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12917 Additionally, this option can specify that GCC should tune the performance
12918 of the code for a big.LITTLE system.  Permissible names are:
12919 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12921 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12922 performance for a blend of processors within architecture @var{arch}.
12923 The aim is to generate code that run well on the current most popular
12924 processors, balancing between optimizations that benefit some CPUs in the
12925 range, and avoiding performance pitfalls of other CPUs.  The effects of
12926 this option may change in future GCC versions as CPU models come and go.
12928 @option{-mtune=native} causes the compiler to auto-detect the CPU
12929 of the build computer.  At present, this feature is only supported on
12930 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12931 unsuccessful the option has no effect.
12933 @item -mcpu=@var{name}
12934 @opindex mcpu
12935 This specifies the name of the target ARM processor.  GCC uses this name
12936 to derive the name of the target ARM architecture (as if specified
12937 by @option{-march}) and the ARM processor type for which to tune for
12938 performance (as if specified by @option{-mtune}).  Where this option
12939 is used in conjunction with @option{-march} or @option{-mtune},
12940 those options take precedence over the appropriate part of this option.
12942 Permissible names for this option are the same as those for
12943 @option{-mtune}.
12945 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12946 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12947 See @option{-mtune} for more information.
12949 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12950 of the build computer.  At present, this feature is only supported on
12951 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12952 is unsuccessful the option has no effect.
12954 @item -mfpu=@var{name}
12955 @opindex mfpu
12956 This specifies what floating-point hardware (or hardware emulation) is
12957 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12958 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12959 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12960 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12961 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12962 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12964 If @option{-msoft-float} is specified this specifies the format of
12965 floating-point values.
12967 If the selected floating-point hardware includes the NEON extension
12968 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12969 operations are not generated by GCC's auto-vectorization pass unless
12970 @option{-funsafe-math-optimizations} is also specified.  This is
12971 because NEON hardware does not fully implement the IEEE 754 standard for
12972 floating-point arithmetic (in particular denormal values are treated as
12973 zero), so the use of NEON instructions may lead to a loss of precision.
12975 @item -mfp16-format=@var{name}
12976 @opindex mfp16-format
12977 Specify the format of the @code{__fp16} half-precision floating-point type.
12978 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12979 the default is @samp{none}, in which case the @code{__fp16} type is not
12980 defined.  @xref{Half-Precision}, for more information.
12982 @item -mstructure-size-boundary=@var{n}
12983 @opindex mstructure-size-boundary
12984 The sizes of all structures and unions are rounded up to a multiple
12985 of the number of bits set by this option.  Permissible values are 8, 32
12986 and 64.  The default value varies for different toolchains.  For the COFF
12987 targeted toolchain the default value is 8.  A value of 64 is only allowed
12988 if the underlying ABI supports it.
12990 Specifying a larger number can produce faster, more efficient code, but
12991 can also increase the size of the program.  Different values are potentially
12992 incompatible.  Code compiled with one value cannot necessarily expect to
12993 work with code or libraries compiled with another value, if they exchange
12994 information using structures or unions.
12996 @item -mabort-on-noreturn
12997 @opindex mabort-on-noreturn
12998 Generate a call to the function @code{abort} at the end of a
12999 @code{noreturn} function.  It is executed if the function tries to
13000 return.
13002 @item -mlong-calls
13003 @itemx -mno-long-calls
13004 @opindex mlong-calls
13005 @opindex mno-long-calls
13006 Tells the compiler to perform function calls by first loading the
13007 address of the function into a register and then performing a subroutine
13008 call on this register.  This switch is needed if the target function
13009 lies outside of the 64-megabyte addressing range of the offset-based
13010 version of subroutine call instruction.
13012 Even if this switch is enabled, not all function calls are turned
13013 into long calls.  The heuristic is that static functions, functions
13014 that have the @samp{short-call} attribute, functions that are inside
13015 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
13016 definitions have already been compiled within the current compilation
13017 unit are not turned into long calls.  The exceptions to this rule are
13018 that weak function definitions, functions with the @samp{long-call}
13019 attribute or the @samp{section} attribute, and functions that are within
13020 the scope of a @samp{#pragma long_calls} directive are always
13021 turned into long calls.
13023 This feature is not enabled by default.  Specifying
13024 @option{-mno-long-calls} restores the default behavior, as does
13025 placing the function calls within the scope of a @samp{#pragma
13026 long_calls_off} directive.  Note these switches have no effect on how
13027 the compiler generates code to handle function calls via function
13028 pointers.
13030 @item -msingle-pic-base
13031 @opindex msingle-pic-base
13032 Treat the register used for PIC addressing as read-only, rather than
13033 loading it in the prologue for each function.  The runtime system is
13034 responsible for initializing this register with an appropriate value
13035 before execution begins.
13037 @item -mpic-register=@var{reg}
13038 @opindex mpic-register
13039 Specify the register to be used for PIC addressing.
13040 For standard PIC base case, the default will be any suitable register
13041 determined by compiler.  For single PIC base case, the default is
13042 @samp{R9} if target is EABI based or stack-checking is enabled,
13043 otherwise the default is @samp{R10}.
13045 @item -mpic-data-is-text-relative
13046 @opindex mpic-data-is-text-relative
13047 Assume that each data segments are relative to text segment at load time.
13048 Therefore, it permits addressing data using PC-relative operations.
13049 This option is on by default for targets other than VxWorks RTP.
13051 @item -mpoke-function-name
13052 @opindex mpoke-function-name
13053 Write the name of each function into the text section, directly
13054 preceding the function prologue.  The generated code is similar to this:
13056 @smallexample
13057      t0
13058          .ascii "arm_poke_function_name", 0
13059          .align
13060      t1
13061          .word 0xff000000 + (t1 - t0)
13062      arm_poke_function_name
13063          mov     ip, sp
13064          stmfd   sp!, @{fp, ip, lr, pc@}
13065          sub     fp, ip, #4
13066 @end smallexample
13068 When performing a stack backtrace, code can inspect the value of
13069 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13070 location @code{pc - 12} and the top 8 bits are set, then we know that
13071 there is a function name embedded immediately preceding this location
13072 and has length @code{((pc[-3]) & 0xff000000)}.
13074 @item -mthumb
13075 @itemx -marm
13076 @opindex marm
13077 @opindex mthumb
13079 Select between generating code that executes in ARM and Thumb
13080 states.  The default for most configurations is to generate code
13081 that executes in ARM state, but the default can be changed by
13082 configuring GCC with the @option{--with-mode=}@var{state}
13083 configure option.
13085 @item -mtpcs-frame
13086 @opindex mtpcs-frame
13087 Generate a stack frame that is compliant with the Thumb Procedure Call
13088 Standard for all non-leaf functions.  (A leaf function is one that does
13089 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13091 @item -mtpcs-leaf-frame
13092 @opindex mtpcs-leaf-frame
13093 Generate a stack frame that is compliant with the Thumb Procedure Call
13094 Standard for all leaf functions.  (A leaf function is one that does
13095 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13097 @item -mcallee-super-interworking
13098 @opindex mcallee-super-interworking
13099 Gives all externally visible functions in the file being compiled an ARM
13100 instruction set header which switches to Thumb mode before executing the
13101 rest of the function.  This allows these functions to be called from
13102 non-interworking code.  This option is not valid in AAPCS configurations
13103 because interworking is enabled by default.
13105 @item -mcaller-super-interworking
13106 @opindex mcaller-super-interworking
13107 Allows calls via function pointers (including virtual functions) to
13108 execute correctly regardless of whether the target code has been
13109 compiled for interworking or not.  There is a small overhead in the cost
13110 of executing a function pointer if this option is enabled.  This option
13111 is not valid in AAPCS configurations because interworking is enabled
13112 by default.
13114 @item -mtp=@var{name}
13115 @opindex mtp
13116 Specify the access model for the thread local storage pointer.  The valid
13117 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
13118 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
13119 (supported in the arm6k architecture), and @option{auto}, which uses the
13120 best available method for the selected processor.  The default setting is
13121 @option{auto}.
13123 @item -mtls-dialect=@var{dialect}
13124 @opindex mtls-dialect
13125 Specify the dialect to use for accessing thread local storage.  Two
13126 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13127 @samp{gnu} dialect selects the original GNU scheme for supporting
13128 local and global dynamic TLS models.  The @samp{gnu2} dialect
13129 selects the GNU descriptor scheme, which provides better performance
13130 for shared libraries.  The GNU descriptor scheme is compatible with
13131 the original scheme, but does require new assembler, linker and
13132 library support.  Initial and local exec TLS models are unaffected by
13133 this option and always use the original scheme.
13135 @item -mword-relocations
13136 @opindex mword-relocations
13137 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13138 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13139 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13140 is specified.
13142 @item -mfix-cortex-m3-ldrd
13143 @opindex mfix-cortex-m3-ldrd
13144 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13145 with overlapping destination and base registers are used.  This option avoids
13146 generating these instructions.  This option is enabled by default when
13147 @option{-mcpu=cortex-m3} is specified.
13149 @item -munaligned-access
13150 @itemx -mno-unaligned-access
13151 @opindex munaligned-access
13152 @opindex mno-unaligned-access
13153 Enables (or disables) reading and writing of 16- and 32- bit values
13154 from addresses that are not 16- or 32- bit aligned.  By default
13155 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13156 architectures, and enabled for all other architectures.  If unaligned
13157 access is not enabled then words in packed data structures will be
13158 accessed a byte at a time.
13160 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
13161 generated object file to either true or false, depending upon the
13162 setting of this option.  If unaligned access is enabled then the
13163 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
13164 defined.
13166 @item -mneon-for-64bits
13167 @opindex mneon-for-64bits
13168 Enables using Neon to handle scalar 64-bits operations. This is
13169 disabled by default since the cost of moving data from core registers
13170 to Neon is high.
13172 @item -mslow-flash-data
13173 @opindex mslow-flash-data
13174 Assume loading data from flash is slower than fetching instruction.
13175 Therefore literal load is minimized for better performance.
13176 This option is only supported when compiling for ARMv7 M-profile and
13177 off by default.
13179 @item -masm-syntax-unified
13180 @opindex masm-syntax-unified
13181 Assume inline assembler is using unified asm syntax.  The default is
13182 currently off which implies divided syntax.  Currently this option is
13183 available only for Thumb1 and has no effect on ARM state and Thumb2.
13184 However, this may change in future releases of GCC.  Divided syntax
13185 should be considered deprecated.
13187 @item -mrestrict-it
13188 @opindex mrestrict-it
13189 Restricts generation of IT blocks to conform to the rules of ARMv8.
13190 IT blocks can only contain a single 16-bit instruction from a select
13191 set of instructions. This option is on by default for ARMv8 Thumb mode.
13192 @end table
13194 @node AVR Options
13195 @subsection AVR Options
13196 @cindex AVR Options
13198 These options are defined for AVR implementations:
13200 @table @gcctabopt
13201 @item -mmcu=@var{mcu}
13202 @opindex mmcu
13203 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13205 The default for this option is@tie{}@code{avr2}.
13207 GCC supports the following AVR devices and ISAs:
13209 @include avr-mmcu.texi
13211 @item -maccumulate-args
13212 @opindex maccumulate-args
13213 Accumulate outgoing function arguments and acquire/release the needed
13214 stack space for outgoing function arguments once in function
13215 prologue/epilogue.  Without this option, outgoing arguments are pushed
13216 before calling a function and popped afterwards.
13218 Popping the arguments after the function call can be expensive on
13219 AVR so that accumulating the stack space might lead to smaller
13220 executables because arguments need not to be removed from the
13221 stack after such a function call.
13223 This option can lead to reduced code size for functions that perform
13224 several calls to functions that get their arguments on the stack like
13225 calls to printf-like functions.
13227 @item -mbranch-cost=@var{cost}
13228 @opindex mbranch-cost
13229 Set the branch costs for conditional branch instructions to
13230 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13231 integers. The default branch cost is 0.
13233 @item -mcall-prologues
13234 @opindex mcall-prologues
13235 Functions prologues/epilogues are expanded as calls to appropriate
13236 subroutines.  Code size is smaller.
13238 @item -mint8
13239 @opindex mint8
13240 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13241 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13242 and @code{long long} is 4 bytes.  Please note that this option does not
13243 conform to the C standards, but it results in smaller code
13244 size.
13246 @item -mno-interrupts
13247 @opindex mno-interrupts
13248 Generated code is not compatible with hardware interrupts.
13249 Code size is smaller.
13251 @item -mrelax
13252 @opindex mrelax
13253 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13254 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13255 Setting @code{-mrelax} just adds the @code{--relax} option to the
13256 linker command line when the linker is called.
13258 Jump relaxing is performed by the linker because jump offsets are not
13259 known before code is located. Therefore, the assembler code generated by the
13260 compiler is the same, but the instructions in the executable may
13261 differ from instructions in the assembler code.
13263 Relaxing must be turned on if linker stubs are needed, see the
13264 section on @code{EIND} and linker stubs below.
13266 @item -msp8
13267 @opindex msp8
13268 Treat the stack pointer register as an 8-bit register,
13269 i.e.@: assume the high byte of the stack pointer is zero.
13270 In general, you don't need to set this option by hand.
13272 This option is used internally by the compiler to select and
13273 build multilibs for architectures @code{avr2} and @code{avr25}.
13274 These architectures mix devices with and without @code{SPH}.
13275 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13276 the compiler driver will add or remove this option from the compiler
13277 proper's command line, because the compiler then knows if the device
13278 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13279 register or not.
13281 @item -mstrict-X
13282 @opindex mstrict-X
13283 Use address register @code{X} in a way proposed by the hardware.  This means
13284 that @code{X} is only used in indirect, post-increment or
13285 pre-decrement addressing.
13287 Without this option, the @code{X} register may be used in the same way
13288 as @code{Y} or @code{Z} which then is emulated by additional
13289 instructions.  
13290 For example, loading a value with @code{X+const} addressing with a
13291 small non-negative @code{const < 64} to a register @var{Rn} is
13292 performed as
13294 @example
13295 adiw r26, const   ; X += const
13296 ld   @var{Rn}, X        ; @var{Rn} = *X
13297 sbiw r26, const   ; X -= const
13298 @end example
13300 @item -mtiny-stack
13301 @opindex mtiny-stack
13302 Only change the lower 8@tie{}bits of the stack pointer.
13304 @item -Waddr-space-convert
13305 @opindex Waddr-space-convert
13306 Warn about conversions between address spaces in the case where the
13307 resulting address space is not contained in the incoming address space.
13308 @end table
13310 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13311 @cindex @code{EIND}
13312 Pointers in the implementation are 16@tie{}bits wide.
13313 The address of a function or label is represented as word address so
13314 that indirect jumps and calls can target any code address in the
13315 range of 64@tie{}Ki words.
13317 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13318 bytes of program memory space, there is a special function register called
13319 @code{EIND} that serves as most significant part of the target address
13320 when @code{EICALL} or @code{EIJMP} instructions are used.
13322 Indirect jumps and calls on these devices are handled as follows by
13323 the compiler and are subject to some limitations:
13325 @itemize @bullet
13327 @item
13328 The compiler never sets @code{EIND}.
13330 @item
13331 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13332 instructions or might read @code{EIND} directly in order to emulate an
13333 indirect call/jump by means of a @code{RET} instruction.
13335 @item
13336 The compiler assumes that @code{EIND} never changes during the startup
13337 code or during the application. In particular, @code{EIND} is not
13338 saved/restored in function or interrupt service routine
13339 prologue/epilogue.
13341 @item
13342 For indirect calls to functions and computed goto, the linker
13343 generates @emph{stubs}. Stubs are jump pads sometimes also called
13344 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13345 The stub contains a direct jump to the desired address.
13347 @item
13348 Linker relaxation must be turned on so that the linker will generate
13349 the stubs correctly an all situaltion. See the compiler option
13350 @code{-mrelax} and the linler option @code{--relax}.
13351 There are corner cases where the linker is supposed to generate stubs
13352 but aborts without relaxation and without a helpful error message.
13354 @item
13355 The default linker script is arranged for code with @code{EIND = 0}.
13356 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13357 linker script has to be used in order to place the sections whose
13358 name start with @code{.trampolines} into the segment where @code{EIND}
13359 points to.
13361 @item
13362 The startup code from libgcc never sets @code{EIND}.
13363 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13364 For the impact of AVR-LibC on @code{EIND}, see the
13365 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13367 @item
13368 It is legitimate for user-specific startup code to set up @code{EIND}
13369 early, for example by means of initialization code located in
13370 section @code{.init3}. Such code runs prior to general startup code
13371 that initializes RAM and calls constructors, but after the bit
13372 of startup code from AVR-LibC that sets @code{EIND} to the segment
13373 where the vector table is located.
13374 @example
13375 #include <avr/io.h>
13377 static void
13378 __attribute__((section(".init3"),naked,used,no_instrument_function))
13379 init3_set_eind (void)
13381   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13382                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13384 @end example
13386 @noindent
13387 The @code{__trampolines_start} symbol is defined in the linker script.
13389 @item
13390 Stubs are generated automatically by the linker if
13391 the following two conditions are met:
13392 @itemize @minus
13394 @item The address of a label is taken by means of the @code{gs} modifier
13395 (short for @emph{generate stubs}) like so:
13396 @example
13397 LDI r24, lo8(gs(@var{func}))
13398 LDI r25, hi8(gs(@var{func}))
13399 @end example
13400 @item The final location of that label is in a code segment
13401 @emph{outside} the segment where the stubs are located.
13402 @end itemize
13404 @item
13405 The compiler emits such @code{gs} modifiers for code labels in the
13406 following situations:
13407 @itemize @minus
13408 @item Taking address of a function or code label.
13409 @item Computed goto.
13410 @item If prologue-save function is used, see @option{-mcall-prologues}
13411 command-line option.
13412 @item Switch/case dispatch tables. If you do not want such dispatch
13413 tables you can specify the @option{-fno-jump-tables} command-line option.
13414 @item C and C++ constructors/destructors called during startup/shutdown.
13415 @item If the tools hit a @code{gs()} modifier explained above.
13416 @end itemize
13418 @item
13419 Jumping to non-symbolic addresses like so is @emph{not} supported:
13421 @example
13422 int main (void)
13424     /* Call function at word address 0x2 */
13425     return ((int(*)(void)) 0x2)();
13427 @end example
13429 Instead, a stub has to be set up, i.e.@: the function has to be called
13430 through a symbol (@code{func_4} in the example):
13432 @example
13433 int main (void)
13435     extern int func_4 (void);
13437     /* Call function at byte address 0x4 */
13438     return func_4();
13440 @end example
13442 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13443 Alternatively, @code{func_4} can be defined in the linker script.
13444 @end itemize
13446 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13447 @cindex @code{RAMPD}
13448 @cindex @code{RAMPX}
13449 @cindex @code{RAMPY}
13450 @cindex @code{RAMPZ}
13451 Some AVR devices support memories larger than the 64@tie{}KiB range
13452 that can be accessed with 16-bit pointers.  To access memory locations
13453 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13454 register is used as high part of the address:
13455 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13456 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13457 register, respectively, to get a wide address. Similarly,
13458 @code{RAMPD} is used together with direct addressing.
13460 @itemize
13461 @item
13462 The startup code initializes the @code{RAMP} special function
13463 registers with zero.
13465 @item
13466 If a @ref{AVR Named Address Spaces,named address space} other than
13467 generic or @code{__flash} is used, then @code{RAMPZ} is set
13468 as needed before the operation.
13470 @item
13471 If the device supports RAM larger than 64@tie{}KiB and the compiler
13472 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13473 is reset to zero after the operation.
13475 @item
13476 If the device comes with a specific @code{RAMP} register, the ISR
13477 prologue/epilogue saves/restores that SFR and initializes it with
13478 zero in case the ISR code might (implicitly) use it.
13480 @item
13481 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13482 If you use inline assembler to read from locations outside the
13483 16-bit address range and change one of the @code{RAMP} registers,
13484 you must reset it to zero after the access.
13486 @end itemize
13488 @subsubsection AVR Built-in Macros
13490 GCC defines several built-in macros so that the user code can test
13491 for the presence or absence of features.  Almost any of the following
13492 built-in macros are deduced from device capabilities and thus
13493 triggered by the @code{-mmcu=} command-line option.
13495 For even more AVR-specific built-in macros see
13496 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13498 @table @code
13500 @item __AVR_ARCH__
13501 Build-in macro that resolves to a decimal number that identifies the
13502 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13503 Possible values are:
13505 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13506 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13507 @code{105}, @code{106}, @code{107}
13509 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13510 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13511 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13512 @code{avrxmega6}, @code{avrxmega7}, respectively.
13513 If @var{mcu} specifies a device, this built-in macro is set
13514 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13515 defined to @code{4}.
13517 @item __AVR_@var{Device}__
13518 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13519 the device's name. For example, @code{-mmcu=atmega8} defines the
13520 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13521 @code{__AVR_ATtiny261A__}, etc.
13523 The built-in macros' names follow
13524 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13525 the device name as from the AVR user manual. The difference between
13526 @var{Device} in the built-in macro and @var{device} in
13527 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13529 If @var{device} is not a device but only a core architecture like
13530 @code{avr51}, this macro will not be defined.
13532 @item   __AVR_DEVICE_NAME__
13533 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13534 the device's name. For example, with @code{-mmcu=atmega8} the macro
13535 will be defined to @code{atmega8}.
13537 If @var{device} is not a device but only a core architecture like
13538 @code{avr51}, this macro will not be defined.
13540 @item __AVR_XMEGA__
13541 The device / architecture belongs to the XMEGA family of devices.
13543 @item __AVR_HAVE_ELPM__
13544 The device has the the @code{ELPM} instruction.
13546 @item __AVR_HAVE_ELPMX__
13547 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13548 R@var{n},Z+} instructions.
13550 @item __AVR_HAVE_MOVW__
13551 The device has the @code{MOVW} instruction to perform 16-bit
13552 register-register moves.
13554 @item __AVR_HAVE_LPMX__
13555 The device has the @code{LPM R@var{n},Z} and
13556 @code{LPM R@var{n},Z+} instructions.
13558 @item __AVR_HAVE_MUL__
13559 The device has a hardware multiplier. 
13561 @item __AVR_HAVE_JMP_CALL__
13562 The device has the @code{JMP} and @code{CALL} instructions.
13563 This is the case for devices with at least 16@tie{}KiB of program
13564 memory.
13566 @item __AVR_HAVE_EIJMP_EICALL__
13567 @itemx __AVR_3_BYTE_PC__
13568 The device has the @code{EIJMP} and @code{EICALL} instructions.
13569 This is the case for devices with more than 128@tie{}KiB of program memory.
13570 This also means that the program counter
13571 (PC) is 3@tie{}bytes wide.
13573 @item __AVR_2_BYTE_PC__
13574 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13575 with up to 128@tie{}KiB of program memory.
13577 @item __AVR_HAVE_8BIT_SP__
13578 @itemx __AVR_HAVE_16BIT_SP__
13579 The stack pointer (SP) register is treated as 8-bit respectively
13580 16-bit register by the compiler.
13581 The definition of these macros is affected by @code{-mtiny-stack}.
13583 @item __AVR_HAVE_SPH__
13584 @itemx __AVR_SP8__
13585 The device has the SPH (high part of stack pointer) special function
13586 register or has an 8-bit stack pointer, respectively.
13587 The definition of these macros is affected by @code{-mmcu=} and
13588 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13589 by @code{-msp8}.
13591 @item __AVR_HAVE_RAMPD__
13592 @itemx __AVR_HAVE_RAMPX__
13593 @itemx __AVR_HAVE_RAMPY__
13594 @itemx __AVR_HAVE_RAMPZ__
13595 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13596 @code{RAMPZ} special function register, respectively.
13598 @item __NO_INTERRUPTS__
13599 This macro reflects the @code{-mno-interrupts} command line option.
13601 @item __AVR_ERRATA_SKIP__
13602 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13603 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13604 instructions because of a hardware erratum.  Skip instructions are
13605 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13606 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13607 set.
13609 @item __AVR_ISA_RMW__
13610 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13612 @item __AVR_SFR_OFFSET__=@var{offset}
13613 Instructions that can address I/O special function registers directly
13614 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13615 address as if addressed by an instruction to access RAM like @code{LD}
13616 or @code{STS}. This offset depends on the device architecture and has
13617 to be subtracted from the RAM address in order to get the
13618 respective I/O@tie{}address.
13620 @item __WITH_AVRLIBC__
13621 The compiler is configured to be used together with AVR-Libc.
13622 See the @code{--with-avrlibc} configure option.
13624 @end table
13626 @node Blackfin Options
13627 @subsection Blackfin Options
13628 @cindex Blackfin Options
13630 @table @gcctabopt
13631 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13632 @opindex mcpu=
13633 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13634 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13635 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13636 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13637 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13638 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13639 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13640 @samp{bf561}, @samp{bf592}.
13642 The optional @var{sirevision} specifies the silicon revision of the target
13643 Blackfin processor.  Any workarounds available for the targeted silicon revision
13644 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13645 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13646 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13647 hexadecimal digits representing the major and minor numbers in the silicon
13648 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13649 is not defined.  If @var{sirevision} is @samp{any}, the
13650 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13651 If this optional @var{sirevision} is not used, GCC assumes the latest known
13652 silicon revision of the targeted Blackfin processor.
13654 GCC defines a preprocessor macro for the specified @var{cpu}.
13655 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13656 provided by libgloss to be linked in if @option{-msim} is not given.
13658 Without this option, @samp{bf532} is used as the processor by default.
13660 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13661 only the preprocessor macro is defined.
13663 @item -msim
13664 @opindex msim
13665 Specifies that the program will be run on the simulator.  This causes
13666 the simulator BSP provided by libgloss to be linked in.  This option
13667 has effect only for @samp{bfin-elf} toolchain.
13668 Certain other options, such as @option{-mid-shared-library} and
13669 @option{-mfdpic}, imply @option{-msim}.
13671 @item -momit-leaf-frame-pointer
13672 @opindex momit-leaf-frame-pointer
13673 Don't keep the frame pointer in a register for leaf functions.  This
13674 avoids the instructions to save, set up and restore frame pointers and
13675 makes an extra register available in leaf functions.  The option
13676 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13677 which might make debugging harder.
13679 @item -mspecld-anomaly
13680 @opindex mspecld-anomaly
13681 When enabled, the compiler ensures that the generated code does not
13682 contain speculative loads after jump instructions. If this option is used,
13683 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13685 @item -mno-specld-anomaly
13686 @opindex mno-specld-anomaly
13687 Don't generate extra code to prevent speculative loads from occurring.
13689 @item -mcsync-anomaly
13690 @opindex mcsync-anomaly
13691 When enabled, the compiler ensures that the generated code does not
13692 contain CSYNC or SSYNC instructions too soon after conditional branches.
13693 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13695 @item -mno-csync-anomaly
13696 @opindex mno-csync-anomaly
13697 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13698 occurring too soon after a conditional branch.
13700 @item -mlow-64k
13701 @opindex mlow-64k
13702 When enabled, the compiler is free to take advantage of the knowledge that
13703 the entire program fits into the low 64k of memory.
13705 @item -mno-low-64k
13706 @opindex mno-low-64k
13707 Assume that the program is arbitrarily large.  This is the default.
13709 @item -mstack-check-l1
13710 @opindex mstack-check-l1
13711 Do stack checking using information placed into L1 scratchpad memory by the
13712 uClinux kernel.
13714 @item -mid-shared-library
13715 @opindex mid-shared-library
13716 Generate code that supports shared libraries via the library ID method.
13717 This allows for execute in place and shared libraries in an environment
13718 without virtual memory management.  This option implies @option{-fPIC}.
13719 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13721 @item -mno-id-shared-library
13722 @opindex mno-id-shared-library
13723 Generate code that doesn't assume ID-based shared libraries are being used.
13724 This is the default.
13726 @item -mleaf-id-shared-library
13727 @opindex mleaf-id-shared-library
13728 Generate code that supports shared libraries via the library ID method,
13729 but assumes that this library or executable won't link against any other
13730 ID shared libraries.  That allows the compiler to use faster code for jumps
13731 and calls.
13733 @item -mno-leaf-id-shared-library
13734 @opindex mno-leaf-id-shared-library
13735 Do not assume that the code being compiled won't link against any ID shared
13736 libraries.  Slower code is generated for jump and call insns.
13738 @item -mshared-library-id=n
13739 @opindex mshared-library-id
13740 Specifies the identification number of the ID-based shared library being
13741 compiled.  Specifying a value of 0 generates more compact code; specifying
13742 other values forces the allocation of that number to the current
13743 library but is no more space- or time-efficient than omitting this option.
13745 @item -msep-data
13746 @opindex msep-data
13747 Generate code that allows the data segment to be located in a different
13748 area of memory from the text segment.  This allows for execute in place in
13749 an environment without virtual memory management by eliminating relocations
13750 against the text section.
13752 @item -mno-sep-data
13753 @opindex mno-sep-data
13754 Generate code that assumes that the data segment follows the text segment.
13755 This is the default.
13757 @item -mlong-calls
13758 @itemx -mno-long-calls
13759 @opindex mlong-calls
13760 @opindex mno-long-calls
13761 Tells the compiler to perform function calls by first loading the
13762 address of the function into a register and then performing a subroutine
13763 call on this register.  This switch is needed if the target function
13764 lies outside of the 24-bit addressing range of the offset-based
13765 version of subroutine call instruction.
13767 This feature is not enabled by default.  Specifying
13768 @option{-mno-long-calls} restores the default behavior.  Note these
13769 switches have no effect on how the compiler generates code to handle
13770 function calls via function pointers.
13772 @item -mfast-fp
13773 @opindex mfast-fp
13774 Link with the fast floating-point library. This library relaxes some of
13775 the IEEE floating-point standard's rules for checking inputs against
13776 Not-a-Number (NAN), in the interest of performance.
13778 @item -minline-plt
13779 @opindex minline-plt
13780 Enable inlining of PLT entries in function calls to functions that are
13781 not known to bind locally.  It has no effect without @option{-mfdpic}.
13783 @item -mmulticore
13784 @opindex mmulticore
13785 Build a standalone application for multicore Blackfin processors. 
13786 This option causes proper start files and link scripts supporting 
13787 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13788 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13790 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13791 selects the one-application-per-core programming model.  Without
13792 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13793 programming model is used. In this model, the main function of Core B
13794 should be named as @code{coreb_main}.
13796 If this option is not used, the single-core application programming
13797 model is used.
13799 @item -mcorea
13800 @opindex mcorea
13801 Build a standalone application for Core A of BF561 when using
13802 the one-application-per-core programming model. Proper start files
13803 and link scripts are used to support Core A, and the macro
13804 @code{__BFIN_COREA} is defined.
13805 This option can only be used in conjunction with @option{-mmulticore}.
13807 @item -mcoreb
13808 @opindex mcoreb
13809 Build a standalone application for Core B of BF561 when using
13810 the one-application-per-core programming model. Proper start files
13811 and link scripts are used to support Core B, and the macro
13812 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13813 should be used instead of @code{main}. 
13814 This option can only be used in conjunction with @option{-mmulticore}.
13816 @item -msdram
13817 @opindex msdram
13818 Build a standalone application for SDRAM. Proper start files and
13819 link scripts are used to put the application into SDRAM, and the macro
13820 @code{__BFIN_SDRAM} is defined.
13821 The loader should initialize SDRAM before loading the application.
13823 @item -micplb
13824 @opindex micplb
13825 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13826 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13827 are enabled; for standalone applications the default is off.
13828 @end table
13830 @node C6X Options
13831 @subsection C6X Options
13832 @cindex C6X Options
13834 @table @gcctabopt
13835 @item -march=@var{name}
13836 @opindex march
13837 This specifies the name of the target architecture.  GCC uses this
13838 name to determine what kind of instructions it can emit when generating
13839 assembly code.  Permissible names are: @samp{c62x},
13840 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13842 @item -mbig-endian
13843 @opindex mbig-endian
13844 Generate code for a big-endian target.
13846 @item -mlittle-endian
13847 @opindex mlittle-endian
13848 Generate code for a little-endian target.  This is the default.
13850 @item -msim
13851 @opindex msim
13852 Choose startup files and linker script suitable for the simulator.
13854 @item -msdata=default
13855 @opindex msdata=default
13856 Put small global and static data in the @samp{.neardata} section,
13857 which is pointed to by register @code{B14}.  Put small uninitialized
13858 global and static data in the @samp{.bss} section, which is adjacent
13859 to the @samp{.neardata} section.  Put small read-only data into the
13860 @samp{.rodata} section.  The corresponding sections used for large
13861 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13863 @item -msdata=all
13864 @opindex msdata=all
13865 Put all data, not just small objects, into the sections reserved for
13866 small data, and use addressing relative to the @code{B14} register to
13867 access them.
13869 @item -msdata=none
13870 @opindex msdata=none
13871 Make no use of the sections reserved for small data, and use absolute
13872 addresses to access all data.  Put all initialized global and static
13873 data in the @samp{.fardata} section, and all uninitialized data in the
13874 @samp{.far} section.  Put all constant data into the @samp{.const}
13875 section.
13876 @end table
13878 @node CRIS Options
13879 @subsection CRIS Options
13880 @cindex CRIS Options
13882 These options are defined specifically for the CRIS ports.
13884 @table @gcctabopt
13885 @item -march=@var{architecture-type}
13886 @itemx -mcpu=@var{architecture-type}
13887 @opindex march
13888 @opindex mcpu
13889 Generate code for the specified architecture.  The choices for
13890 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13891 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13892 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13893 @samp{v10}.
13895 @item -mtune=@var{architecture-type}
13896 @opindex mtune
13897 Tune to @var{architecture-type} everything applicable about the generated
13898 code, except for the ABI and the set of available instructions.  The
13899 choices for @var{architecture-type} are the same as for
13900 @option{-march=@var{architecture-type}}.
13902 @item -mmax-stack-frame=@var{n}
13903 @opindex mmax-stack-frame
13904 Warn when the stack frame of a function exceeds @var{n} bytes.
13906 @item -metrax4
13907 @itemx -metrax100
13908 @opindex metrax4
13909 @opindex metrax100
13910 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13911 @option{-march=v3} and @option{-march=v8} respectively.
13913 @item -mmul-bug-workaround
13914 @itemx -mno-mul-bug-workaround
13915 @opindex mmul-bug-workaround
13916 @opindex mno-mul-bug-workaround
13917 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13918 models where it applies.  This option is active by default.
13920 @item -mpdebug
13921 @opindex mpdebug
13922 Enable CRIS-specific verbose debug-related information in the assembly
13923 code.  This option also has the effect of turning off the @samp{#NO_APP}
13924 formatted-code indicator to the assembler at the beginning of the
13925 assembly file.
13927 @item -mcc-init
13928 @opindex mcc-init
13929 Do not use condition-code results from previous instruction; always emit
13930 compare and test instructions before use of condition codes.
13932 @item -mno-side-effects
13933 @opindex mno-side-effects
13934 Do not emit instructions with side effects in addressing modes other than
13935 post-increment.
13937 @item -mstack-align
13938 @itemx -mno-stack-align
13939 @itemx -mdata-align
13940 @itemx -mno-data-align
13941 @itemx -mconst-align
13942 @itemx -mno-const-align
13943 @opindex mstack-align
13944 @opindex mno-stack-align
13945 @opindex mdata-align
13946 @opindex mno-data-align
13947 @opindex mconst-align
13948 @opindex mno-const-align
13949 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13950 stack frame, individual data and constants to be aligned for the maximum
13951 single data access size for the chosen CPU model.  The default is to
13952 arrange for 32-bit alignment.  ABI details such as structure layout are
13953 not affected by these options.
13955 @item -m32-bit
13956 @itemx -m16-bit
13957 @itemx -m8-bit
13958 @opindex m32-bit
13959 @opindex m16-bit
13960 @opindex m8-bit
13961 Similar to the stack- data- and const-align options above, these options
13962 arrange for stack frame, writable data and constants to all be 32-bit,
13963 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13965 @item -mno-prologue-epilogue
13966 @itemx -mprologue-epilogue
13967 @opindex mno-prologue-epilogue
13968 @opindex mprologue-epilogue
13969 With @option{-mno-prologue-epilogue}, the normal function prologue and
13970 epilogue which set up the stack frame are omitted and no return
13971 instructions or return sequences are generated in the code.  Use this
13972 option only together with visual inspection of the compiled code: no
13973 warnings or errors are generated when call-saved registers must be saved,
13974 or storage for local variables needs to be allocated.
13976 @item -mno-gotplt
13977 @itemx -mgotplt
13978 @opindex mno-gotplt
13979 @opindex mgotplt
13980 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13981 instruction sequences that load addresses for functions from the PLT part
13982 of the GOT rather than (traditional on other architectures) calls to the
13983 PLT@.  The default is @option{-mgotplt}.
13985 @item -melf
13986 @opindex melf
13987 Legacy no-op option only recognized with the cris-axis-elf and
13988 cris-axis-linux-gnu targets.
13990 @item -mlinux
13991 @opindex mlinux
13992 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13994 @item -sim
13995 @opindex sim
13996 This option, recognized for the cris-axis-elf, arranges
13997 to link with input-output functions from a simulator library.  Code,
13998 initialized data and zero-initialized data are allocated consecutively.
14000 @item -sim2
14001 @opindex sim2
14002 Like @option{-sim}, but pass linker options to locate initialized data at
14003 0x40000000 and zero-initialized data at 0x80000000.
14004 @end table
14006 @node CR16 Options
14007 @subsection CR16 Options
14008 @cindex CR16 Options
14010 These options are defined specifically for the CR16 ports.
14012 @table @gcctabopt
14014 @item -mmac
14015 @opindex mmac
14016 Enable the use of multiply-accumulate instructions. Disabled by default.
14018 @item -mcr16cplus
14019 @itemx -mcr16c
14020 @opindex mcr16cplus
14021 @opindex mcr16c
14022 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
14023 is default.
14025 @item -msim
14026 @opindex msim
14027 Links the library libsim.a which is in compatible with simulator. Applicable
14028 to ELF compiler only.
14030 @item -mint32
14031 @opindex mint32
14032 Choose integer type as 32-bit wide.
14034 @item -mbit-ops
14035 @opindex mbit-ops
14036 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14038 @item -mdata-model=@var{model}
14039 @opindex mdata-model
14040 Choose a data model. The choices for @var{model} are @samp{near},
14041 @samp{far} or @samp{medium}. @samp{medium} is default.
14042 However, @samp{far} is not valid with @option{-mcr16c}, as the
14043 CR16C architecture does not support the far data model.
14044 @end table
14046 @node Darwin Options
14047 @subsection Darwin Options
14048 @cindex Darwin options
14050 These options are defined for all architectures running the Darwin operating
14051 system.
14053 FSF GCC on Darwin does not create ``fat'' object files; it creates
14054 an object file for the single architecture that GCC was built to
14055 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14056 @option{-arch} options are used; it does so by running the compiler or
14057 linker multiple times and joining the results together with
14058 @file{lipo}.
14060 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14061 @samp{i686}) is determined by the flags that specify the ISA
14062 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14063 @option{-force_cpusubtype_ALL} option can be used to override this.
14065 The Darwin tools vary in their behavior when presented with an ISA
14066 mismatch.  The assembler, @file{as}, only permits instructions to
14067 be used that are valid for the subtype of the file it is generating,
14068 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14069 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14070 and prints an error if asked to create a shared library with a less
14071 restrictive subtype than its input files (for instance, trying to put
14072 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14073 for executables, @command{ld}, quietly gives the executable the most
14074 restrictive subtype of any of its input files.
14076 @table @gcctabopt
14077 @item -F@var{dir}
14078 @opindex F
14079 Add the framework directory @var{dir} to the head of the list of
14080 directories to be searched for header files.  These directories are
14081 interleaved with those specified by @option{-I} options and are
14082 scanned in a left-to-right order.
14084 A framework directory is a directory with frameworks in it.  A
14085 framework is a directory with a @file{Headers} and/or
14086 @file{PrivateHeaders} directory contained directly in it that ends
14087 in @file{.framework}.  The name of a framework is the name of this
14088 directory excluding the @file{.framework}.  Headers associated with
14089 the framework are found in one of those two directories, with
14090 @file{Headers} being searched first.  A subframework is a framework
14091 directory that is in a framework's @file{Frameworks} directory.
14092 Includes of subframework headers can only appear in a header of a
14093 framework that contains the subframework, or in a sibling subframework
14094 header.  Two subframeworks are siblings if they occur in the same
14095 framework.  A subframework should not have the same name as a
14096 framework; a warning is issued if this is violated.  Currently a
14097 subframework cannot have subframeworks; in the future, the mechanism
14098 may be extended to support this.  The standard frameworks can be found
14099 in @file{/System/Library/Frameworks} and
14100 @file{/Library/Frameworks}.  An example include looks like
14101 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14102 the name of the framework and @file{header.h} is found in the
14103 @file{PrivateHeaders} or @file{Headers} directory.
14105 @item -iframework@var{dir}
14106 @opindex iframework
14107 Like @option{-F} except the directory is a treated as a system
14108 directory.  The main difference between this @option{-iframework} and
14109 @option{-F} is that with @option{-iframework} the compiler does not
14110 warn about constructs contained within header files found via
14111 @var{dir}.  This option is valid only for the C family of languages.
14113 @item -gused
14114 @opindex gused
14115 Emit debugging information for symbols that are used.  For stabs
14116 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14117 This is by default ON@.
14119 @item -gfull
14120 @opindex gfull
14121 Emit debugging information for all symbols and types.
14123 @item -mmacosx-version-min=@var{version}
14124 The earliest version of MacOS X that this executable will run on
14125 is @var{version}.  Typical values of @var{version} include @code{10.1},
14126 @code{10.2}, and @code{10.3.9}.
14128 If the compiler was built to use the system's headers by default,
14129 then the default for this option is the system version on which the
14130 compiler is running, otherwise the default is to make choices that
14131 are compatible with as many systems and code bases as possible.
14133 @item -mkernel
14134 @opindex mkernel
14135 Enable kernel development mode.  The @option{-mkernel} option sets
14136 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14137 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14138 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14139 applicable.  This mode also sets @option{-mno-altivec},
14140 @option{-msoft-float}, @option{-fno-builtin} and
14141 @option{-mlong-branch} for PowerPC targets.
14143 @item -mone-byte-bool
14144 @opindex mone-byte-bool
14145 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
14146 By default @samp{sizeof(bool)} is @samp{4} when compiling for
14147 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
14148 option has no effect on x86.
14150 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14151 to generate code that is not binary compatible with code generated
14152 without that switch.  Using this switch may require recompiling all
14153 other modules in a program, including system libraries.  Use this
14154 switch to conform to a non-default data model.
14156 @item -mfix-and-continue
14157 @itemx -ffix-and-continue
14158 @itemx -findirect-data
14159 @opindex mfix-and-continue
14160 @opindex ffix-and-continue
14161 @opindex findirect-data
14162 Generate code suitable for fast turnaround development, such as to
14163 allow GDB to dynamically load @code{.o} files into already-running
14164 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14165 are provided for backwards compatibility.
14167 @item -all_load
14168 @opindex all_load
14169 Loads all members of static archive libraries.
14170 See man ld(1) for more information.
14172 @item -arch_errors_fatal
14173 @opindex arch_errors_fatal
14174 Cause the errors having to do with files that have the wrong architecture
14175 to be fatal.
14177 @item -bind_at_load
14178 @opindex bind_at_load
14179 Causes the output file to be marked such that the dynamic linker will
14180 bind all undefined references when the file is loaded or launched.
14182 @item -bundle
14183 @opindex bundle
14184 Produce a Mach-o bundle format file.
14185 See man ld(1) for more information.
14187 @item -bundle_loader @var{executable}
14188 @opindex bundle_loader
14189 This option specifies the @var{executable} that will load the build
14190 output file being linked.  See man ld(1) for more information.
14192 @item -dynamiclib
14193 @opindex dynamiclib
14194 When passed this option, GCC produces a dynamic library instead of
14195 an executable when linking, using the Darwin @file{libtool} command.
14197 @item -force_cpusubtype_ALL
14198 @opindex force_cpusubtype_ALL
14199 This causes GCC's output file to have the @var{ALL} subtype, instead of
14200 one controlled by the @option{-mcpu} or @option{-march} option.
14202 @item -allowable_client  @var{client_name}
14203 @itemx -client_name
14204 @itemx -compatibility_version
14205 @itemx -current_version
14206 @itemx -dead_strip
14207 @itemx -dependency-file
14208 @itemx -dylib_file
14209 @itemx -dylinker_install_name
14210 @itemx -dynamic
14211 @itemx -exported_symbols_list
14212 @itemx -filelist
14213 @need 800
14214 @itemx -flat_namespace
14215 @itemx -force_flat_namespace
14216 @itemx -headerpad_max_install_names
14217 @itemx -image_base
14218 @itemx -init
14219 @itemx -install_name
14220 @itemx -keep_private_externs
14221 @itemx -multi_module
14222 @itemx -multiply_defined
14223 @itemx -multiply_defined_unused
14224 @need 800
14225 @itemx -noall_load
14226 @itemx -no_dead_strip_inits_and_terms
14227 @itemx -nofixprebinding
14228 @itemx -nomultidefs
14229 @itemx -noprebind
14230 @itemx -noseglinkedit
14231 @itemx -pagezero_size
14232 @itemx -prebind
14233 @itemx -prebind_all_twolevel_modules
14234 @itemx -private_bundle
14235 @need 800
14236 @itemx -read_only_relocs
14237 @itemx -sectalign
14238 @itemx -sectobjectsymbols
14239 @itemx -whyload
14240 @itemx -seg1addr
14241 @itemx -sectcreate
14242 @itemx -sectobjectsymbols
14243 @itemx -sectorder
14244 @itemx -segaddr
14245 @itemx -segs_read_only_addr
14246 @need 800
14247 @itemx -segs_read_write_addr
14248 @itemx -seg_addr_table
14249 @itemx -seg_addr_table_filename
14250 @itemx -seglinkedit
14251 @itemx -segprot
14252 @itemx -segs_read_only_addr
14253 @itemx -segs_read_write_addr
14254 @itemx -single_module
14255 @itemx -static
14256 @itemx -sub_library
14257 @need 800
14258 @itemx -sub_umbrella
14259 @itemx -twolevel_namespace
14260 @itemx -umbrella
14261 @itemx -undefined
14262 @itemx -unexported_symbols_list
14263 @itemx -weak_reference_mismatches
14264 @itemx -whatsloaded
14265 @opindex allowable_client
14266 @opindex client_name
14267 @opindex compatibility_version
14268 @opindex current_version
14269 @opindex dead_strip
14270 @opindex dependency-file
14271 @opindex dylib_file
14272 @opindex dylinker_install_name
14273 @opindex dynamic
14274 @opindex exported_symbols_list
14275 @opindex filelist
14276 @opindex flat_namespace
14277 @opindex force_flat_namespace
14278 @opindex headerpad_max_install_names
14279 @opindex image_base
14280 @opindex init
14281 @opindex install_name
14282 @opindex keep_private_externs
14283 @opindex multi_module
14284 @opindex multiply_defined
14285 @opindex multiply_defined_unused
14286 @opindex noall_load
14287 @opindex no_dead_strip_inits_and_terms
14288 @opindex nofixprebinding
14289 @opindex nomultidefs
14290 @opindex noprebind
14291 @opindex noseglinkedit
14292 @opindex pagezero_size
14293 @opindex prebind
14294 @opindex prebind_all_twolevel_modules
14295 @opindex private_bundle
14296 @opindex read_only_relocs
14297 @opindex sectalign
14298 @opindex sectobjectsymbols
14299 @opindex whyload
14300 @opindex seg1addr
14301 @opindex sectcreate
14302 @opindex sectobjectsymbols
14303 @opindex sectorder
14304 @opindex segaddr
14305 @opindex segs_read_only_addr
14306 @opindex segs_read_write_addr
14307 @opindex seg_addr_table
14308 @opindex seg_addr_table_filename
14309 @opindex seglinkedit
14310 @opindex segprot
14311 @opindex segs_read_only_addr
14312 @opindex segs_read_write_addr
14313 @opindex single_module
14314 @opindex static
14315 @opindex sub_library
14316 @opindex sub_umbrella
14317 @opindex twolevel_namespace
14318 @opindex umbrella
14319 @opindex undefined
14320 @opindex unexported_symbols_list
14321 @opindex weak_reference_mismatches
14322 @opindex whatsloaded
14323 These options are passed to the Darwin linker.  The Darwin linker man page
14324 describes them in detail.
14325 @end table
14327 @node DEC Alpha Options
14328 @subsection DEC Alpha Options
14330 These @samp{-m} options are defined for the DEC Alpha implementations:
14332 @table @gcctabopt
14333 @item -mno-soft-float
14334 @itemx -msoft-float
14335 @opindex mno-soft-float
14336 @opindex msoft-float
14337 Use (do not use) the hardware floating-point instructions for
14338 floating-point operations.  When @option{-msoft-float} is specified,
14339 functions in @file{libgcc.a} are used to perform floating-point
14340 operations.  Unless they are replaced by routines that emulate the
14341 floating-point operations, or compiled in such a way as to call such
14342 emulations routines, these routines issue floating-point
14343 operations.   If you are compiling for an Alpha without floating-point
14344 operations, you must ensure that the library is built so as not to call
14345 them.
14347 Note that Alpha implementations without floating-point operations are
14348 required to have floating-point registers.
14350 @item -mfp-reg
14351 @itemx -mno-fp-regs
14352 @opindex mfp-reg
14353 @opindex mno-fp-regs
14354 Generate code that uses (does not use) the floating-point register set.
14355 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14356 register set is not used, floating-point operands are passed in integer
14357 registers as if they were integers and floating-point results are passed
14358 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14359 so any function with a floating-point argument or return value called by code
14360 compiled with @option{-mno-fp-regs} must also be compiled with that
14361 option.
14363 A typical use of this option is building a kernel that does not use,
14364 and hence need not save and restore, any floating-point registers.
14366 @item -mieee
14367 @opindex mieee
14368 The Alpha architecture implements floating-point hardware optimized for
14369 maximum performance.  It is mostly compliant with the IEEE floating-point
14370 standard.  However, for full compliance, software assistance is
14371 required.  This option generates code fully IEEE-compliant code
14372 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14373 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14374 defined during compilation.  The resulting code is less efficient but is
14375 able to correctly support denormalized numbers and exceptional IEEE
14376 values such as not-a-number and plus/minus infinity.  Other Alpha
14377 compilers call this option @option{-ieee_with_no_inexact}.
14379 @item -mieee-with-inexact
14380 @opindex mieee-with-inexact
14381 This is like @option{-mieee} except the generated code also maintains
14382 the IEEE @var{inexact-flag}.  Turning on this option causes the
14383 generated code to implement fully-compliant IEEE math.  In addition to
14384 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14385 macro.  On some Alpha implementations the resulting code may execute
14386 significantly slower than the code generated by default.  Since there is
14387 very little code that depends on the @var{inexact-flag}, you should
14388 normally not specify this option.  Other Alpha compilers call this
14389 option @option{-ieee_with_inexact}.
14391 @item -mfp-trap-mode=@var{trap-mode}
14392 @opindex mfp-trap-mode
14393 This option controls what floating-point related traps are enabled.
14394 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14395 The trap mode can be set to one of four values:
14397 @table @samp
14398 @item n
14399 This is the default (normal) setting.  The only traps that are enabled
14400 are the ones that cannot be disabled in software (e.g., division by zero
14401 trap).
14403 @item u
14404 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14405 as well.
14407 @item su
14408 Like @samp{u}, but the instructions are marked to be safe for software
14409 completion (see Alpha architecture manual for details).
14411 @item sui
14412 Like @samp{su}, but inexact traps are enabled as well.
14413 @end table
14415 @item -mfp-rounding-mode=@var{rounding-mode}
14416 @opindex mfp-rounding-mode
14417 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14418 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14421 @table @samp
14422 @item n
14423 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14424 the nearest machine number or towards the even machine number in case
14425 of a tie.
14427 @item m
14428 Round towards minus infinity.
14430 @item c
14431 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14433 @item d
14434 Dynamic rounding mode.  A field in the floating-point control register
14435 (@var{fpcr}, see Alpha architecture reference manual) controls the
14436 rounding mode in effect.  The C library initializes this register for
14437 rounding towards plus infinity.  Thus, unless your program modifies the
14438 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14439 @end table
14441 @item -mtrap-precision=@var{trap-precision}
14442 @opindex mtrap-precision
14443 In the Alpha architecture, floating-point traps are imprecise.  This
14444 means without software assistance it is impossible to recover from a
14445 floating trap and program execution normally needs to be terminated.
14446 GCC can generate code that can assist operating system trap handlers
14447 in determining the exact location that caused a floating-point trap.
14448 Depending on the requirements of an application, different levels of
14449 precisions can be selected:
14451 @table @samp
14452 @item p
14453 Program precision.  This option is the default and means a trap handler
14454 can only identify which program caused a floating-point exception.
14456 @item f
14457 Function precision.  The trap handler can determine the function that
14458 caused a floating-point exception.
14460 @item i
14461 Instruction precision.  The trap handler can determine the exact
14462 instruction that caused a floating-point exception.
14463 @end table
14465 Other Alpha compilers provide the equivalent options called
14466 @option{-scope_safe} and @option{-resumption_safe}.
14468 @item -mieee-conformant
14469 @opindex mieee-conformant
14470 This option marks the generated code as IEEE conformant.  You must not
14471 use this option unless you also specify @option{-mtrap-precision=i} and either
14472 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14473 is to emit the line @samp{.eflag 48} in the function prologue of the
14474 generated assembly file.
14476 @item -mbuild-constants
14477 @opindex mbuild-constants
14478 Normally GCC examines a 32- or 64-bit integer constant to
14479 see if it can construct it from smaller constants in two or three
14480 instructions.  If it cannot, it outputs the constant as a literal and
14481 generates code to load it from the data segment at run time.
14483 Use this option to require GCC to construct @emph{all} integer constants
14484 using code, even if it takes more instructions (the maximum is six).
14486 You typically use this option to build a shared library dynamic
14487 loader.  Itself a shared library, it must relocate itself in memory
14488 before it can find the variables and constants in its own data segment.
14490 @item -mbwx
14491 @itemx -mno-bwx
14492 @itemx -mcix
14493 @itemx -mno-cix
14494 @itemx -mfix
14495 @itemx -mno-fix
14496 @itemx -mmax
14497 @itemx -mno-max
14498 @opindex mbwx
14499 @opindex mno-bwx
14500 @opindex mcix
14501 @opindex mno-cix
14502 @opindex mfix
14503 @opindex mno-fix
14504 @opindex mmax
14505 @opindex mno-max
14506 Indicate whether GCC should generate code to use the optional BWX,
14507 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14508 sets supported by the CPU type specified via @option{-mcpu=} option or that
14509 of the CPU on which GCC was built if none is specified.
14511 @item -mfloat-vax
14512 @itemx -mfloat-ieee
14513 @opindex mfloat-vax
14514 @opindex mfloat-ieee
14515 Generate code that uses (does not use) VAX F and G floating-point
14516 arithmetic instead of IEEE single and double precision.
14518 @item -mexplicit-relocs
14519 @itemx -mno-explicit-relocs
14520 @opindex mexplicit-relocs
14521 @opindex mno-explicit-relocs
14522 Older Alpha assemblers provided no way to generate symbol relocations
14523 except via assembler macros.  Use of these macros does not allow
14524 optimal instruction scheduling.  GNU binutils as of version 2.12
14525 supports a new syntax that allows the compiler to explicitly mark
14526 which relocations should apply to which instructions.  This option
14527 is mostly useful for debugging, as GCC detects the capabilities of
14528 the assembler when it is built and sets the default accordingly.
14530 @item -msmall-data
14531 @itemx -mlarge-data
14532 @opindex msmall-data
14533 @opindex mlarge-data
14534 When @option{-mexplicit-relocs} is in effect, static data is
14535 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14536 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14537 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14538 16-bit relocations off of the @code{$gp} register.  This limits the
14539 size of the small data area to 64KB, but allows the variables to be
14540 directly accessed via a single instruction.
14542 The default is @option{-mlarge-data}.  With this option the data area
14543 is limited to just below 2GB@.  Programs that require more than 2GB of
14544 data must use @code{malloc} or @code{mmap} to allocate the data in the
14545 heap instead of in the program's data segment.
14547 When generating code for shared libraries, @option{-fpic} implies
14548 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14550 @item -msmall-text
14551 @itemx -mlarge-text
14552 @opindex msmall-text
14553 @opindex mlarge-text
14554 When @option{-msmall-text} is used, the compiler assumes that the
14555 code of the entire program (or shared library) fits in 4MB, and is
14556 thus reachable with a branch instruction.  When @option{-msmall-data}
14557 is used, the compiler can assume that all local symbols share the
14558 same @code{$gp} value, and thus reduce the number of instructions
14559 required for a function call from 4 to 1.
14561 The default is @option{-mlarge-text}.
14563 @item -mcpu=@var{cpu_type}
14564 @opindex mcpu
14565 Set the instruction set and instruction scheduling parameters for
14566 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14567 style name or the corresponding chip number.  GCC supports scheduling
14568 parameters for the EV4, EV5 and EV6 family of processors and
14569 chooses the default values for the instruction set from the processor
14570 you specify.  If you do not specify a processor type, GCC defaults
14571 to the processor on which the compiler was built.
14573 Supported values for @var{cpu_type} are
14575 @table @samp
14576 @item ev4
14577 @itemx ev45
14578 @itemx 21064
14579 Schedules as an EV4 and has no instruction set extensions.
14581 @item ev5
14582 @itemx 21164
14583 Schedules as an EV5 and has no instruction set extensions.
14585 @item ev56
14586 @itemx 21164a
14587 Schedules as an EV5 and supports the BWX extension.
14589 @item pca56
14590 @itemx 21164pc
14591 @itemx 21164PC
14592 Schedules as an EV5 and supports the BWX and MAX extensions.
14594 @item ev6
14595 @itemx 21264
14596 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14598 @item ev67
14599 @itemx 21264a
14600 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14601 @end table
14603 Native toolchains also support the value @samp{native},
14604 which selects the best architecture option for the host processor.
14605 @option{-mcpu=native} has no effect if GCC does not recognize
14606 the processor.
14608 @item -mtune=@var{cpu_type}
14609 @opindex mtune
14610 Set only the instruction scheduling parameters for machine type
14611 @var{cpu_type}.  The instruction set is not changed.
14613 Native toolchains also support the value @samp{native},
14614 which selects the best architecture option for the host processor.
14615 @option{-mtune=native} has no effect if GCC does not recognize
14616 the processor.
14618 @item -mmemory-latency=@var{time}
14619 @opindex mmemory-latency
14620 Sets the latency the scheduler should assume for typical memory
14621 references as seen by the application.  This number is highly
14622 dependent on the memory access patterns used by the application
14623 and the size of the external cache on the machine.
14625 Valid options for @var{time} are
14627 @table @samp
14628 @item @var{number}
14629 A decimal number representing clock cycles.
14631 @item L1
14632 @itemx L2
14633 @itemx L3
14634 @itemx main
14635 The compiler contains estimates of the number of clock cycles for
14636 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14637 (also called Dcache, Scache, and Bcache), as well as to main memory.
14638 Note that L3 is only valid for EV5.
14640 @end table
14641 @end table
14643 @node FR30 Options
14644 @subsection FR30 Options
14645 @cindex FR30 Options
14647 These options are defined specifically for the FR30 port.
14649 @table @gcctabopt
14651 @item -msmall-model
14652 @opindex msmall-model
14653 Use the small address space model.  This can produce smaller code, but
14654 it does assume that all symbolic values and addresses fit into a
14655 20-bit range.
14657 @item -mno-lsim
14658 @opindex mno-lsim
14659 Assume that runtime support has been provided and so there is no need
14660 to include the simulator library (@file{libsim.a}) on the linker
14661 command line.
14663 @end table
14665 @node FRV Options
14666 @subsection FRV Options
14667 @cindex FRV Options
14669 @table @gcctabopt
14670 @item -mgpr-32
14671 @opindex mgpr-32
14673 Only use the first 32 general-purpose registers.
14675 @item -mgpr-64
14676 @opindex mgpr-64
14678 Use all 64 general-purpose registers.
14680 @item -mfpr-32
14681 @opindex mfpr-32
14683 Use only the first 32 floating-point registers.
14685 @item -mfpr-64
14686 @opindex mfpr-64
14688 Use all 64 floating-point registers.
14690 @item -mhard-float
14691 @opindex mhard-float
14693 Use hardware instructions for floating-point operations.
14695 @item -msoft-float
14696 @opindex msoft-float
14698 Use library routines for floating-point operations.
14700 @item -malloc-cc
14701 @opindex malloc-cc
14703 Dynamically allocate condition code registers.
14705 @item -mfixed-cc
14706 @opindex mfixed-cc
14708 Do not try to dynamically allocate condition code registers, only
14709 use @code{icc0} and @code{fcc0}.
14711 @item -mdword
14712 @opindex mdword
14714 Change ABI to use double word insns.
14716 @item -mno-dword
14717 @opindex mno-dword
14719 Do not use double word instructions.
14721 @item -mdouble
14722 @opindex mdouble
14724 Use floating-point double instructions.
14726 @item -mno-double
14727 @opindex mno-double
14729 Do not use floating-point double instructions.
14731 @item -mmedia
14732 @opindex mmedia
14734 Use media instructions.
14736 @item -mno-media
14737 @opindex mno-media
14739 Do not use media instructions.
14741 @item -mmuladd
14742 @opindex mmuladd
14744 Use multiply and add/subtract instructions.
14746 @item -mno-muladd
14747 @opindex mno-muladd
14749 Do not use multiply and add/subtract instructions.
14751 @item -mfdpic
14752 @opindex mfdpic
14754 Select the FDPIC ABI, which uses function descriptors to represent
14755 pointers to functions.  Without any PIC/PIE-related options, it
14756 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14757 assumes GOT entries and small data are within a 12-bit range from the
14758 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14759 are computed with 32 bits.
14760 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14762 @item -minline-plt
14763 @opindex minline-plt
14765 Enable inlining of PLT entries in function calls to functions that are
14766 not known to bind locally.  It has no effect without @option{-mfdpic}.
14767 It's enabled by default if optimizing for speed and compiling for
14768 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14769 optimization option such as @option{-O3} or above is present in the
14770 command line.
14772 @item -mTLS
14773 @opindex mTLS
14775 Assume a large TLS segment when generating thread-local code.
14777 @item -mtls
14778 @opindex mtls
14780 Do not assume a large TLS segment when generating thread-local code.
14782 @item -mgprel-ro
14783 @opindex mgprel-ro
14785 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14786 that is known to be in read-only sections.  It's enabled by default,
14787 except for @option{-fpic} or @option{-fpie}: even though it may help
14788 make the global offset table smaller, it trades 1 instruction for 4.
14789 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14790 one of which may be shared by multiple symbols, and it avoids the need
14791 for a GOT entry for the referenced symbol, so it's more likely to be a
14792 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14794 @item -multilib-library-pic
14795 @opindex multilib-library-pic
14797 Link with the (library, not FD) pic libraries.  It's implied by
14798 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14799 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14800 it explicitly.
14802 @item -mlinked-fp
14803 @opindex mlinked-fp
14805 Follow the EABI requirement of always creating a frame pointer whenever
14806 a stack frame is allocated.  This option is enabled by default and can
14807 be disabled with @option{-mno-linked-fp}.
14809 @item -mlong-calls
14810 @opindex mlong-calls
14812 Use indirect addressing to call functions outside the current
14813 compilation unit.  This allows the functions to be placed anywhere
14814 within the 32-bit address space.
14816 @item -malign-labels
14817 @opindex malign-labels
14819 Try to align labels to an 8-byte boundary by inserting NOPs into the
14820 previous packet.  This option only has an effect when VLIW packing
14821 is enabled.  It doesn't create new packets; it merely adds NOPs to
14822 existing ones.
14824 @item -mlibrary-pic
14825 @opindex mlibrary-pic
14827 Generate position-independent EABI code.
14829 @item -macc-4
14830 @opindex macc-4
14832 Use only the first four media accumulator registers.
14834 @item -macc-8
14835 @opindex macc-8
14837 Use all eight media accumulator registers.
14839 @item -mpack
14840 @opindex mpack
14842 Pack VLIW instructions.
14844 @item -mno-pack
14845 @opindex mno-pack
14847 Do not pack VLIW instructions.
14849 @item -mno-eflags
14850 @opindex mno-eflags
14852 Do not mark ABI switches in e_flags.
14854 @item -mcond-move
14855 @opindex mcond-move
14857 Enable the use of conditional-move instructions (default).
14859 This switch is mainly for debugging the compiler and will likely be removed
14860 in a future version.
14862 @item -mno-cond-move
14863 @opindex mno-cond-move
14865 Disable the use of conditional-move instructions.
14867 This switch is mainly for debugging the compiler and will likely be removed
14868 in a future version.
14870 @item -mscc
14871 @opindex mscc
14873 Enable the use of conditional set instructions (default).
14875 This switch is mainly for debugging the compiler and will likely be removed
14876 in a future version.
14878 @item -mno-scc
14879 @opindex mno-scc
14881 Disable the use of conditional set instructions.
14883 This switch is mainly for debugging the compiler and will likely be removed
14884 in a future version.
14886 @item -mcond-exec
14887 @opindex mcond-exec
14889 Enable the use of conditional execution (default).
14891 This switch is mainly for debugging the compiler and will likely be removed
14892 in a future version.
14894 @item -mno-cond-exec
14895 @opindex mno-cond-exec
14897 Disable the use of conditional execution.
14899 This switch is mainly for debugging the compiler and will likely be removed
14900 in a future version.
14902 @item -mvliw-branch
14903 @opindex mvliw-branch
14905 Run a pass to pack branches into VLIW instructions (default).
14907 This switch is mainly for debugging the compiler and will likely be removed
14908 in a future version.
14910 @item -mno-vliw-branch
14911 @opindex mno-vliw-branch
14913 Do not run a pass to pack branches into VLIW instructions.
14915 This switch is mainly for debugging the compiler and will likely be removed
14916 in a future version.
14918 @item -mmulti-cond-exec
14919 @opindex mmulti-cond-exec
14921 Enable optimization of @code{&&} and @code{||} in conditional execution
14922 (default).
14924 This switch is mainly for debugging the compiler and will likely be removed
14925 in a future version.
14927 @item -mno-multi-cond-exec
14928 @opindex mno-multi-cond-exec
14930 Disable optimization of @code{&&} and @code{||} in conditional execution.
14932 This switch is mainly for debugging the compiler and will likely be removed
14933 in a future version.
14935 @item -mnested-cond-exec
14936 @opindex mnested-cond-exec
14938 Enable nested conditional execution optimizations (default).
14940 This switch is mainly for debugging the compiler and will likely be removed
14941 in a future version.
14943 @item -mno-nested-cond-exec
14944 @opindex mno-nested-cond-exec
14946 Disable nested conditional execution optimizations.
14948 This switch is mainly for debugging the compiler and will likely be removed
14949 in a future version.
14951 @item -moptimize-membar
14952 @opindex moptimize-membar
14954 This switch removes redundant @code{membar} instructions from the
14955 compiler-generated code.  It is enabled by default.
14957 @item -mno-optimize-membar
14958 @opindex mno-optimize-membar
14960 This switch disables the automatic removal of redundant @code{membar}
14961 instructions from the generated code.
14963 @item -mtomcat-stats
14964 @opindex mtomcat-stats
14966 Cause gas to print out tomcat statistics.
14968 @item -mcpu=@var{cpu}
14969 @opindex mcpu
14971 Select the processor type for which to generate code.  Possible values are
14972 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14973 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14975 @end table
14977 @node GNU/Linux Options
14978 @subsection GNU/Linux Options
14980 These @samp{-m} options are defined for GNU/Linux targets:
14982 @table @gcctabopt
14983 @item -mglibc
14984 @opindex mglibc
14985 Use the GNU C library.  This is the default except
14986 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14988 @item -muclibc
14989 @opindex muclibc
14990 Use uClibc C library.  This is the default on
14991 @samp{*-*-linux-*uclibc*} targets.
14993 @item -mbionic
14994 @opindex mbionic
14995 Use Bionic C library.  This is the default on
14996 @samp{*-*-linux-*android*} targets.
14998 @item -mandroid
14999 @opindex mandroid
15000 Compile code compatible with Android platform.  This is the default on
15001 @samp{*-*-linux-*android*} targets.
15003 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
15004 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
15005 this option makes the GCC driver pass Android-specific options to the linker.
15006 Finally, this option causes the preprocessor macro @code{__ANDROID__}
15007 to be defined.
15009 @item -tno-android-cc
15010 @opindex tno-android-cc
15011 Disable compilation effects of @option{-mandroid}, i.e., do not enable
15012 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
15013 @option{-fno-rtti} by default.
15015 @item -tno-android-ld
15016 @opindex tno-android-ld
15017 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
15018 linking options to the linker.
15020 @end table
15022 @node H8/300 Options
15023 @subsection H8/300 Options
15025 These @samp{-m} options are defined for the H8/300 implementations:
15027 @table @gcctabopt
15028 @item -mrelax
15029 @opindex mrelax
15030 Shorten some address references at link time, when possible; uses the
15031 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15032 ld, Using ld}, for a fuller description.
15034 @item -mh
15035 @opindex mh
15036 Generate code for the H8/300H@.
15038 @item -ms
15039 @opindex ms
15040 Generate code for the H8S@.
15042 @item -mn
15043 @opindex mn
15044 Generate code for the H8S and H8/300H in the normal mode.  This switch
15045 must be used either with @option{-mh} or @option{-ms}.
15047 @item -ms2600
15048 @opindex ms2600
15049 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15051 @item -mexr
15052 @opindex mexr
15053 Extended registers are stored on stack before execution of function
15054 with monitor attribute. Default option is @option{-mexr}.
15055 This option is valid only for H8S targets.
15057 @item -mno-exr
15058 @opindex mno-exr
15059 Extended registers are not stored on stack before execution of function 
15060 with monitor attribute. Default option is @option{-mno-exr}. 
15061 This option is valid only for H8S targets.
15063 @item -mint32
15064 @opindex mint32
15065 Make @code{int} data 32 bits by default.
15067 @item -malign-300
15068 @opindex malign-300
15069 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15070 The default for the H8/300H and H8S is to align longs and floats on
15071 4-byte boundaries.
15072 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15073 This option has no effect on the H8/300.
15074 @end table
15076 @node HPPA Options
15077 @subsection HPPA Options
15078 @cindex HPPA Options
15080 These @samp{-m} options are defined for the HPPA family of computers:
15082 @table @gcctabopt
15083 @item -march=@var{architecture-type}
15084 @opindex march
15085 Generate code for the specified architecture.  The choices for
15086 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15087 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15088 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15089 architecture option for your machine.  Code compiled for lower numbered
15090 architectures runs on higher numbered architectures, but not the
15091 other way around.
15093 @item -mpa-risc-1-0
15094 @itemx -mpa-risc-1-1
15095 @itemx -mpa-risc-2-0
15096 @opindex mpa-risc-1-0
15097 @opindex mpa-risc-1-1
15098 @opindex mpa-risc-2-0
15099 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15101 @item -mjump-in-delay
15102 @opindex mjump-in-delay
15103 This option is ignored and provided for compatibility purposes only.
15105 @item -mdisable-fpregs
15106 @opindex mdisable-fpregs
15107 Prevent floating-point registers from being used in any manner.  This is
15108 necessary for compiling kernels that perform lazy context switching of
15109 floating-point registers.  If you use this option and attempt to perform
15110 floating-point operations, the compiler aborts.
15112 @item -mdisable-indexing
15113 @opindex mdisable-indexing
15114 Prevent the compiler from using indexing address modes.  This avoids some
15115 rather obscure problems when compiling MIG generated code under MACH@.
15117 @item -mno-space-regs
15118 @opindex mno-space-regs
15119 Generate code that assumes the target has no space registers.  This allows
15120 GCC to generate faster indirect calls and use unscaled index address modes.
15122 Such code is suitable for level 0 PA systems and kernels.
15124 @item -mfast-indirect-calls
15125 @opindex mfast-indirect-calls
15126 Generate code that assumes calls never cross space boundaries.  This
15127 allows GCC to emit code that performs faster indirect calls.
15129 This option does not work in the presence of shared libraries or nested
15130 functions.
15132 @item -mfixed-range=@var{register-range}
15133 @opindex mfixed-range
15134 Generate code treating the given register range as fixed registers.
15135 A fixed register is one that the register allocator cannot use.  This is
15136 useful when compiling kernel code.  A register range is specified as
15137 two registers separated by a dash.  Multiple register ranges can be
15138 specified separated by a comma.
15140 @item -mlong-load-store
15141 @opindex mlong-load-store
15142 Generate 3-instruction load and store sequences as sometimes required by
15143 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15144 the HP compilers.
15146 @item -mportable-runtime
15147 @opindex mportable-runtime
15148 Use the portable calling conventions proposed by HP for ELF systems.
15150 @item -mgas
15151 @opindex mgas
15152 Enable the use of assembler directives only GAS understands.
15154 @item -mschedule=@var{cpu-type}
15155 @opindex mschedule
15156 Schedule code according to the constraints for the machine type
15157 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15158 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15159 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15160 proper scheduling option for your machine.  The default scheduling is
15161 @samp{8000}.
15163 @item -mlinker-opt
15164 @opindex mlinker-opt
15165 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15166 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15167 linkers in which they give bogus error messages when linking some programs.
15169 @item -msoft-float
15170 @opindex msoft-float
15171 Generate output containing library calls for floating point.
15172 @strong{Warning:} the requisite libraries are not available for all HPPA
15173 targets.  Normally the facilities of the machine's usual C compiler are
15174 used, but this cannot be done directly in cross-compilation.  You must make
15175 your own arrangements to provide suitable library functions for
15176 cross-compilation.
15178 @option{-msoft-float} changes the calling convention in the output file;
15179 therefore, it is only useful if you compile @emph{all} of a program with
15180 this option.  In particular, you need to compile @file{libgcc.a}, the
15181 library that comes with GCC, with @option{-msoft-float} in order for
15182 this to work.
15184 @item -msio
15185 @opindex msio
15186 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15187 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15188 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15189 options are available under HP-UX and HI-UX@.
15191 @item -mgnu-ld
15192 @opindex mgnu-ld
15193 Use options specific to GNU @command{ld}.
15194 This passes @option{-shared} to @command{ld} when
15195 building a shared library.  It is the default when GCC is configured,
15196 explicitly or implicitly, with the GNU linker.  This option does not
15197 affect which @command{ld} is called; it only changes what parameters
15198 are passed to that @command{ld}.
15199 The @command{ld} that is called is determined by the
15200 @option{--with-ld} configure option, GCC's program search path, and
15201 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15202 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15203 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15205 @item -mhp-ld
15206 @opindex mhp-ld
15207 Use options specific to HP @command{ld}.
15208 This passes @option{-b} to @command{ld} when building
15209 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15210 links.  It is the default when GCC is configured, explicitly or
15211 implicitly, with the HP linker.  This option does not affect
15212 which @command{ld} is called; it only changes what parameters are passed to that
15213 @command{ld}.
15214 The @command{ld} that is called is determined by the @option{--with-ld}
15215 configure option, GCC's program search path, and finally by the user's
15216 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15217 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15218 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15220 @item -mlong-calls
15221 @opindex mno-long-calls
15222 Generate code that uses long call sequences.  This ensures that a call
15223 is always able to reach linker generated stubs.  The default is to generate
15224 long calls only when the distance from the call site to the beginning
15225 of the function or translation unit, as the case may be, exceeds a
15226 predefined limit set by the branch type being used.  The limits for
15227 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15228 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15229 240,000 bytes.
15231 Distances are measured from the beginning of functions when using the
15232 @option{-ffunction-sections} option, or when using the @option{-mgas}
15233 and @option{-mno-portable-runtime} options together under HP-UX with
15234 the SOM linker.
15236 It is normally not desirable to use this option as it degrades
15237 performance.  However, it may be useful in large applications,
15238 particularly when partial linking is used to build the application.
15240 The types of long calls used depends on the capabilities of the
15241 assembler and linker, and the type of code being generated.  The
15242 impact on systems that support long absolute calls, and long pic
15243 symbol-difference or pc-relative calls should be relatively small.
15244 However, an indirect call is used on 32-bit ELF systems in pic code
15245 and it is quite long.
15247 @item -munix=@var{unix-std}
15248 @opindex march
15249 Generate compiler predefines and select a startfile for the specified
15250 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15251 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15252 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15253 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15254 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15255 and later.
15257 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15258 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15259 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15260 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15261 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15262 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15264 It is @emph{important} to note that this option changes the interfaces
15265 for various library routines.  It also affects the operational behavior
15266 of the C library.  Thus, @emph{extreme} care is needed in using this
15267 option.
15269 Library code that is intended to operate with more than one UNIX
15270 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15271 as appropriate.  Most GNU software doesn't provide this capability.
15273 @item -nolibdld
15274 @opindex nolibdld
15275 Suppress the generation of link options to search libdld.sl when the
15276 @option{-static} option is specified on HP-UX 10 and later.
15278 @item -static
15279 @opindex static
15280 The HP-UX implementation of setlocale in libc has a dependency on
15281 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15282 when the @option{-static} option is specified, special link options
15283 are needed to resolve this dependency.
15285 On HP-UX 10 and later, the GCC driver adds the necessary options to
15286 link with libdld.sl when the @option{-static} option is specified.
15287 This causes the resulting binary to be dynamic.  On the 64-bit port,
15288 the linkers generate dynamic binaries by default in any case.  The
15289 @option{-nolibdld} option can be used to prevent the GCC driver from
15290 adding these link options.
15292 @item -threads
15293 @opindex threads
15294 Add support for multithreading with the @dfn{dce thread} library
15295 under HP-UX@.  This option sets flags for both the preprocessor and
15296 linker.
15297 @end table
15299 @node i386 and x86-64 Options
15300 @subsection Intel 386 and AMD x86-64 Options
15301 @cindex i386 Options
15302 @cindex x86-64 Options
15303 @cindex Intel 386 Options
15304 @cindex AMD x86-64 Options
15306 These @samp{-m} options are defined for the i386 and x86-64 family of
15307 computers:
15309 @table @gcctabopt
15311 @item -march=@var{cpu-type}
15312 @opindex march
15313 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15314 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15315 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15316 to generate code that may not run at all on processors other than the one
15317 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15318 @option{-mtune=@var{cpu-type}}.
15320 The choices for @var{cpu-type} are:
15322 @table @samp
15323 @item native
15324 This selects the CPU to generate code for at compilation time by determining
15325 the processor type of the compiling machine.  Using @option{-march=native}
15326 enables all instruction subsets supported by the local machine (hence
15327 the result might not run on different machines).  Using @option{-mtune=native}
15328 produces code optimized for the local machine under the constraints
15329 of the selected instruction set.  
15331 @item i386
15332 Original Intel i386 CPU@.
15334 @item i486
15335 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15337 @item i586
15338 @itemx pentium
15339 Intel Pentium CPU with no MMX support.
15341 @item pentium-mmx
15342 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15344 @item pentiumpro
15345 Intel Pentium Pro CPU@.
15347 @item i686
15348 When used with @option{-march}, the Pentium Pro
15349 instruction set is used, so the code runs on all i686 family chips.
15350 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15352 @item pentium2
15353 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15354 support.
15356 @item pentium3
15357 @itemx pentium3m
15358 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15359 set support.
15361 @item pentium-m
15362 Intel Pentium M; low-power version of Intel Pentium III CPU
15363 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15365 @item pentium4
15366 @itemx pentium4m
15367 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15369 @item prescott
15370 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15371 set support.
15373 @item nocona
15374 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15375 SSE2 and SSE3 instruction set support.
15377 @item core2
15378 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15379 instruction set support.
15381 @item nehalem
15382 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15383 SSE4.1, SSE4.2 and POPCNT instruction set support.
15385 @item westmere
15386 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15387 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15389 @item sandybridge
15390 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15391 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15393 @item ivybridge
15394 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15395 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15396 instruction set support.
15398 @item haswell
15399 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15400 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15401 BMI, BMI2 and F16C instruction set support.
15403 @item broadwell
15404 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15405 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15406 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15408 @item bonnell
15409 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15410 instruction set support.
15412 @item silvermont
15413 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15414 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15416 @item k6
15417 AMD K6 CPU with MMX instruction set support.
15419 @item k6-2
15420 @itemx k6-3
15421 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15423 @item athlon
15424 @itemx athlon-tbird
15425 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15426 support.
15428 @item athlon-4
15429 @itemx athlon-xp
15430 @itemx athlon-mp
15431 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15432 instruction set support.
15434 @item k8
15435 @itemx opteron
15436 @itemx athlon64
15437 @itemx athlon-fx
15438 Processors based on the AMD K8 core with x86-64 instruction set support,
15439 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15440 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15441 instruction set extensions.)
15443 @item k8-sse3
15444 @itemx opteron-sse3
15445 @itemx athlon64-sse3
15446 Improved versions of AMD K8 cores with SSE3 instruction set support.
15448 @item amdfam10
15449 @itemx barcelona
15450 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15451 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15452 instruction set extensions.)
15454 @item bdver1
15455 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15456 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15457 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15458 @item bdver2
15459 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15460 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15461 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15462 extensions.)
15463 @item bdver3
15464 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15465 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15466 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15467 64-bit instruction set extensions.
15468 @item bdver4
15469 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15470 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15471 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15472 SSE4.2, ABM and 64-bit instruction set extensions.
15474 @item btver1
15475 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15476 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15477 instruction set extensions.)
15479 @item btver2
15480 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15481 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15482 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15484 @item winchip-c6
15485 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15486 set support.
15488 @item winchip2
15489 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15490 instruction set support.
15492 @item c3
15493 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15494 implemented for this chip.)
15496 @item c3-2
15497 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15498 (No scheduling is
15499 implemented for this chip.)
15501 @item geode
15502 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15503 @end table
15505 @item -mtune=@var{cpu-type}
15506 @opindex mtune
15507 Tune to @var{cpu-type} everything applicable about the generated code, except
15508 for the ABI and the set of available instructions.  
15509 While picking a specific @var{cpu-type} schedules things appropriately
15510 for that particular chip, the compiler does not generate any code that
15511 cannot run on the default machine type unless you use a
15512 @option{-march=@var{cpu-type}} option.
15513 For example, if GCC is configured for i686-pc-linux-gnu
15514 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15515 but still runs on i686 machines.
15517 The choices for @var{cpu-type} are the same as for @option{-march}.
15518 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15520 @table @samp
15521 @item generic
15522 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15523 If you know the CPU on which your code will run, then you should use
15524 the corresponding @option{-mtune} or @option{-march} option instead of
15525 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15526 of your application will have, then you should use this option.
15528 As new processors are deployed in the marketplace, the behavior of this
15529 option will change.  Therefore, if you upgrade to a newer version of
15530 GCC, code generation controlled by this option will change to reflect
15531 the processors
15532 that are most common at the time that version of GCC is released.
15534 There is no @option{-march=generic} option because @option{-march}
15535 indicates the instruction set the compiler can use, and there is no
15536 generic instruction set applicable to all processors.  In contrast,
15537 @option{-mtune} indicates the processor (or, in this case, collection of
15538 processors) for which the code is optimized.
15540 @item intel
15541 Produce code optimized for the most current Intel processors, which are
15542 Haswell and Silvermont for this version of GCC.  If you know the CPU
15543 on which your code will run, then you should use the corresponding
15544 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15545 But, if you want your application performs better on both Haswell and
15546 Silvermont, then you should use this option.
15548 As new Intel processors are deployed in the marketplace, the behavior of
15549 this option will change.  Therefore, if you upgrade to a newer version of
15550 GCC, code generation controlled by this option will change to reflect
15551 the most current Intel processors at the time that version of GCC is
15552 released.
15554 There is no @option{-march=intel} option because @option{-march} indicates
15555 the instruction set the compiler can use, and there is no common
15556 instruction set applicable to all processors.  In contrast,
15557 @option{-mtune} indicates the processor (or, in this case, collection of
15558 processors) for which the code is optimized.
15559 @end table
15561 @item -mcpu=@var{cpu-type}
15562 @opindex mcpu
15563 A deprecated synonym for @option{-mtune}.
15565 @item -mfpmath=@var{unit}
15566 @opindex mfpmath
15567 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15568 for @var{unit} are:
15570 @table @samp
15571 @item 387
15572 Use the standard 387 floating-point coprocessor present on the majority of chips and
15573 emulated otherwise.  Code compiled with this option runs almost everywhere.
15574 The temporary results are computed in 80-bit precision instead of the precision
15575 specified by the type, resulting in slightly different results compared to most
15576 of other chips.  See @option{-ffloat-store} for more detailed description.
15578 This is the default choice for i386 compiler.
15580 @item sse
15581 Use scalar floating-point instructions present in the SSE instruction set.
15582 This instruction set is supported by Pentium III and newer chips,
15583 and in the AMD line
15584 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15585 instruction set supports only single-precision arithmetic, thus the double and
15586 extended-precision arithmetic are still done using 387.  A later version, present
15587 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15588 arithmetic too.
15590 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15591 or @option{-msse2} switches to enable SSE extensions and make this option
15592 effective.  For the x86-64 compiler, these extensions are enabled by default.
15594 The resulting code should be considerably faster in the majority of cases and avoid
15595 the numerical instability problems of 387 code, but may break some existing
15596 code that expects temporaries to be 80 bits.
15598 This is the default choice for the x86-64 compiler.
15600 @item sse,387
15601 @itemx sse+387
15602 @itemx both
15603 Attempt to utilize both instruction sets at once.  This effectively doubles the
15604 amount of available registers, and on chips with separate execution units for
15605 387 and SSE the execution resources too.  Use this option with care, as it is
15606 still experimental, because the GCC register allocator does not model separate
15607 functional units well, resulting in unstable performance.
15608 @end table
15610 @item -masm=@var{dialect}
15611 @opindex masm=@var{dialect}
15612 Output assembly instructions using selected @var{dialect}.  Supported
15613 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15614 not support @samp{intel}.
15616 @item -mieee-fp
15617 @itemx -mno-ieee-fp
15618 @opindex mieee-fp
15619 @opindex mno-ieee-fp
15620 Control whether or not the compiler uses IEEE floating-point
15621 comparisons.  These correctly handle the case where the result of a
15622 comparison is unordered.
15624 @item -msoft-float
15625 @opindex msoft-float
15626 Generate output containing library calls for floating point.
15628 @strong{Warning:} the requisite libraries are not part of GCC@.
15629 Normally the facilities of the machine's usual C compiler are used, but
15630 this can't be done directly in cross-compilation.  You must make your
15631 own arrangements to provide suitable library functions for
15632 cross-compilation.
15634 On machines where a function returns floating-point results in the 80387
15635 register stack, some floating-point opcodes may be emitted even if
15636 @option{-msoft-float} is used.
15638 @item -mno-fp-ret-in-387
15639 @opindex mno-fp-ret-in-387
15640 Do not use the FPU registers for return values of functions.
15642 The usual calling convention has functions return values of types
15643 @code{float} and @code{double} in an FPU register, even if there
15644 is no FPU@.  The idea is that the operating system should emulate
15645 an FPU@.
15647 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15648 in ordinary CPU registers instead.
15650 @item -mno-fancy-math-387
15651 @opindex mno-fancy-math-387
15652 Some 387 emulators do not support the @code{sin}, @code{cos} and
15653 @code{sqrt} instructions for the 387.  Specify this option to avoid
15654 generating those instructions.  This option is the default on FreeBSD,
15655 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15656 indicates that the target CPU always has an FPU and so the
15657 instruction does not need emulation.  These
15658 instructions are not generated unless you also use the
15659 @option{-funsafe-math-optimizations} switch.
15661 @item -malign-double
15662 @itemx -mno-align-double
15663 @opindex malign-double
15664 @opindex mno-align-double
15665 Control whether GCC aligns @code{double}, @code{long double}, and
15666 @code{long long} variables on a two-word boundary or a one-word
15667 boundary.  Aligning @code{double} variables on a two-word boundary
15668 produces code that runs somewhat faster on a Pentium at the
15669 expense of more memory.
15671 On x86-64, @option{-malign-double} is enabled by default.
15673 @strong{Warning:} if you use the @option{-malign-double} switch,
15674 structures containing the above types are aligned differently than
15675 the published application binary interface specifications for the 386
15676 and are not binary compatible with structures in code compiled
15677 without that switch.
15679 @item -m96bit-long-double
15680 @itemx -m128bit-long-double
15681 @opindex m96bit-long-double
15682 @opindex m128bit-long-double
15683 These switches control the size of @code{long double} type.  The i386
15684 application binary interface specifies the size to be 96 bits,
15685 so @option{-m96bit-long-double} is the default in 32-bit mode.
15687 Modern architectures (Pentium and newer) prefer @code{long double}
15688 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15689 conforming to the ABI, this is not possible.  So specifying
15690 @option{-m128bit-long-double} aligns @code{long double}
15691 to a 16-byte boundary by padding the @code{long double} with an additional
15692 32-bit zero.
15694 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15695 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15697 Notice that neither of these options enable any extra precision over the x87
15698 standard of 80 bits for a @code{long double}.
15700 @strong{Warning:} if you override the default value for your target ABI, this
15701 changes the size of 
15702 structures and arrays containing @code{long double} variables,
15703 as well as modifying the function calling convention for functions taking
15704 @code{long double}.  Hence they are not binary-compatible
15705 with code compiled without that switch.
15707 @item -mlong-double-64
15708 @itemx -mlong-double-80
15709 @itemx -mlong-double-128
15710 @opindex mlong-double-64
15711 @opindex mlong-double-80
15712 @opindex mlong-double-128
15713 These switches control the size of @code{long double} type. A size
15714 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15715 type. This is the default for 32-bit Bionic C library.  A size
15716 of 128 bits makes the @code{long double} type equivalent to the
15717 @code{__float128} type. This is the default for 64-bit Bionic C library.
15719 @strong{Warning:} if you override the default value for your target ABI, this
15720 changes the size of
15721 structures and arrays containing @code{long double} variables,
15722 as well as modifying the function calling convention for functions taking
15723 @code{long double}.  Hence they are not binary-compatible
15724 with code compiled without that switch.
15726 @item -malign-data=@var{type}
15727 @opindex malign-data
15728 Control how GCC aligns variables.  Supported values for @var{type} are
15729 @samp{compat} uses increased alignment value compatible uses GCC 4.8
15730 and earlier, @samp{abi} uses alignment value as specified by the
15731 psABI, and @samp{cacheline} uses increased alignment value to match
15732 the cache line size.  @samp{compat} is the default.
15734 @item -mlarge-data-threshold=@var{threshold}
15735 @opindex mlarge-data-threshold
15736 When @option{-mcmodel=medium} is specified, data objects larger than
15737 @var{threshold} are placed in the large data section.  This value must be the
15738 same across all objects linked into the binary, and defaults to 65535.
15740 @item -mrtd
15741 @opindex mrtd
15742 Use a different function-calling convention, in which functions that
15743 take a fixed number of arguments return with the @code{ret @var{num}}
15744 instruction, which pops their arguments while returning.  This saves one
15745 instruction in the caller since there is no need to pop the arguments
15746 there.
15748 You can specify that an individual function is called with this calling
15749 sequence with the function attribute @samp{stdcall}.  You can also
15750 override the @option{-mrtd} option by using the function attribute
15751 @samp{cdecl}.  @xref{Function Attributes}.
15753 @strong{Warning:} this calling convention is incompatible with the one
15754 normally used on Unix, so you cannot use it if you need to call
15755 libraries compiled with the Unix compiler.
15757 Also, you must provide function prototypes for all functions that
15758 take variable numbers of arguments (including @code{printf});
15759 otherwise incorrect code is generated for calls to those
15760 functions.
15762 In addition, seriously incorrect code results if you call a
15763 function with too many arguments.  (Normally, extra arguments are
15764 harmlessly ignored.)
15766 @item -mregparm=@var{num}
15767 @opindex mregparm
15768 Control how many registers are used to pass integer arguments.  By
15769 default, no registers are used to pass arguments, and at most 3
15770 registers can be used.  You can control this behavior for a specific
15771 function by using the function attribute @samp{regparm}.
15772 @xref{Function Attributes}.
15774 @strong{Warning:} if you use this switch, and
15775 @var{num} is nonzero, then you must build all modules with the same
15776 value, including any libraries.  This includes the system libraries and
15777 startup modules.
15779 @item -msseregparm
15780 @opindex msseregparm
15781 Use SSE register passing conventions for float and double arguments
15782 and return values.  You can control this behavior for a specific
15783 function by using the function attribute @samp{sseregparm}.
15784 @xref{Function Attributes}.
15786 @strong{Warning:} if you use this switch then you must build all
15787 modules with the same value, including any libraries.  This includes
15788 the system libraries and startup modules.
15790 @item -mvect8-ret-in-mem
15791 @opindex mvect8-ret-in-mem
15792 Return 8-byte vectors in memory instead of MMX registers.  This is the
15793 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15794 Studio compilers until version 12.  Later compiler versions (starting
15795 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15796 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15797 you need to remain compatible with existing code produced by those
15798 previous compiler versions or older versions of GCC@.
15800 @item -mpc32
15801 @itemx -mpc64
15802 @itemx -mpc80
15803 @opindex mpc32
15804 @opindex mpc64
15805 @opindex mpc80
15807 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15808 is specified, the significands of results of floating-point operations are
15809 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15810 significands of results of floating-point operations to 53 bits (double
15811 precision) and @option{-mpc80} rounds the significands of results of
15812 floating-point operations to 64 bits (extended double precision), which is
15813 the default.  When this option is used, floating-point operations in higher
15814 precisions are not available to the programmer without setting the FPU
15815 control word explicitly.
15817 Setting the rounding of floating-point operations to less than the default
15818 80 bits can speed some programs by 2% or more.  Note that some mathematical
15819 libraries assume that extended-precision (80-bit) floating-point operations
15820 are enabled by default; routines in such libraries could suffer significant
15821 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15822 when this option is used to set the precision to less than extended precision.
15824 @item -mstackrealign
15825 @opindex mstackrealign
15826 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15827 option generates an alternate prologue and epilogue that realigns the
15828 run-time stack if necessary.  This supports mixing legacy codes that keep
15829 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15830 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15831 applicable to individual functions.
15833 @item -mpreferred-stack-boundary=@var{num}
15834 @opindex mpreferred-stack-boundary
15835 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15836 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15837 the default is 4 (16 bytes or 128 bits).
15839 @strong{Warning:} When generating code for the x86-64 architecture with
15840 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15841 used to keep the stack boundary aligned to 8 byte boundary.  Since
15842 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15843 intended to be used in controlled environment where stack space is
15844 important limitation.  This option will lead to wrong code when functions
15845 compiled with 16 byte stack alignment (such as functions from a standard
15846 library) are called with misaligned stack.  In this case, SSE
15847 instructions may lead to misaligned memory access traps.  In addition,
15848 variable arguments will be handled incorrectly for 16 byte aligned
15849 objects (including x87 long double and __int128), leading to wrong
15850 results.  You must build all modules with
15851 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15852 includes the system libraries and startup modules.
15854 @item -mincoming-stack-boundary=@var{num}
15855 @opindex mincoming-stack-boundary
15856 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15857 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15858 the one specified by @option{-mpreferred-stack-boundary} is used.
15860 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15861 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15862 suffer significant run time performance penalties.  On Pentium III, the
15863 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15864 properly if it is not 16-byte aligned.
15866 To ensure proper alignment of this values on the stack, the stack boundary
15867 must be as aligned as that required by any value stored on the stack.
15868 Further, every function must be generated such that it keeps the stack
15869 aligned.  Thus calling a function compiled with a higher preferred
15870 stack boundary from a function compiled with a lower preferred stack
15871 boundary most likely misaligns the stack.  It is recommended that
15872 libraries that use callbacks always use the default setting.
15874 This extra alignment does consume extra stack space, and generally
15875 increases code size.  Code that is sensitive to stack space usage, such
15876 as embedded systems and operating system kernels, may want to reduce the
15877 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15879 @need 200
15880 @item -mmmx
15881 @opindex mmmx
15882 @need 200
15883 @itemx -msse
15884 @opindex msse
15885 @need 200
15886 @itemx -msse2
15887 @need 200
15888 @itemx -msse3
15889 @need 200
15890 @itemx -mssse3
15891 @need 200
15892 @itemx -msse4
15893 @need 200
15894 @itemx -msse4a
15895 @need 200
15896 @itemx -msse4.1
15897 @need 200
15898 @itemx -msse4.2
15899 @need 200
15900 @itemx -mavx
15901 @opindex mavx
15902 @need 200
15903 @itemx -mavx2
15904 @need 200
15905 @itemx -mavx512f
15906 @need 200
15907 @itemx -mavx512pf
15908 @need 200
15909 @itemx -mavx512er
15910 @need 200
15911 @itemx -mavx512cd
15912 @need 200
15913 @itemx -msha
15914 @opindex msha
15915 @need 200
15916 @itemx -maes
15917 @opindex maes
15918 @need 200
15919 @itemx -mpclmul
15920 @opindex mpclmul
15921 @need 200
15922 @itemx -mclfushopt
15923 @opindex mclfushopt
15924 @need 200
15925 @itemx -mfsgsbase
15926 @opindex mfsgsbase
15927 @need 200
15928 @itemx -mrdrnd
15929 @opindex mrdrnd
15930 @need 200
15931 @itemx -mf16c
15932 @opindex mf16c
15933 @need 200
15934 @itemx -mfma
15935 @opindex mfma
15936 @need 200
15937 @itemx -mfma4
15938 @need 200
15939 @itemx -mno-fma4
15940 @need 200
15941 @itemx -mprefetchwt1
15942 @opindex mprefetchwt1
15943 @need 200
15944 @itemx -mxop
15945 @opindex mxop
15946 @need 200
15947 @itemx -mlwp
15948 @opindex mlwp
15949 @need 200
15950 @itemx -m3dnow
15951 @opindex m3dnow
15952 @need 200
15953 @itemx -mpopcnt
15954 @opindex mpopcnt
15955 @need 200
15956 @itemx -mabm
15957 @opindex mabm
15958 @need 200
15959 @itemx -mbmi
15960 @opindex mbmi
15961 @need 200
15962 @itemx -mbmi2
15963 @need 200
15964 @itemx -mlzcnt
15965 @opindex mlzcnt
15966 @need 200
15967 @itemx -mfxsr
15968 @opindex mfxsr
15969 @need 200
15970 @itemx -mxsave
15971 @opindex mxsave
15972 @need 200
15973 @itemx -mxsaveopt
15974 @opindex mxsaveopt
15975 @need 200
15976 @itemx -mxsavec
15977 @opindex mxsavec
15978 @need 200
15979 @itemx -mxsaves
15980 @opindex mxsaves
15981 @need 200
15982 @itemx -mrtm
15983 @opindex mrtm
15984 @need 200
15985 @itemx -mtbm
15986 @opindex mtbm
15987 @need 200
15988 @itemx -mmpx
15989 @opindex mmpx
15990 These switches enable the use of instructions in the MMX, SSE,
15991 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15992 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15993 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15994 extended instruction sets.  Each has a corresponding @option{-mno-} option
15995 to disable use of these instructions.
15997 These extensions are also available as built-in functions: see
15998 @ref{X86 Built-in Functions}, for details of the functions enabled and
15999 disabled by these switches.
16001 To generate SSE/SSE2 instructions automatically from floating-point
16002 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
16004 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
16005 generates new AVX instructions or AVX equivalence for all SSEx instructions
16006 when needed.
16008 These options enable GCC to use these extended instructions in
16009 generated code, even without @option{-mfpmath=sse}.  Applications that
16010 perform run-time CPU detection must compile separate files for each
16011 supported architecture, using the appropriate flags.  In particular,
16012 the file containing the CPU detection code should be compiled without
16013 these options.
16015 @item -mdump-tune-features
16016 @opindex mdump-tune-features
16017 This option instructs GCC to dump the names of the x86 performance 
16018 tuning features and default settings. The names can be used in 
16019 @option{-mtune-ctrl=@var{feature-list}}.
16021 @item -mtune-ctrl=@var{feature-list}
16022 @opindex mtune-ctrl=@var{feature-list}
16023 This option is used to do fine grain control of x86 code generation features.
16024 @var{feature-list} is a comma separated list of @var{feature} names. See also
16025 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
16026 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
16027 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
16028 developers. Using it may lead to code paths not covered by testing and can
16029 potentially result in compiler ICEs or runtime errors.
16031 @item -mno-default
16032 @opindex mno-default
16033 This option instructs GCC to turn off all tunable features. See also 
16034 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
16036 @item -mcld
16037 @opindex mcld
16038 This option instructs GCC to emit a @code{cld} instruction in the prologue
16039 of functions that use string instructions.  String instructions depend on
16040 the DF flag to select between autoincrement or autodecrement mode.  While the
16041 ABI specifies the DF flag to be cleared on function entry, some operating
16042 systems violate this specification by not clearing the DF flag in their
16043 exception dispatchers.  The exception handler can be invoked with the DF flag
16044 set, which leads to wrong direction mode when string instructions are used.
16045 This option can be enabled by default on 32-bit x86 targets by configuring
16046 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
16047 instructions can be suppressed with the @option{-mno-cld} compiler option
16048 in this case.
16050 @item -mvzeroupper
16051 @opindex mvzeroupper
16052 This option instructs GCC to emit a @code{vzeroupper} instruction
16053 before a transfer of control flow out of the function to minimize
16054 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
16055 intrinsics.
16057 @item -mprefer-avx128
16058 @opindex mprefer-avx128
16059 This option instructs GCC to use 128-bit AVX instructions instead of
16060 256-bit AVX instructions in the auto-vectorizer.
16062 @item -mcx16
16063 @opindex mcx16
16064 This option enables GCC to generate @code{CMPXCHG16B} instructions.
16065 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
16066 (or oword) data types.  
16067 This is useful for high-resolution counters that can be updated
16068 by multiple processors (or cores).  This instruction is generated as part of
16069 atomic built-in functions: see @ref{__sync Builtins} or
16070 @ref{__atomic Builtins} for details.
16072 @item -msahf
16073 @opindex msahf
16074 This option enables generation of @code{SAHF} instructions in 64-bit code.
16075 Early Intel Pentium 4 CPUs with Intel 64 support,
16076 prior to the introduction of Pentium 4 G1 step in December 2005,
16077 lacked the @code{LAHF} and @code{SAHF} instructions
16078 which were supported by AMD64.
16079 These are load and store instructions, respectively, for certain status flags.
16080 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
16081 @code{drem}, and @code{remainder} built-in functions;
16082 see @ref{Other Builtins} for details.
16084 @item -mmovbe
16085 @opindex mmovbe
16086 This option enables use of the @code{movbe} instruction to implement
16087 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
16089 @item -mcrc32
16090 @opindex mcrc32
16091 This option enables built-in functions @code{__builtin_ia32_crc32qi},
16092 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
16093 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
16095 @item -mrecip
16096 @opindex mrecip
16097 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
16098 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
16099 with an additional Newton-Raphson step
16100 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
16101 (and their vectorized
16102 variants) for single-precision floating-point arguments.  These instructions
16103 are generated only when @option{-funsafe-math-optimizations} is enabled
16104 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
16105 Note that while the throughput of the sequence is higher than the throughput
16106 of the non-reciprocal instruction, the precision of the sequence can be
16107 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
16109 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
16110 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
16111 combination), and doesn't need @option{-mrecip}.
16113 Also note that GCC emits the above sequence with additional Newton-Raphson step
16114 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
16115 already with @option{-ffast-math} (or the above option combination), and
16116 doesn't need @option{-mrecip}.
16118 @item -mrecip=@var{opt}
16119 @opindex mrecip=opt
16120 This option controls which reciprocal estimate instructions
16121 may be used.  @var{opt} is a comma-separated list of options, which may
16122 be preceded by a @samp{!} to invert the option:
16124 @table @samp
16125 @item all
16126 Enable all estimate instructions.
16128 @item default
16129 Enable the default instructions, equivalent to @option{-mrecip}.
16131 @item none
16132 Disable all estimate instructions, equivalent to @option{-mno-recip}.
16134 @item div
16135 Enable the approximation for scalar division.
16137 @item vec-div
16138 Enable the approximation for vectorized division.
16140 @item sqrt
16141 Enable the approximation for scalar square root.
16143 @item vec-sqrt
16144 Enable the approximation for vectorized square root.
16145 @end table
16147 So, for example, @option{-mrecip=all,!sqrt} enables
16148 all of the reciprocal approximations, except for square root.
16150 @item -mveclibabi=@var{type}
16151 @opindex mveclibabi
16152 Specifies the ABI type to use for vectorizing intrinsics using an
16153 external library.  Supported values for @var{type} are @samp{svml} 
16154 for the Intel short
16155 vector math library and @samp{acml} for the AMD math core library.
16156 To use this option, both @option{-ftree-vectorize} and
16157 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
16158 ABI-compatible library must be specified at link time.
16160 GCC currently emits calls to @code{vmldExp2},
16161 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
16162 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
16163 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
16164 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
16165 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
16166 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
16167 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
16168 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
16169 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
16170 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
16171 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
16172 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
16173 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
16174 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
16175 when @option{-mveclibabi=acml} is used.  
16177 @item -mabi=@var{name}
16178 @opindex mabi
16179 Generate code for the specified calling convention.  Permissible values
16180 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
16181 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
16182 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
16183 You can control this behavior for a specific function by
16184 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
16185 @xref{Function Attributes}.
16187 @item -mtls-dialect=@var{type}
16188 @opindex mtls-dialect
16189 Generate code to access thread-local storage using the @samp{gnu} or
16190 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
16191 @samp{gnu2} is more efficient, but it may add compile- and run-time
16192 requirements that cannot be satisfied on all systems.
16194 @item -mpush-args
16195 @itemx -mno-push-args
16196 @opindex mpush-args
16197 @opindex mno-push-args
16198 Use PUSH operations to store outgoing parameters.  This method is shorter
16199 and usually equally fast as method using SUB/MOV operations and is enabled
16200 by default.  In some cases disabling it may improve performance because of
16201 improved scheduling and reduced dependencies.
16203 @item -maccumulate-outgoing-args
16204 @opindex maccumulate-outgoing-args
16205 If enabled, the maximum amount of space required for outgoing arguments is
16206 computed in the function prologue.  This is faster on most modern CPUs
16207 because of reduced dependencies, improved scheduling and reduced stack usage
16208 when the preferred stack boundary is not equal to 2.  The drawback is a notable
16209 increase in code size.  This switch implies @option{-mno-push-args}.
16211 @item -mthreads
16212 @opindex mthreads
16213 Support thread-safe exception handling on MinGW.  Programs that rely
16214 on thread-safe exception handling must compile and link all code with the
16215 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
16216 @code{-D_MT}; when linking, it links in a special thread helper library
16217 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
16219 @item -mno-align-stringops
16220 @opindex mno-align-stringops
16221 Do not align the destination of inlined string operations.  This switch reduces
16222 code size and improves performance in case the destination is already aligned,
16223 but GCC doesn't know about it.
16225 @item -minline-all-stringops
16226 @opindex minline-all-stringops
16227 By default GCC inlines string operations only when the destination is 
16228 known to be aligned to least a 4-byte boundary.  
16229 This enables more inlining and increases code
16230 size, but may improve performance of code that depends on fast
16231 @code{memcpy}, @code{strlen},
16232 and @code{memset} for short lengths.
16234 @item -minline-stringops-dynamically
16235 @opindex minline-stringops-dynamically
16236 For string operations of unknown size, use run-time checks with
16237 inline code for small blocks and a library call for large blocks.
16239 @item -mstringop-strategy=@var{alg}
16240 @opindex mstringop-strategy=@var{alg}
16241 Override the internal decision heuristic for the particular algorithm to use
16242 for inlining string operations.  The allowed values for @var{alg} are:
16244 @table @samp
16245 @item rep_byte
16246 @itemx rep_4byte
16247 @itemx rep_8byte
16248 Expand using i386 @code{rep} prefix of the specified size.
16250 @item byte_loop
16251 @itemx loop
16252 @itemx unrolled_loop
16253 Expand into an inline loop.
16255 @item libcall
16256 Always use a library call.
16257 @end table
16259 @item -mmemcpy-strategy=@var{strategy}
16260 @opindex mmemcpy-strategy=@var{strategy}
16261 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
16262 should be inlined and what inline algorithm to use when the expected size
16263 of the copy operation is known. @var{strategy} 
16264 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
16265 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
16266 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
16267 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
16268 in the list must be specified in increasing order.  The minimal byte size for 
16269 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
16270 preceding range.
16272 @item -mmemset-strategy=@var{strategy}
16273 @opindex mmemset-strategy=@var{strategy}
16274 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
16275 @code{__builtin_memset} expansion.
16277 @item -momit-leaf-frame-pointer
16278 @opindex momit-leaf-frame-pointer
16279 Don't keep the frame pointer in a register for leaf functions.  This
16280 avoids the instructions to save, set up, and restore frame pointers and
16281 makes an extra register available in leaf functions.  The option
16282 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
16283 which might make debugging harder.
16285 @item -mtls-direct-seg-refs
16286 @itemx -mno-tls-direct-seg-refs
16287 @opindex mtls-direct-seg-refs
16288 Controls whether TLS variables may be accessed with offsets from the
16289 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16290 or whether the thread base pointer must be added.  Whether or not this
16291 is valid depends on the operating system, and whether it maps the
16292 segment to cover the entire TLS area.
16294 For systems that use the GNU C Library, the default is on.
16296 @item -msse2avx
16297 @itemx -mno-sse2avx
16298 @opindex msse2avx
16299 Specify that the assembler should encode SSE instructions with VEX
16300 prefix.  The option @option{-mavx} turns this on by default.
16302 @item -mfentry
16303 @itemx -mno-fentry
16304 @opindex mfentry
16305 If profiling is active (@option{-pg}), put the profiling
16306 counter call before the prologue.
16307 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16308 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16310 @item -mrecord-mcount
16311 @itemx -mno-record-mcount
16312 @opindex mrecord-mcount
16313 If profiling is active (@option{-pg}), generate a __mcount_loc section
16314 that contains pointers to each profiling call. This is useful for
16315 automatically patching and out calls.
16317 @item -mnop-mcount
16318 @itemx -mno-nop-mcount
16319 @opindex mnop-mcount
16320 If profiling is active (@option{-pg}), generate the calls to
16321 the profiling functions as nops. This is useful when they
16322 should be patched in later dynamically. This is likely only
16323 useful together with @option{-mrecord-mcount}.
16325 @item -mskip-rax-setup
16326 @itemx -mno-skip-rax-setup
16327 @opindex mskip-rax-setup
16328 When generating code for the x86-64 architecture with SSE extensions
16329 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
16330 register when there are no variable arguments passed in vector registers.
16332 @strong{Warning:} Since RAX register is used to avoid unnecessarily
16333 saving vector registers on stack when passing variable arguments, the
16334 impacts of this option are callees may waste some stack space,
16335 misbehave or jump to a random location.  GCC 4.4 or newer don't have
16336 those issues, regardless the RAX register value.
16338 @item -m8bit-idiv
16339 @itemx -mno-8bit-idiv
16340 @opindex m8bit-idiv
16341 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16342 much faster than 32-bit/64-bit integer divide.  This option generates a
16343 run-time check.  If both dividend and divisor are within range of 0
16344 to 255, 8-bit unsigned integer divide is used instead of
16345 32-bit/64-bit integer divide.
16347 @item -mavx256-split-unaligned-load
16348 @itemx -mavx256-split-unaligned-store
16349 @opindex mavx256-split-unaligned-load
16350 @opindex mavx256-split-unaligned-store
16351 Split 32-byte AVX unaligned load and store.
16353 @item -mstack-protector-guard=@var{guard}
16354 @opindex mstack-protector-guard=@var{guard}
16355 Generate stack protection code using canary at @var{guard}.  Supported
16356 locations are @samp{global} for global canary or @samp{tls} for per-thread
16357 canary in the TLS block (the default).  This option has effect only when
16358 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16360 @end table
16362 These @samp{-m} switches are supported in addition to the above
16363 on x86-64 processors in 64-bit environments.
16365 @table @gcctabopt
16366 @item -m32
16367 @itemx -m64
16368 @itemx -mx32
16369 @itemx -m16
16370 @opindex m32
16371 @opindex m64
16372 @opindex mx32
16373 @opindex m16
16374 Generate code for a 16-bit, 32-bit or 64-bit environment.
16375 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16376 to 32 bits, and
16377 generates code that runs on any i386 system.
16379 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16380 types to 64 bits, and generates code for the x86-64 architecture.
16381 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16382 and @option{-mdynamic-no-pic} options.
16384 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16385 to 32 bits, and
16386 generates code for the x86-64 architecture.
16388 The @option{-m16} option is the same as @option{-m32}, except for that
16389 it outputs the @code{.code16gcc} assembly directive at the beginning of
16390 the assembly output so that the binary can run in 16-bit mode.
16392 @item -mno-red-zone
16393 @opindex mno-red-zone
16394 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16395 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16396 stack pointer that is not modified by signal or interrupt handlers
16397 and therefore can be used for temporary data without adjusting the stack
16398 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16400 @item -mcmodel=small
16401 @opindex mcmodel=small
16402 Generate code for the small code model: the program and its symbols must
16403 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16404 Programs can be statically or dynamically linked.  This is the default
16405 code model.
16407 @item -mcmodel=kernel
16408 @opindex mcmodel=kernel
16409 Generate code for the kernel code model.  The kernel runs in the
16410 negative 2 GB of the address space.
16411 This model has to be used for Linux kernel code.
16413 @item -mcmodel=medium
16414 @opindex mcmodel=medium
16415 Generate code for the medium model: the program is linked in the lower 2
16416 GB of the address space.  Small symbols are also placed there.  Symbols
16417 with sizes larger than @option{-mlarge-data-threshold} are put into
16418 large data or BSS sections and can be located above 2GB.  Programs can
16419 be statically or dynamically linked.
16421 @item -mcmodel=large
16422 @opindex mcmodel=large
16423 Generate code for the large model.  This model makes no assumptions
16424 about addresses and sizes of sections.
16426 @item -maddress-mode=long
16427 @opindex maddress-mode=long
16428 Generate code for long address mode.  This is only supported for 64-bit
16429 and x32 environments.  It is the default address mode for 64-bit
16430 environments.
16432 @item -maddress-mode=short
16433 @opindex maddress-mode=short
16434 Generate code for short address mode.  This is only supported for 32-bit
16435 and x32 environments.  It is the default address mode for 32-bit and
16436 x32 environments.
16437 @end table
16439 @node i386 and x86-64 Windows Options
16440 @subsection i386 and x86-64 Windows Options
16441 @cindex i386 and x86-64 Windows Options
16443 These additional options are available for Microsoft Windows targets:
16445 @table @gcctabopt
16446 @item -mconsole
16447 @opindex mconsole
16448 This option
16449 specifies that a console application is to be generated, by
16450 instructing the linker to set the PE header subsystem type
16451 required for console applications.
16452 This option is available for Cygwin and MinGW targets and is
16453 enabled by default on those targets.
16455 @item -mdll
16456 @opindex mdll
16457 This option is available for Cygwin and MinGW targets.  It
16458 specifies that a DLL---a dynamic link library---is to be
16459 generated, enabling the selection of the required runtime
16460 startup object and entry point.
16462 @item -mnop-fun-dllimport
16463 @opindex mnop-fun-dllimport
16464 This option is available for Cygwin and MinGW targets.  It
16465 specifies that the @code{dllimport} attribute should be ignored.
16467 @item -mthread
16468 @opindex mthread
16469 This option is available for MinGW targets. It specifies
16470 that MinGW-specific thread support is to be used.
16472 @item -municode
16473 @opindex municode
16474 This option is available for MinGW-w64 targets.  It causes
16475 the @code{UNICODE} preprocessor macro to be predefined, and
16476 chooses Unicode-capable runtime startup code.
16478 @item -mwin32
16479 @opindex mwin32
16480 This option is available for Cygwin and MinGW targets.  It
16481 specifies that the typical Microsoft Windows predefined macros are to
16482 be set in the pre-processor, but does not influence the choice
16483 of runtime library/startup code.
16485 @item -mwindows
16486 @opindex mwindows
16487 This option is available for Cygwin and MinGW targets.  It
16488 specifies that a GUI application is to be generated by
16489 instructing the linker to set the PE header subsystem type
16490 appropriately.
16492 @item -fno-set-stack-executable
16493 @opindex fno-set-stack-executable
16494 This option is available for MinGW targets. It specifies that
16495 the executable flag for the stack used by nested functions isn't
16496 set. This is necessary for binaries running in kernel mode of
16497 Microsoft Windows, as there the User32 API, which is used to set executable
16498 privileges, isn't available.
16500 @item -fwritable-relocated-rdata
16501 @opindex fno-writable-relocated-rdata
16502 This option is available for MinGW and Cygwin targets.  It specifies
16503 that relocated-data in read-only section is put into .data
16504 section.  This is a necessary for older runtimes not supporting
16505 modification of .rdata sections for pseudo-relocation.
16507 @item -mpe-aligned-commons
16508 @opindex mpe-aligned-commons
16509 This option is available for Cygwin and MinGW targets.  It
16510 specifies that the GNU extension to the PE file format that
16511 permits the correct alignment of COMMON variables should be
16512 used when generating code.  It is enabled by default if
16513 GCC detects that the target assembler found during configuration
16514 supports the feature.
16515 @end table
16517 See also under @ref{i386 and x86-64 Options} for standard options.
16519 @node IA-64 Options
16520 @subsection IA-64 Options
16521 @cindex IA-64 Options
16523 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16525 @table @gcctabopt
16526 @item -mbig-endian
16527 @opindex mbig-endian
16528 Generate code for a big-endian target.  This is the default for HP-UX@.
16530 @item -mlittle-endian
16531 @opindex mlittle-endian
16532 Generate code for a little-endian target.  This is the default for AIX5
16533 and GNU/Linux.
16535 @item -mgnu-as
16536 @itemx -mno-gnu-as
16537 @opindex mgnu-as
16538 @opindex mno-gnu-as
16539 Generate (or don't) code for the GNU assembler.  This is the default.
16540 @c Also, this is the default if the configure option @option{--with-gnu-as}
16541 @c is used.
16543 @item -mgnu-ld
16544 @itemx -mno-gnu-ld
16545 @opindex mgnu-ld
16546 @opindex mno-gnu-ld
16547 Generate (or don't) code for the GNU linker.  This is the default.
16548 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16549 @c is used.
16551 @item -mno-pic
16552 @opindex mno-pic
16553 Generate code that does not use a global pointer register.  The result
16554 is not position independent code, and violates the IA-64 ABI@.
16556 @item -mvolatile-asm-stop
16557 @itemx -mno-volatile-asm-stop
16558 @opindex mvolatile-asm-stop
16559 @opindex mno-volatile-asm-stop
16560 Generate (or don't) a stop bit immediately before and after volatile asm
16561 statements.
16563 @item -mregister-names
16564 @itemx -mno-register-names
16565 @opindex mregister-names
16566 @opindex mno-register-names
16567 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16568 the stacked registers.  This may make assembler output more readable.
16570 @item -mno-sdata
16571 @itemx -msdata
16572 @opindex mno-sdata
16573 @opindex msdata
16574 Disable (or enable) optimizations that use the small data section.  This may
16575 be useful for working around optimizer bugs.
16577 @item -mconstant-gp
16578 @opindex mconstant-gp
16579 Generate code that uses a single constant global pointer value.  This is
16580 useful when compiling kernel code.
16582 @item -mauto-pic
16583 @opindex mauto-pic
16584 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16585 This is useful when compiling firmware code.
16587 @item -minline-float-divide-min-latency
16588 @opindex minline-float-divide-min-latency
16589 Generate code for inline divides of floating-point values
16590 using the minimum latency algorithm.
16592 @item -minline-float-divide-max-throughput
16593 @opindex minline-float-divide-max-throughput
16594 Generate code for inline divides of floating-point values
16595 using the maximum throughput algorithm.
16597 @item -mno-inline-float-divide
16598 @opindex mno-inline-float-divide
16599 Do not generate inline code for divides of floating-point values.
16601 @item -minline-int-divide-min-latency
16602 @opindex minline-int-divide-min-latency
16603 Generate code for inline divides of integer values
16604 using the minimum latency algorithm.
16606 @item -minline-int-divide-max-throughput
16607 @opindex minline-int-divide-max-throughput
16608 Generate code for inline divides of integer values
16609 using the maximum throughput algorithm.
16611 @item -mno-inline-int-divide
16612 @opindex mno-inline-int-divide
16613 Do not generate inline code for divides of integer values.
16615 @item -minline-sqrt-min-latency
16616 @opindex minline-sqrt-min-latency
16617 Generate code for inline square roots
16618 using the minimum latency algorithm.
16620 @item -minline-sqrt-max-throughput
16621 @opindex minline-sqrt-max-throughput
16622 Generate code for inline square roots
16623 using the maximum throughput algorithm.
16625 @item -mno-inline-sqrt
16626 @opindex mno-inline-sqrt
16627 Do not generate inline code for @code{sqrt}.
16629 @item -mfused-madd
16630 @itemx -mno-fused-madd
16631 @opindex mfused-madd
16632 @opindex mno-fused-madd
16633 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16634 instructions.  The default is to use these instructions.
16636 @item -mno-dwarf2-asm
16637 @itemx -mdwarf2-asm
16638 @opindex mno-dwarf2-asm
16639 @opindex mdwarf2-asm
16640 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16641 info.  This may be useful when not using the GNU assembler.
16643 @item -mearly-stop-bits
16644 @itemx -mno-early-stop-bits
16645 @opindex mearly-stop-bits
16646 @opindex mno-early-stop-bits
16647 Allow stop bits to be placed earlier than immediately preceding the
16648 instruction that triggered the stop bit.  This can improve instruction
16649 scheduling, but does not always do so.
16651 @item -mfixed-range=@var{register-range}
16652 @opindex mfixed-range
16653 Generate code treating the given register range as fixed registers.
16654 A fixed register is one that the register allocator cannot use.  This is
16655 useful when compiling kernel code.  A register range is specified as
16656 two registers separated by a dash.  Multiple register ranges can be
16657 specified separated by a comma.
16659 @item -mtls-size=@var{tls-size}
16660 @opindex mtls-size
16661 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16664 @item -mtune=@var{cpu-type}
16665 @opindex mtune
16666 Tune the instruction scheduling for a particular CPU, Valid values are
16667 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16668 and @samp{mckinley}.
16670 @item -milp32
16671 @itemx -mlp64
16672 @opindex milp32
16673 @opindex mlp64
16674 Generate code for a 32-bit or 64-bit environment.
16675 The 32-bit environment sets int, long and pointer to 32 bits.
16676 The 64-bit environment sets int to 32 bits and long and pointer
16677 to 64 bits.  These are HP-UX specific flags.
16679 @item -mno-sched-br-data-spec
16680 @itemx -msched-br-data-spec
16681 @opindex mno-sched-br-data-spec
16682 @opindex msched-br-data-spec
16683 (Dis/En)able data speculative scheduling before reload.
16684 This results in generation of @code{ld.a} instructions and
16685 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16686 The default is 'disable'.
16688 @item -msched-ar-data-spec
16689 @itemx -mno-sched-ar-data-spec
16690 @opindex msched-ar-data-spec
16691 @opindex mno-sched-ar-data-spec
16692 (En/Dis)able data speculative scheduling after reload.
16693 This results in generation of @code{ld.a} instructions and
16694 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16695 The default is 'enable'.
16697 @item -mno-sched-control-spec
16698 @itemx -msched-control-spec
16699 @opindex mno-sched-control-spec
16700 @opindex msched-control-spec
16701 (Dis/En)able control speculative scheduling.  This feature is
16702 available only during region scheduling (i.e.@: before reload).
16703 This results in generation of the @code{ld.s} instructions and
16704 the corresponding check instructions @code{chk.s}.
16705 The default is 'disable'.
16707 @item -msched-br-in-data-spec
16708 @itemx -mno-sched-br-in-data-spec
16709 @opindex msched-br-in-data-spec
16710 @opindex mno-sched-br-in-data-spec
16711 (En/Dis)able speculative scheduling of the instructions that
16712 are dependent on the data speculative loads before reload.
16713 This is effective only with @option{-msched-br-data-spec} enabled.
16714 The default is 'enable'.
16716 @item -msched-ar-in-data-spec
16717 @itemx -mno-sched-ar-in-data-spec
16718 @opindex msched-ar-in-data-spec
16719 @opindex mno-sched-ar-in-data-spec
16720 (En/Dis)able speculative scheduling of the instructions that
16721 are dependent on the data speculative loads after reload.
16722 This is effective only with @option{-msched-ar-data-spec} enabled.
16723 The default is 'enable'.
16725 @item -msched-in-control-spec
16726 @itemx -mno-sched-in-control-spec
16727 @opindex msched-in-control-spec
16728 @opindex mno-sched-in-control-spec
16729 (En/Dis)able speculative scheduling of the instructions that
16730 are dependent on the control speculative loads.
16731 This is effective only with @option{-msched-control-spec} enabled.
16732 The default is 'enable'.
16734 @item -mno-sched-prefer-non-data-spec-insns
16735 @itemx -msched-prefer-non-data-spec-insns
16736 @opindex mno-sched-prefer-non-data-spec-insns
16737 @opindex msched-prefer-non-data-spec-insns
16738 If enabled, data-speculative instructions are chosen for schedule
16739 only if there are no other choices at the moment.  This makes
16740 the use of the data speculation much more conservative.
16741 The default is 'disable'.
16743 @item -mno-sched-prefer-non-control-spec-insns
16744 @itemx -msched-prefer-non-control-spec-insns
16745 @opindex mno-sched-prefer-non-control-spec-insns
16746 @opindex msched-prefer-non-control-spec-insns
16747 If enabled, control-speculative instructions are chosen for schedule
16748 only if there are no other choices at the moment.  This makes
16749 the use of the control speculation much more conservative.
16750 The default is 'disable'.
16752 @item -mno-sched-count-spec-in-critical-path
16753 @itemx -msched-count-spec-in-critical-path
16754 @opindex mno-sched-count-spec-in-critical-path
16755 @opindex msched-count-spec-in-critical-path
16756 If enabled, speculative dependencies are considered during
16757 computation of the instructions priorities.  This makes the use of the
16758 speculation a bit more conservative.
16759 The default is 'disable'.
16761 @item -msched-spec-ldc
16762 @opindex msched-spec-ldc
16763 Use a simple data speculation check.  This option is on by default.
16765 @item -msched-control-spec-ldc
16766 @opindex msched-spec-ldc
16767 Use a simple check for control speculation.  This option is on by default.
16769 @item -msched-stop-bits-after-every-cycle
16770 @opindex msched-stop-bits-after-every-cycle
16771 Place a stop bit after every cycle when scheduling.  This option is on
16772 by default.
16774 @item -msched-fp-mem-deps-zero-cost
16775 @opindex msched-fp-mem-deps-zero-cost
16776 Assume that floating-point stores and loads are not likely to cause a conflict
16777 when placed into the same instruction group.  This option is disabled by
16778 default.
16780 @item -msel-sched-dont-check-control-spec
16781 @opindex msel-sched-dont-check-control-spec
16782 Generate checks for control speculation in selective scheduling.
16783 This flag is disabled by default.
16785 @item -msched-max-memory-insns=@var{max-insns}
16786 @opindex msched-max-memory-insns
16787 Limit on the number of memory insns per instruction group, giving lower
16788 priority to subsequent memory insns attempting to schedule in the same
16789 instruction group. Frequently useful to prevent cache bank conflicts.
16790 The default value is 1.
16792 @item -msched-max-memory-insns-hard-limit
16793 @opindex msched-max-memory-insns-hard-limit
16794 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16795 disallowing more than that number in an instruction group.
16796 Otherwise, the limit is ``soft'', meaning that non-memory operations
16797 are preferred when the limit is reached, but memory operations may still
16798 be scheduled.
16800 @end table
16802 @node LM32 Options
16803 @subsection LM32 Options
16804 @cindex LM32 options
16806 These @option{-m} options are defined for the LatticeMico32 architecture:
16808 @table @gcctabopt
16809 @item -mbarrel-shift-enabled
16810 @opindex mbarrel-shift-enabled
16811 Enable barrel-shift instructions.
16813 @item -mdivide-enabled
16814 @opindex mdivide-enabled
16815 Enable divide and modulus instructions.
16817 @item -mmultiply-enabled
16818 @opindex multiply-enabled
16819 Enable multiply instructions.
16821 @item -msign-extend-enabled
16822 @opindex msign-extend-enabled
16823 Enable sign extend instructions.
16825 @item -muser-enabled
16826 @opindex muser-enabled
16827 Enable user-defined instructions.
16829 @end table
16831 @node M32C Options
16832 @subsection M32C Options
16833 @cindex M32C options
16835 @table @gcctabopt
16836 @item -mcpu=@var{name}
16837 @opindex mcpu=
16838 Select the CPU for which code is generated.  @var{name} may be one of
16839 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16840 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16841 the M32C/80 series.
16843 @item -msim
16844 @opindex msim
16845 Specifies that the program will be run on the simulator.  This causes
16846 an alternate runtime library to be linked in which supports, for
16847 example, file I/O@.  You must not use this option when generating
16848 programs that will run on real hardware; you must provide your own
16849 runtime library for whatever I/O functions are needed.
16851 @item -memregs=@var{number}
16852 @opindex memregs=
16853 Specifies the number of memory-based pseudo-registers GCC uses
16854 during code generation.  These pseudo-registers are used like real
16855 registers, so there is a tradeoff between GCC's ability to fit the
16856 code into available registers, and the performance penalty of using
16857 memory instead of registers.  Note that all modules in a program must
16858 be compiled with the same value for this option.  Because of that, you
16859 must not use this option with GCC's default runtime libraries.
16861 @end table
16863 @node M32R/D Options
16864 @subsection M32R/D Options
16865 @cindex M32R/D options
16867 These @option{-m} options are defined for Renesas M32R/D architectures:
16869 @table @gcctabopt
16870 @item -m32r2
16871 @opindex m32r2
16872 Generate code for the M32R/2@.
16874 @item -m32rx
16875 @opindex m32rx
16876 Generate code for the M32R/X@.
16878 @item -m32r
16879 @opindex m32r
16880 Generate code for the M32R@.  This is the default.
16882 @item -mmodel=small
16883 @opindex mmodel=small
16884 Assume all objects live in the lower 16MB of memory (so that their addresses
16885 can be loaded with the @code{ld24} instruction), and assume all subroutines
16886 are reachable with the @code{bl} instruction.
16887 This is the default.
16889 The addressability of a particular object can be set with the
16890 @code{model} attribute.
16892 @item -mmodel=medium
16893 @opindex mmodel=medium
16894 Assume objects may be anywhere in the 32-bit address space (the compiler
16895 generates @code{seth/add3} instructions to load their addresses), and
16896 assume all subroutines are reachable with the @code{bl} instruction.
16898 @item -mmodel=large
16899 @opindex mmodel=large
16900 Assume objects may be anywhere in the 32-bit address space (the compiler
16901 generates @code{seth/add3} instructions to load their addresses), and
16902 assume subroutines may not be reachable with the @code{bl} instruction
16903 (the compiler generates the much slower @code{seth/add3/jl}
16904 instruction sequence).
16906 @item -msdata=none
16907 @opindex msdata=none
16908 Disable use of the small data area.  Variables are put into
16909 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16910 @code{section} attribute has been specified).
16911 This is the default.
16913 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16914 Objects may be explicitly put in the small data area with the
16915 @code{section} attribute using one of these sections.
16917 @item -msdata=sdata
16918 @opindex msdata=sdata
16919 Put small global and static data in the small data area, but do not
16920 generate special code to reference them.
16922 @item -msdata=use
16923 @opindex msdata=use
16924 Put small global and static data in the small data area, and generate
16925 special instructions to reference them.
16927 @item -G @var{num}
16928 @opindex G
16929 @cindex smaller data references
16930 Put global and static objects less than or equal to @var{num} bytes
16931 into the small data or BSS sections instead of the normal data or BSS
16932 sections.  The default value of @var{num} is 8.
16933 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16934 for this option to have any effect.
16936 All modules should be compiled with the same @option{-G @var{num}} value.
16937 Compiling with different values of @var{num} may or may not work; if it
16938 doesn't the linker gives an error message---incorrect code is not
16939 generated.
16941 @item -mdebug
16942 @opindex mdebug
16943 Makes the M32R-specific code in the compiler display some statistics
16944 that might help in debugging programs.
16946 @item -malign-loops
16947 @opindex malign-loops
16948 Align all loops to a 32-byte boundary.
16950 @item -mno-align-loops
16951 @opindex mno-align-loops
16952 Do not enforce a 32-byte alignment for loops.  This is the default.
16954 @item -missue-rate=@var{number}
16955 @opindex missue-rate=@var{number}
16956 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16957 or 2.
16959 @item -mbranch-cost=@var{number}
16960 @opindex mbranch-cost=@var{number}
16961 @var{number} can only be 1 or 2.  If it is 1 then branches are
16962 preferred over conditional code, if it is 2, then the opposite applies.
16964 @item -mflush-trap=@var{number}
16965 @opindex mflush-trap=@var{number}
16966 Specifies the trap number to use to flush the cache.  The default is
16967 12.  Valid numbers are between 0 and 15 inclusive.
16969 @item -mno-flush-trap
16970 @opindex mno-flush-trap
16971 Specifies that the cache cannot be flushed by using a trap.
16973 @item -mflush-func=@var{name}
16974 @opindex mflush-func=@var{name}
16975 Specifies the name of the operating system function to call to flush
16976 the cache.  The default is @emph{_flush_cache}, but a function call
16977 is only used if a trap is not available.
16979 @item -mno-flush-func
16980 @opindex mno-flush-func
16981 Indicates that there is no OS function for flushing the cache.
16983 @end table
16985 @node M680x0 Options
16986 @subsection M680x0 Options
16987 @cindex M680x0 options
16989 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16990 The default settings depend on which architecture was selected when
16991 the compiler was configured; the defaults for the most common choices
16992 are given below.
16994 @table @gcctabopt
16995 @item -march=@var{arch}
16996 @opindex march
16997 Generate code for a specific M680x0 or ColdFire instruction set
16998 architecture.  Permissible values of @var{arch} for M680x0
16999 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
17000 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
17001 architectures are selected according to Freescale's ISA classification
17002 and the permissible values are: @samp{isaa}, @samp{isaaplus},
17003 @samp{isab} and @samp{isac}.
17005 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
17006 code for a ColdFire target.  The @var{arch} in this macro is one of the
17007 @option{-march} arguments given above.
17009 When used together, @option{-march} and @option{-mtune} select code
17010 that runs on a family of similar processors but that is optimized
17011 for a particular microarchitecture.
17013 @item -mcpu=@var{cpu}
17014 @opindex mcpu
17015 Generate code for a specific M680x0 or ColdFire processor.
17016 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
17017 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
17018 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
17019 below, which also classifies the CPUs into families:
17021 @multitable @columnfractions 0.20 0.80
17022 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
17023 @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}
17024 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
17025 @item @samp{5206e} @tab @samp{5206e}
17026 @item @samp{5208} @tab @samp{5207} @samp{5208}
17027 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
17028 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
17029 @item @samp{5216} @tab @samp{5214} @samp{5216}
17030 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
17031 @item @samp{5225} @tab @samp{5224} @samp{5225}
17032 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
17033 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
17034 @item @samp{5249} @tab @samp{5249}
17035 @item @samp{5250} @tab @samp{5250}
17036 @item @samp{5271} @tab @samp{5270} @samp{5271}
17037 @item @samp{5272} @tab @samp{5272}
17038 @item @samp{5275} @tab @samp{5274} @samp{5275}
17039 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
17040 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
17041 @item @samp{5307} @tab @samp{5307}
17042 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
17043 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
17044 @item @samp{5407} @tab @samp{5407}
17045 @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}
17046 @end multitable
17048 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
17049 @var{arch} is compatible with @var{cpu}.  Other combinations of
17050 @option{-mcpu} and @option{-march} are rejected.
17052 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
17053 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
17054 where the value of @var{family} is given by the table above.
17056 @item -mtune=@var{tune}
17057 @opindex mtune
17058 Tune the code for a particular microarchitecture within the
17059 constraints set by @option{-march} and @option{-mcpu}.
17060 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
17061 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
17062 and @samp{cpu32}.  The ColdFire microarchitectures
17063 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
17065 You can also use @option{-mtune=68020-40} for code that needs
17066 to run relatively well on 68020, 68030 and 68040 targets.
17067 @option{-mtune=68020-60} is similar but includes 68060 targets
17068 as well.  These two options select the same tuning decisions as
17069 @option{-m68020-40} and @option{-m68020-60} respectively.
17071 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
17072 when tuning for 680x0 architecture @var{arch}.  It also defines
17073 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
17074 option is used.  If GCC is tuning for a range of architectures,
17075 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
17076 it defines the macros for every architecture in the range.
17078 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
17079 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
17080 of the arguments given above.
17082 @item -m68000
17083 @itemx -mc68000
17084 @opindex m68000
17085 @opindex mc68000
17086 Generate output for a 68000.  This is the default
17087 when the compiler is configured for 68000-based systems.
17088 It is equivalent to @option{-march=68000}.
17090 Use this option for microcontrollers with a 68000 or EC000 core,
17091 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
17093 @item -m68010
17094 @opindex m68010
17095 Generate output for a 68010.  This is the default
17096 when the compiler is configured for 68010-based systems.
17097 It is equivalent to @option{-march=68010}.
17099 @item -m68020
17100 @itemx -mc68020
17101 @opindex m68020
17102 @opindex mc68020
17103 Generate output for a 68020.  This is the default
17104 when the compiler is configured for 68020-based systems.
17105 It is equivalent to @option{-march=68020}.
17107 @item -m68030
17108 @opindex m68030
17109 Generate output for a 68030.  This is the default when the compiler is
17110 configured for 68030-based systems.  It is equivalent to
17111 @option{-march=68030}.
17113 @item -m68040
17114 @opindex m68040
17115 Generate output for a 68040.  This is the default when the compiler is
17116 configured for 68040-based systems.  It is equivalent to
17117 @option{-march=68040}.
17119 This option inhibits the use of 68881/68882 instructions that have to be
17120 emulated by software on the 68040.  Use this option if your 68040 does not
17121 have code to emulate those instructions.
17123 @item -m68060
17124 @opindex m68060
17125 Generate output for a 68060.  This is the default when the compiler is
17126 configured for 68060-based systems.  It is equivalent to
17127 @option{-march=68060}.
17129 This option inhibits the use of 68020 and 68881/68882 instructions that
17130 have to be emulated by software on the 68060.  Use this option if your 68060
17131 does not have code to emulate those instructions.
17133 @item -mcpu32
17134 @opindex mcpu32
17135 Generate output for a CPU32.  This is the default
17136 when the compiler is configured for CPU32-based systems.
17137 It is equivalent to @option{-march=cpu32}.
17139 Use this option for microcontrollers with a
17140 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17141 68336, 68340, 68341, 68349 and 68360.
17143 @item -m5200
17144 @opindex m5200
17145 Generate output for a 520X ColdFire CPU@.  This is the default
17146 when the compiler is configured for 520X-based systems.
17147 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17148 in favor of that option.
17150 Use this option for microcontroller with a 5200 core, including
17151 the MCF5202, MCF5203, MCF5204 and MCF5206.
17153 @item -m5206e
17154 @opindex m5206e
17155 Generate output for a 5206e ColdFire CPU@.  The option is now
17156 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17158 @item -m528x
17159 @opindex m528x
17160 Generate output for a member of the ColdFire 528X family.
17161 The option is now deprecated in favor of the equivalent
17162 @option{-mcpu=528x}.
17164 @item -m5307
17165 @opindex m5307
17166 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17167 in favor of the equivalent @option{-mcpu=5307}.
17169 @item -m5407
17170 @opindex m5407
17171 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17172 in favor of the equivalent @option{-mcpu=5407}.
17174 @item -mcfv4e
17175 @opindex mcfv4e
17176 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17177 This includes use of hardware floating-point instructions.
17178 The option is equivalent to @option{-mcpu=547x}, and is now
17179 deprecated in favor of that option.
17181 @item -m68020-40
17182 @opindex m68020-40
17183 Generate output for a 68040, without using any of the new instructions.
17184 This results in code that can run relatively efficiently on either a
17185 68020/68881 or a 68030 or a 68040.  The generated code does use the
17186 68881 instructions that are emulated on the 68040.
17188 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17190 @item -m68020-60
17191 @opindex m68020-60
17192 Generate output for a 68060, without using any of the new instructions.
17193 This results in code that can run relatively efficiently on either a
17194 68020/68881 or a 68030 or a 68040.  The generated code does use the
17195 68881 instructions that are emulated on the 68060.
17197 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17199 @item -mhard-float
17200 @itemx -m68881
17201 @opindex mhard-float
17202 @opindex m68881
17203 Generate floating-point instructions.  This is the default for 68020
17204 and above, and for ColdFire devices that have an FPU@.  It defines the
17205 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
17206 on ColdFire targets.
17208 @item -msoft-float
17209 @opindex msoft-float
17210 Do not generate floating-point instructions; use library calls instead.
17211 This is the default for 68000, 68010, and 68832 targets.  It is also
17212 the default for ColdFire devices that have no FPU.
17214 @item -mdiv
17215 @itemx -mno-div
17216 @opindex mdiv
17217 @opindex mno-div
17218 Generate (do not generate) ColdFire hardware divide and remainder
17219 instructions.  If @option{-march} is used without @option{-mcpu},
17220 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17221 architectures.  Otherwise, the default is taken from the target CPU
17222 (either the default CPU, or the one specified by @option{-mcpu}).  For
17223 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17224 @option{-mcpu=5206e}.
17226 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
17228 @item -mshort
17229 @opindex mshort
17230 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17231 Additionally, parameters passed on the stack are also aligned to a
17232 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17234 @item -mno-short
17235 @opindex mno-short
17236 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17238 @item -mnobitfield
17239 @itemx -mno-bitfield
17240 @opindex mnobitfield
17241 @opindex mno-bitfield
17242 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17243 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17245 @item -mbitfield
17246 @opindex mbitfield
17247 Do use the bit-field instructions.  The @option{-m68020} option implies
17248 @option{-mbitfield}.  This is the default if you use a configuration
17249 designed for a 68020.
17251 @item -mrtd
17252 @opindex mrtd
17253 Use a different function-calling convention, in which functions
17254 that take a fixed number of arguments return with the @code{rtd}
17255 instruction, which pops their arguments while returning.  This
17256 saves one instruction in the caller since there is no need to pop
17257 the arguments there.
17259 This calling convention is incompatible with the one normally
17260 used on Unix, so you cannot use it if you need to call libraries
17261 compiled with the Unix compiler.
17263 Also, you must provide function prototypes for all functions that
17264 take variable numbers of arguments (including @code{printf});
17265 otherwise incorrect code is generated for calls to those
17266 functions.
17268 In addition, seriously incorrect code results if you call a
17269 function with too many arguments.  (Normally, extra arguments are
17270 harmlessly ignored.)
17272 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17273 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17275 @item -mno-rtd
17276 @opindex mno-rtd
17277 Do not use the calling conventions selected by @option{-mrtd}.
17278 This is the default.
17280 @item -malign-int
17281 @itemx -mno-align-int
17282 @opindex malign-int
17283 @opindex mno-align-int
17284 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17285 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17286 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17287 Aligning variables on 32-bit boundaries produces code that runs somewhat
17288 faster on processors with 32-bit busses at the expense of more memory.
17290 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17291 aligns structures containing the above types differently than
17292 most published application binary interface specifications for the m68k.
17294 @item -mpcrel
17295 @opindex mpcrel
17296 Use the pc-relative addressing mode of the 68000 directly, instead of
17297 using a global offset table.  At present, this option implies @option{-fpic},
17298 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17299 not presently supported with @option{-mpcrel}, though this could be supported for
17300 68020 and higher processors.
17302 @item -mno-strict-align
17303 @itemx -mstrict-align
17304 @opindex mno-strict-align
17305 @opindex mstrict-align
17306 Do not (do) assume that unaligned memory references are handled by
17307 the system.
17309 @item -msep-data
17310 Generate code that allows the data segment to be located in a different
17311 area of memory from the text segment.  This allows for execute-in-place in
17312 an environment without virtual memory management.  This option implies
17313 @option{-fPIC}.
17315 @item -mno-sep-data
17316 Generate code that assumes that the data segment follows the text segment.
17317 This is the default.
17319 @item -mid-shared-library
17320 Generate code that supports shared libraries via the library ID method.
17321 This allows for execute-in-place and shared libraries in an environment
17322 without virtual memory management.  This option implies @option{-fPIC}.
17324 @item -mno-id-shared-library
17325 Generate code that doesn't assume ID-based shared libraries are being used.
17326 This is the default.
17328 @item -mshared-library-id=n
17329 Specifies the identification number of the ID-based shared library being
17330 compiled.  Specifying a value of 0 generates more compact code; specifying
17331 other values forces the allocation of that number to the current
17332 library, but is no more space- or time-efficient than omitting this option.
17334 @item -mxgot
17335 @itemx -mno-xgot
17336 @opindex mxgot
17337 @opindex mno-xgot
17338 When generating position-independent code for ColdFire, generate code
17339 that works if the GOT has more than 8192 entries.  This code is
17340 larger and slower than code generated without this option.  On M680x0
17341 processors, this option is not needed; @option{-fPIC} suffices.
17343 GCC normally uses a single instruction to load values from the GOT@.
17344 While this is relatively efficient, it only works if the GOT
17345 is smaller than about 64k.  Anything larger causes the linker
17346 to report an error such as:
17348 @cindex relocation truncated to fit (ColdFire)
17349 @smallexample
17350 relocation truncated to fit: R_68K_GOT16O foobar
17351 @end smallexample
17353 If this happens, you should recompile your code with @option{-mxgot}.
17354 It should then work with very large GOTs.  However, code generated with
17355 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17356 the value of a global symbol.
17358 Note that some linkers, including newer versions of the GNU linker,
17359 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17360 you should only need to use @option{-mxgot} when compiling a single
17361 object file that accesses more than 8192 GOT entries.  Very few do.
17363 These options have no effect unless GCC is generating
17364 position-independent code.
17366 @end table
17368 @node MCore Options
17369 @subsection MCore Options
17370 @cindex MCore options
17372 These are the @samp{-m} options defined for the Motorola M*Core
17373 processors.
17375 @table @gcctabopt
17377 @item -mhardlit
17378 @itemx -mno-hardlit
17379 @opindex mhardlit
17380 @opindex mno-hardlit
17381 Inline constants into the code stream if it can be done in two
17382 instructions or less.
17384 @item -mdiv
17385 @itemx -mno-div
17386 @opindex mdiv
17387 @opindex mno-div
17388 Use the divide instruction.  (Enabled by default).
17390 @item -mrelax-immediate
17391 @itemx -mno-relax-immediate
17392 @opindex mrelax-immediate
17393 @opindex mno-relax-immediate
17394 Allow arbitrary-sized immediates in bit operations.
17396 @item -mwide-bitfields
17397 @itemx -mno-wide-bitfields
17398 @opindex mwide-bitfields
17399 @opindex mno-wide-bitfields
17400 Always treat bit-fields as @code{int}-sized.
17402 @item -m4byte-functions
17403 @itemx -mno-4byte-functions
17404 @opindex m4byte-functions
17405 @opindex mno-4byte-functions
17406 Force all functions to be aligned to a 4-byte boundary.
17408 @item -mcallgraph-data
17409 @itemx -mno-callgraph-data
17410 @opindex mcallgraph-data
17411 @opindex mno-callgraph-data
17412 Emit callgraph information.
17414 @item -mslow-bytes
17415 @itemx -mno-slow-bytes
17416 @opindex mslow-bytes
17417 @opindex mno-slow-bytes
17418 Prefer word access when reading byte quantities.
17420 @item -mlittle-endian
17421 @itemx -mbig-endian
17422 @opindex mlittle-endian
17423 @opindex mbig-endian
17424 Generate code for a little-endian target.
17426 @item -m210
17427 @itemx -m340
17428 @opindex m210
17429 @opindex m340
17430 Generate code for the 210 processor.
17432 @item -mno-lsim
17433 @opindex mno-lsim
17434 Assume that runtime support has been provided and so omit the
17435 simulator library (@file{libsim.a)} from the linker command line.
17437 @item -mstack-increment=@var{size}
17438 @opindex mstack-increment
17439 Set the maximum amount for a single stack increment operation.  Large
17440 values can increase the speed of programs that contain functions
17441 that need a large amount of stack space, but they can also trigger a
17442 segmentation fault if the stack is extended too much.  The default
17443 value is 0x1000.
17445 @end table
17447 @node MeP Options
17448 @subsection MeP Options
17449 @cindex MeP options
17451 @table @gcctabopt
17453 @item -mabsdiff
17454 @opindex mabsdiff
17455 Enables the @code{abs} instruction, which is the absolute difference
17456 between two registers.
17458 @item -mall-opts
17459 @opindex mall-opts
17460 Enables all the optional instructions---average, multiply, divide, bit
17461 operations, leading zero, absolute difference, min/max, clip, and
17462 saturation.
17465 @item -maverage
17466 @opindex maverage
17467 Enables the @code{ave} instruction, which computes the average of two
17468 registers.
17470 @item -mbased=@var{n}
17471 @opindex mbased=
17472 Variables of size @var{n} bytes or smaller are placed in the
17473 @code{.based} section by default.  Based variables use the @code{$tp}
17474 register as a base register, and there is a 128-byte limit to the
17475 @code{.based} section.
17477 @item -mbitops
17478 @opindex mbitops
17479 Enables the bit operation instructions---bit test (@code{btstm}), set
17480 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17481 test-and-set (@code{tas}).
17483 @item -mc=@var{name}
17484 @opindex mc=
17485 Selects which section constant data is placed in.  @var{name} may
17486 be @code{tiny}, @code{near}, or @code{far}.
17488 @item -mclip
17489 @opindex mclip
17490 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17491 useful unless you also provide @code{-mminmax}.
17493 @item -mconfig=@var{name}
17494 @opindex mconfig=
17495 Selects one of the built-in core configurations.  Each MeP chip has
17496 one or more modules in it; each module has a core CPU and a variety of
17497 coprocessors, optional instructions, and peripherals.  The
17498 @code{MeP-Integrator} tool, not part of GCC, provides these
17499 configurations through this option; using this option is the same as
17500 using all the corresponding command-line options.  The default
17501 configuration is @code{default}.
17503 @item -mcop
17504 @opindex mcop
17505 Enables the coprocessor instructions.  By default, this is a 32-bit
17506 coprocessor.  Note that the coprocessor is normally enabled via the
17507 @code{-mconfig=} option.
17509 @item -mcop32
17510 @opindex mcop32
17511 Enables the 32-bit coprocessor's instructions.
17513 @item -mcop64
17514 @opindex mcop64
17515 Enables the 64-bit coprocessor's instructions.
17517 @item -mivc2
17518 @opindex mivc2
17519 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17521 @item -mdc
17522 @opindex mdc
17523 Causes constant variables to be placed in the @code{.near} section.
17525 @item -mdiv
17526 @opindex mdiv
17527 Enables the @code{div} and @code{divu} instructions.
17529 @item -meb
17530 @opindex meb
17531 Generate big-endian code.
17533 @item -mel
17534 @opindex mel
17535 Generate little-endian code.
17537 @item -mio-volatile
17538 @opindex mio-volatile
17539 Tells the compiler that any variable marked with the @code{io}
17540 attribute is to be considered volatile.
17542 @item -ml
17543 @opindex ml
17544 Causes variables to be assigned to the @code{.far} section by default.
17546 @item -mleadz
17547 @opindex mleadz
17548 Enables the @code{leadz} (leading zero) instruction.
17550 @item -mm
17551 @opindex mm
17552 Causes variables to be assigned to the @code{.near} section by default.
17554 @item -mminmax
17555 @opindex mminmax
17556 Enables the @code{min} and @code{max} instructions.
17558 @item -mmult
17559 @opindex mmult
17560 Enables the multiplication and multiply-accumulate instructions.
17562 @item -mno-opts
17563 @opindex mno-opts
17564 Disables all the optional instructions enabled by @code{-mall-opts}.
17566 @item -mrepeat
17567 @opindex mrepeat
17568 Enables the @code{repeat} and @code{erepeat} instructions, used for
17569 low-overhead looping.
17571 @item -ms
17572 @opindex ms
17573 Causes all variables to default to the @code{.tiny} section.  Note
17574 that there is a 65536-byte limit to this section.  Accesses to these
17575 variables use the @code{%gp} base register.
17577 @item -msatur
17578 @opindex msatur
17579 Enables the saturation instructions.  Note that the compiler does not
17580 currently generate these itself, but this option is included for
17581 compatibility with other tools, like @code{as}.
17583 @item -msdram
17584 @opindex msdram
17585 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17587 @item -msim
17588 @opindex msim
17589 Link the simulator run-time libraries.
17591 @item -msimnovec
17592 @opindex msimnovec
17593 Link the simulator runtime libraries, excluding built-in support
17594 for reset and exception vectors and tables.
17596 @item -mtf
17597 @opindex mtf
17598 Causes all functions to default to the @code{.far} section.  Without
17599 this option, functions default to the @code{.near} section.
17601 @item -mtiny=@var{n}
17602 @opindex mtiny=
17603 Variables that are @var{n} bytes or smaller are allocated to the
17604 @code{.tiny} section.  These variables use the @code{$gp} base
17605 register.  The default for this option is 4, but note that there's a
17606 65536-byte limit to the @code{.tiny} section.
17608 @end table
17610 @node MicroBlaze Options
17611 @subsection MicroBlaze Options
17612 @cindex MicroBlaze Options
17614 @table @gcctabopt
17616 @item -msoft-float
17617 @opindex msoft-float
17618 Use software emulation for floating point (default).
17620 @item -mhard-float
17621 @opindex mhard-float
17622 Use hardware floating-point instructions.
17624 @item -mmemcpy
17625 @opindex mmemcpy
17626 Do not optimize block moves, use @code{memcpy}.
17628 @item -mno-clearbss
17629 @opindex mno-clearbss
17630 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17632 @item -mcpu=@var{cpu-type}
17633 @opindex mcpu=
17634 Use features of, and schedule code for, the given CPU.
17635 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17636 where @var{X} is a major version, @var{YY} is the minor version, and
17637 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17638 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17640 @item -mxl-soft-mul
17641 @opindex mxl-soft-mul
17642 Use software multiply emulation (default).
17644 @item -mxl-soft-div
17645 @opindex mxl-soft-div
17646 Use software emulation for divides (default).
17648 @item -mxl-barrel-shift
17649 @opindex mxl-barrel-shift
17650 Use the hardware barrel shifter.
17652 @item -mxl-pattern-compare
17653 @opindex mxl-pattern-compare
17654 Use pattern compare instructions.
17656 @item -msmall-divides
17657 @opindex msmall-divides
17658 Use table lookup optimization for small signed integer divisions.
17660 @item -mxl-stack-check
17661 @opindex mxl-stack-check
17662 This option is deprecated.  Use @option{-fstack-check} instead.
17664 @item -mxl-gp-opt
17665 @opindex mxl-gp-opt
17666 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17668 @item -mxl-multiply-high
17669 @opindex mxl-multiply-high
17670 Use multiply high instructions for high part of 32x32 multiply.
17672 @item -mxl-float-convert
17673 @opindex mxl-float-convert
17674 Use hardware floating-point conversion instructions.
17676 @item -mxl-float-sqrt
17677 @opindex mxl-float-sqrt
17678 Use hardware floating-point square root instruction.
17680 @item -mbig-endian
17681 @opindex mbig-endian
17682 Generate code for a big-endian target.
17684 @item -mlittle-endian
17685 @opindex mlittle-endian
17686 Generate code for a little-endian target.
17688 @item -mxl-reorder
17689 @opindex mxl-reorder
17690 Use reorder instructions (swap and byte reversed load/store).
17692 @item -mxl-mode-@var{app-model}
17693 Select application model @var{app-model}.  Valid models are
17694 @table @samp
17695 @item executable
17696 normal executable (default), uses startup code @file{crt0.o}.
17698 @item xmdstub
17699 for use with Xilinx Microprocessor Debugger (XMD) based
17700 software intrusive debug agent called xmdstub. This uses startup file
17701 @file{crt1.o} and sets the start address of the program to 0x800.
17703 @item bootstrap
17704 for applications that are loaded using a bootloader.
17705 This model uses startup file @file{crt2.o} which does not contain a processor
17706 reset vector handler. This is suitable for transferring control on a
17707 processor reset to the bootloader rather than the application.
17709 @item novectors
17710 for applications that do not require any of the
17711 MicroBlaze vectors. This option may be useful for applications running
17712 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17713 @end table
17715 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17716 @option{-mxl-mode-@var{app-model}}.
17718 @end table
17720 @node MIPS Options
17721 @subsection MIPS Options
17722 @cindex MIPS options
17724 @table @gcctabopt
17726 @item -EB
17727 @opindex EB
17728 Generate big-endian code.
17730 @item -EL
17731 @opindex EL
17732 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17733 configurations.
17735 @item -march=@var{arch}
17736 @opindex march
17737 Generate code that runs on @var{arch}, which can be the name of a
17738 generic MIPS ISA, or the name of a particular processor.
17739 The ISA names are:
17740 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17741 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17742 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17743 @samp{mips64r5} and @samp{mips64r6}.
17744 The processor names are:
17745 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17746 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17747 @samp{5kc}, @samp{5kf},
17748 @samp{20kc},
17749 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17750 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17751 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17752 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17753 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17754 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17755 @samp{m4k},
17756 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17757 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17758 @samp{orion},
17759 @samp{p5600},
17760 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17761 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17762 @samp{rm7000}, @samp{rm9000},
17763 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17764 @samp{sb1},
17765 @samp{sr71000},
17766 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17767 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17768 @samp{xlr} and @samp{xlp}.
17769 The special value @samp{from-abi} selects the
17770 most compatible architecture for the selected ABI (that is,
17771 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17773 The native Linux/GNU toolchain also supports the value @samp{native},
17774 which selects the best architecture option for the host processor.
17775 @option{-march=native} has no effect if GCC does not recognize
17776 the processor.
17778 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17779 (for example, @option{-march=r2k}).  Prefixes are optional, and
17780 @samp{vr} may be written @samp{r}.
17782 Names of the form @samp{@var{n}f2_1} refer to processors with
17783 FPUs clocked at half the rate of the core, names of the form
17784 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17785 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17786 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17787 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17788 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17789 accepted as synonyms for @samp{@var{n}f1_1}.
17791 GCC defines two macros based on the value of this option.  The first
17792 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17793 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17794 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17795 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17796 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17798 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17799 above.  In other words, it has the full prefix and does not
17800 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17801 the macro names the resolved architecture (either @samp{"mips1"} or
17802 @samp{"mips3"}).  It names the default architecture when no
17803 @option{-march} option is given.
17805 @item -mtune=@var{arch}
17806 @opindex mtune
17807 Optimize for @var{arch}.  Among other things, this option controls
17808 the way instructions are scheduled, and the perceived cost of arithmetic
17809 operations.  The list of @var{arch} values is the same as for
17810 @option{-march}.
17812 When this option is not used, GCC optimizes for the processor
17813 specified by @option{-march}.  By using @option{-march} and
17814 @option{-mtune} together, it is possible to generate code that
17815 runs on a family of processors, but optimize the code for one
17816 particular member of that family.
17818 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17819 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17820 @option{-march} ones described above.
17822 @item -mips1
17823 @opindex mips1
17824 Equivalent to @option{-march=mips1}.
17826 @item -mips2
17827 @opindex mips2
17828 Equivalent to @option{-march=mips2}.
17830 @item -mips3
17831 @opindex mips3
17832 Equivalent to @option{-march=mips3}.
17834 @item -mips4
17835 @opindex mips4
17836 Equivalent to @option{-march=mips4}.
17838 @item -mips32
17839 @opindex mips32
17840 Equivalent to @option{-march=mips32}.
17842 @item -mips32r3
17843 @opindex mips32r3
17844 Equivalent to @option{-march=mips32r3}.
17846 @item -mips32r5
17847 @opindex mips32r5
17848 Equivalent to @option{-march=mips32r5}.
17850 @item -mips32r6
17851 @opindex mips32r6
17852 Equivalent to @option{-march=mips32r6}.
17854 @item -mips64
17855 @opindex mips64
17856 Equivalent to @option{-march=mips64}.
17858 @item -mips64r2
17859 @opindex mips64r2
17860 Equivalent to @option{-march=mips64r2}.
17862 @item -mips64r3
17863 @opindex mips64r3
17864 Equivalent to @option{-march=mips64r3}.
17866 @item -mips64r5
17867 @opindex mips64r5
17868 Equivalent to @option{-march=mips64r5}.
17870 @item -mips64r6
17871 @opindex mips64r6
17872 Equivalent to @option{-march=mips64r6}.
17874 @item -mips16
17875 @itemx -mno-mips16
17876 @opindex mips16
17877 @opindex mno-mips16
17878 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17879 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17881 MIPS16 code generation can also be controlled on a per-function basis
17882 by means of @code{mips16} and @code{nomips16} attributes.
17883 @xref{Function Attributes}, for more information.
17885 @item -mflip-mips16
17886 @opindex mflip-mips16
17887 Generate MIPS16 code on alternating functions.  This option is provided
17888 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17889 not intended for ordinary use in compiling user code.
17891 @item -minterlink-compressed
17892 @item -mno-interlink-compressed
17893 @opindex minterlink-compressed
17894 @opindex mno-interlink-compressed
17895 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17896 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17898 For example, code using the standard ISA encoding cannot jump directly
17899 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17900 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17901 knows that the target of the jump is not compressed.
17903 @item -minterlink-mips16
17904 @itemx -mno-interlink-mips16
17905 @opindex minterlink-mips16
17906 @opindex mno-interlink-mips16
17907 Aliases of @option{-minterlink-compressed} and
17908 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17909 and are retained for backwards compatibility.
17911 @item -mabi=32
17912 @itemx -mabi=o64
17913 @itemx -mabi=n32
17914 @itemx -mabi=64
17915 @itemx -mabi=eabi
17916 @opindex mabi=32
17917 @opindex mabi=o64
17918 @opindex mabi=n32
17919 @opindex mabi=64
17920 @opindex mabi=eabi
17921 Generate code for the given ABI@.
17923 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17924 generates 64-bit code when you select a 64-bit architecture, but you
17925 can use @option{-mgp32} to get 32-bit code instead.
17927 For information about the O64 ABI, see
17928 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17930 GCC supports a variant of the o32 ABI in which floating-point registers
17931 are 64 rather than 32 bits wide.  You can select this combination with
17932 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17933 and @code{mfhc1} instructions and is therefore only supported for
17934 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17936 The register assignments for arguments and return values remain the
17937 same, but each scalar value is passed in a single 64-bit register
17938 rather than a pair of 32-bit registers.  For example, scalar
17939 floating-point values are returned in @samp{$f0} only, not a
17940 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17941 remains the same in that the even-numbered double-precision registers
17942 are saved.
17944 Two additional variants of the o32 ABI are supported to enable
17945 a transition from 32-bit to 64-bit registers.  These are FPXX
17946 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17947 The FPXX extension mandates that all code must execute correctly
17948 when run using 32-bit or 64-bit registers.  The code can be interlinked
17949 with either FP32 or FP64, but not both.
17950 The FP64A extension is similar to the FP64 extension but forbids the
17951 use of odd-numbered single-precision registers.  This can be used
17952 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17953 processors and allows both FP32 and FP64A code to interlink and
17954 run in the same process without changing FPU modes.
17956 @item -mabicalls
17957 @itemx -mno-abicalls
17958 @opindex mabicalls
17959 @opindex mno-abicalls
17960 Generate (do not generate) code that is suitable for SVR4-style
17961 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17962 systems.
17964 @item -mshared
17965 @itemx -mno-shared
17966 Generate (do not generate) code that is fully position-independent,
17967 and that can therefore be linked into shared libraries.  This option
17968 only affects @option{-mabicalls}.
17970 All @option{-mabicalls} code has traditionally been position-independent,
17971 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17972 as an extension, the GNU toolchain allows executables to use absolute
17973 accesses for locally-binding symbols.  It can also use shorter GP
17974 initialization sequences and generate direct calls to locally-defined
17975 functions.  This mode is selected by @option{-mno-shared}.
17977 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17978 objects that can only be linked by the GNU linker.  However, the option
17979 does not affect the ABI of the final executable; it only affects the ABI
17980 of relocatable objects.  Using @option{-mno-shared} generally makes
17981 executables both smaller and quicker.
17983 @option{-mshared} is the default.
17985 @item -mplt
17986 @itemx -mno-plt
17987 @opindex mplt
17988 @opindex mno-plt
17989 Assume (do not assume) that the static and dynamic linkers
17990 support PLTs and copy relocations.  This option only affects
17991 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17992 has no effect without @option{-msym32}.
17994 You can make @option{-mplt} the default by configuring
17995 GCC with @option{--with-mips-plt}.  The default is
17996 @option{-mno-plt} otherwise.
17998 @item -mxgot
17999 @itemx -mno-xgot
18000 @opindex mxgot
18001 @opindex mno-xgot
18002 Lift (do not lift) the usual restrictions on the size of the global
18003 offset table.
18005 GCC normally uses a single instruction to load values from the GOT@.
18006 While this is relatively efficient, it only works if the GOT
18007 is smaller than about 64k.  Anything larger causes the linker
18008 to report an error such as:
18010 @cindex relocation truncated to fit (MIPS)
18011 @smallexample
18012 relocation truncated to fit: R_MIPS_GOT16 foobar
18013 @end smallexample
18015 If this happens, you should recompile your code with @option{-mxgot}.
18016 This works with very large GOTs, although the code is also
18017 less efficient, since it takes three instructions to fetch the
18018 value of a global symbol.
18020 Note that some linkers can create multiple GOTs.  If you have such a
18021 linker, you should only need to use @option{-mxgot} when a single object
18022 file accesses more than 64k's worth of GOT entries.  Very few do.
18024 These options have no effect unless GCC is generating position
18025 independent code.
18027 @item -mgp32
18028 @opindex mgp32
18029 Assume that general-purpose registers are 32 bits wide.
18031 @item -mgp64
18032 @opindex mgp64
18033 Assume that general-purpose registers are 64 bits wide.
18035 @item -mfp32
18036 @opindex mfp32
18037 Assume that floating-point registers are 32 bits wide.
18039 @item -mfp64
18040 @opindex mfp64
18041 Assume that floating-point registers are 64 bits wide.
18043 @item -mfpxx
18044 @opindex mfpxx
18045 Do not assume the width of floating-point registers.
18047 @item -mhard-float
18048 @opindex mhard-float
18049 Use floating-point coprocessor instructions.
18051 @item -msoft-float
18052 @opindex msoft-float
18053 Do not use floating-point coprocessor instructions.  Implement
18054 floating-point calculations using library calls instead.
18056 @item -mno-float
18057 @opindex mno-float
18058 Equivalent to @option{-msoft-float}, but additionally asserts that the
18059 program being compiled does not perform any floating-point operations.
18060 This option is presently supported only by some bare-metal MIPS
18061 configurations, where it may select a special set of libraries
18062 that lack all floating-point support (including, for example, the
18063 floating-point @code{printf} formats).  
18064 If code compiled with @code{-mno-float} accidentally contains
18065 floating-point operations, it is likely to suffer a link-time
18066 or run-time failure.
18068 @item -msingle-float
18069 @opindex msingle-float
18070 Assume that the floating-point coprocessor only supports single-precision
18071 operations.
18073 @item -mdouble-float
18074 @opindex mdouble-float
18075 Assume that the floating-point coprocessor supports double-precision
18076 operations.  This is the default.
18078 @item -modd-spreg
18079 @itemx -mno-odd-spreg
18080 @opindex modd-spreg
18081 @opindex mno-odd-spreg
18082 Enable the use of odd-numbered single-precision floating-point registers
18083 for the o32 ABI.  This is the default for processors that are known to
18084 support these registers.  When using the o32 FPXX ABI, @code{-mno-odd-spreg}
18085 is set by default.
18087 @item -mabs=2008
18088 @itemx -mabs=legacy
18089 @opindex mabs=2008
18090 @opindex mabs=legacy
18091 These options control the treatment of the special not-a-number (NaN)
18092 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
18093 @code{neg.@i{fmt}} machine instructions.
18095 By default or when the @option{-mabs=legacy} is used the legacy
18096 treatment is selected.  In this case these instructions are considered
18097 arithmetic and avoided where correct operation is required and the
18098 input operand might be a NaN.  A longer sequence of instructions that
18099 manipulate the sign bit of floating-point datum manually is used
18100 instead unless the @option{-ffinite-math-only} option has also been
18101 specified.
18103 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
18104 this case these instructions are considered non-arithmetic and therefore
18105 operating correctly in all cases, including in particular where the
18106 input operand is a NaN.  These instructions are therefore always used
18107 for the respective operations.
18109 @item -mnan=2008
18110 @itemx -mnan=legacy
18111 @opindex mnan=2008
18112 @opindex mnan=legacy
18113 These options control the encoding of the special not-a-number (NaN)
18114 IEEE 754 floating-point data.
18116 The @option{-mnan=legacy} option selects the legacy encoding.  In this
18117 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
18118 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
18119 by the first bit of their trailing significand field being 1.
18121 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18122 this case qNaNs are denoted by the first bit of their trailing
18123 significand field being 1, whereas sNaNs are denoted by the first bit of
18124 their trailing significand field being 0.
18126 The default is @option{-mnan=legacy} unless GCC has been configured with
18127 @option{--with-nan=2008}.
18129 @item -mllsc
18130 @itemx -mno-llsc
18131 @opindex mllsc
18132 @opindex mno-llsc
18133 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18134 implement atomic memory built-in functions.  When neither option is
18135 specified, GCC uses the instructions if the target architecture
18136 supports them.
18138 @option{-mllsc} is useful if the runtime environment can emulate the
18139 instructions and @option{-mno-llsc} can be useful when compiling for
18140 nonstandard ISAs.  You can make either option the default by
18141 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18142 respectively.  @option{--with-llsc} is the default for some
18143 configurations; see the installation documentation for details.
18145 @item -mdsp
18146 @itemx -mno-dsp
18147 @opindex mdsp
18148 @opindex mno-dsp
18149 Use (do not use) revision 1 of the MIPS DSP ASE@.
18150 @xref{MIPS DSP Built-in Functions}.  This option defines the
18151 preprocessor macro @samp{__mips_dsp}.  It also defines
18152 @samp{__mips_dsp_rev} to 1.
18154 @item -mdspr2
18155 @itemx -mno-dspr2
18156 @opindex mdspr2
18157 @opindex mno-dspr2
18158 Use (do not use) revision 2 of the MIPS DSP ASE@.
18159 @xref{MIPS DSP Built-in Functions}.  This option defines the
18160 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
18161 It also defines @samp{__mips_dsp_rev} to 2.
18163 @item -msmartmips
18164 @itemx -mno-smartmips
18165 @opindex msmartmips
18166 @opindex mno-smartmips
18167 Use (do not use) the MIPS SmartMIPS ASE.
18169 @item -mpaired-single
18170 @itemx -mno-paired-single
18171 @opindex mpaired-single
18172 @opindex mno-paired-single
18173 Use (do not use) paired-single floating-point instructions.
18174 @xref{MIPS Paired-Single Support}.  This option requires
18175 hardware floating-point support to be enabled.
18177 @item -mdmx
18178 @itemx -mno-mdmx
18179 @opindex mdmx
18180 @opindex mno-mdmx
18181 Use (do not use) MIPS Digital Media Extension instructions.
18182 This option can only be used when generating 64-bit code and requires
18183 hardware floating-point support to be enabled.
18185 @item -mips3d
18186 @itemx -mno-mips3d
18187 @opindex mips3d
18188 @opindex mno-mips3d
18189 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18190 The option @option{-mips3d} implies @option{-mpaired-single}.
18192 @item -mmicromips
18193 @itemx -mno-micromips
18194 @opindex mmicromips
18195 @opindex mno-mmicromips
18196 Generate (do not generate) microMIPS code.
18198 MicroMIPS code generation can also be controlled on a per-function basis
18199 by means of @code{micromips} and @code{nomicromips} attributes.
18200 @xref{Function Attributes}, for more information.
18202 @item -mmt
18203 @itemx -mno-mt
18204 @opindex mmt
18205 @opindex mno-mt
18206 Use (do not use) MT Multithreading instructions.
18208 @item -mmcu
18209 @itemx -mno-mcu
18210 @opindex mmcu
18211 @opindex mno-mcu
18212 Use (do not use) the MIPS MCU ASE instructions.
18214 @item -meva
18215 @itemx -mno-eva
18216 @opindex meva
18217 @opindex mno-eva
18218 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18220 @item -mvirt
18221 @itemx -mno-virt
18222 @opindex mvirt
18223 @opindex mno-virt
18224 Use (do not use) the MIPS Virtualization Application Specific instructions.
18226 @item -mxpa
18227 @itemx -mno-xpa
18228 @opindex mxpa
18229 @opindex mno-xpa
18230 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18232 @item -mlong64
18233 @opindex mlong64
18234 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18235 an explanation of the default and the way that the pointer size is
18236 determined.
18238 @item -mlong32
18239 @opindex mlong32
18240 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18242 The default size of @code{int}s, @code{long}s and pointers depends on
18243 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18244 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18245 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18246 or the same size as integer registers, whichever is smaller.
18248 @item -msym32
18249 @itemx -mno-sym32
18250 @opindex msym32
18251 @opindex mno-sym32
18252 Assume (do not assume) that all symbols have 32-bit values, regardless
18253 of the selected ABI@.  This option is useful in combination with
18254 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18255 to generate shorter and faster references to symbolic addresses.
18257 @item -G @var{num}
18258 @opindex G
18259 Put definitions of externally-visible data in a small data section
18260 if that data is no bigger than @var{num} bytes.  GCC can then generate
18261 more efficient accesses to the data; see @option{-mgpopt} for details.
18263 The default @option{-G} option depends on the configuration.
18265 @item -mlocal-sdata
18266 @itemx -mno-local-sdata
18267 @opindex mlocal-sdata
18268 @opindex mno-local-sdata
18269 Extend (do not extend) the @option{-G} behavior to local data too,
18270 such as to static variables in C@.  @option{-mlocal-sdata} is the
18271 default for all configurations.
18273 If the linker complains that an application is using too much small data,
18274 you might want to try rebuilding the less performance-critical parts with
18275 @option{-mno-local-sdata}.  You might also want to build large
18276 libraries with @option{-mno-local-sdata}, so that the libraries leave
18277 more room for the main program.
18279 @item -mextern-sdata
18280 @itemx -mno-extern-sdata
18281 @opindex mextern-sdata
18282 @opindex mno-extern-sdata
18283 Assume (do not assume) that externally-defined data is in
18284 a small data section if the size of that data is within the @option{-G} limit.
18285 @option{-mextern-sdata} is the default for all configurations.
18287 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18288 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18289 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18290 is placed in a small data section.  If @var{Var} is defined by another
18291 module, you must either compile that module with a high-enough
18292 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18293 definition.  If @var{Var} is common, you must link the application
18294 with a high-enough @option{-G} setting.
18296 The easiest way of satisfying these restrictions is to compile
18297 and link every module with the same @option{-G} option.  However,
18298 you may wish to build a library that supports several different
18299 small data limits.  You can do this by compiling the library with
18300 the highest supported @option{-G} setting and additionally using
18301 @option{-mno-extern-sdata} to stop the library from making assumptions
18302 about externally-defined data.
18304 @item -mgpopt
18305 @itemx -mno-gpopt
18306 @opindex mgpopt
18307 @opindex mno-gpopt
18308 Use (do not use) GP-relative accesses for symbols that are known to be
18309 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18310 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18311 configurations.
18313 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18314 might not hold the value of @code{_gp}.  For example, if the code is
18315 part of a library that might be used in a boot monitor, programs that
18316 call boot monitor routines pass an unknown value in @code{$gp}.
18317 (In such situations, the boot monitor itself is usually compiled
18318 with @option{-G0}.)
18320 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18321 @option{-mno-extern-sdata}.
18323 @item -membedded-data
18324 @itemx -mno-embedded-data
18325 @opindex membedded-data
18326 @opindex mno-embedded-data
18327 Allocate variables to the read-only data section first if possible, then
18328 next in the small data section if possible, otherwise in data.  This gives
18329 slightly slower code than the default, but reduces the amount of RAM required
18330 when executing, and thus may be preferred for some embedded systems.
18332 @item -muninit-const-in-rodata
18333 @itemx -mno-uninit-const-in-rodata
18334 @opindex muninit-const-in-rodata
18335 @opindex mno-uninit-const-in-rodata
18336 Put uninitialized @code{const} variables in the read-only data section.
18337 This option is only meaningful in conjunction with @option{-membedded-data}.
18339 @item -mcode-readable=@var{setting}
18340 @opindex mcode-readable
18341 Specify whether GCC may generate code that reads from executable sections.
18342 There are three possible settings:
18344 @table @gcctabopt
18345 @item -mcode-readable=yes
18346 Instructions may freely access executable sections.  This is the
18347 default setting.
18349 @item -mcode-readable=pcrel
18350 MIPS16 PC-relative load instructions can access executable sections,
18351 but other instructions must not do so.  This option is useful on 4KSc
18352 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18353 It is also useful on processors that can be configured to have a dual
18354 instruction/data SRAM interface and that, like the M4K, automatically
18355 redirect PC-relative loads to the instruction RAM.
18357 @item -mcode-readable=no
18358 Instructions must not access executable sections.  This option can be
18359 useful on targets that are configured to have a dual instruction/data
18360 SRAM interface but that (unlike the M4K) do not automatically redirect
18361 PC-relative loads to the instruction RAM.
18362 @end table
18364 @item -msplit-addresses
18365 @itemx -mno-split-addresses
18366 @opindex msplit-addresses
18367 @opindex mno-split-addresses
18368 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18369 relocation operators.  This option has been superseded by
18370 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18372 @item -mexplicit-relocs
18373 @itemx -mno-explicit-relocs
18374 @opindex mexplicit-relocs
18375 @opindex mno-explicit-relocs
18376 Use (do not use) assembler relocation operators when dealing with symbolic
18377 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18378 is to use assembler macros instead.
18380 @option{-mexplicit-relocs} is the default if GCC was configured
18381 to use an assembler that supports relocation operators.
18383 @item -mcheck-zero-division
18384 @itemx -mno-check-zero-division
18385 @opindex mcheck-zero-division
18386 @opindex mno-check-zero-division
18387 Trap (do not trap) on integer division by zero.
18389 The default is @option{-mcheck-zero-division}.
18391 @item -mdivide-traps
18392 @itemx -mdivide-breaks
18393 @opindex mdivide-traps
18394 @opindex mdivide-breaks
18395 MIPS systems check for division by zero by generating either a
18396 conditional trap or a break instruction.  Using traps results in
18397 smaller code, but is only supported on MIPS II and later.  Also, some
18398 versions of the Linux kernel have a bug that prevents trap from
18399 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18400 allow conditional traps on architectures that support them and
18401 @option{-mdivide-breaks} to force the use of breaks.
18403 The default is usually @option{-mdivide-traps}, but this can be
18404 overridden at configure time using @option{--with-divide=breaks}.
18405 Divide-by-zero checks can be completely disabled using
18406 @option{-mno-check-zero-division}.
18408 @item -mmemcpy
18409 @itemx -mno-memcpy
18410 @opindex mmemcpy
18411 @opindex mno-memcpy
18412 Force (do not force) the use of @code{memcpy()} for non-trivial block
18413 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18414 most constant-sized copies.
18416 @item -mlong-calls
18417 @itemx -mno-long-calls
18418 @opindex mlong-calls
18419 @opindex mno-long-calls
18420 Disable (do not disable) use of the @code{jal} instruction.  Calling
18421 functions using @code{jal} is more efficient but requires the caller
18422 and callee to be in the same 256 megabyte segment.
18424 This option has no effect on abicalls code.  The default is
18425 @option{-mno-long-calls}.
18427 @item -mmad
18428 @itemx -mno-mad
18429 @opindex mmad
18430 @opindex mno-mad
18431 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18432 instructions, as provided by the R4650 ISA@.
18434 @item -mimadd
18435 @itemx -mno-imadd
18436 @opindex mimadd
18437 @opindex mno-imadd
18438 Enable (disable) use of the @code{madd} and @code{msub} integer
18439 instructions.  The default is @option{-mimadd} on architectures
18440 that support @code{madd} and @code{msub} except for the 74k 
18441 architecture where it was found to generate slower code.
18443 @item -mfused-madd
18444 @itemx -mno-fused-madd
18445 @opindex mfused-madd
18446 @opindex mno-fused-madd
18447 Enable (disable) use of the floating-point multiply-accumulate
18448 instructions, when they are available.  The default is
18449 @option{-mfused-madd}.
18451 On the R8000 CPU when multiply-accumulate instructions are used,
18452 the intermediate product is calculated to infinite precision
18453 and is not subject to the FCSR Flush to Zero bit.  This may be
18454 undesirable in some circumstances.  On other processors the result
18455 is numerically identical to the equivalent computation using
18456 separate multiply, add, subtract and negate instructions.
18458 @item -nocpp
18459 @opindex nocpp
18460 Tell the MIPS assembler to not run its preprocessor over user
18461 assembler files (with a @samp{.s} suffix) when assembling them.
18463 @item -mfix-24k
18464 @item -mno-fix-24k
18465 @opindex mfix-24k
18466 @opindex mno-fix-24k
18467 Work around the 24K E48 (lost data on stores during refill) errata.
18468 The workarounds are implemented by the assembler rather than by GCC@.
18470 @item -mfix-r4000
18471 @itemx -mno-fix-r4000
18472 @opindex mfix-r4000
18473 @opindex mno-fix-r4000
18474 Work around certain R4000 CPU errata:
18475 @itemize @minus
18476 @item
18477 A double-word or a variable shift may give an incorrect result if executed
18478 immediately after starting an integer division.
18479 @item
18480 A double-word or a variable shift may give an incorrect result if executed
18481 while an integer multiplication is in progress.
18482 @item
18483 An integer division may give an incorrect result if started in a delay slot
18484 of a taken branch or a jump.
18485 @end itemize
18487 @item -mfix-r4400
18488 @itemx -mno-fix-r4400
18489 @opindex mfix-r4400
18490 @opindex mno-fix-r4400
18491 Work around certain R4400 CPU errata:
18492 @itemize @minus
18493 @item
18494 A double-word or a variable shift may give an incorrect result if executed
18495 immediately after starting an integer division.
18496 @end itemize
18498 @item -mfix-r10000
18499 @itemx -mno-fix-r10000
18500 @opindex mfix-r10000
18501 @opindex mno-fix-r10000
18502 Work around certain R10000 errata:
18503 @itemize @minus
18504 @item
18505 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18506 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18507 @end itemize
18509 This option can only be used if the target architecture supports
18510 branch-likely instructions.  @option{-mfix-r10000} is the default when
18511 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18512 otherwise.
18514 @item -mfix-rm7000
18515 @itemx -mno-fix-rm7000
18516 @opindex mfix-rm7000
18517 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18518 workarounds are implemented by the assembler rather than by GCC@.
18520 @item -mfix-vr4120
18521 @itemx -mno-fix-vr4120
18522 @opindex mfix-vr4120
18523 Work around certain VR4120 errata:
18524 @itemize @minus
18525 @item
18526 @code{dmultu} does not always produce the correct result.
18527 @item
18528 @code{div} and @code{ddiv} do not always produce the correct result if one
18529 of the operands is negative.
18530 @end itemize
18531 The workarounds for the division errata rely on special functions in
18532 @file{libgcc.a}.  At present, these functions are only provided by
18533 the @code{mips64vr*-elf} configurations.
18535 Other VR4120 errata require a NOP to be inserted between certain pairs of
18536 instructions.  These errata are handled by the assembler, not by GCC itself.
18538 @item -mfix-vr4130
18539 @opindex mfix-vr4130
18540 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18541 workarounds are implemented by the assembler rather than by GCC,
18542 although GCC avoids using @code{mflo} and @code{mfhi} if the
18543 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18544 instructions are available instead.
18546 @item -mfix-sb1
18547 @itemx -mno-fix-sb1
18548 @opindex mfix-sb1
18549 Work around certain SB-1 CPU core errata.
18550 (This flag currently works around the SB-1 revision 2
18551 ``F1'' and ``F2'' floating-point errata.)
18553 @item -mr10k-cache-barrier=@var{setting}
18554 @opindex mr10k-cache-barrier
18555 Specify whether GCC should insert cache barriers to avoid the
18556 side-effects of speculation on R10K processors.
18558 In common with many processors, the R10K tries to predict the outcome
18559 of a conditional branch and speculatively executes instructions from
18560 the ``taken'' branch.  It later aborts these instructions if the
18561 predicted outcome is wrong.  However, on the R10K, even aborted
18562 instructions can have side effects.
18564 This problem only affects kernel stores and, depending on the system,
18565 kernel loads.  As an example, a speculatively-executed store may load
18566 the target memory into cache and mark the cache line as dirty, even if
18567 the store itself is later aborted.  If a DMA operation writes to the
18568 same area of memory before the ``dirty'' line is flushed, the cached
18569 data overwrites the DMA-ed data.  See the R10K processor manual
18570 for a full description, including other potential problems.
18572 One workaround is to insert cache barrier instructions before every memory
18573 access that might be speculatively executed and that might have side
18574 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18575 controls GCC's implementation of this workaround.  It assumes that
18576 aborted accesses to any byte in the following regions does not have
18577 side effects:
18579 @enumerate
18580 @item
18581 the memory occupied by the current function's stack frame;
18583 @item
18584 the memory occupied by an incoming stack argument;
18586 @item
18587 the memory occupied by an object with a link-time-constant address.
18588 @end enumerate
18590 It is the kernel's responsibility to ensure that speculative
18591 accesses to these regions are indeed safe.
18593 If the input program contains a function declaration such as:
18595 @smallexample
18596 void foo (void);
18597 @end smallexample
18599 then the implementation of @code{foo} must allow @code{j foo} and
18600 @code{jal foo} to be executed speculatively.  GCC honors this
18601 restriction for functions it compiles itself.  It expects non-GCC
18602 functions (such as hand-written assembly code) to do the same.
18604 The option has three forms:
18606 @table @gcctabopt
18607 @item -mr10k-cache-barrier=load-store
18608 Insert a cache barrier before a load or store that might be
18609 speculatively executed and that might have side effects even
18610 if aborted.
18612 @item -mr10k-cache-barrier=store
18613 Insert a cache barrier before a store that might be speculatively
18614 executed and that might have side effects even if aborted.
18616 @item -mr10k-cache-barrier=none
18617 Disable the insertion of cache barriers.  This is the default setting.
18618 @end table
18620 @item -mflush-func=@var{func}
18621 @itemx -mno-flush-func
18622 @opindex mflush-func
18623 Specifies the function to call to flush the I and D caches, or to not
18624 call any such function.  If called, the function must take the same
18625 arguments as the common @code{_flush_func()}, that is, the address of the
18626 memory range for which the cache is being flushed, the size of the
18627 memory range, and the number 3 (to flush both caches).  The default
18628 depends on the target GCC was configured for, but commonly is either
18629 @samp{_flush_func} or @samp{__cpu_flush}.
18631 @item mbranch-cost=@var{num}
18632 @opindex mbranch-cost
18633 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18634 This cost is only a heuristic and is not guaranteed to produce
18635 consistent results across releases.  A zero cost redundantly selects
18636 the default, which is based on the @option{-mtune} setting.
18638 @item -mbranch-likely
18639 @itemx -mno-branch-likely
18640 @opindex mbranch-likely
18641 @opindex mno-branch-likely
18642 Enable or disable use of Branch Likely instructions, regardless of the
18643 default for the selected architecture.  By default, Branch Likely
18644 instructions may be generated if they are supported by the selected
18645 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18646 and processors that implement those architectures; for those, Branch
18647 Likely instructions are not be generated by default because the MIPS32
18648 and MIPS64 architectures specifically deprecate their use.
18650 @item -mfp-exceptions
18651 @itemx -mno-fp-exceptions
18652 @opindex mfp-exceptions
18653 Specifies whether FP exceptions are enabled.  This affects how
18654 FP instructions are scheduled for some processors.
18655 The default is that FP exceptions are
18656 enabled.
18658 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18659 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18660 FP pipe.
18662 @item -mvr4130-align
18663 @itemx -mno-vr4130-align
18664 @opindex mvr4130-align
18665 The VR4130 pipeline is two-way superscalar, but can only issue two
18666 instructions together if the first one is 8-byte aligned.  When this
18667 option is enabled, GCC aligns pairs of instructions that it
18668 thinks should execute in parallel.
18670 This option only has an effect when optimizing for the VR4130.
18671 It normally makes code faster, but at the expense of making it bigger.
18672 It is enabled by default at optimization level @option{-O3}.
18674 @item -msynci
18675 @itemx -mno-synci
18676 @opindex msynci
18677 Enable (disable) generation of @code{synci} instructions on
18678 architectures that support it.  The @code{synci} instructions (if
18679 enabled) are generated when @code{__builtin___clear_cache()} is
18680 compiled.
18682 This option defaults to @code{-mno-synci}, but the default can be
18683 overridden by configuring with @code{--with-synci}.
18685 When compiling code for single processor systems, it is generally safe
18686 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18687 does not invalidate the instruction caches on all cores and may lead
18688 to undefined behavior.
18690 @item -mrelax-pic-calls
18691 @itemx -mno-relax-pic-calls
18692 @opindex mrelax-pic-calls
18693 Try to turn PIC calls that are normally dispatched via register
18694 @code{$25} into direct calls.  This is only possible if the linker can
18695 resolve the destination at link-time and if the destination is within
18696 range for a direct call.
18698 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18699 an assembler and a linker that support the @code{.reloc} assembly
18700 directive and @code{-mexplicit-relocs} is in effect.  With
18701 @code{-mno-explicit-relocs}, this optimization can be performed by the
18702 assembler and the linker alone without help from the compiler.
18704 @item -mmcount-ra-address
18705 @itemx -mno-mcount-ra-address
18706 @opindex mmcount-ra-address
18707 @opindex mno-mcount-ra-address
18708 Emit (do not emit) code that allows @code{_mcount} to modify the
18709 calling function's return address.  When enabled, this option extends
18710 the usual @code{_mcount} interface with a new @var{ra-address}
18711 parameter, which has type @code{intptr_t *} and is passed in register
18712 @code{$12}.  @code{_mcount} can then modify the return address by
18713 doing both of the following:
18714 @itemize
18715 @item
18716 Returning the new address in register @code{$31}.
18717 @item
18718 Storing the new address in @code{*@var{ra-address}},
18719 if @var{ra-address} is nonnull.
18720 @end itemize
18722 The default is @option{-mno-mcount-ra-address}.
18724 @end table
18726 @node MMIX Options
18727 @subsection MMIX Options
18728 @cindex MMIX Options
18730 These options are defined for the MMIX:
18732 @table @gcctabopt
18733 @item -mlibfuncs
18734 @itemx -mno-libfuncs
18735 @opindex mlibfuncs
18736 @opindex mno-libfuncs
18737 Specify that intrinsic library functions are being compiled, passing all
18738 values in registers, no matter the size.
18740 @item -mepsilon
18741 @itemx -mno-epsilon
18742 @opindex mepsilon
18743 @opindex mno-epsilon
18744 Generate floating-point comparison instructions that compare with respect
18745 to the @code{rE} epsilon register.
18747 @item -mabi=mmixware
18748 @itemx -mabi=gnu
18749 @opindex mabi=mmixware
18750 @opindex mabi=gnu
18751 Generate code that passes function parameters and return values that (in
18752 the called function) are seen as registers @code{$0} and up, as opposed to
18753 the GNU ABI which uses global registers @code{$231} and up.
18755 @item -mzero-extend
18756 @itemx -mno-zero-extend
18757 @opindex mzero-extend
18758 @opindex mno-zero-extend
18759 When reading data from memory in sizes shorter than 64 bits, use (do not
18760 use) zero-extending load instructions by default, rather than
18761 sign-extending ones.
18763 @item -mknuthdiv
18764 @itemx -mno-knuthdiv
18765 @opindex mknuthdiv
18766 @opindex mno-knuthdiv
18767 Make the result of a division yielding a remainder have the same sign as
18768 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18769 remainder follows the sign of the dividend.  Both methods are
18770 arithmetically valid, the latter being almost exclusively used.
18772 @item -mtoplevel-symbols
18773 @itemx -mno-toplevel-symbols
18774 @opindex mtoplevel-symbols
18775 @opindex mno-toplevel-symbols
18776 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18777 code can be used with the @code{PREFIX} assembly directive.
18779 @item -melf
18780 @opindex melf
18781 Generate an executable in the ELF format, rather than the default
18782 @samp{mmo} format used by the @command{mmix} simulator.
18784 @item -mbranch-predict
18785 @itemx -mno-branch-predict
18786 @opindex mbranch-predict
18787 @opindex mno-branch-predict
18788 Use (do not use) the probable-branch instructions, when static branch
18789 prediction indicates a probable branch.
18791 @item -mbase-addresses
18792 @itemx -mno-base-addresses
18793 @opindex mbase-addresses
18794 @opindex mno-base-addresses
18795 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18796 base address automatically generates a request (handled by the assembler
18797 and the linker) for a constant to be set up in a global register.  The
18798 register is used for one or more base address requests within the range 0
18799 to 255 from the value held in the register.  The generally leads to short
18800 and fast code, but the number of different data items that can be
18801 addressed is limited.  This means that a program that uses lots of static
18802 data may require @option{-mno-base-addresses}.
18804 @item -msingle-exit
18805 @itemx -mno-single-exit
18806 @opindex msingle-exit
18807 @opindex mno-single-exit
18808 Force (do not force) generated code to have a single exit point in each
18809 function.
18810 @end table
18812 @node MN10300 Options
18813 @subsection MN10300 Options
18814 @cindex MN10300 options
18816 These @option{-m} options are defined for Matsushita MN10300 architectures:
18818 @table @gcctabopt
18819 @item -mmult-bug
18820 @opindex mmult-bug
18821 Generate code to avoid bugs in the multiply instructions for the MN10300
18822 processors.  This is the default.
18824 @item -mno-mult-bug
18825 @opindex mno-mult-bug
18826 Do not generate code to avoid bugs in the multiply instructions for the
18827 MN10300 processors.
18829 @item -mam33
18830 @opindex mam33
18831 Generate code using features specific to the AM33 processor.
18833 @item -mno-am33
18834 @opindex mno-am33
18835 Do not generate code using features specific to the AM33 processor.  This
18836 is the default.
18838 @item -mam33-2
18839 @opindex mam33-2
18840 Generate code using features specific to the AM33/2.0 processor.
18842 @item -mam34
18843 @opindex mam34
18844 Generate code using features specific to the AM34 processor.
18846 @item -mtune=@var{cpu-type}
18847 @opindex mtune
18848 Use the timing characteristics of the indicated CPU type when
18849 scheduling instructions.  This does not change the targeted processor
18850 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18851 @samp{am33-2} or @samp{am34}.
18853 @item -mreturn-pointer-on-d0
18854 @opindex mreturn-pointer-on-d0
18855 When generating a function that returns a pointer, return the pointer
18856 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18857 only in @code{a0}, and attempts to call such functions without a prototype
18858 result in errors.  Note that this option is on by default; use
18859 @option{-mno-return-pointer-on-d0} to disable it.
18861 @item -mno-crt0
18862 @opindex mno-crt0
18863 Do not link in the C run-time initialization object file.
18865 @item -mrelax
18866 @opindex mrelax
18867 Indicate to the linker that it should perform a relaxation optimization pass
18868 to shorten branches, calls and absolute memory addresses.  This option only
18869 has an effect when used on the command line for the final link step.
18871 This option makes symbolic debugging impossible.
18873 @item -mliw
18874 @opindex mliw
18875 Allow the compiler to generate @emph{Long Instruction Word}
18876 instructions if the target is the @samp{AM33} or later.  This is the
18877 default.  This option defines the preprocessor macro @samp{__LIW__}.
18879 @item -mnoliw
18880 @opindex mnoliw
18881 Do not allow the compiler to generate @emph{Long Instruction Word}
18882 instructions.  This option defines the preprocessor macro
18883 @samp{__NO_LIW__}.
18885 @item -msetlb
18886 @opindex msetlb
18887 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18888 instructions if the target is the @samp{AM33} or later.  This is the
18889 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18891 @item -mnosetlb
18892 @opindex mnosetlb
18893 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18894 instructions.  This option defines the preprocessor macro
18895 @samp{__NO_SETLB__}.
18897 @end table
18899 @node Moxie Options
18900 @subsection Moxie Options
18901 @cindex Moxie Options
18903 @table @gcctabopt
18905 @item -meb
18906 @opindex meb
18907 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18908 configurations.
18910 @item -mel
18911 @opindex mel
18912 Generate little-endian code.
18914 @item -mmul.x
18915 @opindex mmul.x
18916 Generate mul.x and umul.x instructions.  This is the default for
18917 @samp{moxiebox-*-*} configurations.
18919 @item -mno-crt0
18920 @opindex mno-crt0
18921 Do not link in the C run-time initialization object file.
18923 @end table
18925 @node MSP430 Options
18926 @subsection MSP430 Options
18927 @cindex MSP430 Options
18929 These options are defined for the MSP430:
18931 @table @gcctabopt
18933 @item -masm-hex
18934 @opindex masm-hex
18935 Force assembly output to always use hex constants.  Normally such
18936 constants are signed decimals, but this option is available for
18937 testsuite and/or aesthetic purposes.
18939 @item -mmcu=
18940 @opindex mmcu=
18941 Select the MCU to target.  This is used to create a C preprocessor
18942 symbol based upon the MCU name, converted to upper case and pre- and
18943 post- fixed with @code{__}.  This in turn will be used by the
18944 @code{msp430.h} header file to select an MCU specific supplimentary
18945 header file.
18947 The option also sets the ISA to use.  If the MCU name is one that is
18948 known to only support the 430 ISA then that is selected, otherwise the
18949 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18950 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18951 name will select the 430X ISA.
18953 In addition an MCU specific linker script will be added to the linker
18954 command line.  The script's name is the name of the MCU with
18955 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18956 command line will define the C preprocessor symbol @code{__XXX__} and
18957 cause the linker to search for a script called @file{xxx.ld}.
18959 This option is also passed on to the assembler.
18961 @item -mcpu=
18962 @opindex mcpu=
18963 Specifies the ISA to use.  Accepted values are @code{msp430},
18964 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18965 @option{-mmcu=} option should be used to select the ISA.
18967 @item -msim
18968 @opindex msim
18969 Link to the simulator runtime libraries and linker script.  Overrides
18970 any scripts that would be selected by the @option{-mmcu=} option.
18972 @item -mlarge
18973 @opindex mlarge
18974 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18976 @item -msmall
18977 @opindex msmall
18978 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18980 @item -mrelax
18981 @opindex mrelax
18982 This option is passed to the assembler and linker, and allows the
18983 linker to perform certain optimizations that cannot be done until
18984 the final link.
18986 @item mhwmult=
18987 @opindex mhwmult=
18988 Describes the type of hardware multiply supported by the target.
18989 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18990 for the original 16-bit-only multiply supported by early MCUs.
18991 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18992 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18993 A value of @code{auto} can also be given.  This tells GCC to deduce
18994 the hardware multiply support based upon the MCU name provided by the
18995 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18996 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18997 default setting.
18999 Hardware multiplies are normally performed by calling a library
19000 routine.  This saves space in the generated code.  When compiling at
19001 @code{-O3} or higher however the hardware multiplier is invoked
19002 inline.  This makes for bigger, but faster code.
19004 The hardware multiply routines disable interrupts whilst running and
19005 restore the previous interrupt state when they finish.  This makes
19006 them safe to use inside interrupt handlers as well as in normal code.
19008 @item -minrt
19009 @opindex minrt
19010 Enable the use of a minimum runtime environment - no static
19011 initializers or constructors.  This is intended for memory-constrained
19012 devices.  The compiler will include special symbols in some objects
19013 that tell the linker and runtime which code fragments are required.
19015 @end table
19017 @node NDS32 Options
19018 @subsection NDS32 Options
19019 @cindex NDS32 Options
19021 These options are defined for NDS32 implementations:
19023 @table @gcctabopt
19025 @item -mbig-endian
19026 @opindex mbig-endian
19027 Generate code in big-endian mode.
19029 @item -mlittle-endian
19030 @opindex mlittle-endian
19031 Generate code in little-endian mode.
19033 @item -mreduced-regs
19034 @opindex mreduced-regs
19035 Use reduced-set registers for register allocation.
19037 @item -mfull-regs
19038 @opindex mfull-regs
19039 Use full-set registers for register allocation.
19041 @item -mcmov
19042 @opindex mcmov
19043 Generate conditional move instructions.
19045 @item -mno-cmov
19046 @opindex mno-cmov
19047 Do not generate conditional move instructions.
19049 @item -mperf-ext
19050 @opindex mperf-ext
19051 Generate performance extension instructions.
19053 @item -mno-perf-ext
19054 @opindex mno-perf-ext
19055 Do not generate performance extension instructions.
19057 @item -mv3push
19058 @opindex mv3push
19059 Generate v3 push25/pop25 instructions.
19061 @item -mno-v3push
19062 @opindex mno-v3push
19063 Do not generate v3 push25/pop25 instructions.
19065 @item -m16-bit
19066 @opindex m16-bit
19067 Generate 16-bit instructions.
19069 @item -mno-16-bit
19070 @opindex mno-16-bit
19071 Do not generate 16-bit instructions.
19073 @item -mgp-direct
19074 @opindex mgp-direct
19075 Generate GP base instructions directly.
19077 @item -mno-gp-direct
19078 @opindex mno-gp-direct
19079 Do no generate GP base instructions directly.
19081 @item -misr-vector-size=@var{num}
19082 @opindex misr-vector-size
19083 Specify the size of each interrupt vector, which must be 4 or 16.
19085 @item -mcache-block-size=@var{num}
19086 @opindex mcache-block-size
19087 Specify the size of each cache block,
19088 which must be a power of 2 between 4 and 512.
19090 @item -march=@var{arch}
19091 @opindex march
19092 Specify the name of the target architecture.
19094 @item -mforce-fp-as-gp
19095 @opindex mforce-fp-as-gp
19096 Prevent $fp being allocated during register allocation so that compiler
19097 is able to force performing fp-as-gp optimization.
19099 @item -mforbid-fp-as-gp
19100 @opindex mforbid-fp-as-gp
19101 Forbid using $fp to access static and global variables.
19102 This option strictly forbids fp-as-gp optimization
19103 regardless of @option{-mforce-fp-as-gp}.
19105 @item -mex9
19106 @opindex mex9
19107 Use special directives to guide linker doing ex9 optimization.
19109 @item -mctor-dtor
19110 @opindex mctor-dtor
19111 Enable constructor/destructor feature.
19113 @item -mrelax
19114 @opindex mrelax
19115 Guide linker to relax instructions.
19117 @end table
19119 @node Nios II Options
19120 @subsection Nios II Options
19121 @cindex Nios II options
19122 @cindex Altera Nios II options
19124 These are the options defined for the Altera Nios II processor.
19126 @table @gcctabopt
19128 @item -G @var{num}
19129 @opindex G
19130 @cindex smaller data references
19131 Put global and static objects less than or equal to @var{num} bytes
19132 into the small data or BSS sections instead of the normal data or BSS
19133 sections.  The default value of @var{num} is 8.
19135 @item -mgpopt
19136 @itemx -mno-gpopt
19137 @opindex mgpopt
19138 @opindex mno-gpopt
19139 Generate (do not generate) GP-relative accesses for objects in the
19140 small data or BSS sections.  The default is @option{-mgpopt} except
19141 when @option{-fpic} or @option{-fPIC} is specified to generate
19142 position-independent code.  Note that the Nios II ABI does not permit
19143 GP-relative accesses from shared libraries.
19145 You may need to specify @option{-mno-gpopt} explicitly when building
19146 programs that include large amounts of small data, including large
19147 GOT data sections.  In this case, the 16-bit offset for GP-relative
19148 addressing may not be large enough to allow access to the entire 
19149 small data section.
19151 @item -mel
19152 @itemx -meb
19153 @opindex mel
19154 @opindex meb
19155 Generate little-endian (default) or big-endian (experimental) code,
19156 respectively.
19158 @item -mbypass-cache
19159 @itemx -mno-bypass-cache
19160 @opindex mno-bypass-cache
19161 @opindex mbypass-cache
19162 Force all load and store instructions to always bypass cache by 
19163 using I/O variants of the instructions. The default is not to
19164 bypass the cache.
19166 @item -mno-cache-volatile 
19167 @itemx -mcache-volatile       
19168 @opindex mcache-volatile 
19169 @opindex mno-cache-volatile
19170 Volatile memory access bypass the cache using the I/O variants of 
19171 the load and store instructions. The default is not to bypass the cache.
19173 @item -mno-fast-sw-div
19174 @itemx -mfast-sw-div
19175 @opindex mno-fast-sw-div
19176 @opindex mfast-sw-div
19177 Do not use table-based fast divide for small numbers. The default 
19178 is to use the fast divide at @option{-O3} and above.
19180 @item -mno-hw-mul
19181 @itemx -mhw-mul
19182 @itemx -mno-hw-mulx
19183 @itemx -mhw-mulx
19184 @itemx -mno-hw-div
19185 @itemx -mhw-div
19186 @opindex mno-hw-mul
19187 @opindex mhw-mul
19188 @opindex mno-hw-mulx
19189 @opindex mhw-mulx
19190 @opindex mno-hw-div
19191 @opindex mhw-div
19192 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19193 instructions by the compiler. The default is to emit @code{mul}
19194 and not emit @code{div} and @code{mulx}.
19196 @item -mcustom-@var{insn}=@var{N}
19197 @itemx -mno-custom-@var{insn}
19198 @opindex mcustom-@var{insn}
19199 @opindex mno-custom-@var{insn}
19200 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19201 custom instruction with encoding @var{N} when generating code that uses 
19202 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
19203 instruction 253 for single-precision floating-point add operations instead
19204 of the default behavior of using a library call.
19206 The following values of @var{insn} are supported.  Except as otherwise
19207 noted, floating-point operations are expected to be implemented with
19208 normal IEEE 754 semantics and correspond directly to the C operators or the
19209 equivalent GCC built-in functions (@pxref{Other Builtins}).
19211 Single-precision floating point:
19212 @table @asis
19214 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19215 Binary arithmetic operations.
19217 @item @samp{fnegs}
19218 Unary negation.
19220 @item @samp{fabss}
19221 Unary absolute value.
19223 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19224 Comparison operations.
19226 @item @samp{fmins}, @samp{fmaxs}
19227 Floating-point minimum and maximum.  These instructions are only
19228 generated if @option{-ffinite-math-only} is specified.
19230 @item @samp{fsqrts}
19231 Unary square root operation.
19233 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19234 Floating-point trigonometric and exponential functions.  These instructions
19235 are only generated if @option{-funsafe-math-optimizations} is also specified.
19237 @end table
19239 Double-precision floating point:
19240 @table @asis
19242 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19243 Binary arithmetic operations.
19245 @item @samp{fnegd}
19246 Unary negation.
19248 @item @samp{fabsd}
19249 Unary absolute value.
19251 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19252 Comparison operations.
19254 @item @samp{fmind}, @samp{fmaxd}
19255 Double-precision minimum and maximum.  These instructions are only
19256 generated if @option{-ffinite-math-only} is specified.
19258 @item @samp{fsqrtd}
19259 Unary square root operation.
19261 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19262 Double-precision trigonometric and exponential functions.  These instructions
19263 are only generated if @option{-funsafe-math-optimizations} is also specified.
19265 @end table
19267 Conversions:
19268 @table @asis
19269 @item @samp{fextsd}
19270 Conversion from single precision to double precision.
19272 @item @samp{ftruncds}
19273 Conversion from double precision to single precision.
19275 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19276 Conversion from floating point to signed or unsigned integer types, with
19277 truncation towards zero.
19279 @item @samp{round}
19280 Conversion from single-precision floating point to signed integer,
19281 rounding to the nearest integer and ties away from zero.
19282 This corresponds to the @code{__builtin_lroundf} function when
19283 @option{-fno-math-errno} is used.
19285 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19286 Conversion from signed or unsigned integer types to floating-point types.
19288 @end table
19290 In addition, all of the following transfer instructions for internal
19291 registers X and Y must be provided to use any of the double-precision
19292 floating-point instructions.  Custom instructions taking two
19293 double-precision source operands expect the first operand in the
19294 64-bit register X.  The other operand (or only operand of a unary
19295 operation) is given to the custom arithmetic instruction with the
19296 least significant half in source register @var{src1} and the most
19297 significant half in @var{src2}.  A custom instruction that returns a
19298 double-precision result returns the most significant 32 bits in the
19299 destination register and the other half in 32-bit register Y.  
19300 GCC automatically generates the necessary code sequences to write
19301 register X and/or read register Y when double-precision floating-point
19302 instructions are used.
19304 @table @asis
19306 @item @samp{fwrx}
19307 Write @var{src1} into the least significant half of X and @var{src2} into
19308 the most significant half of X.
19310 @item @samp{fwry}
19311 Write @var{src1} into Y.
19313 @item @samp{frdxhi}, @samp{frdxlo}
19314 Read the most or least (respectively) significant half of X and store it in
19315 @var{dest}.
19317 @item @samp{frdy}
19318 Read the value of Y and store it into @var{dest}.
19319 @end table
19321 Note that you can gain more local control over generation of Nios II custom
19322 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19323 and @code{target("no-custom-@var{insn}")} function attributes
19324 (@pxref{Function Attributes})
19325 or pragmas (@pxref{Function Specific Option Pragmas}).
19327 @item -mcustom-fpu-cfg=@var{name}
19328 @opindex mcustom-fpu-cfg
19330 This option enables a predefined, named set of custom instruction encodings
19331 (see @option{-mcustom-@var{insn}} above).  
19332 Currently, the following sets are defined:
19334 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19335 @gccoptlist{-mcustom-fmuls=252 @gol
19336 -mcustom-fadds=253 @gol
19337 -mcustom-fsubs=254 @gol
19338 -fsingle-precision-constant}
19340 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19341 @gccoptlist{-mcustom-fmuls=252 @gol
19342 -mcustom-fadds=253 @gol
19343 -mcustom-fsubs=254 @gol
19344 -mcustom-fdivs=255 @gol
19345 -fsingle-precision-constant}
19347 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19348 @gccoptlist{-mcustom-floatus=243 @gol
19349 -mcustom-fixsi=244 @gol
19350 -mcustom-floatis=245 @gol
19351 -mcustom-fcmpgts=246 @gol
19352 -mcustom-fcmples=249 @gol
19353 -mcustom-fcmpeqs=250 @gol
19354 -mcustom-fcmpnes=251 @gol
19355 -mcustom-fmuls=252 @gol
19356 -mcustom-fadds=253 @gol
19357 -mcustom-fsubs=254 @gol
19358 -mcustom-fdivs=255 @gol
19359 -fsingle-precision-constant}
19361 Custom instruction assignments given by individual
19362 @option{-mcustom-@var{insn}=} options override those given by
19363 @option{-mcustom-fpu-cfg=}, regardless of the
19364 order of the options on the command line.
19366 Note that you can gain more local control over selection of a FPU
19367 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19368 function attribute (@pxref{Function Attributes})
19369 or pragma (@pxref{Function Specific Option Pragmas}).
19371 @end table
19373 These additional @samp{-m} options are available for the Altera Nios II
19374 ELF (bare-metal) target:
19376 @table @gcctabopt
19378 @item -mhal
19379 @opindex mhal
19380 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19381 startup and termination code, and is typically used in conjunction with
19382 @option{-msys-crt0=} to specify the location of the alternate startup code
19383 provided by the HAL BSP.
19385 @item -msmallc
19386 @opindex msmallc
19387 Link with a limited version of the C library, @option{-lsmallc}, rather than
19388 Newlib.
19390 @item -msys-crt0=@var{startfile}
19391 @opindex msys-crt0
19392 @var{startfile} is the file name of the startfile (crt0) to use 
19393 when linking.  This option is only useful in conjunction with @option{-mhal}.
19395 @item -msys-lib=@var{systemlib}
19396 @opindex msys-lib
19397 @var{systemlib} is the library name of the library that provides
19398 low-level system calls required by the C library,
19399 e.g. @code{read} and @code{write}.
19400 This option is typically used to link with a library provided by a HAL BSP.
19402 @end table
19404 @node PDP-11 Options
19405 @subsection PDP-11 Options
19406 @cindex PDP-11 Options
19408 These options are defined for the PDP-11:
19410 @table @gcctabopt
19411 @item -mfpu
19412 @opindex mfpu
19413 Use hardware FPP floating point.  This is the default.  (FIS floating
19414 point on the PDP-11/40 is not supported.)
19416 @item -msoft-float
19417 @opindex msoft-float
19418 Do not use hardware floating point.
19420 @item -mac0
19421 @opindex mac0
19422 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19424 @item -mno-ac0
19425 @opindex mno-ac0
19426 Return floating-point results in memory.  This is the default.
19428 @item -m40
19429 @opindex m40
19430 Generate code for a PDP-11/40.
19432 @item -m45
19433 @opindex m45
19434 Generate code for a PDP-11/45.  This is the default.
19436 @item -m10
19437 @opindex m10
19438 Generate code for a PDP-11/10.
19440 @item -mbcopy-builtin
19441 @opindex mbcopy-builtin
19442 Use inline @code{movmemhi} patterns for copying memory.  This is the
19443 default.
19445 @item -mbcopy
19446 @opindex mbcopy
19447 Do not use inline @code{movmemhi} patterns for copying memory.
19449 @item -mint16
19450 @itemx -mno-int32
19451 @opindex mint16
19452 @opindex mno-int32
19453 Use 16-bit @code{int}.  This is the default.
19455 @item -mint32
19456 @itemx -mno-int16
19457 @opindex mint32
19458 @opindex mno-int16
19459 Use 32-bit @code{int}.
19461 @item -mfloat64
19462 @itemx -mno-float32
19463 @opindex mfloat64
19464 @opindex mno-float32
19465 Use 64-bit @code{float}.  This is the default.
19467 @item -mfloat32
19468 @itemx -mno-float64
19469 @opindex mfloat32
19470 @opindex mno-float64
19471 Use 32-bit @code{float}.
19473 @item -mabshi
19474 @opindex mabshi
19475 Use @code{abshi2} pattern.  This is the default.
19477 @item -mno-abshi
19478 @opindex mno-abshi
19479 Do not use @code{abshi2} pattern.
19481 @item -mbranch-expensive
19482 @opindex mbranch-expensive
19483 Pretend that branches are expensive.  This is for experimenting with
19484 code generation only.
19486 @item -mbranch-cheap
19487 @opindex mbranch-cheap
19488 Do not pretend that branches are expensive.  This is the default.
19490 @item -munix-asm
19491 @opindex munix-asm
19492 Use Unix assembler syntax.  This is the default when configured for
19493 @samp{pdp11-*-bsd}.
19495 @item -mdec-asm
19496 @opindex mdec-asm
19497 Use DEC assembler syntax.  This is the default when configured for any
19498 PDP-11 target other than @samp{pdp11-*-bsd}.
19499 @end table
19501 @node picoChip Options
19502 @subsection picoChip Options
19503 @cindex picoChip options
19505 These @samp{-m} options are defined for picoChip implementations:
19507 @table @gcctabopt
19509 @item -mae=@var{ae_type}
19510 @opindex mcpu
19511 Set the instruction set, register set, and instruction scheduling
19512 parameters for array element type @var{ae_type}.  Supported values
19513 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19515 @option{-mae=ANY} selects a completely generic AE type.  Code
19516 generated with this option runs on any of the other AE types.  The
19517 code is not as efficient as it would be if compiled for a specific
19518 AE type, and some types of operation (e.g., multiplication) do not
19519 work properly on all types of AE.
19521 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19522 for compiled code, and is the default.
19524 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19525 option may suffer from poor performance of byte (char) manipulation,
19526 since the DSP AE does not provide hardware support for byte load/stores.
19528 @item -msymbol-as-address
19529 Enable the compiler to directly use a symbol name as an address in a
19530 load/store instruction, without first loading it into a
19531 register.  Typically, the use of this option generates larger
19532 programs, which run faster than when the option isn't used.  However, the
19533 results vary from program to program, so it is left as a user option,
19534 rather than being permanently enabled.
19536 @item -mno-inefficient-warnings
19537 Disables warnings about the generation of inefficient code.  These
19538 warnings can be generated, for example, when compiling code that
19539 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19540 no hardware support for byte-level memory operations, so all byte
19541 load/stores must be synthesized from word load/store operations.  This is
19542 inefficient and a warning is generated to indicate
19543 that you should rewrite the code to avoid byte operations, or to target
19544 an AE type that has the necessary hardware support.  This option disables
19545 these warnings.
19547 @end table
19549 @node PowerPC Options
19550 @subsection PowerPC Options
19551 @cindex PowerPC options
19553 These are listed under @xref{RS/6000 and PowerPC Options}.
19555 @node RL78 Options
19556 @subsection RL78 Options
19557 @cindex RL78 Options
19559 @table @gcctabopt
19561 @item -msim
19562 @opindex msim
19563 Links in additional target libraries to support operation within a
19564 simulator.
19566 @item -mmul=none
19567 @itemx -mmul=g13
19568 @itemx -mmul=rl78
19569 @opindex mmul
19570 Specifies the type of hardware multiplication support to be used.  The
19571 default is @code{none}, which uses software multiplication functions.
19572 The @code{g13} option is for the hardware multiply/divide peripheral
19573 only on the RL78/G13 targets.  The @code{rl78} option is for the
19574 standard hardware multiplication defined in the RL78 software manual.
19576 @item -m64bit-doubles
19577 @itemx -m32bit-doubles
19578 @opindex m64bit-doubles
19579 @opindex m32bit-doubles
19580 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19581 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19582 @option{-m32bit-doubles}.
19584 @end table
19586 @node RS/6000 and PowerPC Options
19587 @subsection IBM RS/6000 and PowerPC Options
19588 @cindex RS/6000 and PowerPC Options
19589 @cindex IBM RS/6000 and PowerPC Options
19591 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19592 @table @gcctabopt
19593 @item -mpowerpc-gpopt
19594 @itemx -mno-powerpc-gpopt
19595 @itemx -mpowerpc-gfxopt
19596 @itemx -mno-powerpc-gfxopt
19597 @need 800
19598 @itemx -mpowerpc64
19599 @itemx -mno-powerpc64
19600 @itemx -mmfcrf
19601 @itemx -mno-mfcrf
19602 @itemx -mpopcntb
19603 @itemx -mno-popcntb
19604 @itemx -mpopcntd
19605 @itemx -mno-popcntd
19606 @itemx -mfprnd
19607 @itemx -mno-fprnd
19608 @need 800
19609 @itemx -mcmpb
19610 @itemx -mno-cmpb
19611 @itemx -mmfpgpr
19612 @itemx -mno-mfpgpr
19613 @itemx -mhard-dfp
19614 @itemx -mno-hard-dfp
19615 @opindex mpowerpc-gpopt
19616 @opindex mno-powerpc-gpopt
19617 @opindex mpowerpc-gfxopt
19618 @opindex mno-powerpc-gfxopt
19619 @opindex mpowerpc64
19620 @opindex mno-powerpc64
19621 @opindex mmfcrf
19622 @opindex mno-mfcrf
19623 @opindex mpopcntb
19624 @opindex mno-popcntb
19625 @opindex mpopcntd
19626 @opindex mno-popcntd
19627 @opindex mfprnd
19628 @opindex mno-fprnd
19629 @opindex mcmpb
19630 @opindex mno-cmpb
19631 @opindex mmfpgpr
19632 @opindex mno-mfpgpr
19633 @opindex mhard-dfp
19634 @opindex mno-hard-dfp
19635 You use these options to specify which instructions are available on the
19636 processor you are using.  The default value of these options is
19637 determined when configuring GCC@.  Specifying the
19638 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19639 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19640 rather than the options listed above.
19642 Specifying @option{-mpowerpc-gpopt} allows
19643 GCC to use the optional PowerPC architecture instructions in the
19644 General Purpose group, including floating-point square root.  Specifying
19645 @option{-mpowerpc-gfxopt} allows GCC to
19646 use the optional PowerPC architecture instructions in the Graphics
19647 group, including floating-point select.
19649 The @option{-mmfcrf} option allows GCC to generate the move from
19650 condition register field instruction implemented on the POWER4
19651 processor and other processors that support the PowerPC V2.01
19652 architecture.
19653 The @option{-mpopcntb} option allows GCC to generate the popcount and
19654 double-precision FP reciprocal estimate instruction implemented on the
19655 POWER5 processor and other processors that support the PowerPC V2.02
19656 architecture.
19657 The @option{-mpopcntd} option allows GCC to generate the popcount
19658 instruction implemented on the POWER7 processor and other processors
19659 that support the PowerPC V2.06 architecture.
19660 The @option{-mfprnd} option allows GCC to generate the FP round to
19661 integer instructions implemented on the POWER5+ processor and other
19662 processors that support the PowerPC V2.03 architecture.
19663 The @option{-mcmpb} option allows GCC to generate the compare bytes
19664 instruction implemented on the POWER6 processor and other processors
19665 that support the PowerPC V2.05 architecture.
19666 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19667 general-purpose register instructions implemented on the POWER6X
19668 processor and other processors that support the extended PowerPC V2.05
19669 architecture.
19670 The @option{-mhard-dfp} option allows GCC to generate the decimal
19671 floating-point instructions implemented on some POWER processors.
19673 The @option{-mpowerpc64} option allows GCC to generate the additional
19674 64-bit instructions that are found in the full PowerPC64 architecture
19675 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19676 @option{-mno-powerpc64}.
19678 @item -mcpu=@var{cpu_type}
19679 @opindex mcpu
19680 Set architecture type, register usage, and
19681 instruction scheduling parameters for machine type @var{cpu_type}.
19682 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19683 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19684 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19685 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19686 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19687 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19688 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19689 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19690 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19691 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19692 @samp{powerpc64}, and @samp{rs64}.
19694 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19695 PowerPC and 64-bit PowerPC architecture machine
19696 types, with an appropriate, generic processor model assumed for
19697 scheduling purposes.
19699 The other options specify a specific processor.  Code generated under
19700 those options runs best on that processor, and may not run at all on
19701 others.
19703 The @option{-mcpu} options automatically enable or disable the
19704 following options:
19706 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19707 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19708 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19709 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19710 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19711 -mquad-memory -mquad-memory-atomic}
19713 The particular options set for any particular CPU varies between
19714 compiler versions, depending on what setting seems to produce optimal
19715 code for that CPU; it doesn't necessarily reflect the actual hardware's
19716 capabilities.  If you wish to set an individual option to a particular
19717 value, you may specify it after the @option{-mcpu} option, like
19718 @option{-mcpu=970 -mno-altivec}.
19720 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19721 not enabled or disabled by the @option{-mcpu} option at present because
19722 AIX does not have full support for these options.  You may still
19723 enable or disable them individually if you're sure it'll work in your
19724 environment.
19726 @item -mtune=@var{cpu_type}
19727 @opindex mtune
19728 Set the instruction scheduling parameters for machine type
19729 @var{cpu_type}, but do not set the architecture type or register usage,
19730 as @option{-mcpu=@var{cpu_type}} does.  The same
19731 values for @var{cpu_type} are used for @option{-mtune} as for
19732 @option{-mcpu}.  If both are specified, the code generated uses the
19733 architecture and registers set by @option{-mcpu}, but the
19734 scheduling parameters set by @option{-mtune}.
19736 @item -mcmodel=small
19737 @opindex mcmodel=small
19738 Generate PowerPC64 code for the small model: The TOC is limited to
19739 64k.
19741 @item -mcmodel=medium
19742 @opindex mcmodel=medium
19743 Generate PowerPC64 code for the medium model: The TOC and other static
19744 data may be up to a total of 4G in size.
19746 @item -mcmodel=large
19747 @opindex mcmodel=large
19748 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19749 in size.  Other data and code is only limited by the 64-bit address
19750 space.
19752 @item -maltivec
19753 @itemx -mno-altivec
19754 @opindex maltivec
19755 @opindex mno-altivec
19756 Generate code that uses (does not use) AltiVec instructions, and also
19757 enable the use of built-in functions that allow more direct access to
19758 the AltiVec instruction set.  You may also need to set
19759 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19760 enhancements.
19762 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19763 @option{-maltivec=be}, the element order for Altivec intrinsics such
19764 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19765 match array element order corresponding to the endianness of the
19766 target.  That is, element zero identifies the leftmost element in a
19767 vector register when targeting a big-endian platform, and identifies
19768 the rightmost element in a vector register when targeting a
19769 little-endian platform.
19771 @item -maltivec=be
19772 @opindex maltivec=be
19773 Generate Altivec instructions using big-endian element order,
19774 regardless of whether the target is big- or little-endian.  This is
19775 the default when targeting a big-endian platform.
19777 The element order is used to interpret element numbers in Altivec
19778 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19779 @code{vec_insert}.  By default, these will match array element order
19780 corresponding to the endianness for the target.
19782 @item -maltivec=le
19783 @opindex maltivec=le
19784 Generate Altivec instructions using little-endian element order,
19785 regardless of whether the target is big- or little-endian.  This is
19786 the default when targeting a little-endian platform.  This option is
19787 currently ignored when targeting a big-endian platform.
19789 The element order is used to interpret element numbers in Altivec
19790 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19791 @code{vec_insert}.  By default, these will match array element order
19792 corresponding to the endianness for the target.
19794 @item -mvrsave
19795 @itemx -mno-vrsave
19796 @opindex mvrsave
19797 @opindex mno-vrsave
19798 Generate VRSAVE instructions when generating AltiVec code.
19800 @item -mgen-cell-microcode
19801 @opindex mgen-cell-microcode
19802 Generate Cell microcode instructions.
19804 @item -mwarn-cell-microcode
19805 @opindex mwarn-cell-microcode
19806 Warn when a Cell microcode instruction is emitted.  An example
19807 of a Cell microcode instruction is a variable shift.
19809 @item -msecure-plt
19810 @opindex msecure-plt
19811 Generate code that allows @command{ld} and @command{ld.so}
19812 to build executables and shared
19813 libraries with non-executable @code{.plt} and @code{.got} sections.
19814 This is a PowerPC
19815 32-bit SYSV ABI option.
19817 @item -mbss-plt
19818 @opindex mbss-plt
19819 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19820 fills in, and
19821 requires @code{.plt} and @code{.got}
19822 sections that are both writable and executable.
19823 This is a PowerPC 32-bit SYSV ABI option.
19825 @item -misel
19826 @itemx -mno-isel
19827 @opindex misel
19828 @opindex mno-isel
19829 This switch enables or disables the generation of ISEL instructions.
19831 @item -misel=@var{yes/no}
19832 This switch has been deprecated.  Use @option{-misel} and
19833 @option{-mno-isel} instead.
19835 @item -mspe
19836 @itemx -mno-spe
19837 @opindex mspe
19838 @opindex mno-spe
19839 This switch enables or disables the generation of SPE simd
19840 instructions.
19842 @item -mpaired
19843 @itemx -mno-paired
19844 @opindex mpaired
19845 @opindex mno-paired
19846 This switch enables or disables the generation of PAIRED simd
19847 instructions.
19849 @item -mspe=@var{yes/no}
19850 This option has been deprecated.  Use @option{-mspe} and
19851 @option{-mno-spe} instead.
19853 @item -mvsx
19854 @itemx -mno-vsx
19855 @opindex mvsx
19856 @opindex mno-vsx
19857 Generate code that uses (does not use) vector/scalar (VSX)
19858 instructions, and also enable the use of built-in functions that allow
19859 more direct access to the VSX instruction set.
19861 @item -mcrypto
19862 @itemx -mno-crypto
19863 @opindex mcrypto
19864 @opindex mno-crypto
19865 Enable the use (disable) of the built-in functions that allow direct
19866 access to the cryptographic instructions that were added in version
19867 2.07 of the PowerPC ISA.
19869 @item -mdirect-move
19870 @itemx -mno-direct-move
19871 @opindex mdirect-move
19872 @opindex mno-direct-move
19873 Generate code that uses (does not use) the instructions to move data
19874 between the general purpose registers and the vector/scalar (VSX)
19875 registers that were added in version 2.07 of the PowerPC ISA.
19877 @item -mpower8-fusion
19878 @itemx -mno-power8-fusion
19879 @opindex mpower8-fusion
19880 @opindex mno-power8-fusion
19881 Generate code that keeps (does not keeps) some integer operations
19882 adjacent so that the instructions can be fused together on power8 and
19883 later processors.
19885 @item -mpower8-vector
19886 @itemx -mno-power8-vector
19887 @opindex mpower8-vector
19888 @opindex mno-power8-vector
19889 Generate code that uses (does not use) the vector and scalar
19890 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19891 enable the use of built-in functions that allow more direct access to
19892 the vector instructions.
19894 @item -mquad-memory
19895 @itemx -mno-quad-memory
19896 @opindex mquad-memory
19897 @opindex mno-quad-memory
19898 Generate code that uses (does not use) the non-atomic quad word memory
19899 instructions.  The @option{-mquad-memory} option requires use of
19900 64-bit mode.
19902 @item -mquad-memory-atomic
19903 @itemx -mno-quad-memory-atomic
19904 @opindex mquad-memory-atomic
19905 @opindex mno-quad-memory-atomic
19906 Generate code that uses (does not use) the atomic quad word memory
19907 instructions.  The @option{-mquad-memory-atomic} option requires use of
19908 64-bit mode.
19910 @item -mupper-regs-df
19911 @itemx -mno-upper-regs-df
19912 @opindex mupper-regs-df
19913 @opindex mno-upper-regs-df
19914 Generate code that uses (does not use) the scalar double precision
19915 instructions that target all 64 registers in the vector/scalar
19916 floating point register set that were added in version 2.06 of the
19917 PowerPC ISA.  The @option{-mupper-regs-df} turned on by default if you
19918 use either of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19919 @option{-mvsx} options.
19921 @item -mupper-regs-sf
19922 @itemx -mno-upper-regs-sf
19923 @opindex mupper-regs-sf
19924 @opindex mno-upper-regs-sf
19925 Generate code that uses (does not use) the scalar single precision
19926 instructions that target all 64 registers in the vector/scalar
19927 floating point register set that were added in version 2.07 of the
19928 PowerPC ISA.  The @option{-mupper-regs-sf} turned on by default if you
19929 use either of the @option{-mcpu=power8}, or @option{-mpower8-vector}
19930 options.
19932 @item -mupper-regs
19933 @itemx -mno-upper-regs
19934 @opindex mupper-regs
19935 @opindex mno-upper-regs
19936 Generate code that uses (does not use) the scalar
19937 instructions that target all 64 registers in the vector/scalar
19938 floating point register set, depending on the model of the machine.
19940 If the @option{-mno-upper-regs} option was used, it will turn off both
19941 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19943 @item -mfloat-gprs=@var{yes/single/double/no}
19944 @itemx -mfloat-gprs
19945 @opindex mfloat-gprs
19946 This switch enables or disables the generation of floating-point
19947 operations on the general-purpose registers for architectures that
19948 support it.
19950 The argument @var{yes} or @var{single} enables the use of
19951 single-precision floating-point operations.
19953 The argument @var{double} enables the use of single and
19954 double-precision floating-point operations.
19956 The argument @var{no} disables floating-point operations on the
19957 general-purpose registers.
19959 This option is currently only available on the MPC854x.
19961 @item -m32
19962 @itemx -m64
19963 @opindex m32
19964 @opindex m64
19965 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19966 targets (including GNU/Linux).  The 32-bit environment sets int, long
19967 and pointer to 32 bits and generates code that runs on any PowerPC
19968 variant.  The 64-bit environment sets int to 32 bits and long and
19969 pointer to 64 bits, and generates code for PowerPC64, as for
19970 @option{-mpowerpc64}.
19972 @item -mfull-toc
19973 @itemx -mno-fp-in-toc
19974 @itemx -mno-sum-in-toc
19975 @itemx -mminimal-toc
19976 @opindex mfull-toc
19977 @opindex mno-fp-in-toc
19978 @opindex mno-sum-in-toc
19979 @opindex mminimal-toc
19980 Modify generation of the TOC (Table Of Contents), which is created for
19981 every executable file.  The @option{-mfull-toc} option is selected by
19982 default.  In that case, GCC allocates at least one TOC entry for
19983 each unique non-automatic variable reference in your program.  GCC
19984 also places floating-point constants in the TOC@.  However, only
19985 16,384 entries are available in the TOC@.
19987 If you receive a linker error message that saying you have overflowed
19988 the available TOC space, you can reduce the amount of TOC space used
19989 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19990 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19991 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19992 generate code to calculate the sum of an address and a constant at
19993 run time instead of putting that sum into the TOC@.  You may specify one
19994 or both of these options.  Each causes GCC to produce very slightly
19995 slower and larger code at the expense of conserving TOC space.
19997 If you still run out of space in the TOC even when you specify both of
19998 these options, specify @option{-mminimal-toc} instead.  This option causes
19999 GCC to make only one TOC entry for every file.  When you specify this
20000 option, GCC produces code that is slower and larger but which
20001 uses extremely little TOC space.  You may wish to use this option
20002 only on files that contain less frequently-executed code.
20004 @item -maix64
20005 @itemx -maix32
20006 @opindex maix64
20007 @opindex maix32
20008 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
20009 @code{long} type, and the infrastructure needed to support them.
20010 Specifying @option{-maix64} implies @option{-mpowerpc64},
20011 while @option{-maix32} disables the 64-bit ABI and
20012 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
20014 @item -mxl-compat
20015 @itemx -mno-xl-compat
20016 @opindex mxl-compat
20017 @opindex mno-xl-compat
20018 Produce code that conforms more closely to IBM XL compiler semantics
20019 when using AIX-compatible ABI@.  Pass floating-point arguments to
20020 prototyped functions beyond the register save area (RSA) on the stack
20021 in addition to argument FPRs.  Do not assume that most significant
20022 double in 128-bit long double value is properly rounded when comparing
20023 values and converting to double.  Use XL symbol names for long double
20024 support routines.
20026 The AIX calling convention was extended but not initially documented to
20027 handle an obscure K&R C case of calling a function that takes the
20028 address of its arguments with fewer arguments than declared.  IBM XL
20029 compilers access floating-point arguments that do not fit in the
20030 RSA from the stack when a subroutine is compiled without
20031 optimization.  Because always storing floating-point arguments on the
20032 stack is inefficient and rarely needed, this option is not enabled by
20033 default and only is necessary when calling subroutines compiled by IBM
20034 XL compilers without optimization.
20036 @item -mpe
20037 @opindex mpe
20038 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
20039 application written to use message passing with special startup code to
20040 enable the application to run.  The system must have PE installed in the
20041 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
20042 must be overridden with the @option{-specs=} option to specify the
20043 appropriate directory location.  The Parallel Environment does not
20044 support threads, so the @option{-mpe} option and the @option{-pthread}
20045 option are incompatible.
20047 @item -malign-natural
20048 @itemx -malign-power
20049 @opindex malign-natural
20050 @opindex malign-power
20051 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
20052 @option{-malign-natural} overrides the ABI-defined alignment of larger
20053 types, such as floating-point doubles, on their natural size-based boundary.
20054 The option @option{-malign-power} instructs GCC to follow the ABI-specified
20055 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
20057 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
20058 is not supported.
20060 @item -msoft-float
20061 @itemx -mhard-float
20062 @opindex msoft-float
20063 @opindex mhard-float
20064 Generate code that does not use (uses) the floating-point register set.
20065 Software floating-point emulation is provided if you use the
20066 @option{-msoft-float} option, and pass the option to GCC when linking.
20068 @item -msingle-float
20069 @itemx -mdouble-float
20070 @opindex msingle-float
20071 @opindex mdouble-float
20072 Generate code for single- or double-precision floating-point operations.
20073 @option{-mdouble-float} implies @option{-msingle-float}.
20075 @item -msimple-fpu
20076 @opindex msimple-fpu
20077 Do not generate @code{sqrt} and @code{div} instructions for hardware
20078 floating-point unit.
20080 @item -mfpu=@var{name}
20081 @opindex mfpu
20082 Specify type of floating-point unit.  Valid values for @var{name} are
20083 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
20084 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
20085 @samp{sp_full} (equivalent to @option{-msingle-float}),
20086 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
20088 @item -mxilinx-fpu
20089 @opindex mxilinx-fpu
20090 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
20092 @item -mmultiple
20093 @itemx -mno-multiple
20094 @opindex mmultiple
20095 @opindex mno-multiple
20096 Generate code that uses (does not use) the load multiple word
20097 instructions and the store multiple word instructions.  These
20098 instructions are generated by default on POWER systems, and not
20099 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
20100 PowerPC systems, since those instructions do not work when the
20101 processor is in little-endian mode.  The exceptions are PPC740 and
20102 PPC750 which permit these instructions in little-endian mode.
20104 @item -mstring
20105 @itemx -mno-string
20106 @opindex mstring
20107 @opindex mno-string
20108 Generate code that uses (does not use) the load string instructions
20109 and the store string word instructions to save multiple registers and
20110 do small block moves.  These instructions are generated by default on
20111 POWER systems, and not generated on PowerPC systems.  Do not use
20112 @option{-mstring} on little-endian PowerPC systems, since those
20113 instructions do not work when the processor is in little-endian mode.
20114 The exceptions are PPC740 and PPC750 which permit these instructions
20115 in little-endian mode.
20117 @item -mupdate
20118 @itemx -mno-update
20119 @opindex mupdate
20120 @opindex mno-update
20121 Generate code that uses (does not use) the load or store instructions
20122 that update the base register to the address of the calculated memory
20123 location.  These instructions are generated by default.  If you use
20124 @option{-mno-update}, there is a small window between the time that the
20125 stack pointer is updated and the address of the previous frame is
20126 stored, which means code that walks the stack frame across interrupts or
20127 signals may get corrupted data.
20129 @item -mavoid-indexed-addresses
20130 @itemx -mno-avoid-indexed-addresses
20131 @opindex mavoid-indexed-addresses
20132 @opindex mno-avoid-indexed-addresses
20133 Generate code that tries to avoid (not avoid) the use of indexed load
20134 or store instructions. These instructions can incur a performance
20135 penalty on Power6 processors in certain situations, such as when
20136 stepping through large arrays that cross a 16M boundary.  This option
20137 is enabled by default when targeting Power6 and disabled otherwise.
20139 @item -mfused-madd
20140 @itemx -mno-fused-madd
20141 @opindex mfused-madd
20142 @opindex mno-fused-madd
20143 Generate code that uses (does not use) the floating-point multiply and
20144 accumulate instructions.  These instructions are generated by default
20145 if hardware floating point is used.  The machine-dependent
20146 @option{-mfused-madd} option is now mapped to the machine-independent
20147 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20148 mapped to @option{-ffp-contract=off}.
20150 @item -mmulhw
20151 @itemx -mno-mulhw
20152 @opindex mmulhw
20153 @opindex mno-mulhw
20154 Generate code that uses (does not use) the half-word multiply and
20155 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20156 These instructions are generated by default when targeting those
20157 processors.
20159 @item -mdlmzb
20160 @itemx -mno-dlmzb
20161 @opindex mdlmzb
20162 @opindex mno-dlmzb
20163 Generate code that uses (does not use) the string-search @samp{dlmzb}
20164 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20165 generated by default when targeting those processors.
20167 @item -mno-bit-align
20168 @itemx -mbit-align
20169 @opindex mno-bit-align
20170 @opindex mbit-align
20171 On System V.4 and embedded PowerPC systems do not (do) force structures
20172 and unions that contain bit-fields to be aligned to the base type of the
20173 bit-field.
20175 For example, by default a structure containing nothing but 8
20176 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20177 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20178 the structure is aligned to a 1-byte boundary and is 1 byte in
20179 size.
20181 @item -mno-strict-align
20182 @itemx -mstrict-align
20183 @opindex mno-strict-align
20184 @opindex mstrict-align
20185 On System V.4 and embedded PowerPC systems do not (do) assume that
20186 unaligned memory references are handled by the system.
20188 @item -mrelocatable
20189 @itemx -mno-relocatable
20190 @opindex mrelocatable
20191 @opindex mno-relocatable
20192 Generate code that allows (does not allow) a static executable to be
20193 relocated to a different address at run time.  A simple embedded
20194 PowerPC system loader should relocate the entire contents of
20195 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20196 a table of 32-bit addresses generated by this option.  For this to
20197 work, all objects linked together must be compiled with
20198 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20199 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20201 @item -mrelocatable-lib
20202 @itemx -mno-relocatable-lib
20203 @opindex mrelocatable-lib
20204 @opindex mno-relocatable-lib
20205 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20206 @code{.fixup} section to allow static executables to be relocated at
20207 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20208 alignment of @option{-mrelocatable}.  Objects compiled with
20209 @option{-mrelocatable-lib} may be linked with objects compiled with
20210 any combination of the @option{-mrelocatable} options.
20212 @item -mno-toc
20213 @itemx -mtoc
20214 @opindex mno-toc
20215 @opindex mtoc
20216 On System V.4 and embedded PowerPC systems do not (do) assume that
20217 register 2 contains a pointer to a global area pointing to the addresses
20218 used in the program.
20220 @item -mlittle
20221 @itemx -mlittle-endian
20222 @opindex mlittle
20223 @opindex mlittle-endian
20224 On System V.4 and embedded PowerPC systems compile code for the
20225 processor in little-endian mode.  The @option{-mlittle-endian} option is
20226 the same as @option{-mlittle}.
20228 @item -mbig
20229 @itemx -mbig-endian
20230 @opindex mbig
20231 @opindex mbig-endian
20232 On System V.4 and embedded PowerPC systems compile code for the
20233 processor in big-endian mode.  The @option{-mbig-endian} option is
20234 the same as @option{-mbig}.
20236 @item -mdynamic-no-pic
20237 @opindex mdynamic-no-pic
20238 On Darwin and Mac OS X systems, compile code so that it is not
20239 relocatable, but that its external references are relocatable.  The
20240 resulting code is suitable for applications, but not shared
20241 libraries.
20243 @item -msingle-pic-base
20244 @opindex msingle-pic-base
20245 Treat the register used for PIC addressing as read-only, rather than
20246 loading it in the prologue for each function.  The runtime system is
20247 responsible for initializing this register with an appropriate value
20248 before execution begins.
20250 @item -mprioritize-restricted-insns=@var{priority}
20251 @opindex mprioritize-restricted-insns
20252 This option controls the priority that is assigned to
20253 dispatch-slot restricted instructions during the second scheduling
20254 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20255 or @samp{2} to assign no, highest, or second-highest (respectively) 
20256 priority to dispatch-slot restricted
20257 instructions.
20259 @item -msched-costly-dep=@var{dependence_type}
20260 @opindex msched-costly-dep
20261 This option controls which dependences are considered costly
20262 by the target during instruction scheduling.  The argument
20263 @var{dependence_type} takes one of the following values:
20265 @table @asis
20266 @item @samp{no}
20267 No dependence is costly.
20269 @item @samp{all}
20270 All dependences are costly.
20272 @item @samp{true_store_to_load}
20273 A true dependence from store to load is costly.
20275 @item @samp{store_to_load}
20276 Any dependence from store to load is costly.
20278 @item @var{number}
20279 Any dependence for which the latency is greater than or equal to 
20280 @var{number} is costly.
20281 @end table
20283 @item -minsert-sched-nops=@var{scheme}
20284 @opindex minsert-sched-nops
20285 This option controls which NOP insertion scheme is used during
20286 the second scheduling pass.  The argument @var{scheme} takes one of the
20287 following values:
20289 @table @asis
20290 @item @samp{no}
20291 Don't insert NOPs.
20293 @item @samp{pad}
20294 Pad with NOPs any dispatch group that has vacant issue slots,
20295 according to the scheduler's grouping.
20297 @item @samp{regroup_exact}
20298 Insert NOPs to force costly dependent insns into
20299 separate groups.  Insert exactly as many NOPs as needed to force an insn
20300 to a new group, according to the estimated processor grouping.
20302 @item @var{number}
20303 Insert NOPs to force costly dependent insns into
20304 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20305 @end table
20307 @item -mcall-sysv
20308 @opindex mcall-sysv
20309 On System V.4 and embedded PowerPC systems compile code using calling
20310 conventions that adhere to the March 1995 draft of the System V
20311 Application Binary Interface, PowerPC processor supplement.  This is the
20312 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20314 @item -mcall-sysv-eabi
20315 @itemx -mcall-eabi
20316 @opindex mcall-sysv-eabi
20317 @opindex mcall-eabi
20318 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20320 @item -mcall-sysv-noeabi
20321 @opindex mcall-sysv-noeabi
20322 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20324 @item -mcall-aixdesc
20325 @opindex m
20326 On System V.4 and embedded PowerPC systems compile code for the AIX
20327 operating system.
20329 @item -mcall-linux
20330 @opindex mcall-linux
20331 On System V.4 and embedded PowerPC systems compile code for the
20332 Linux-based GNU system.
20334 @item -mcall-freebsd
20335 @opindex mcall-freebsd
20336 On System V.4 and embedded PowerPC systems compile code for the
20337 FreeBSD operating system.
20339 @item -mcall-netbsd
20340 @opindex mcall-netbsd
20341 On System V.4 and embedded PowerPC systems compile code for the
20342 NetBSD operating system.
20344 @item -mcall-openbsd
20345 @opindex mcall-netbsd
20346 On System V.4 and embedded PowerPC systems compile code for the
20347 OpenBSD operating system.
20349 @item -maix-struct-return
20350 @opindex maix-struct-return
20351 Return all structures in memory (as specified by the AIX ABI)@.
20353 @item -msvr4-struct-return
20354 @opindex msvr4-struct-return
20355 Return structures smaller than 8 bytes in registers (as specified by the
20356 SVR4 ABI)@.
20358 @item -mabi=@var{abi-type}
20359 @opindex mabi
20360 Extend the current ABI with a particular extension, or remove such extension.
20361 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
20362 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
20363 @var{elfv1}, @var{elfv2}@.
20365 @item -mabi=spe
20366 @opindex mabi=spe
20367 Extend the current ABI with SPE ABI extensions.  This does not change
20368 the default ABI, instead it adds the SPE ABI extensions to the current
20369 ABI@.
20371 @item -mabi=no-spe
20372 @opindex mabi=no-spe
20373 Disable Book-E SPE ABI extensions for the current ABI@.
20375 @item -mabi=ibmlongdouble
20376 @opindex mabi=ibmlongdouble
20377 Change the current ABI to use IBM extended-precision long double.
20378 This is a PowerPC 32-bit SYSV ABI option.
20380 @item -mabi=ieeelongdouble
20381 @opindex mabi=ieeelongdouble
20382 Change the current ABI to use IEEE extended-precision long double.
20383 This is a PowerPC 32-bit Linux ABI option.
20385 @item -mabi=elfv1
20386 @opindex mabi=elfv1
20387 Change the current ABI to use the ELFv1 ABI.
20388 This is the default ABI for big-endian PowerPC 64-bit Linux.
20389 Overriding the default ABI requires special system support and is
20390 likely to fail in spectacular ways.
20392 @item -mabi=elfv2
20393 @opindex mabi=elfv2
20394 Change the current ABI to use the ELFv2 ABI.
20395 This is the default ABI for little-endian PowerPC 64-bit Linux.
20396 Overriding the default ABI requires special system support and is
20397 likely to fail in spectacular ways.
20399 @item -mprototype
20400 @itemx -mno-prototype
20401 @opindex mprototype
20402 @opindex mno-prototype
20403 On System V.4 and embedded PowerPC systems assume that all calls to
20404 variable argument functions are properly prototyped.  Otherwise, the
20405 compiler must insert an instruction before every non-prototyped call to
20406 set or clear bit 6 of the condition code register (@var{CR}) to
20407 indicate whether floating-point values are passed in the floating-point
20408 registers in case the function takes variable arguments.  With
20409 @option{-mprototype}, only calls to prototyped variable argument functions
20410 set or clear the bit.
20412 @item -msim
20413 @opindex msim
20414 On embedded PowerPC systems, assume that the startup module is called
20415 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20416 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20417 configurations.
20419 @item -mmvme
20420 @opindex mmvme
20421 On embedded PowerPC systems, assume that the startup module is called
20422 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20423 @file{libc.a}.
20425 @item -mads
20426 @opindex mads
20427 On embedded PowerPC systems, assume that the startup module is called
20428 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20429 @file{libc.a}.
20431 @item -myellowknife
20432 @opindex myellowknife
20433 On embedded PowerPC systems, assume that the startup module is called
20434 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20435 @file{libc.a}.
20437 @item -mvxworks
20438 @opindex mvxworks
20439 On System V.4 and embedded PowerPC systems, specify that you are
20440 compiling for a VxWorks system.
20442 @item -memb
20443 @opindex memb
20444 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20445 header to indicate that @samp{eabi} extended relocations are used.
20447 @item -meabi
20448 @itemx -mno-eabi
20449 @opindex meabi
20450 @opindex mno-eabi
20451 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20452 Embedded Applications Binary Interface (EABI), which is a set of
20453 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20454 means that the stack is aligned to an 8-byte boundary, a function
20455 @code{__eabi} is called from @code{main} to set up the EABI
20456 environment, and the @option{-msdata} option can use both @code{r2} and
20457 @code{r13} to point to two separate small data areas.  Selecting
20458 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20459 no EABI initialization function is called from @code{main}, and the
20460 @option{-msdata} option only uses @code{r13} to point to a single
20461 small data area.  The @option{-meabi} option is on by default if you
20462 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20464 @item -msdata=eabi
20465 @opindex msdata=eabi
20466 On System V.4 and embedded PowerPC systems, put small initialized
20467 @code{const} global and static data in the @samp{.sdata2} section, which
20468 is pointed to by register @code{r2}.  Put small initialized
20469 non-@code{const} global and static data in the @samp{.sdata} section,
20470 which is pointed to by register @code{r13}.  Put small uninitialized
20471 global and static data in the @samp{.sbss} section, which is adjacent to
20472 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20473 incompatible with the @option{-mrelocatable} option.  The
20474 @option{-msdata=eabi} option also sets the @option{-memb} option.
20476 @item -msdata=sysv
20477 @opindex msdata=sysv
20478 On System V.4 and embedded PowerPC systems, put small global and static
20479 data in the @samp{.sdata} section, which is pointed to by register
20480 @code{r13}.  Put small uninitialized global and static data in the
20481 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20482 The @option{-msdata=sysv} option is incompatible with the
20483 @option{-mrelocatable} option.
20485 @item -msdata=default
20486 @itemx -msdata
20487 @opindex msdata=default
20488 @opindex msdata
20489 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20490 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20491 same as @option{-msdata=sysv}.
20493 @item -msdata=data
20494 @opindex msdata=data
20495 On System V.4 and embedded PowerPC systems, put small global
20496 data in the @samp{.sdata} section.  Put small uninitialized global
20497 data in the @samp{.sbss} section.  Do not use register @code{r13}
20498 to address small data however.  This is the default behavior unless
20499 other @option{-msdata} options are used.
20501 @item -msdata=none
20502 @itemx -mno-sdata
20503 @opindex msdata=none
20504 @opindex mno-sdata
20505 On embedded PowerPC systems, put all initialized global and static data
20506 in the @samp{.data} section, and all uninitialized data in the
20507 @samp{.bss} section.
20509 @item -mblock-move-inline-limit=@var{num}
20510 @opindex mblock-move-inline-limit
20511 Inline all block moves (such as calls to @code{memcpy} or structure
20512 copies) less than or equal to @var{num} bytes.  The minimum value for
20513 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20514 targets.  The default value is target-specific.
20516 @item -G @var{num}
20517 @opindex G
20518 @cindex smaller data references (PowerPC)
20519 @cindex .sdata/.sdata2 references (PowerPC)
20520 On embedded PowerPC systems, put global and static items less than or
20521 equal to @var{num} bytes into the small data or BSS sections instead of
20522 the normal data or BSS section.  By default, @var{num} is 8.  The
20523 @option{-G @var{num}} switch is also passed to the linker.
20524 All modules should be compiled with the same @option{-G @var{num}} value.
20526 @item -mregnames
20527 @itemx -mno-regnames
20528 @opindex mregnames
20529 @opindex mno-regnames
20530 On System V.4 and embedded PowerPC systems do (do not) emit register
20531 names in the assembly language output using symbolic forms.
20533 @item -mlongcall
20534 @itemx -mno-longcall
20535 @opindex mlongcall
20536 @opindex mno-longcall
20537 By default assume that all calls are far away so that a longer and more
20538 expensive calling sequence is required.  This is required for calls
20539 farther than 32 megabytes (33,554,432 bytes) from the current location.
20540 A short call is generated if the compiler knows
20541 the call cannot be that far away.  This setting can be overridden by
20542 the @code{shortcall} function attribute, or by @code{#pragma
20543 longcall(0)}.
20545 Some linkers are capable of detecting out-of-range calls and generating
20546 glue code on the fly.  On these systems, long calls are unnecessary and
20547 generate slower code.  As of this writing, the AIX linker can do this,
20548 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20549 to the GNU linker for 32-bit PowerPC systems as well.
20551 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20552 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20553 addresses represent the callee and the branch island.  The
20554 Darwin/PPC linker prefers the first address and generates a @code{bl
20555 callee} if the PPC @code{bl} instruction reaches the callee directly;
20556 otherwise, the linker generates @code{bl L42} to call the branch
20557 island.  The branch island is appended to the body of the
20558 calling function; it computes the full 32-bit address of the callee
20559 and jumps to it.
20561 On Mach-O (Darwin) systems, this option directs the compiler emit to
20562 the glue for every direct call, and the Darwin linker decides whether
20563 to use or discard it.
20565 In the future, GCC may ignore all longcall specifications
20566 when the linker is known to generate glue.
20568 @item -mtls-markers
20569 @itemx -mno-tls-markers
20570 @opindex mtls-markers
20571 @opindex mno-tls-markers
20572 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20573 specifying the function argument.  The relocation allows the linker to
20574 reliably associate function call with argument setup instructions for
20575 TLS optimization, which in turn allows GCC to better schedule the
20576 sequence.
20578 @item -pthread
20579 @opindex pthread
20580 Adds support for multithreading with the @dfn{pthreads} library.
20581 This option sets flags for both the preprocessor and linker.
20583 @item -mrecip
20584 @itemx -mno-recip
20585 @opindex mrecip
20586 This option enables use of the reciprocal estimate and
20587 reciprocal square root estimate instructions with additional
20588 Newton-Raphson steps to increase precision instead of doing a divide or
20589 square root and divide for floating-point arguments.  You should use
20590 the @option{-ffast-math} option when using @option{-mrecip} (or at
20591 least @option{-funsafe-math-optimizations},
20592 @option{-finite-math-only}, @option{-freciprocal-math} and
20593 @option{-fno-trapping-math}).  Note that while the throughput of the
20594 sequence is generally higher than the throughput of the non-reciprocal
20595 instruction, the precision of the sequence can be decreased by up to 2
20596 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20597 roots.
20599 @item -mrecip=@var{opt}
20600 @opindex mrecip=opt
20601 This option controls which reciprocal estimate instructions
20602 may be used.  @var{opt} is a comma-separated list of options, which may
20603 be preceded by a @code{!} to invert the option:
20604 @code{all}: enable all estimate instructions,
20605 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20606 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20607 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20608 @code{divf}: enable the single-precision reciprocal approximation instructions;
20609 @code{divd}: enable the double-precision reciprocal approximation instructions;
20610 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20611 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20612 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20614 So, for example, @option{-mrecip=all,!rsqrtd} enables
20615 all of the reciprocal estimate instructions, except for the
20616 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20617 which handle the double-precision reciprocal square root calculations.
20619 @item -mrecip-precision
20620 @itemx -mno-recip-precision
20621 @opindex mrecip-precision
20622 Assume (do not assume) that the reciprocal estimate instructions
20623 provide higher-precision estimates than is mandated by the PowerPC
20624 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20625 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20626 The double-precision square root estimate instructions are not generated by
20627 default on low-precision machines, since they do not provide an
20628 estimate that converges after three steps.
20630 @item -mveclibabi=@var{type}
20631 @opindex mveclibabi
20632 Specifies the ABI type to use for vectorizing intrinsics using an
20633 external library.  The only type supported at present is @code{mass},
20634 which specifies to use IBM's Mathematical Acceleration Subsystem
20635 (MASS) libraries for vectorizing intrinsics using external libraries.
20636 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20637 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20638 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20639 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20640 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20641 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20642 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20643 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20644 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20645 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20646 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20647 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20648 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20649 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20650 for power7.  Both @option{-ftree-vectorize} and
20651 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20652 libraries must be specified at link time.
20654 @item -mfriz
20655 @itemx -mno-friz
20656 @opindex mfriz
20657 Generate (do not generate) the @code{friz} instruction when the
20658 @option{-funsafe-math-optimizations} option is used to optimize
20659 rounding of floating-point values to 64-bit integer and back to floating
20660 point.  The @code{friz} instruction does not return the same value if
20661 the floating-point number is too large to fit in an integer.
20663 @item -mpointers-to-nested-functions
20664 @itemx -mno-pointers-to-nested-functions
20665 @opindex mpointers-to-nested-functions
20666 Generate (do not generate) code to load up the static chain register
20667 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20668 systems where a function pointer points to a 3-word descriptor giving
20669 the function address, TOC value to be loaded in register @var{r2}, and
20670 static chain value to be loaded in register @var{r11}.  The
20671 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20672 call through pointers to nested functions or pointers
20673 to functions compiled in other languages that use the static chain if
20674 you use the @option{-mno-pointers-to-nested-functions}.
20676 @item -msave-toc-indirect
20677 @itemx -mno-save-toc-indirect
20678 @opindex msave-toc-indirect
20679 Generate (do not generate) code to save the TOC value in the reserved
20680 stack location in the function prologue if the function calls through
20681 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20682 saved in the prologue, it is saved just before the call through the
20683 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20685 @item -mcompat-align-parm
20686 @itemx -mno-compat-align-parm
20687 @opindex mcompat-align-parm
20688 Generate (do not generate) code to pass structure parameters with a
20689 maximum alignment of 64 bits, for compatibility with older versions
20690 of GCC.
20692 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20693 structure parameter on a 128-bit boundary when that structure contained
20694 a member requiring 128-bit alignment.  This is corrected in more
20695 recent versions of GCC.  This option may be used to generate code
20696 that is compatible with functions compiled with older versions of
20697 GCC.
20699 The @option{-mno-compat-align-parm} option is the default.
20700 @end table
20702 @node RX Options
20703 @subsection RX Options
20704 @cindex RX Options
20706 These command-line options are defined for RX targets:
20708 @table @gcctabopt
20709 @item -m64bit-doubles
20710 @itemx -m32bit-doubles
20711 @opindex m64bit-doubles
20712 @opindex m32bit-doubles
20713 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20714 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20715 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20716 works on 32-bit values, which is why the default is
20717 @option{-m32bit-doubles}.
20719 @item -fpu
20720 @itemx -nofpu
20721 @opindex fpu
20722 @opindex nofpu
20723 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20724 floating-point hardware.  The default is enabled for the @var{RX600}
20725 series and disabled for the @var{RX200} series.
20727 Floating-point instructions are only generated for 32-bit floating-point 
20728 values, however, so the FPU hardware is not used for doubles if the
20729 @option{-m64bit-doubles} option is used.
20731 @emph{Note} If the @option{-fpu} option is enabled then
20732 @option{-funsafe-math-optimizations} is also enabled automatically.
20733 This is because the RX FPU instructions are themselves unsafe.
20735 @item -mcpu=@var{name}
20736 @opindex mcpu
20737 Selects the type of RX CPU to be targeted.  Currently three types are
20738 supported, the generic @var{RX600} and @var{RX200} series hardware and
20739 the specific @var{RX610} CPU.  The default is @var{RX600}.
20741 The only difference between @var{RX600} and @var{RX610} is that the
20742 @var{RX610} does not support the @code{MVTIPL} instruction.
20744 The @var{RX200} series does not have a hardware floating-point unit
20745 and so @option{-nofpu} is enabled by default when this type is
20746 selected.
20748 @item -mbig-endian-data
20749 @itemx -mlittle-endian-data
20750 @opindex mbig-endian-data
20751 @opindex mlittle-endian-data
20752 Store data (but not code) in the big-endian format.  The default is
20753 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20754 format.
20756 @item -msmall-data-limit=@var{N}
20757 @opindex msmall-data-limit
20758 Specifies the maximum size in bytes of global and static variables
20759 which can be placed into the small data area.  Using the small data
20760 area can lead to smaller and faster code, but the size of area is
20761 limited and it is up to the programmer to ensure that the area does
20762 not overflow.  Also when the small data area is used one of the RX's
20763 registers (usually @code{r13}) is reserved for use pointing to this
20764 area, so it is no longer available for use by the compiler.  This
20765 could result in slower and/or larger code if variables are pushed onto
20766 the stack instead of being held in this register.
20768 Note, common variables (variables that have not been initialized) and
20769 constants are not placed into the small data area as they are assigned
20770 to other sections in the output executable.
20772 The default value is zero, which disables this feature.  Note, this
20773 feature is not enabled by default with higher optimization levels
20774 (@option{-O2} etc) because of the potentially detrimental effects of
20775 reserving a register.  It is up to the programmer to experiment and
20776 discover whether this feature is of benefit to their program.  See the
20777 description of the @option{-mpid} option for a description of how the
20778 actual register to hold the small data area pointer is chosen.
20780 @item -msim
20781 @itemx -mno-sim
20782 @opindex msim
20783 @opindex mno-sim
20784 Use the simulator runtime.  The default is to use the libgloss
20785 board-specific runtime.
20787 @item -mas100-syntax
20788 @itemx -mno-as100-syntax
20789 @opindex mas100-syntax
20790 @opindex mno-as100-syntax
20791 When generating assembler output use a syntax that is compatible with
20792 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20793 assembler, but it has some restrictions so it is not generated by default.
20795 @item -mmax-constant-size=@var{N}
20796 @opindex mmax-constant-size
20797 Specifies the maximum size, in bytes, of a constant that can be used as
20798 an operand in a RX instruction.  Although the RX instruction set does
20799 allow constants of up to 4 bytes in length to be used in instructions,
20800 a longer value equates to a longer instruction.  Thus in some
20801 circumstances it can be beneficial to restrict the size of constants
20802 that are used in instructions.  Constants that are too big are instead
20803 placed into a constant pool and referenced via register indirection.
20805 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20806 or 4 means that constants of any size are allowed.
20808 @item -mrelax
20809 @opindex mrelax
20810 Enable linker relaxation.  Linker relaxation is a process whereby the
20811 linker attempts to reduce the size of a program by finding shorter
20812 versions of various instructions.  Disabled by default.
20814 @item -mint-register=@var{N}
20815 @opindex mint-register
20816 Specify the number of registers to reserve for fast interrupt handler
20817 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20818 means that register @code{r13} is reserved for the exclusive use
20819 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20820 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20821 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20822 A value of 0, the default, does not reserve any registers.
20824 @item -msave-acc-in-interrupts
20825 @opindex msave-acc-in-interrupts
20826 Specifies that interrupt handler functions should preserve the
20827 accumulator register.  This is only necessary if normal code might use
20828 the accumulator register, for example because it performs 64-bit
20829 multiplications.  The default is to ignore the accumulator as this
20830 makes the interrupt handlers faster.
20832 @item -mpid
20833 @itemx -mno-pid
20834 @opindex mpid
20835 @opindex mno-pid
20836 Enables the generation of position independent data.  When enabled any
20837 access to constant data is done via an offset from a base address
20838 held in a register.  This allows the location of constant data to be
20839 determined at run time without requiring the executable to be
20840 relocated, which is a benefit to embedded applications with tight
20841 memory constraints.  Data that can be modified is not affected by this
20842 option.
20844 Note, using this feature reserves a register, usually @code{r13}, for
20845 the constant data base address.  This can result in slower and/or
20846 larger code, especially in complicated functions.
20848 The actual register chosen to hold the constant data base address
20849 depends upon whether the @option{-msmall-data-limit} and/or the
20850 @option{-mint-register} command-line options are enabled.  Starting
20851 with register @code{r13} and proceeding downwards, registers are
20852 allocated first to satisfy the requirements of @option{-mint-register},
20853 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20854 is possible for the small data area register to be @code{r8} if both
20855 @option{-mint-register=4} and @option{-mpid} are specified on the
20856 command line.
20858 By default this feature is not enabled.  The default can be restored
20859 via the @option{-mno-pid} command-line option.
20861 @item -mno-warn-multiple-fast-interrupts
20862 @itemx -mwarn-multiple-fast-interrupts
20863 @opindex mno-warn-multiple-fast-interrupts
20864 @opindex mwarn-multiple-fast-interrupts
20865 Prevents GCC from issuing a warning message if it finds more than one
20866 fast interrupt handler when it is compiling a file.  The default is to
20867 issue a warning for each extra fast interrupt handler found, as the RX
20868 only supports one such interrupt.
20870 @end table
20872 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20873 has special significance to the RX port when used with the
20874 @code{interrupt} function attribute.  This attribute indicates a
20875 function intended to process fast interrupts.  GCC ensures
20876 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20877 and/or @code{r13} and only provided that the normal use of the
20878 corresponding registers have been restricted via the
20879 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20880 options.
20882 @node S/390 and zSeries Options
20883 @subsection S/390 and zSeries Options
20884 @cindex S/390 and zSeries Options
20886 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20888 @table @gcctabopt
20889 @item -mhard-float
20890 @itemx -msoft-float
20891 @opindex mhard-float
20892 @opindex msoft-float
20893 Use (do not use) the hardware floating-point instructions and registers
20894 for floating-point operations.  When @option{-msoft-float} is specified,
20895 functions in @file{libgcc.a} are used to perform floating-point
20896 operations.  When @option{-mhard-float} is specified, the compiler
20897 generates IEEE floating-point instructions.  This is the default.
20899 @item -mhard-dfp
20900 @itemx -mno-hard-dfp
20901 @opindex mhard-dfp
20902 @opindex mno-hard-dfp
20903 Use (do not use) the hardware decimal-floating-point instructions for
20904 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20905 specified, functions in @file{libgcc.a} are used to perform
20906 decimal-floating-point operations.  When @option{-mhard-dfp} is
20907 specified, the compiler generates decimal-floating-point hardware
20908 instructions.  This is the default for @option{-march=z9-ec} or higher.
20910 @item -mlong-double-64
20911 @itemx -mlong-double-128
20912 @opindex mlong-double-64
20913 @opindex mlong-double-128
20914 These switches control the size of @code{long double} type. A size
20915 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20916 type. This is the default.
20918 @item -mbackchain
20919 @itemx -mno-backchain
20920 @opindex mbackchain
20921 @opindex mno-backchain
20922 Store (do not store) the address of the caller's frame as backchain pointer
20923 into the callee's stack frame.
20924 A backchain may be needed to allow debugging using tools that do not understand
20925 DWARF 2 call frame information.
20926 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20927 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20928 the backchain is placed into the topmost word of the 96/160 byte register
20929 save area.
20931 In general, code compiled with @option{-mbackchain} is call-compatible with
20932 code compiled with @option{-mmo-backchain}; however, use of the backchain
20933 for debugging purposes usually requires that the whole binary is built with
20934 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20935 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20936 to build a linux kernel use @option{-msoft-float}.
20938 The default is to not maintain the backchain.
20940 @item -mpacked-stack
20941 @itemx -mno-packed-stack
20942 @opindex mpacked-stack
20943 @opindex mno-packed-stack
20944 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20945 specified, the compiler uses the all fields of the 96/160 byte register save
20946 area only for their default purpose; unused fields still take up stack space.
20947 When @option{-mpacked-stack} is specified, register save slots are densely
20948 packed at the top of the register save area; unused space is reused for other
20949 purposes, allowing for more efficient use of the available stack space.
20950 However, when @option{-mbackchain} is also in effect, the topmost word of
20951 the save area is always used to store the backchain, and the return address
20952 register is always saved two words below the backchain.
20954 As long as the stack frame backchain is not used, code generated with
20955 @option{-mpacked-stack} is call-compatible with code generated with
20956 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20957 S/390 or zSeries generated code that uses the stack frame backchain at run
20958 time, not just for debugging purposes.  Such code is not call-compatible
20959 with code compiled with @option{-mpacked-stack}.  Also, note that the
20960 combination of @option{-mbackchain},
20961 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20962 to build a linux kernel use @option{-msoft-float}.
20964 The default is to not use the packed stack layout.
20966 @item -msmall-exec
20967 @itemx -mno-small-exec
20968 @opindex msmall-exec
20969 @opindex mno-small-exec
20970 Generate (or do not generate) code using the @code{bras} instruction
20971 to do subroutine calls.
20972 This only works reliably if the total executable size does not
20973 exceed 64k.  The default is to use the @code{basr} instruction instead,
20974 which does not have this limitation.
20976 @item -m64
20977 @itemx -m31
20978 @opindex m64
20979 @opindex m31
20980 When @option{-m31} is specified, generate code compliant to the
20981 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20982 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20983 particular to generate 64-bit instructions.  For the @samp{s390}
20984 targets, the default is @option{-m31}, while the @samp{s390x}
20985 targets default to @option{-m64}.
20987 @item -mzarch
20988 @itemx -mesa
20989 @opindex mzarch
20990 @opindex mesa
20991 When @option{-mzarch} is specified, generate code using the
20992 instructions available on z/Architecture.
20993 When @option{-mesa} is specified, generate code using the
20994 instructions available on ESA/390.  Note that @option{-mesa} is
20995 not possible with @option{-m64}.
20996 When generating code compliant to the GNU/Linux for S/390 ABI,
20997 the default is @option{-mesa}.  When generating code compliant
20998 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
21000 @item -mmvcle
21001 @itemx -mno-mvcle
21002 @opindex mmvcle
21003 @opindex mno-mvcle
21004 Generate (or do not generate) code using the @code{mvcle} instruction
21005 to perform block moves.  When @option{-mno-mvcle} is specified,
21006 use a @code{mvc} loop instead.  This is the default unless optimizing for
21007 size.
21009 @item -mdebug
21010 @itemx -mno-debug
21011 @opindex mdebug
21012 @opindex mno-debug
21013 Print (or do not print) additional debug information when compiling.
21014 The default is to not print debug information.
21016 @item -march=@var{cpu-type}
21017 @opindex march
21018 Generate code that runs on @var{cpu-type}, which is the name of a system
21019 representing a certain processor type.  Possible values for
21020 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
21021 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
21022 When generating code using the instructions available on z/Architecture,
21023 the default is @option{-march=z900}.  Otherwise, the default is
21024 @option{-march=g5}.
21026 @item -mtune=@var{cpu-type}
21027 @opindex mtune
21028 Tune to @var{cpu-type} everything applicable about the generated code,
21029 except for the ABI and the set of available instructions.
21030 The list of @var{cpu-type} values is the same as for @option{-march}.
21031 The default is the value used for @option{-march}.
21033 @item -mtpf-trace
21034 @itemx -mno-tpf-trace
21035 @opindex mtpf-trace
21036 @opindex mno-tpf-trace
21037 Generate code that adds (does not add) in TPF OS specific branches to trace
21038 routines in the operating system.  This option is off by default, even
21039 when compiling for the TPF OS@.
21041 @item -mfused-madd
21042 @itemx -mno-fused-madd
21043 @opindex mfused-madd
21044 @opindex mno-fused-madd
21045 Generate code that uses (does not use) the floating-point multiply and
21046 accumulate instructions.  These instructions are generated by default if
21047 hardware floating point is used.
21049 @item -mwarn-framesize=@var{framesize}
21050 @opindex mwarn-framesize
21051 Emit a warning if the current function exceeds the given frame size.  Because
21052 this is a compile-time check it doesn't need to be a real problem when the program
21053 runs.  It is intended to identify functions that most probably cause
21054 a stack overflow.  It is useful to be used in an environment with limited stack
21055 size e.g.@: the linux kernel.
21057 @item -mwarn-dynamicstack
21058 @opindex mwarn-dynamicstack
21059 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
21060 arrays.  This is generally a bad idea with a limited stack size.
21062 @item -mstack-guard=@var{stack-guard}
21063 @itemx -mstack-size=@var{stack-size}
21064 @opindex mstack-guard
21065 @opindex mstack-size
21066 If these options are provided the S/390 back end emits additional instructions in
21067 the function prologue that trigger a trap if the stack size is @var{stack-guard}
21068 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
21069 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
21070 the frame size of the compiled function is chosen.
21071 These options are intended to be used to help debugging stack overflow problems.
21072 The additionally emitted code causes only little overhead and hence can also be
21073 used in production-like systems without greater performance degradation.  The given
21074 values have to be exact powers of 2 and @var{stack-size} has to be greater than
21075 @var{stack-guard} without exceeding 64k.
21076 In order to be efficient the extra code makes the assumption that the stack starts
21077 at an address aligned to the value given by @var{stack-size}.
21078 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
21080 @item -mhotpatch[=@var{halfwords}]
21081 @itemx -mno-hotpatch
21082 @opindex mhotpatch
21083 If the hotpatch option is enabled, a ``hot-patching'' function
21084 prologue is generated for all functions in the compilation unit.
21085 The funtion label is prepended with the given number of two-byte
21086 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
21087 instructions if no argument is present.  Functions with a
21088 hot-patching prologue are never inlined automatically, and a
21089 hot-patching prologue is never generated for functions
21090 that are explicitly inline.
21092 This option can be overridden for individual functions with the
21093 @code{hotpatch} attribute.
21094 @end table
21096 @node Score Options
21097 @subsection Score Options
21098 @cindex Score Options
21100 These options are defined for Score implementations:
21102 @table @gcctabopt
21103 @item -meb
21104 @opindex meb
21105 Compile code for big-endian mode.  This is the default.
21107 @item -mel
21108 @opindex mel
21109 Compile code for little-endian mode.
21111 @item -mnhwloop
21112 @opindex mnhwloop
21113 Disable generation of @code{bcnz} instructions.
21115 @item -muls
21116 @opindex muls
21117 Enable generation of unaligned load and store instructions.
21119 @item -mmac
21120 @opindex mmac
21121 Enable the use of multiply-accumulate instructions. Disabled by default.
21123 @item -mscore5
21124 @opindex mscore5
21125 Specify the SCORE5 as the target architecture.
21127 @item -mscore5u
21128 @opindex mscore5u
21129 Specify the SCORE5U of the target architecture.
21131 @item -mscore7
21132 @opindex mscore7
21133 Specify the SCORE7 as the target architecture. This is the default.
21135 @item -mscore7d
21136 @opindex mscore7d
21137 Specify the SCORE7D as the target architecture.
21138 @end table
21140 @node SH Options
21141 @subsection SH Options
21143 These @samp{-m} options are defined for the SH implementations:
21145 @table @gcctabopt
21146 @item -m1
21147 @opindex m1
21148 Generate code for the SH1.
21150 @item -m2
21151 @opindex m2
21152 Generate code for the SH2.
21154 @item -m2e
21155 Generate code for the SH2e.
21157 @item -m2a-nofpu
21158 @opindex m2a-nofpu
21159 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21160 that the floating-point unit is not used.
21162 @item -m2a-single-only
21163 @opindex m2a-single-only
21164 Generate code for the SH2a-FPU, in such a way that no double-precision
21165 floating-point operations are used.
21167 @item -m2a-single
21168 @opindex m2a-single
21169 Generate code for the SH2a-FPU assuming the floating-point unit is in
21170 single-precision mode by default.
21172 @item -m2a
21173 @opindex m2a
21174 Generate code for the SH2a-FPU assuming the floating-point unit is in
21175 double-precision mode by default.
21177 @item -m3
21178 @opindex m3
21179 Generate code for the SH3.
21181 @item -m3e
21182 @opindex m3e
21183 Generate code for the SH3e.
21185 @item -m4-nofpu
21186 @opindex m4-nofpu
21187 Generate code for the SH4 without a floating-point unit.
21189 @item -m4-single-only
21190 @opindex m4-single-only
21191 Generate code for the SH4 with a floating-point unit that only
21192 supports single-precision arithmetic.
21194 @item -m4-single
21195 @opindex m4-single
21196 Generate code for the SH4 assuming the floating-point unit is in
21197 single-precision mode by default.
21199 @item -m4
21200 @opindex m4
21201 Generate code for the SH4.
21203 @item -m4-100
21204 @opindex m4-100
21205 Generate code for SH4-100.
21207 @item -m4-100-nofpu
21208 @opindex m4-100-nofpu
21209 Generate code for SH4-100 in such a way that the
21210 floating-point unit is not used.
21212 @item -m4-100-single
21213 @opindex m4-100-single
21214 Generate code for SH4-100 assuming the floating-point unit is in
21215 single-precision mode by default.
21217 @item -m4-100-single-only
21218 @opindex m4-100-single-only
21219 Generate code for SH4-100 in such a way that no double-precision
21220 floating-point operations are used.
21222 @item -m4-200
21223 @opindex m4-200
21224 Generate code for SH4-200.
21226 @item -m4-200-nofpu
21227 @opindex m4-200-nofpu
21228 Generate code for SH4-200 without in such a way that the
21229 floating-point unit is not used.
21231 @item -m4-200-single
21232 @opindex m4-200-single
21233 Generate code for SH4-200 assuming the floating-point unit is in
21234 single-precision mode by default.
21236 @item -m4-200-single-only
21237 @opindex m4-200-single-only
21238 Generate code for SH4-200 in such a way that no double-precision
21239 floating-point operations are used.
21241 @item -m4-300
21242 @opindex m4-300
21243 Generate code for SH4-300.
21245 @item -m4-300-nofpu
21246 @opindex m4-300-nofpu
21247 Generate code for SH4-300 without in such a way that the
21248 floating-point unit is not used.
21250 @item -m4-300-single
21251 @opindex m4-300-single
21252 Generate code for SH4-300 in such a way that no double-precision
21253 floating-point operations are used.
21255 @item -m4-300-single-only
21256 @opindex m4-300-single-only
21257 Generate code for SH4-300 in such a way that no double-precision
21258 floating-point operations are used.
21260 @item -m4-340
21261 @opindex m4-340
21262 Generate code for SH4-340 (no MMU, no FPU).
21264 @item -m4-500
21265 @opindex m4-500
21266 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21267 assembler.
21269 @item -m4a-nofpu
21270 @opindex m4a-nofpu
21271 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21272 floating-point unit is not used.
21274 @item -m4a-single-only
21275 @opindex m4a-single-only
21276 Generate code for the SH4a, in such a way that no double-precision
21277 floating-point operations are used.
21279 @item -m4a-single
21280 @opindex m4a-single
21281 Generate code for the SH4a assuming the floating-point unit is in
21282 single-precision mode by default.
21284 @item -m4a
21285 @opindex m4a
21286 Generate code for the SH4a.
21288 @item -m4al
21289 @opindex m4al
21290 Same as @option{-m4a-nofpu}, except that it implicitly passes
21291 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21292 instructions at the moment.
21294 @item -m5-32media
21295 @opindex m5-32media
21296 Generate 32-bit code for SHmedia.
21298 @item -m5-32media-nofpu
21299 @opindex m5-32media-nofpu
21300 Generate 32-bit code for SHmedia in such a way that the
21301 floating-point unit is not used.
21303 @item -m5-64media
21304 @opindex m5-64media
21305 Generate 64-bit code for SHmedia.
21307 @item -m5-64media-nofpu
21308 @opindex m5-64media-nofpu
21309 Generate 64-bit code for SHmedia in such a way that the
21310 floating-point unit is not used.
21312 @item -m5-compact
21313 @opindex m5-compact
21314 Generate code for SHcompact.
21316 @item -m5-compact-nofpu
21317 @opindex m5-compact-nofpu
21318 Generate code for SHcompact in such a way that the
21319 floating-point unit is not used.
21321 @item -mb
21322 @opindex mb
21323 Compile code for the processor in big-endian mode.
21325 @item -ml
21326 @opindex ml
21327 Compile code for the processor in little-endian mode.
21329 @item -mdalign
21330 @opindex mdalign
21331 Align doubles at 64-bit boundaries.  Note that this changes the calling
21332 conventions, and thus some functions from the standard C library do
21333 not work unless you recompile it first with @option{-mdalign}.
21335 @item -mrelax
21336 @opindex mrelax
21337 Shorten some address references at link time, when possible; uses the
21338 linker option @option{-relax}.
21340 @item -mbigtable
21341 @opindex mbigtable
21342 Use 32-bit offsets in @code{switch} tables.  The default is to use
21343 16-bit offsets.
21345 @item -mbitops
21346 @opindex mbitops
21347 Enable the use of bit manipulation instructions on SH2A.
21349 @item -mfmovd
21350 @opindex mfmovd
21351 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21352 alignment constraints.
21354 @item -mrenesas
21355 @opindex mrenesas
21356 Comply with the calling conventions defined by Renesas.
21358 @item -mno-renesas
21359 @opindex mno-renesas
21360 Comply with the calling conventions defined for GCC before the Renesas
21361 conventions were available.  This option is the default for all
21362 targets of the SH toolchain.
21364 @item -mnomacsave
21365 @opindex mnomacsave
21366 Mark the @code{MAC} register as call-clobbered, even if
21367 @option{-mrenesas} is given.
21369 @item -mieee
21370 @itemx -mno-ieee
21371 @opindex mieee
21372 @opindex mno-ieee
21373 Control the IEEE compliance of floating-point comparisons, which affects the
21374 handling of cases where the result of a comparison is unordered.  By default
21375 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21376 enabled @option{-mno-ieee} is implicitly set, which results in faster
21377 floating-point greater-equal and less-equal comparisons.  The implcit settings
21378 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21380 @item -minline-ic_invalidate
21381 @opindex minline-ic_invalidate
21382 Inline code to invalidate instruction cache entries after setting up
21383 nested function trampolines.
21384 This option has no effect if @option{-musermode} is in effect and the selected
21385 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21386 instruction.
21387 If the selected code generation option does not allow the use of the @code{icbi}
21388 instruction, and @option{-musermode} is not in effect, the inlined code
21389 manipulates the instruction cache address array directly with an associative
21390 write.  This not only requires privileged mode at run time, but it also
21391 fails if the cache line had been mapped via the TLB and has become unmapped.
21393 @item -misize
21394 @opindex misize
21395 Dump instruction size and location in the assembly code.
21397 @item -mpadstruct
21398 @opindex mpadstruct
21399 This option is deprecated.  It pads structures to multiple of 4 bytes,
21400 which is incompatible with the SH ABI@.
21402 @item -matomic-model=@var{model}
21403 @opindex matomic-model=@var{model}
21404 Sets the model of atomic operations and additional parameters as a comma
21405 separated list.  For details on the atomic built-in functions see
21406 @ref{__atomic Builtins}.  The following models and parameters are supported:
21408 @table @samp
21410 @item none
21411 Disable compiler generated atomic sequences and emit library calls for atomic
21412 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21414 @item soft-gusa
21415 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21416 built-in functions.  The generated atomic sequences require additional support
21417 from the interrupt/exception handling code of the system and are only suitable
21418 for SH3* and SH4* single-core systems.  This option is enabled by default when
21419 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21420 this option will also partially utilize the hardware atomic instructions
21421 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21422 @samp{strict} is specified.  
21424 @item soft-tcb
21425 Generate software atomic sequences that use a variable in the thread control
21426 block.  This is a variation of the gUSA sequences which can also be used on
21427 SH1* and SH2* targets.  The generated atomic sequences require additional
21428 support from the interrupt/exception handling code of the system and are only
21429 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21430 parameter has to be specified as well.
21432 @item soft-imask
21433 Generate software atomic sequences that temporarily disable interrupts by
21434 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21435 in privileged mode and is only suitable for single-core systems.  Additional
21436 support from the interrupt/exception handling code of the system is not
21437 required.  This model is enabled by default when the target is
21438 @code{sh*-*-linux*} and SH1* or SH2*.
21440 @item hard-llcs
21441 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21442 instructions only.  This is only available on SH4A and is suitable for
21443 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21444 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21445 Code compiled with this option will also be compatible with other software
21446 atomic model interrupt/exception handling systems if executed on an SH4A
21447 system.  Additional support from the interrupt/exception handling code of the
21448 system is not required for this model.
21450 @item gbr-offset=
21451 This parameter specifies the offset in bytes of the variable in the thread
21452 control block structure that should be used by the generated atomic sequences
21453 when the @samp{soft-tcb} model has been selected.  For other models this
21454 parameter is ignored.  The specified value must be an integer multiple of four
21455 and in the range 0-1020.
21457 @item strict
21458 This parameter prevents mixed usage of multiple atomic models, even though they
21459 would be compatible, and will make the compiler generate atomic sequences of the
21460 specified model only.
21462 @end table
21464 @item -mtas
21465 @opindex mtas
21466 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21467 Notice that depending on the particular hardware and software configuration
21468 this can degrade overall performance due to the operand cache line flushes
21469 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21470 processors the @code{tas.b} instruction must be used with caution since it
21471 can result in data corruption for certain cache configurations.
21473 @item -mprefergot
21474 @opindex mprefergot
21475 When generating position-independent code, emit function calls using
21476 the Global Offset Table instead of the Procedure Linkage Table.
21478 @item -musermode
21479 @itemx -mno-usermode
21480 @opindex musermode
21481 @opindex mno-usermode
21482 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21483 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21484 inlined code would not work in user mode.  @option{-musermode} is the default
21485 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21486 @option{-musermode} has no effect, since there is no user mode.
21488 @item -multcost=@var{number}
21489 @opindex multcost=@var{number}
21490 Set the cost to assume for a multiply insn.
21492 @item -mdiv=@var{strategy}
21493 @opindex mdiv=@var{strategy}
21494 Set the division strategy to be used for integer division operations.
21495 For SHmedia @var{strategy} can be one of: 
21497 @table @samp
21499 @item fp 
21500 Performs the operation in floating point.  This has a very high latency,
21501 but needs only a few instructions, so it might be a good choice if
21502 your code has enough easily-exploitable ILP to allow the compiler to
21503 schedule the floating-point instructions together with other instructions.
21504 Division by zero causes a floating-point exception.
21506 @item inv
21507 Uses integer operations to calculate the inverse of the divisor,
21508 and then multiplies the dividend with the inverse.  This strategy allows
21509 CSE and hoisting of the inverse calculation.  Division by zero calculates
21510 an unspecified result, but does not trap.
21512 @item inv:minlat
21513 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21514 have been found, or if the entire operation has been hoisted to the same
21515 place, the last stages of the inverse calculation are intertwined with the
21516 final multiply to reduce the overall latency, at the expense of using a few
21517 more instructions, and thus offering fewer scheduling opportunities with
21518 other code.
21520 @item call
21521 Calls a library function that usually implements the @samp{inv:minlat}
21522 strategy.
21523 This gives high code density for @code{m5-*media-nofpu} compilations.
21525 @item call2
21526 Uses a different entry point of the same library function, where it
21527 assumes that a pointer to a lookup table has already been set up, which
21528 exposes the pointer load to CSE and code hoisting optimizations.
21530 @item inv:call
21531 @itemx inv:call2
21532 @itemx inv:fp
21533 Use the @samp{inv} algorithm for initial
21534 code generation, but if the code stays unoptimized, revert to the @samp{call},
21535 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21536 potentially-trapping side effect of division by zero is carried by a
21537 separate instruction, so it is possible that all the integer instructions
21538 are hoisted out, but the marker for the side effect stays where it is.
21539 A recombination to floating-point operations or a call is not possible
21540 in that case.
21542 @item inv20u
21543 @itemx inv20l
21544 Variants of the @samp{inv:minlat} strategy.  In the case
21545 that the inverse calculation is not separated from the multiply, they speed
21546 up division where the dividend fits into 20 bits (plus sign where applicable)
21547 by inserting a test to skip a number of operations in this case; this test
21548 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21549 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21551 @end table
21553 For targets other than SHmedia @var{strategy} can be one of:
21555 @table @samp
21557 @item call-div1
21558 Calls a library function that uses the single-step division instruction
21559 @code{div1} to perform the operation.  Division by zero calculates an
21560 unspecified result and does not trap.  This is the default except for SH4,
21561 SH2A and SHcompact.
21563 @item call-fp
21564 Calls a library function that performs the operation in double precision
21565 floating point.  Division by zero causes a floating-point exception.  This is
21566 the default for SHcompact with FPU.  Specifying this for targets that do not
21567 have a double precision FPU will default to @code{call-div1}.
21569 @item call-table
21570 Calls a library function that uses a lookup table for small divisors and
21571 the @code{div1} instruction with case distinction for larger divisors.  Division
21572 by zero calculates an unspecified result and does not trap.  This is the default
21573 for SH4.  Specifying this for targets that do not have dynamic shift
21574 instructions will default to @code{call-div1}.
21576 @end table
21578 When a division strategy has not been specified the default strategy will be
21579 selected based on the current target.  For SH2A the default strategy is to
21580 use the @code{divs} and @code{divu} instructions instead of library function
21581 calls.
21583 @item -maccumulate-outgoing-args
21584 @opindex maccumulate-outgoing-args
21585 Reserve space once for outgoing arguments in the function prologue rather
21586 than around each call.  Generally beneficial for performance and size.  Also
21587 needed for unwinding to avoid changing the stack frame around conditional code.
21589 @item -mdivsi3_libfunc=@var{name}
21590 @opindex mdivsi3_libfunc=@var{name}
21591 Set the name of the library function used for 32-bit signed division to
21592 @var{name}.
21593 This only affects the name used in the @samp{call} and @samp{inv:call}
21594 division strategies, and the compiler still expects the same
21595 sets of input/output/clobbered registers as if this option were not present.
21597 @item -mfixed-range=@var{register-range}
21598 @opindex mfixed-range
21599 Generate code treating the given register range as fixed registers.
21600 A fixed register is one that the register allocator can not use.  This is
21601 useful when compiling kernel code.  A register range is specified as
21602 two registers separated by a dash.  Multiple register ranges can be
21603 specified separated by a comma.
21605 @item -mindexed-addressing
21606 @opindex mindexed-addressing
21607 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21608 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21609 semantics for the indexed addressing mode.  The architecture allows the
21610 implementation of processors with 64-bit MMU, which the OS could use to
21611 get 32-bit addressing, but since no current hardware implementation supports
21612 this or any other way to make the indexed addressing mode safe to use in
21613 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21615 @item -mgettrcost=@var{number}
21616 @opindex mgettrcost=@var{number}
21617 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21618 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21620 @item -mpt-fixed
21621 @opindex mpt-fixed
21622 Assume @code{pt*} instructions won't trap.  This generally generates
21623 better-scheduled code, but is unsafe on current hardware.
21624 The current architecture
21625 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21626 anded with 3 is 3.
21627 This has the unintentional effect of making it unsafe to schedule these
21628 instructions before a branch, or hoist them out of a loop.  For example,
21629 @code{__do_global_ctors}, a part of @file{libgcc}
21630 that runs constructors at program
21631 startup, calls functions in a list which is delimited by @minus{}1.  With the
21632 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21633 That means that all the constructors run a bit more quickly, but when
21634 the loop comes to the end of the list, the program crashes because @code{ptabs}
21635 loads @minus{}1 into a target register.  
21637 Since this option is unsafe for any
21638 hardware implementing the current architecture specification, the default
21639 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21640 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21641 this deters register allocation from using target registers for storing
21642 ordinary integers.
21644 @item -minvalid-symbols
21645 @opindex minvalid-symbols
21646 Assume symbols might be invalid.  Ordinary function symbols generated by
21647 the compiler are always valid to load with
21648 @code{movi}/@code{shori}/@code{ptabs} or
21649 @code{movi}/@code{shori}/@code{ptrel},
21650 but with assembler and/or linker tricks it is possible
21651 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21652 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21653 It prevents cross-basic-block CSE, hoisting and most scheduling
21654 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21656 @item -mbranch-cost=@var{num}
21657 @opindex mbranch-cost=@var{num}
21658 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21659 make the compiler try to generate more branch-free code if possible.  
21660 If not specified the value is selected depending on the processor type that
21661 is being compiled for.
21663 @item -mzdcbranch
21664 @itemx -mno-zdcbranch
21665 @opindex mzdcbranch
21666 @opindex mno-zdcbranch
21667 Assume (do not assume) that zero displacement conditional branch instructions
21668 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21669 compiler will try to prefer zero displacement branch code sequences.  This is
21670 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21671 disabled by specifying @option{-mno-zdcbranch}.
21673 @item -mfused-madd
21674 @itemx -mno-fused-madd
21675 @opindex mfused-madd
21676 @opindex mno-fused-madd
21677 Generate code that uses (does not use) the floating-point multiply and
21678 accumulate instructions.  These instructions are generated by default
21679 if hardware floating point is used.  The machine-dependent
21680 @option{-mfused-madd} option is now mapped to the machine-independent
21681 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21682 mapped to @option{-ffp-contract=off}.
21684 @item -mfsca
21685 @itemx -mno-fsca
21686 @opindex mfsca
21687 @opindex mno-fsca
21688 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21689 and cosine approximations.  The option @code{-mfsca} must be used in
21690 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21691 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21692 approximations even if @code{-funsafe-math-optimizations} is in effect.
21694 @item -mfsrra
21695 @itemx -mno-fsrra
21696 @opindex mfsrra
21697 @opindex mno-fsrra
21698 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21699 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21700 in combination with @code{-funsafe-math-optimizations} and
21701 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21702 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21703 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21704 in effect.
21706 @item -mpretend-cmove
21707 @opindex mpretend-cmove
21708 Prefer zero-displacement conditional branches for conditional move instruction
21709 patterns.  This can result in faster code on the SH4 processor.
21711 @end table
21713 @node Solaris 2 Options
21714 @subsection Solaris 2 Options
21715 @cindex Solaris 2 options
21717 These @samp{-m} options are supported on Solaris 2:
21719 @table @gcctabopt
21720 @item -mclear-hwcap
21721 @opindex mclear-hwcap
21722 @option{-mclear-hwcap} tells the compiler to remove the hardware
21723 capabilities generated by the Solaris assembler.  This is only necessary
21724 when object files use ISA extensions not supported by the current
21725 machine, but check at runtime whether or not to use them.
21727 @item -mimpure-text
21728 @opindex mimpure-text
21729 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21730 the compiler to not pass @option{-z text} to the linker when linking a
21731 shared object.  Using this option, you can link position-dependent
21732 code into a shared object.
21734 @option{-mimpure-text} suppresses the ``relocations remain against
21735 allocatable but non-writable sections'' linker error message.
21736 However, the necessary relocations trigger copy-on-write, and the
21737 shared object is not actually shared across processes.  Instead of
21738 using @option{-mimpure-text}, you should compile all source code with
21739 @option{-fpic} or @option{-fPIC}.
21741 @end table
21743 These switches are supported in addition to the above on Solaris 2:
21745 @table @gcctabopt
21746 @item -pthreads
21747 @opindex pthreads
21748 Add support for multithreading using the POSIX threads library.  This
21749 option sets flags for both the preprocessor and linker.  This option does
21750 not affect the thread safety of object code produced  by the compiler or
21751 that of libraries supplied with it.
21753 @item -pthread
21754 @opindex pthread
21755 This is a synonym for @option{-pthreads}.
21756 @end table
21758 @node SPARC Options
21759 @subsection SPARC Options
21760 @cindex SPARC options
21762 These @samp{-m} options are supported on the SPARC:
21764 @table @gcctabopt
21765 @item -mno-app-regs
21766 @itemx -mapp-regs
21767 @opindex mno-app-regs
21768 @opindex mapp-regs
21769 Specify @option{-mapp-regs} to generate output using the global registers
21770 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21771 global register 1, each global register 2 through 4 is then treated as an
21772 allocable register that is clobbered by function calls.  This is the default.
21774 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21775 specify @option{-mno-app-regs}.  You should compile libraries and system
21776 software with this option.
21778 @item -mflat
21779 @itemx -mno-flat
21780 @opindex mflat
21781 @opindex mno-flat
21782 With @option{-mflat}, the compiler does not generate save/restore instructions
21783 and uses a ``flat'' or single register window model.  This model is compatible
21784 with the regular register window model.  The local registers and the input
21785 registers (0--5) are still treated as ``call-saved'' registers and are
21786 saved on the stack as needed.
21788 With @option{-mno-flat} (the default), the compiler generates save/restore
21789 instructions (except for leaf functions).  This is the normal operating mode.
21791 @item -mfpu
21792 @itemx -mhard-float
21793 @opindex mfpu
21794 @opindex mhard-float
21795 Generate output containing floating-point instructions.  This is the
21796 default.
21798 @item -mno-fpu
21799 @itemx -msoft-float
21800 @opindex mno-fpu
21801 @opindex msoft-float
21802 Generate output containing library calls for floating point.
21803 @strong{Warning:} the requisite libraries are not available for all SPARC
21804 targets.  Normally the facilities of the machine's usual C compiler are
21805 used, but this cannot be done directly in cross-compilation.  You must make
21806 your own arrangements to provide suitable library functions for
21807 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21808 @samp{sparclite-*-*} do provide software floating-point support.
21810 @option{-msoft-float} changes the calling convention in the output file;
21811 therefore, it is only useful if you compile @emph{all} of a program with
21812 this option.  In particular, you need to compile @file{libgcc.a}, the
21813 library that comes with GCC, with @option{-msoft-float} in order for
21814 this to work.
21816 @item -mhard-quad-float
21817 @opindex mhard-quad-float
21818 Generate output containing quad-word (long double) floating-point
21819 instructions.
21821 @item -msoft-quad-float
21822 @opindex msoft-quad-float
21823 Generate output containing library calls for quad-word (long double)
21824 floating-point instructions.  The functions called are those specified
21825 in the SPARC ABI@.  This is the default.
21827 As of this writing, there are no SPARC implementations that have hardware
21828 support for the quad-word floating-point instructions.  They all invoke
21829 a trap handler for one of these instructions, and then the trap handler
21830 emulates the effect of the instruction.  Because of the trap handler overhead,
21831 this is much slower than calling the ABI library routines.  Thus the
21832 @option{-msoft-quad-float} option is the default.
21834 @item -mno-unaligned-doubles
21835 @itemx -munaligned-doubles
21836 @opindex mno-unaligned-doubles
21837 @opindex munaligned-doubles
21838 Assume that doubles have 8-byte alignment.  This is the default.
21840 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21841 alignment only if they are contained in another type, or if they have an
21842 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21843 Specifying this option avoids some rare compatibility problems with code
21844 generated by other compilers.  It is not the default because it results
21845 in a performance loss, especially for floating-point code.
21847 @item -muser-mode
21848 @itemx -mno-user-mode
21849 @opindex muser-mode
21850 @opindex mno-user-mode
21851 Do not generate code that can only run in supervisor mode.  This is relevant
21852 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21853 default is @option{-mno-user-mode}.
21855 @item -mno-faster-structs
21856 @itemx -mfaster-structs
21857 @opindex mno-faster-structs
21858 @opindex mfaster-structs
21859 With @option{-mfaster-structs}, the compiler assumes that structures
21860 should have 8-byte alignment.  This enables the use of pairs of
21861 @code{ldd} and @code{std} instructions for copies in structure
21862 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21863 However, the use of this changed alignment directly violates the SPARC
21864 ABI@.  Thus, it's intended only for use on targets where the developer
21865 acknowledges that their resulting code is not directly in line with
21866 the rules of the ABI@.
21868 @item -mcpu=@var{cpu_type}
21869 @opindex mcpu
21870 Set the instruction set, register set, and instruction scheduling parameters
21871 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21872 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21873 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21874 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21875 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21876 @samp{niagara3} and @samp{niagara4}.
21878 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21879 which selects the best architecture option for the host processor.
21880 @option{-mcpu=native} has no effect if GCC does not recognize
21881 the processor.
21883 Default instruction scheduling parameters are used for values that select
21884 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21885 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21887 Here is a list of each supported architecture and their supported
21888 implementations.
21890 @table @asis
21891 @item v7
21892 cypress, leon3v7
21894 @item v8
21895 supersparc, hypersparc, leon, leon3
21897 @item sparclite
21898 f930, f934, sparclite86x
21900 @item sparclet
21901 tsc701
21903 @item v9
21904 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21905 @end table
21907 By default (unless configured otherwise), GCC generates code for the V7
21908 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21909 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21910 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21911 SPARCStation 1, 2, IPX etc.
21913 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21914 architecture.  The only difference from V7 code is that the compiler emits
21915 the integer multiply and integer divide instructions which exist in SPARC-V8
21916 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21917 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21918 2000 series.
21920 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21921 the SPARC architecture.  This adds the integer multiply, integer divide step
21922 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21923 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21924 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21925 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21926 MB86934 chip, which is the more recent SPARClite with FPU@.
21928 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21929 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21930 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21931 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21932 optimizes it for the TEMIC SPARClet chip.
21934 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21935 architecture.  This adds 64-bit integer and floating-point move instructions,
21936 3 additional floating-point condition code registers and conditional move
21937 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21938 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21939 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21940 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21941 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21942 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21943 additionally optimizes it for Sun UltraSPARC T2 chips. With
21944 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21945 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21946 additionally optimizes it for Sun UltraSPARC T4 chips.
21948 @item -mtune=@var{cpu_type}
21949 @opindex mtune
21950 Set the instruction scheduling parameters for machine type
21951 @var{cpu_type}, but do not set the instruction set or register set that the
21952 option @option{-mcpu=@var{cpu_type}} does.
21954 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21955 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21956 that select a particular CPU implementation.  Those are @samp{cypress},
21957 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21958 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21959 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21960 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21961 toolchains, @samp{native} can also be used.
21963 @item -mv8plus
21964 @itemx -mno-v8plus
21965 @opindex mv8plus
21966 @opindex mno-v8plus
21967 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21968 difference from the V8 ABI is that the global and out registers are
21969 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21970 mode for all SPARC-V9 processors.
21972 @item -mvis
21973 @itemx -mno-vis
21974 @opindex mvis
21975 @opindex mno-vis
21976 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21977 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21979 @item -mvis2
21980 @itemx -mno-vis2
21981 @opindex mvis2
21982 @opindex mno-vis2
21983 With @option{-mvis2}, GCC generates code that takes advantage of
21984 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21985 default is @option{-mvis2} when targeting a cpu that supports such
21986 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21987 also sets @option{-mvis}.
21989 @item -mvis3
21990 @itemx -mno-vis3
21991 @opindex mvis3
21992 @opindex mno-vis3
21993 With @option{-mvis3}, GCC generates code that takes advantage of
21994 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21995 default is @option{-mvis3} when targeting a cpu that supports such
21996 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21997 also sets @option{-mvis2} and @option{-mvis}.
21999 @item -mcbcond
22000 @itemx -mno-cbcond
22001 @opindex mcbcond
22002 @opindex mno-cbcond
22003 With @option{-mcbcond}, GCC generates code that takes advantage of
22004 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
22005 The default is @option{-mcbcond} when targeting a cpu that supports such
22006 instructions, such as niagara-4 and later.
22008 @item -mpopc
22009 @itemx -mno-popc
22010 @opindex mpopc
22011 @opindex mno-popc
22012 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
22013 population count instruction.  The default is @option{-mpopc}
22014 when targeting a cpu that supports such instructions, such as Niagara-2 and
22015 later.
22017 @item -mfmaf
22018 @itemx -mno-fmaf
22019 @opindex mfmaf
22020 @opindex mno-fmaf
22021 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
22022 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
22023 when targeting a cpu that supports such instructions, such as Niagara-3 and
22024 later.
22026 @item -mfix-at697f
22027 @opindex mfix-at697f
22028 Enable the documented workaround for the single erratum of the Atmel AT697F
22029 processor (which corresponds to erratum #13 of the AT697E processor).
22031 @item -mfix-ut699
22032 @opindex mfix-ut699
22033 Enable the documented workarounds for the floating-point errata and the data
22034 cache nullify errata of the UT699 processor.
22035 @end table
22037 These @samp{-m} options are supported in addition to the above
22038 on SPARC-V9 processors in 64-bit environments:
22040 @table @gcctabopt
22041 @item -m32
22042 @itemx -m64
22043 @opindex m32
22044 @opindex m64
22045 Generate code for a 32-bit or 64-bit environment.
22046 The 32-bit environment sets int, long and pointer to 32 bits.
22047 The 64-bit environment sets int to 32 bits and long and pointer
22048 to 64 bits.
22050 @item -mcmodel=@var{which}
22051 @opindex mcmodel
22052 Set the code model to one of
22054 @table @samp
22055 @item medlow
22056 The Medium/Low code model: 64-bit addresses, programs
22057 must be linked in the low 32 bits of memory.  Programs can be statically
22058 or dynamically linked.
22060 @item medmid
22061 The Medium/Middle code model: 64-bit addresses, programs
22062 must be linked in the low 44 bits of memory, the text and data segments must
22063 be less than 2GB in size and the data segment must be located within 2GB of
22064 the text segment.
22066 @item medany
22067 The Medium/Anywhere code model: 64-bit addresses, programs
22068 may be linked anywhere in memory, the text and data segments must be less
22069 than 2GB in size and the data segment must be located within 2GB of the
22070 text segment.
22072 @item embmedany
22073 The Medium/Anywhere code model for embedded systems:
22074 64-bit addresses, the text and data segments must be less than 2GB in
22075 size, both starting anywhere in memory (determined at link time).  The
22076 global register %g4 points to the base of the data segment.  Programs
22077 are statically linked and PIC is not supported.
22078 @end table
22080 @item -mmemory-model=@var{mem-model}
22081 @opindex mmemory-model
22082 Set the memory model in force on the processor to one of
22084 @table @samp
22085 @item default
22086 The default memory model for the processor and operating system.
22088 @item rmo
22089 Relaxed Memory Order
22091 @item pso
22092 Partial Store Order
22094 @item tso
22095 Total Store Order
22097 @item sc
22098 Sequential Consistency
22099 @end table
22101 These memory models are formally defined in Appendix D of the Sparc V9
22102 architecture manual, as set in the processor's @code{PSTATE.MM} field.
22104 @item -mstack-bias
22105 @itemx -mno-stack-bias
22106 @opindex mstack-bias
22107 @opindex mno-stack-bias
22108 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
22109 frame pointer if present, are offset by @minus{}2047 which must be added back
22110 when making stack frame references.  This is the default in 64-bit mode.
22111 Otherwise, assume no such offset is present.
22112 @end table
22114 @node SPU Options
22115 @subsection SPU Options
22116 @cindex SPU options
22118 These @samp{-m} options are supported on the SPU:
22120 @table @gcctabopt
22121 @item -mwarn-reloc
22122 @itemx -merror-reloc
22123 @opindex mwarn-reloc
22124 @opindex merror-reloc
22126 The loader for SPU does not handle dynamic relocations.  By default, GCC
22127 gives an error when it generates code that requires a dynamic
22128 relocation.  @option{-mno-error-reloc} disables the error,
22129 @option{-mwarn-reloc} generates a warning instead.
22131 @item -msafe-dma
22132 @itemx -munsafe-dma
22133 @opindex msafe-dma
22134 @opindex munsafe-dma
22136 Instructions that initiate or test completion of DMA must not be
22137 reordered with respect to loads and stores of the memory that is being
22138 accessed.
22139 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
22140 memory accesses, but that can lead to inefficient code in places where the
22141 memory is known to not change.  Rather than mark the memory as volatile,
22142 you can use @option{-msafe-dma} to tell the compiler to treat
22143 the DMA instructions as potentially affecting all memory.  
22145 @item -mbranch-hints
22146 @opindex mbranch-hints
22148 By default, GCC generates a branch hint instruction to avoid
22149 pipeline stalls for always-taken or probably-taken branches.  A hint
22150 is not generated closer than 8 instructions away from its branch.
22151 There is little reason to disable them, except for debugging purposes,
22152 or to make an object a little bit smaller.
22154 @item -msmall-mem
22155 @itemx -mlarge-mem
22156 @opindex msmall-mem
22157 @opindex mlarge-mem
22159 By default, GCC generates code assuming that addresses are never larger
22160 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22161 a full 32-bit address.
22163 @item -mstdmain
22164 @opindex mstdmain
22166 By default, GCC links against startup code that assumes the SPU-style
22167 main function interface (which has an unconventional parameter list).
22168 With @option{-mstdmain}, GCC links your program against startup
22169 code that assumes a C99-style interface to @code{main}, including a
22170 local copy of @code{argv} strings.
22172 @item -mfixed-range=@var{register-range}
22173 @opindex mfixed-range
22174 Generate code treating the given register range as fixed registers.
22175 A fixed register is one that the register allocator cannot use.  This is
22176 useful when compiling kernel code.  A register range is specified as
22177 two registers separated by a dash.  Multiple register ranges can be
22178 specified separated by a comma.
22180 @item -mea32
22181 @itemx -mea64
22182 @opindex mea32
22183 @opindex mea64
22184 Compile code assuming that pointers to the PPU address space accessed
22185 via the @code{__ea} named address space qualifier are either 32 or 64
22186 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22187 all object code in an executable must be compiled with the same setting.
22189 @item -maddress-space-conversion
22190 @itemx -mno-address-space-conversion
22191 @opindex maddress-space-conversion
22192 @opindex mno-address-space-conversion
22193 Allow/disallow treating the @code{__ea} address space as superset
22194 of the generic address space.  This enables explicit type casts
22195 between @code{__ea} and generic pointer as well as implicit
22196 conversions of generic pointers to @code{__ea} pointers.  The
22197 default is to allow address space pointer conversions.
22199 @item -mcache-size=@var{cache-size}
22200 @opindex mcache-size
22201 This option controls the version of libgcc that the compiler links to an
22202 executable and selects a software-managed cache for accessing variables
22203 in the @code{__ea} address space with a particular cache size.  Possible
22204 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22205 and @samp{128}.  The default cache size is 64KB.
22207 @item -matomic-updates
22208 @itemx -mno-atomic-updates
22209 @opindex matomic-updates
22210 @opindex mno-atomic-updates
22211 This option controls the version of libgcc that the compiler links to an
22212 executable and selects whether atomic updates to the software-managed
22213 cache of PPU-side variables are used.  If you use atomic updates, changes
22214 to a PPU variable from SPU code using the @code{__ea} named address space
22215 qualifier do not interfere with changes to other PPU variables residing
22216 in the same cache line from PPU code.  If you do not use atomic updates,
22217 such interference may occur; however, writing back cache lines is
22218 more efficient.  The default behavior is to use atomic updates.
22220 @item -mdual-nops
22221 @itemx -mdual-nops=@var{n}
22222 @opindex mdual-nops
22223 By default, GCC inserts nops to increase dual issue when it expects
22224 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22225 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22226 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22228 @item -mhint-max-nops=@var{n}
22229 @opindex mhint-max-nops
22230 Maximum number of nops to insert for a branch hint.  A branch hint must
22231 be at least 8 instructions away from the branch it is affecting.  GCC
22232 inserts up to @var{n} nops to enforce this, otherwise it does not
22233 generate the branch hint.
22235 @item -mhint-max-distance=@var{n}
22236 @opindex mhint-max-distance
22237 The encoding of the branch hint instruction limits the hint to be within
22238 256 instructions of the branch it is affecting.  By default, GCC makes
22239 sure it is within 125.
22241 @item -msafe-hints
22242 @opindex msafe-hints
22243 Work around a hardware bug that causes the SPU to stall indefinitely.
22244 By default, GCC inserts the @code{hbrp} instruction to make sure
22245 this stall won't happen.
22247 @end table
22249 @node System V Options
22250 @subsection Options for System V
22252 These additional options are available on System V Release 4 for
22253 compatibility with other compilers on those systems:
22255 @table @gcctabopt
22256 @item -G
22257 @opindex G
22258 Create a shared object.
22259 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22261 @item -Qy
22262 @opindex Qy
22263 Identify the versions of each tool used by the compiler, in a
22264 @code{.ident} assembler directive in the output.
22266 @item -Qn
22267 @opindex Qn
22268 Refrain from adding @code{.ident} directives to the output file (this is
22269 the default).
22271 @item -YP,@var{dirs}
22272 @opindex YP
22273 Search the directories @var{dirs}, and no others, for libraries
22274 specified with @option{-l}.
22276 @item -Ym,@var{dir}
22277 @opindex Ym
22278 Look in the directory @var{dir} to find the M4 preprocessor.
22279 The assembler uses this option.
22280 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22281 @c the generic assembler that comes with Solaris takes just -Ym.
22282 @end table
22284 @node TILE-Gx Options
22285 @subsection TILE-Gx Options
22286 @cindex TILE-Gx options
22288 These @samp{-m} options are supported on the TILE-Gx:
22290 @table @gcctabopt
22291 @item -mcmodel=small
22292 @opindex mcmodel=small
22293 Generate code for the small model.  The distance for direct calls is
22294 limited to 500M in either direction.  PC-relative addresses are 32
22295 bits.  Absolute addresses support the full address range.
22297 @item -mcmodel=large
22298 @opindex mcmodel=large
22299 Generate code for the large model.  There is no limitation on call
22300 distance, pc-relative addresses, or absolute addresses.
22302 @item -mcpu=@var{name}
22303 @opindex mcpu
22304 Selects the type of CPU to be targeted.  Currently the only supported
22305 type is @samp{tilegx}.
22307 @item -m32
22308 @itemx -m64
22309 @opindex m32
22310 @opindex m64
22311 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22312 environment sets int, long, and pointer to 32 bits.  The 64-bit
22313 environment sets int to 32 bits and long and pointer to 64 bits.
22315 @item -mbig-endian
22316 @itemx -mlittle-endian
22317 @opindex mbig-endian
22318 @opindex mlittle-endian
22319 Generate code in big/little endian mode, respectively.
22320 @end table
22322 @node TILEPro Options
22323 @subsection TILEPro Options
22324 @cindex TILEPro options
22326 These @samp{-m} options are supported on the TILEPro:
22328 @table @gcctabopt
22329 @item -mcpu=@var{name}
22330 @opindex mcpu
22331 Selects the type of CPU to be targeted.  Currently the only supported
22332 type is @samp{tilepro}.
22334 @item -m32
22335 @opindex m32
22336 Generate code for a 32-bit environment, which sets int, long, and
22337 pointer to 32 bits.  This is the only supported behavior so the flag
22338 is essentially ignored.
22339 @end table
22341 @node V850 Options
22342 @subsection V850 Options
22343 @cindex V850 Options
22345 These @samp{-m} options are defined for V850 implementations:
22347 @table @gcctabopt
22348 @item -mlong-calls
22349 @itemx -mno-long-calls
22350 @opindex mlong-calls
22351 @opindex mno-long-calls
22352 Treat all calls as being far away (near).  If calls are assumed to be
22353 far away, the compiler always loads the function's address into a
22354 register, and calls indirect through the pointer.
22356 @item -mno-ep
22357 @itemx -mep
22358 @opindex mno-ep
22359 @opindex mep
22360 Do not optimize (do optimize) basic blocks that use the same index
22361 pointer 4 or more times to copy pointer into the @code{ep} register, and
22362 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22363 option is on by default if you optimize.
22365 @item -mno-prolog-function
22366 @itemx -mprolog-function
22367 @opindex mno-prolog-function
22368 @opindex mprolog-function
22369 Do not use (do use) external functions to save and restore registers
22370 at the prologue and epilogue of a function.  The external functions
22371 are slower, but use less code space if more than one function saves
22372 the same number of registers.  The @option{-mprolog-function} option
22373 is on by default if you optimize.
22375 @item -mspace
22376 @opindex mspace
22377 Try to make the code as small as possible.  At present, this just turns
22378 on the @option{-mep} and @option{-mprolog-function} options.
22380 @item -mtda=@var{n}
22381 @opindex mtda
22382 Put static or global variables whose size is @var{n} bytes or less into
22383 the tiny data area that register @code{ep} points to.  The tiny data
22384 area can hold up to 256 bytes in total (128 bytes for byte references).
22386 @item -msda=@var{n}
22387 @opindex msda
22388 Put static or global variables whose size is @var{n} bytes or less into
22389 the small data area that register @code{gp} points to.  The small data
22390 area can hold up to 64 kilobytes.
22392 @item -mzda=@var{n}
22393 @opindex mzda
22394 Put static or global variables whose size is @var{n} bytes or less into
22395 the first 32 kilobytes of memory.
22397 @item -mv850
22398 @opindex mv850
22399 Specify that the target processor is the V850.
22401 @item -mv850e3v5
22402 @opindex mv850e3v5
22403 Specify that the target processor is the V850E3V5.  The preprocessor
22404 constant @samp{__v850e3v5__} is defined if this option is used.
22406 @item -mv850e2v4
22407 @opindex mv850e2v4
22408 Specify that the target processor is the V850E3V5.  This is an alias for
22409 the @option{-mv850e3v5} option.
22411 @item -mv850e2v3
22412 @opindex mv850e2v3
22413 Specify that the target processor is the V850E2V3.  The preprocessor
22414 constant @samp{__v850e2v3__} is defined if this option is used.
22416 @item -mv850e2
22417 @opindex mv850e2
22418 Specify that the target processor is the V850E2.  The preprocessor
22419 constant @samp{__v850e2__} is defined if this option is used.
22421 @item -mv850e1
22422 @opindex mv850e1
22423 Specify that the target processor is the V850E1.  The preprocessor
22424 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22425 this option is used.
22427 @item -mv850es
22428 @opindex mv850es
22429 Specify that the target processor is the V850ES.  This is an alias for
22430 the @option{-mv850e1} option.
22432 @item -mv850e
22433 @opindex mv850e
22434 Specify that the target processor is the V850E@.  The preprocessor
22435 constant @samp{__v850e__} is defined if this option is used.
22437 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22438 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22439 are defined then a default target processor is chosen and the
22440 relevant @samp{__v850*__} preprocessor constant is defined.
22442 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22443 defined, regardless of which processor variant is the target.
22445 @item -mdisable-callt
22446 @itemx -mno-disable-callt
22447 @opindex mdisable-callt
22448 @opindex mno-disable-callt
22449 This option suppresses generation of the @code{CALLT} instruction for the
22450 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22451 architecture.
22453 This option is enabled by default when the RH850 ABI is
22454 in use (see @option{-mrh850-abi}), and disabled by default when the
22455 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22456 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22458 @item -mrelax
22459 @itemx -mno-relax
22460 @opindex mrelax
22461 @opindex mno-relax
22462 Pass on (or do not pass on) the @option{-mrelax} command line option
22463 to the assembler.
22465 @item -mlong-jumps
22466 @itemx -mno-long-jumps
22467 @opindex mlong-jumps
22468 @opindex mno-long-jumps
22469 Disable (or re-enable) the generation of PC-relative jump instructions.
22471 @item -msoft-float
22472 @itemx -mhard-float
22473 @opindex msoft-float
22474 @opindex mhard-float
22475 Disable (or re-enable) the generation of hardware floating point
22476 instructions.  This option is only significant when the target
22477 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22478 instructions are being generated then the C preprocessor symbol
22479 @code{__FPU_OK__} will be defined, otherwise the symbol
22480 @code{__NO_FPU__} will be defined.
22482 @item -mloop
22483 @opindex mloop
22484 Enables the use of the e3v5 LOOP instruction.  The use of this
22485 instruction is not enabled by default when the e3v5 architecture is
22486 selected because its use is still experimental.
22488 @item -mrh850-abi
22489 @itemx -mghs
22490 @opindex mrh850-abi
22491 @opindex mghs
22492 Enables support for the RH850 version of the V850 ABI.  This is the
22493 default.  With this version of the ABI the following rules apply:
22495 @itemize
22496 @item
22497 Integer sized structures and unions are returned via a memory pointer
22498 rather than a register.
22500 @item
22501 Large structures and unions (more than 8 bytes in size) are passed by
22502 value.
22504 @item
22505 Functions are aligned to 16-bit boundaries.
22507 @item
22508 The @option{-m8byte-align} command line option is supported.
22510 @item
22511 The @option{-mdisable-callt} command line option is enabled by
22512 default.  The @option{-mno-disable-callt} command line option is not
22513 supported.
22514 @end itemize
22516 When this version of the ABI is enabled the C preprocessor symbol
22517 @code{__V850_RH850_ABI__} is defined.
22519 @item -mgcc-abi
22520 @opindex mgcc-abi
22521 Enables support for the old GCC version of the V850 ABI.  With this
22522 version of the ABI the following rules apply:
22524 @itemize
22525 @item
22526 Integer sized structures and unions are returned in register @code{r10}.
22528 @item
22529 Large structures and unions (more than 8 bytes in size) are passed by
22530 reference.
22532 @item
22533 Functions are aligned to 32-bit boundaries, unless optimizing for
22534 size.
22536 @item
22537 The @option{-m8byte-align} command line option is not supported.
22539 @item
22540 The @option{-mdisable-callt} command line option is supported but not
22541 enabled by default.
22542 @end itemize
22544 When this version of the ABI is enabled the C preprocessor symbol
22545 @code{__V850_GCC_ABI__} is defined.
22547 @item -m8byte-align
22548 @itemx -mno-8byte-align
22549 @opindex m8byte-align
22550 @opindex mno-8byte-align
22551 Enables support for @code{doubles} and @code{long long} types to be
22552 aligned on 8-byte boundaries.  The default is to restrict the
22553 alignment of all objects to at most 4-bytes.  When
22554 @option{-m8byte-align} is in effect the C preprocessor symbol
22555 @code{__V850_8BYTE_ALIGN__} will be defined.
22557 @item -mbig-switch
22558 @opindex mbig-switch
22559 Generate code suitable for big switch tables.  Use this option only if
22560 the assembler/linker complain about out of range branches within a switch
22561 table.
22563 @item -mapp-regs
22564 @opindex mapp-regs
22565 This option causes r2 and r5 to be used in the code generated by
22566 the compiler.  This setting is the default.
22568 @item -mno-app-regs
22569 @opindex mno-app-regs
22570 This option causes r2 and r5 to be treated as fixed registers.
22572 @end table
22574 @node VAX Options
22575 @subsection VAX Options
22576 @cindex VAX options
22578 These @samp{-m} options are defined for the VAX:
22580 @table @gcctabopt
22581 @item -munix
22582 @opindex munix
22583 Do not output certain jump instructions (@code{aobleq} and so on)
22584 that the Unix assembler for the VAX cannot handle across long
22585 ranges.
22587 @item -mgnu
22588 @opindex mgnu
22589 Do output those jump instructions, on the assumption that the
22590 GNU assembler is being used.
22592 @item -mg
22593 @opindex mg
22594 Output code for G-format floating-point numbers instead of D-format.
22595 @end table
22597 @node VMS Options
22598 @subsection VMS Options
22600 These @samp{-m} options are defined for the VMS implementations:
22602 @table @gcctabopt
22603 @item -mvms-return-codes
22604 @opindex mvms-return-codes
22605 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22606 condition (e.g.@ error) codes.
22608 @item -mdebug-main=@var{prefix}
22609 @opindex mdebug-main=@var{prefix}
22610 Flag the first routine whose name starts with @var{prefix} as the main
22611 routine for the debugger.
22613 @item -mmalloc64
22614 @opindex mmalloc64
22615 Default to 64-bit memory allocation routines.
22617 @item -mpointer-size=@var{size}
22618 @opindex mpointer-size=@var{size}
22619 Set the default size of pointers. Possible options for @var{size} are
22620 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22621 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22622 The later option disables @code{pragma pointer_size}.
22623 @end table
22625 @node VxWorks Options
22626 @subsection VxWorks Options
22627 @cindex VxWorks Options
22629 The options in this section are defined for all VxWorks targets.
22630 Options specific to the target hardware are listed with the other
22631 options for that target.
22633 @table @gcctabopt
22634 @item -mrtp
22635 @opindex mrtp
22636 GCC can generate code for both VxWorks kernels and real time processes
22637 (RTPs).  This option switches from the former to the latter.  It also
22638 defines the preprocessor macro @code{__RTP__}.
22640 @item -non-static
22641 @opindex non-static
22642 Link an RTP executable against shared libraries rather than static
22643 libraries.  The options @option{-static} and @option{-shared} can
22644 also be used for RTPs (@pxref{Link Options}); @option{-static}
22645 is the default.
22647 @item -Bstatic
22648 @itemx -Bdynamic
22649 @opindex Bstatic
22650 @opindex Bdynamic
22651 These options are passed down to the linker.  They are defined for
22652 compatibility with Diab.
22654 @item -Xbind-lazy
22655 @opindex Xbind-lazy
22656 Enable lazy binding of function calls.  This option is equivalent to
22657 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22659 @item -Xbind-now
22660 @opindex Xbind-now
22661 Disable lazy binding of function calls.  This option is the default and
22662 is defined for compatibility with Diab.
22663 @end table
22665 @node x86-64 Options
22666 @subsection x86-64 Options
22667 @cindex x86-64 options
22669 These are listed under @xref{i386 and x86-64 Options}.
22671 @node Xstormy16 Options
22672 @subsection Xstormy16 Options
22673 @cindex Xstormy16 Options
22675 These options are defined for Xstormy16:
22677 @table @gcctabopt
22678 @item -msim
22679 @opindex msim
22680 Choose startup files and linker script suitable for the simulator.
22681 @end table
22683 @node Xtensa Options
22684 @subsection Xtensa Options
22685 @cindex Xtensa Options
22687 These options are supported for Xtensa targets:
22689 @table @gcctabopt
22690 @item -mconst16
22691 @itemx -mno-const16
22692 @opindex mconst16
22693 @opindex mno-const16
22694 Enable or disable use of @code{CONST16} instructions for loading
22695 constant values.  The @code{CONST16} instruction is currently not a
22696 standard option from Tensilica.  When enabled, @code{CONST16}
22697 instructions are always used in place of the standard @code{L32R}
22698 instructions.  The use of @code{CONST16} is enabled by default only if
22699 the @code{L32R} instruction is not available.
22701 @item -mfused-madd
22702 @itemx -mno-fused-madd
22703 @opindex mfused-madd
22704 @opindex mno-fused-madd
22705 Enable or disable use of fused multiply/add and multiply/subtract
22706 instructions in the floating-point option.  This has no effect if the
22707 floating-point option is not also enabled.  Disabling fused multiply/add
22708 and multiply/subtract instructions forces the compiler to use separate
22709 instructions for the multiply and add/subtract operations.  This may be
22710 desirable in some cases where strict IEEE 754-compliant results are
22711 required: the fused multiply add/subtract instructions do not round the
22712 intermediate result, thereby producing results with @emph{more} bits of
22713 precision than specified by the IEEE standard.  Disabling fused multiply
22714 add/subtract instructions also ensures that the program output is not
22715 sensitive to the compiler's ability to combine multiply and add/subtract
22716 operations.
22718 @item -mserialize-volatile
22719 @itemx -mno-serialize-volatile
22720 @opindex mserialize-volatile
22721 @opindex mno-serialize-volatile
22722 When this option is enabled, GCC inserts @code{MEMW} instructions before
22723 @code{volatile} memory references to guarantee sequential consistency.
22724 The default is @option{-mserialize-volatile}.  Use
22725 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22727 @item -mforce-no-pic
22728 @opindex mforce-no-pic
22729 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22730 position-independent code (PIC), this option disables PIC for compiling
22731 kernel code.
22733 @item -mtext-section-literals
22734 @itemx -mno-text-section-literals
22735 @opindex mtext-section-literals
22736 @opindex mno-text-section-literals
22737 Control the treatment of literal pools.  The default is
22738 @option{-mno-text-section-literals}, which places literals in a separate
22739 section in the output file.  This allows the literal pool to be placed
22740 in a data RAM/ROM, and it also allows the linker to combine literal
22741 pools from separate object files to remove redundant literals and
22742 improve code size.  With @option{-mtext-section-literals}, the literals
22743 are interspersed in the text section in order to keep them as close as
22744 possible to their references.  This may be necessary for large assembly
22745 files.
22747 @item -mtarget-align
22748 @itemx -mno-target-align
22749 @opindex mtarget-align
22750 @opindex mno-target-align
22751 When this option is enabled, GCC instructs the assembler to
22752 automatically align instructions to reduce branch penalties at the
22753 expense of some code density.  The assembler attempts to widen density
22754 instructions to align branch targets and the instructions following call
22755 instructions.  If there are not enough preceding safe density
22756 instructions to align a target, no widening is performed.  The
22757 default is @option{-mtarget-align}.  These options do not affect the
22758 treatment of auto-aligned instructions like @code{LOOP}, which the
22759 assembler always aligns, either by widening density instructions or
22760 by inserting NOP instructions.
22762 @item -mlongcalls
22763 @itemx -mno-longcalls
22764 @opindex mlongcalls
22765 @opindex mno-longcalls
22766 When this option is enabled, GCC instructs the assembler to translate
22767 direct calls to indirect calls unless it can determine that the target
22768 of a direct call is in the range allowed by the call instruction.  This
22769 translation typically occurs for calls to functions in other source
22770 files.  Specifically, the assembler translates a direct @code{CALL}
22771 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22772 The default is @option{-mno-longcalls}.  This option should be used in
22773 programs where the call target can potentially be out of range.  This
22774 option is implemented in the assembler, not the compiler, so the
22775 assembly code generated by GCC still shows direct call
22776 instructions---look at the disassembled object code to see the actual
22777 instructions.  Note that the assembler uses an indirect call for
22778 every cross-file call, not just those that really are out of range.
22779 @end table
22781 @node zSeries Options
22782 @subsection zSeries Options
22783 @cindex zSeries options
22785 These are listed under @xref{S/390 and zSeries Options}.
22787 @node Code Gen Options
22788 @section Options for Code Generation Conventions
22789 @cindex code generation conventions
22790 @cindex options, code generation
22791 @cindex run-time options
22793 These machine-independent options control the interface conventions
22794 used in code generation.
22796 Most of them have both positive and negative forms; the negative form
22797 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22798 one of the forms is listed---the one that is not the default.  You
22799 can figure out the other form by either removing @samp{no-} or adding
22802 @table @gcctabopt
22803 @item -fbounds-check
22804 @opindex fbounds-check
22805 For front ends that support it, generate additional code to check that
22806 indices used to access arrays are within the declared range.  This is
22807 currently only supported by the Java and Fortran front ends, where
22808 this option defaults to true and false respectively.
22810 @item -fstack-reuse=@var{reuse-level}
22811 @opindex fstack_reuse
22812 This option controls stack space reuse for user declared local/auto variables
22813 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22814 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22815 local variables and temporaries, @samp{named_vars} enables the reuse only for
22816 user defined local variables with names, and @samp{none} disables stack reuse
22817 completely. The default value is @samp{all}. The option is needed when the
22818 program extends the lifetime of a scoped local variable or a compiler generated
22819 temporary beyond the end point defined by the language.  When a lifetime of
22820 a variable ends, and if the variable lives in memory, the optimizing compiler
22821 has the freedom to reuse its stack space with other temporaries or scoped
22822 local variables whose live range does not overlap with it. Legacy code extending
22823 local lifetime will likely to break with the stack reuse optimization.
22825 For example,
22827 @smallexample
22828    int *p;
22829    @{
22830      int local1;
22832      p = &local1;
22833      local1 = 10;
22834      ....
22835    @}
22836    @{
22837       int local2;
22838       local2 = 20;
22839       ...
22840    @}
22842    if (*p == 10)  // out of scope use of local1
22843      @{
22845      @}
22846 @end smallexample
22848 Another example:
22849 @smallexample
22851    struct A
22852    @{
22853        A(int k) : i(k), j(k) @{ @}
22854        int i;
22855        int j;
22856    @};
22858    A *ap;
22860    void foo(const A& ar)
22861    @{
22862       ap = &ar;
22863    @}
22865    void bar()
22866    @{
22867       foo(A(10)); // temp object's lifetime ends when foo returns
22869       @{
22870         A a(20);
22871         ....
22872       @}
22873       ap->i+= 10;  // ap references out of scope temp whose space
22874                    // is reused with a. What is the value of ap->i?
22875    @}
22877 @end smallexample
22879 The lifetime of a compiler generated temporary is well defined by the C++
22880 standard. When a lifetime of a temporary ends, and if the temporary lives
22881 in memory, the optimizing compiler has the freedom to reuse its stack
22882 space with other temporaries or scoped local variables whose live range
22883 does not overlap with it. However some of the legacy code relies on
22884 the behavior of older compilers in which temporaries' stack space is
22885 not reused, the aggressive stack reuse can lead to runtime errors. This
22886 option is used to control the temporary stack reuse optimization.
22888 @item -ftrapv
22889 @opindex ftrapv
22890 This option generates traps for signed overflow on addition, subtraction,
22891 multiplication operations.
22893 @item -fwrapv
22894 @opindex fwrapv
22895 This option instructs the compiler to assume that signed arithmetic
22896 overflow of addition, subtraction and multiplication wraps around
22897 using twos-complement representation.  This flag enables some optimizations
22898 and disables others.  This option is enabled by default for the Java
22899 front end, as required by the Java language specification.
22901 @item -fexceptions
22902 @opindex fexceptions
22903 Enable exception handling.  Generates extra code needed to propagate
22904 exceptions.  For some targets, this implies GCC generates frame
22905 unwind information for all functions, which can produce significant data
22906 size overhead, although it does not affect execution.  If you do not
22907 specify this option, GCC enables it by default for languages like
22908 C++ that normally require exception handling, and disables it for
22909 languages like C that do not normally require it.  However, you may need
22910 to enable this option when compiling C code that needs to interoperate
22911 properly with exception handlers written in C++.  You may also wish to
22912 disable this option if you are compiling older C++ programs that don't
22913 use exception handling.
22915 @item -fnon-call-exceptions
22916 @opindex fnon-call-exceptions
22917 Generate code that allows trapping instructions to throw exceptions.
22918 Note that this requires platform-specific runtime support that does
22919 not exist everywhere.  Moreover, it only allows @emph{trapping}
22920 instructions to throw exceptions, i.e.@: memory references or floating-point
22921 instructions.  It does not allow exceptions to be thrown from
22922 arbitrary signal handlers such as @code{SIGALRM}.
22924 @item -fdelete-dead-exceptions
22925 @opindex fdelete-dead-exceptions
22926 Consider that instructions that may throw exceptions but don't otherwise
22927 contribute to the execution of the program can be optimized away.
22928 This option is enabled by default for the Ada front end, as permitted by
22929 the Ada language specification.
22930 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22932 @item -funwind-tables
22933 @opindex funwind-tables
22934 Similar to @option{-fexceptions}, except that it just generates any needed
22935 static data, but does not affect the generated code in any other way.
22936 You normally do not need to enable this option; instead, a language processor
22937 that needs this handling enables it on your behalf.
22939 @item -fasynchronous-unwind-tables
22940 @opindex fasynchronous-unwind-tables
22941 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22942 table is exact at each instruction boundary, so it can be used for stack
22943 unwinding from asynchronous events (such as debugger or garbage collector).
22945 @item -fno-gnu-unique
22946 @opindex fno-gnu-unique
22947 On systems with recent GNU assembler and C library, the C++ compiler
22948 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22949 of template static data members and static local variables in inline
22950 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22951 is necessary to avoid problems with a library used by two different
22952 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22953 therefore disagreeing with the other one about the binding of the
22954 symbol.  But this causes @code{dlclose} to be ignored for affected
22955 DSOs; if your program relies on reinitialization of a DSO via
22956 @code{dlclose} and @code{dlopen}, you can use
22957 @option{-fno-gnu-unique}.
22959 @item -fpcc-struct-return
22960 @opindex fpcc-struct-return
22961 Return ``short'' @code{struct} and @code{union} values in memory like
22962 longer ones, rather than in registers.  This convention is less
22963 efficient, but it has the advantage of allowing intercallability between
22964 GCC-compiled files and files compiled with other compilers, particularly
22965 the Portable C Compiler (pcc).
22967 The precise convention for returning structures in memory depends
22968 on the target configuration macros.
22970 Short structures and unions are those whose size and alignment match
22971 that of some integer type.
22973 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22974 switch is not binary compatible with code compiled with the
22975 @option{-freg-struct-return} switch.
22976 Use it to conform to a non-default application binary interface.
22978 @item -freg-struct-return
22979 @opindex freg-struct-return
22980 Return @code{struct} and @code{union} values in registers when possible.
22981 This is more efficient for small structures than
22982 @option{-fpcc-struct-return}.
22984 If you specify neither @option{-fpcc-struct-return} nor
22985 @option{-freg-struct-return}, GCC defaults to whichever convention is
22986 standard for the target.  If there is no standard convention, GCC
22987 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22988 the principal compiler.  In those cases, we can choose the standard, and
22989 we chose the more efficient register return alternative.
22991 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22992 switch is not binary compatible with code compiled with the
22993 @option{-fpcc-struct-return} switch.
22994 Use it to conform to a non-default application binary interface.
22996 @item -fshort-enums
22997 @opindex fshort-enums
22998 Allocate to an @code{enum} type only as many bytes as it needs for the
22999 declared range of possible values.  Specifically, the @code{enum} type
23000 is equivalent to the smallest integer type that has enough room.
23002 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
23003 code that is not binary compatible with code generated without that switch.
23004 Use it to conform to a non-default application binary interface.
23006 @item -fshort-double
23007 @opindex fshort-double
23008 Use the same size for @code{double} as for @code{float}.
23010 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
23011 code that is not binary compatible with code generated without that switch.
23012 Use it to conform to a non-default application binary interface.
23014 @item -fshort-wchar
23015 @opindex fshort-wchar
23016 Override the underlying type for @samp{wchar_t} to be @samp{short
23017 unsigned int} instead of the default for the target.  This option is
23018 useful for building programs to run under WINE@.
23020 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
23021 code that is not binary compatible with code generated without that switch.
23022 Use it to conform to a non-default application binary interface.
23024 @item -fno-common
23025 @opindex fno-common
23026 In C code, controls the placement of uninitialized global variables.
23027 Unix C compilers have traditionally permitted multiple definitions of
23028 such variables in different compilation units by placing the variables
23029 in a common block.
23030 This is the behavior specified by @option{-fcommon}, and is the default
23031 for GCC on most targets.
23032 On the other hand, this behavior is not required by ISO C, and on some
23033 targets may carry a speed or code size penalty on variable references.
23034 The @option{-fno-common} option specifies that the compiler should place
23035 uninitialized global variables in the data section of the object file,
23036 rather than generating them as common blocks.
23037 This has the effect that if the same variable is declared
23038 (without @code{extern}) in two different compilations,
23039 you get a multiple-definition error when you link them.
23040 In this case, you must compile with @option{-fcommon} instead.
23041 Compiling with @option{-fno-common} is useful on targets for which
23042 it provides better performance, or if you wish to verify that the
23043 program will work on other systems that always treat uninitialized
23044 variable declarations this way.
23046 @item -fno-ident
23047 @opindex fno-ident
23048 Ignore the @samp{#ident} directive.
23050 @item -finhibit-size-directive
23051 @opindex finhibit-size-directive
23052 Don't output a @code{.size} assembler directive, or anything else that
23053 would cause trouble if the function is split in the middle, and the
23054 two halves are placed at locations far apart in memory.  This option is
23055 used when compiling @file{crtstuff.c}; you should not need to use it
23056 for anything else.
23058 @item -fverbose-asm
23059 @opindex fverbose-asm
23060 Put extra commentary information in the generated assembly code to
23061 make it more readable.  This option is generally only of use to those
23062 who actually need to read the generated assembly code (perhaps while
23063 debugging the compiler itself).
23065 @option{-fno-verbose-asm}, the default, causes the
23066 extra information to be omitted and is useful when comparing two assembler
23067 files.
23069 @item -frecord-gcc-switches
23070 @opindex frecord-gcc-switches
23071 This switch causes the command line used to invoke the
23072 compiler to be recorded into the object file that is being created.
23073 This switch is only implemented on some targets and the exact format
23074 of the recording is target and binary file format dependent, but it
23075 usually takes the form of a section containing ASCII text.  This
23076 switch is related to the @option{-fverbose-asm} switch, but that
23077 switch only records information in the assembler output file as
23078 comments, so it never reaches the object file.
23079 See also @option{-grecord-gcc-switches} for another
23080 way of storing compiler options into the object file.
23082 @item -fpic
23083 @opindex fpic
23084 @cindex global offset table
23085 @cindex PIC
23086 Generate position-independent code (PIC) suitable for use in a shared
23087 library, if supported for the target machine.  Such code accesses all
23088 constant addresses through a global offset table (GOT)@.  The dynamic
23089 loader resolves the GOT entries when the program starts (the dynamic
23090 loader is not part of GCC; it is part of the operating system).  If
23091 the GOT size for the linked executable exceeds a machine-specific
23092 maximum size, you get an error message from the linker indicating that
23093 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23094 instead.  (These maximums are 8k on the SPARC and 32k
23095 on the m68k and RS/6000.  The 386 has no such limit.)
23097 Position-independent code requires special support, and therefore works
23098 only on certain machines.  For the 386, GCC supports PIC for System V
23099 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23100 position-independent.
23102 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23103 are defined to 1.
23105 @item -fPIC
23106 @opindex fPIC
23107 If supported for the target machine, emit position-independent code,
23108 suitable for dynamic linking and avoiding any limit on the size of the
23109 global offset table.  This option makes a difference on the m68k,
23110 PowerPC and SPARC@.
23112 Position-independent code requires special support, and therefore works
23113 only on certain machines.
23115 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23116 are defined to 2.
23118 @item -fpie
23119 @itemx -fPIE
23120 @opindex fpie
23121 @opindex fPIE
23122 These options are similar to @option{-fpic} and @option{-fPIC}, but
23123 generated position independent code can be only linked into executables.
23124 Usually these options are used when @option{-pie} GCC option is
23125 used during linking.
23127 @option{-fpie} and @option{-fPIE} both define the macros
23128 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23129 for @option{-fpie} and 2 for @option{-fPIE}.
23131 @item -fno-jump-tables
23132 @opindex fno-jump-tables
23133 Do not use jump tables for switch statements even where it would be
23134 more efficient than other code generation strategies.  This option is
23135 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23136 building code that forms part of a dynamic linker and cannot
23137 reference the address of a jump table.  On some targets, jump tables
23138 do not require a GOT and this option is not needed.
23140 @item -ffixed-@var{reg}
23141 @opindex ffixed
23142 Treat the register named @var{reg} as a fixed register; generated code
23143 should never refer to it (except perhaps as a stack pointer, frame
23144 pointer or in some other fixed role).
23146 @var{reg} must be the name of a register.  The register names accepted
23147 are machine-specific and are defined in the @code{REGISTER_NAMES}
23148 macro in the machine description macro file.
23150 This flag does not have a negative form, because it specifies a
23151 three-way choice.
23153 @item -fcall-used-@var{reg}
23154 @opindex fcall-used
23155 Treat the register named @var{reg} as an allocable register that is
23156 clobbered by function calls.  It may be allocated for temporaries or
23157 variables that do not live across a call.  Functions compiled this way
23158 do not save and restore the register @var{reg}.
23160 It is an error to use this flag with the frame pointer or stack pointer.
23161 Use of this flag for other registers that have fixed pervasive roles in
23162 the machine's execution model produces disastrous results.
23164 This flag does not have a negative form, because it specifies a
23165 three-way choice.
23167 @item -fcall-saved-@var{reg}
23168 @opindex fcall-saved
23169 Treat the register named @var{reg} as an allocable register saved by
23170 functions.  It may be allocated even for temporaries or variables that
23171 live across a call.  Functions compiled this way save and restore
23172 the register @var{reg} if they use it.
23174 It is an error to use this flag with the frame pointer or stack pointer.
23175 Use of this flag for other registers that have fixed pervasive roles in
23176 the machine's execution model produces disastrous results.
23178 A different sort of disaster results from the use of this flag for
23179 a register in which function values may be returned.
23181 This flag does not have a negative form, because it specifies a
23182 three-way choice.
23184 @item -fpack-struct[=@var{n}]
23185 @opindex fpack-struct
23186 Without a value specified, pack all structure members together without
23187 holes.  When a value is specified (which must be a small power of two), pack
23188 structure members according to this value, representing the maximum
23189 alignment (that is, objects with default alignment requirements larger than
23190 this are output potentially unaligned at the next fitting location.
23192 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23193 code that is not binary compatible with code generated without that switch.
23194 Additionally, it makes the code suboptimal.
23195 Use it to conform to a non-default application binary interface.
23197 @item -finstrument-functions
23198 @opindex finstrument-functions
23199 Generate instrumentation calls for entry and exit to functions.  Just
23200 after function entry and just before function exit, the following
23201 profiling functions are called with the address of the current
23202 function and its call site.  (On some platforms,
23203 @code{__builtin_return_address} does not work beyond the current
23204 function, so the call site information may not be available to the
23205 profiling functions otherwise.)
23207 @smallexample
23208 void __cyg_profile_func_enter (void *this_fn,
23209                                void *call_site);
23210 void __cyg_profile_func_exit  (void *this_fn,
23211                                void *call_site);
23212 @end smallexample
23214 The first argument is the address of the start of the current function,
23215 which may be looked up exactly in the symbol table.
23217 This instrumentation is also done for functions expanded inline in other
23218 functions.  The profiling calls indicate where, conceptually, the
23219 inline function is entered and exited.  This means that addressable
23220 versions of such functions must be available.  If all your uses of a
23221 function are expanded inline, this may mean an additional expansion of
23222 code size.  If you use @samp{extern inline} in your C code, an
23223 addressable version of such functions must be provided.  (This is
23224 normally the case anyway, but if you get lucky and the optimizer always
23225 expands the functions inline, you might have gotten away without
23226 providing static copies.)
23228 A function may be given the attribute @code{no_instrument_function}, in
23229 which case this instrumentation is not done.  This can be used, for
23230 example, for the profiling functions listed above, high-priority
23231 interrupt routines, and any functions from which the profiling functions
23232 cannot safely be called (perhaps signal handlers, if the profiling
23233 routines generate output or allocate memory).
23235 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23236 @opindex finstrument-functions-exclude-file-list
23238 Set the list of functions that are excluded from instrumentation (see
23239 the description of @code{-finstrument-functions}).  If the file that
23240 contains a function definition matches with one of @var{file}, then
23241 that function is not instrumented.  The match is done on substrings:
23242 if the @var{file} parameter is a substring of the file name, it is
23243 considered to be a match.
23245 For example:
23247 @smallexample
23248 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23249 @end smallexample
23251 @noindent
23252 excludes any inline function defined in files whose pathnames
23253 contain @code{/bits/stl} or @code{include/sys}.
23255 If, for some reason, you want to include letter @code{','} in one of
23256 @var{sym}, write @code{'\,'}. For example,
23257 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
23258 (note the single quote surrounding the option).
23260 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23261 @opindex finstrument-functions-exclude-function-list
23263 This is similar to @code{-finstrument-functions-exclude-file-list},
23264 but this option sets the list of function names to be excluded from
23265 instrumentation.  The function name to be matched is its user-visible
23266 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23267 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23268 match is done on substrings: if the @var{sym} parameter is a substring
23269 of the function name, it is considered to be a match.  For C99 and C++
23270 extended identifiers, the function name must be given in UTF-8, not
23271 using universal character names.
23273 @item -fstack-check
23274 @opindex fstack-check
23275 Generate code to verify that you do not go beyond the boundary of the
23276 stack.  You should specify this flag if you are running in an
23277 environment with multiple threads, but you only rarely need to specify it in
23278 a single-threaded environment since stack overflow is automatically
23279 detected on nearly all systems if there is only one stack.
23281 Note that this switch does not actually cause checking to be done; the
23282 operating system or the language runtime must do that.  The switch causes
23283 generation of code to ensure that they see the stack being extended.
23285 You can additionally specify a string parameter: @code{no} means no
23286 checking, @code{generic} means force the use of old-style checking,
23287 @code{specific} means use the best checking method and is equivalent
23288 to bare @option{-fstack-check}.
23290 Old-style checking is a generic mechanism that requires no specific
23291 target support in the compiler but comes with the following drawbacks:
23293 @enumerate
23294 @item
23295 Modified allocation strategy for large objects: they are always
23296 allocated dynamically if their size exceeds a fixed threshold.
23298 @item
23299 Fixed limit on the size of the static frame of functions: when it is
23300 topped by a particular function, stack checking is not reliable and
23301 a warning is issued by the compiler.
23303 @item
23304 Inefficiency: because of both the modified allocation strategy and the
23305 generic implementation, code performance is hampered.
23306 @end enumerate
23308 Note that old-style stack checking is also the fallback method for
23309 @code{specific} if no target support has been added in the compiler.
23311 @item -fstack-limit-register=@var{reg}
23312 @itemx -fstack-limit-symbol=@var{sym}
23313 @itemx -fno-stack-limit
23314 @opindex fstack-limit-register
23315 @opindex fstack-limit-symbol
23316 @opindex fno-stack-limit
23317 Generate code to ensure that the stack does not grow beyond a certain value,
23318 either the value of a register or the address of a symbol.  If a larger
23319 stack is required, a signal is raised at run time.  For most targets,
23320 the signal is raised before the stack overruns the boundary, so
23321 it is possible to catch the signal without taking special precautions.
23323 For instance, if the stack starts at absolute address @samp{0x80000000}
23324 and grows downwards, you can use the flags
23325 @option{-fstack-limit-symbol=__stack_limit} and
23326 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23327 of 128KB@.  Note that this may only work with the GNU linker.
23329 @item -fsplit-stack
23330 @opindex fsplit-stack
23331 Generate code to automatically split the stack before it overflows.
23332 The resulting program has a discontiguous stack which can only
23333 overflow if the program is unable to allocate any more memory.  This
23334 is most useful when running threaded programs, as it is no longer
23335 necessary to calculate a good stack size to use for each thread.  This
23336 is currently only implemented for the i386 and x86_64 back ends running
23337 GNU/Linux.
23339 When code compiled with @option{-fsplit-stack} calls code compiled
23340 without @option{-fsplit-stack}, there may not be much stack space
23341 available for the latter code to run.  If compiling all code,
23342 including library code, with @option{-fsplit-stack} is not an option,
23343 then the linker can fix up these calls so that the code compiled
23344 without @option{-fsplit-stack} always has a large stack.  Support for
23345 this is implemented in the gold linker in GNU binutils release 2.21
23346 and later.
23348 @item -fleading-underscore
23349 @opindex fleading-underscore
23350 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23351 change the way C symbols are represented in the object file.  One use
23352 is to help link with legacy assembly code.
23354 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23355 generate code that is not binary compatible with code generated without that
23356 switch.  Use it to conform to a non-default application binary interface.
23357 Not all targets provide complete support for this switch.
23359 @item -ftls-model=@var{model}
23360 @opindex ftls-model
23361 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23362 The @var{model} argument should be one of @code{global-dynamic},
23363 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
23364 Note that the choice is subject to optimization: the compiler may use
23365 a more efficient model for symbols not visible outside of the translation
23366 unit, or if @option{-fpic} is not given on the command line.
23368 The default without @option{-fpic} is @code{initial-exec}; with
23369 @option{-fpic} the default is @code{global-dynamic}.
23371 @item -fvisibility=@var{default|internal|hidden|protected}
23372 @opindex fvisibility
23373 Set the default ELF image symbol visibility to the specified option---all
23374 symbols are marked with this unless overridden within the code.
23375 Using this feature can very substantially improve linking and
23376 load times of shared object libraries, produce more optimized
23377 code, provide near-perfect API export and prevent symbol clashes.
23378 It is @strong{strongly} recommended that you use this in any shared objects
23379 you distribute.
23381 Despite the nomenclature, @code{default} always means public; i.e.,
23382 available to be linked against from outside the shared object.
23383 @code{protected} and @code{internal} are pretty useless in real-world
23384 usage so the only other commonly used option is @code{hidden}.
23385 The default if @option{-fvisibility} isn't specified is
23386 @code{default}, i.e., make every
23387 symbol public---this causes the same behavior as previous versions of
23388 GCC@.
23390 A good explanation of the benefits offered by ensuring ELF
23391 symbols have the correct visibility is given by ``How To Write
23392 Shared Libraries'' by Ulrich Drepper (which can be found at
23393 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23394 solution made possible by this option to marking things hidden when
23395 the default is public is to make the default hidden and mark things
23396 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23397 and @code{__attribute__ ((visibility("default")))} instead of
23398 @code{__declspec(dllexport)} you get almost identical semantics with
23399 identical syntax.  This is a great boon to those working with
23400 cross-platform projects.
23402 For those adding visibility support to existing code, you may find
23403 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23404 the declarations you wish to set visibility for with (for example)
23405 @samp{#pragma GCC visibility push(hidden)} and
23406 @samp{#pragma GCC visibility pop}.
23407 Bear in mind that symbol visibility should be viewed @strong{as
23408 part of the API interface contract} and thus all new code should
23409 always specify visibility when it is not the default; i.e., declarations
23410 only for use within the local DSO should @strong{always} be marked explicitly
23411 as hidden as so to avoid PLT indirection overheads---making this
23412 abundantly clear also aids readability and self-documentation of the code.
23413 Note that due to ISO C++ specification requirements, @code{operator new} and
23414 @code{operator delete} must always be of default visibility.
23416 Be aware that headers from outside your project, in particular system
23417 headers and headers from any other library you use, may not be
23418 expecting to be compiled with visibility other than the default.  You
23419 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23420 before including any such headers.
23422 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23423 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23424 no modifications.  However, this means that calls to @code{extern}
23425 functions with no explicit visibility use the PLT, so it is more
23426 effective to use @code{__attribute ((visibility))} and/or
23427 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23428 declarations should be treated as hidden.
23430 Note that @option{-fvisibility} does affect C++ vague linkage
23431 entities. This means that, for instance, an exception class that is
23432 be thrown between DSOs must be explicitly marked with default
23433 visibility so that the @samp{type_info} nodes are unified between
23434 the DSOs.
23436 An overview of these techniques, their benefits and how to use them
23437 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23439 @item -fstrict-volatile-bitfields
23440 @opindex fstrict-volatile-bitfields
23441 This option should be used if accesses to volatile bit-fields (or other
23442 structure fields, although the compiler usually honors those types
23443 anyway) should use a single access of the width of the
23444 field's type, aligned to a natural alignment if possible.  For
23445 example, targets with memory-mapped peripheral registers might require
23446 all such accesses to be 16 bits wide; with this flag you can
23447 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23448 is 16 bits on these targets) to force GCC to use 16-bit accesses
23449 instead of, perhaps, a more efficient 32-bit access.
23451 If this option is disabled, the compiler uses the most efficient
23452 instruction.  In the previous example, that might be a 32-bit load
23453 instruction, even though that accesses bytes that do not contain
23454 any portion of the bit-field, or memory-mapped registers unrelated to
23455 the one being updated.
23457 In some cases, such as when the @code{packed} attribute is applied to a 
23458 structure field, it may not be possible to access the field with a single
23459 read or write that is correctly aligned for the target machine.  In this
23460 case GCC falls back to generating multiple accesses rather than code that 
23461 will fault or truncate the result at run time.
23463 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23464 not allowed to touch non bit-field members.  It is therefore recommended
23465 to define all bits of the field's type as bit-field members.
23467 The default value of this option is determined by the application binary
23468 interface for the target processor.
23470 @item -fsync-libcalls
23471 @opindex fsync-libcalls
23472 This option controls whether any out-of-line instance of the @code{__sync}
23473 family of functions may be used to implement the C++11 @code{__atomic}
23474 family of functions.
23476 The default value of this option is enabled, thus the only useful form
23477 of the option is @option{-fno-sync-libcalls}.  This option is used in
23478 the implementation of the @file{libatomic} runtime library.
23480 @end table
23482 @c man end
23484 @node Environment Variables
23485 @section Environment Variables Affecting GCC
23486 @cindex environment variables
23488 @c man begin ENVIRONMENT
23489 This section describes several environment variables that affect how GCC
23490 operates.  Some of them work by specifying directories or prefixes to use
23491 when searching for various kinds of files.  Some are used to specify other
23492 aspects of the compilation environment.
23494 Note that you can also specify places to search using options such as
23495 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23496 take precedence over places specified using environment variables, which
23497 in turn take precedence over those specified by the configuration of GCC@.
23498 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23499 GNU Compiler Collection (GCC) Internals}.
23501 @table @env
23502 @item LANG
23503 @itemx LC_CTYPE
23504 @c @itemx LC_COLLATE
23505 @itemx LC_MESSAGES
23506 @c @itemx LC_MONETARY
23507 @c @itemx LC_NUMERIC
23508 @c @itemx LC_TIME
23509 @itemx LC_ALL
23510 @findex LANG
23511 @findex LC_CTYPE
23512 @c @findex LC_COLLATE
23513 @findex LC_MESSAGES
23514 @c @findex LC_MONETARY
23515 @c @findex LC_NUMERIC
23516 @c @findex LC_TIME
23517 @findex LC_ALL
23518 @cindex locale
23519 These environment variables control the way that GCC uses
23520 localization information which allows GCC to work with different
23521 national conventions.  GCC inspects the locale categories
23522 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23523 so.  These locale categories can be set to any value supported by your
23524 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23525 Kingdom encoded in UTF-8.
23527 The @env{LC_CTYPE} environment variable specifies character
23528 classification.  GCC uses it to determine the character boundaries in
23529 a string; this is needed for some multibyte encodings that contain quote
23530 and escape characters that are otherwise interpreted as a string
23531 end or escape.
23533 The @env{LC_MESSAGES} environment variable specifies the language to
23534 use in diagnostic messages.
23536 If the @env{LC_ALL} environment variable is set, it overrides the value
23537 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23538 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23539 environment variable.  If none of these variables are set, GCC
23540 defaults to traditional C English behavior.
23542 @item TMPDIR
23543 @findex TMPDIR
23544 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23545 files.  GCC uses temporary files to hold the output of one stage of
23546 compilation which is to be used as input to the next stage: for example,
23547 the output of the preprocessor, which is the input to the compiler
23548 proper.
23550 @item GCC_COMPARE_DEBUG
23551 @findex GCC_COMPARE_DEBUG
23552 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23553 @option{-fcompare-debug} to the compiler driver.  See the documentation
23554 of this option for more details.
23556 @item GCC_EXEC_PREFIX
23557 @findex GCC_EXEC_PREFIX
23558 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23559 names of the subprograms executed by the compiler.  No slash is added
23560 when this prefix is combined with the name of a subprogram, but you can
23561 specify a prefix that ends with a slash if you wish.
23563 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23564 an appropriate prefix to use based on the pathname it is invoked with.
23566 If GCC cannot find the subprogram using the specified prefix, it
23567 tries looking in the usual places for the subprogram.
23569 The default value of @env{GCC_EXEC_PREFIX} is
23570 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23571 the installed compiler. In many cases @var{prefix} is the value
23572 of @code{prefix} when you ran the @file{configure} script.
23574 Other prefixes specified with @option{-B} take precedence over this prefix.
23576 This prefix is also used for finding files such as @file{crt0.o} that are
23577 used for linking.
23579 In addition, the prefix is used in an unusual way in finding the
23580 directories to search for header files.  For each of the standard
23581 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23582 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23583 replacing that beginning with the specified prefix to produce an
23584 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23585 @file{foo/bar} just before it searches the standard directory 
23586 @file{/usr/local/lib/bar}.
23587 If a standard directory begins with the configured
23588 @var{prefix} then the value of @var{prefix} is replaced by
23589 @env{GCC_EXEC_PREFIX} when looking for header files.
23591 @item COMPILER_PATH
23592 @findex COMPILER_PATH
23593 The value of @env{COMPILER_PATH} is a colon-separated list of
23594 directories, much like @env{PATH}.  GCC tries the directories thus
23595 specified when searching for subprograms, if it can't find the
23596 subprograms using @env{GCC_EXEC_PREFIX}.
23598 @item LIBRARY_PATH
23599 @findex LIBRARY_PATH
23600 The value of @env{LIBRARY_PATH} is a colon-separated list of
23601 directories, much like @env{PATH}.  When configured as a native compiler,
23602 GCC tries the directories thus specified when searching for special
23603 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23604 using GCC also uses these directories when searching for ordinary
23605 libraries for the @option{-l} option (but directories specified with
23606 @option{-L} come first).
23608 @item LANG
23609 @findex LANG
23610 @cindex locale definition
23611 This variable is used to pass locale information to the compiler.  One way in
23612 which this information is used is to determine the character set to be used
23613 when character literals, string literals and comments are parsed in C and C++.
23614 When the compiler is configured to allow multibyte characters,
23615 the following values for @env{LANG} are recognized:
23617 @table @samp
23618 @item C-JIS
23619 Recognize JIS characters.
23620 @item C-SJIS
23621 Recognize SJIS characters.
23622 @item C-EUCJP
23623 Recognize EUCJP characters.
23624 @end table
23626 If @env{LANG} is not defined, or if it has some other value, then the
23627 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23628 recognize and translate multibyte characters.
23629 @end table
23631 @noindent
23632 Some additional environment variables affect the behavior of the
23633 preprocessor.
23635 @include cppenv.texi
23637 @c man end
23639 @node Precompiled Headers
23640 @section Using Precompiled Headers
23641 @cindex precompiled headers
23642 @cindex speed of compilation
23644 Often large projects have many header files that are included in every
23645 source file.  The time the compiler takes to process these header files
23646 over and over again can account for nearly all of the time required to
23647 build the project.  To make builds faster, GCC allows you to
23648 @dfn{precompile} a header file.
23650 To create a precompiled header file, simply compile it as you would any
23651 other file, if necessary using the @option{-x} option to make the driver
23652 treat it as a C or C++ header file.  You may want to use a
23653 tool like @command{make} to keep the precompiled header up-to-date when
23654 the headers it contains change.
23656 A precompiled header file is searched for when @code{#include} is
23657 seen in the compilation.  As it searches for the included file
23658 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23659 compiler looks for a precompiled header in each directory just before it
23660 looks for the include file in that directory.  The name searched for is
23661 the name specified in the @code{#include} with @samp{.gch} appended.  If
23662 the precompiled header file can't be used, it is ignored.
23664 For instance, if you have @code{#include "all.h"}, and you have
23665 @file{all.h.gch} in the same directory as @file{all.h}, then the
23666 precompiled header file is used if possible, and the original
23667 header is used otherwise.
23669 Alternatively, you might decide to put the precompiled header file in a
23670 directory and use @option{-I} to ensure that directory is searched
23671 before (or instead of) the directory containing the original header.
23672 Then, if you want to check that the precompiled header file is always
23673 used, you can put a file of the same name as the original header in this
23674 directory containing an @code{#error} command.
23676 This also works with @option{-include}.  So yet another way to use
23677 precompiled headers, good for projects not designed with precompiled
23678 header files in mind, is to simply take most of the header files used by
23679 a project, include them from another header file, precompile that header
23680 file, and @option{-include} the precompiled header.  If the header files
23681 have guards against multiple inclusion, they are skipped because
23682 they've already been included (in the precompiled header).
23684 If you need to precompile the same header file for different
23685 languages, targets, or compiler options, you can instead make a
23686 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23687 header in the directory, perhaps using @option{-o}.  It doesn't matter
23688 what you call the files in the directory; every precompiled header in
23689 the directory is considered.  The first precompiled header
23690 encountered in the directory that is valid for this compilation is
23691 used; they're searched in no particular order.
23693 There are many other possibilities, limited only by your imagination,
23694 good sense, and the constraints of your build system.
23696 A precompiled header file can be used only when these conditions apply:
23698 @itemize
23699 @item
23700 Only one precompiled header can be used in a particular compilation.
23702 @item
23703 A precompiled header can't be used once the first C token is seen.  You
23704 can have preprocessor directives before a precompiled header; you cannot
23705 include a precompiled header from inside another header.
23707 @item
23708 The precompiled header file must be produced for the same language as
23709 the current compilation.  You can't use a C precompiled header for a C++
23710 compilation.
23712 @item
23713 The precompiled header file must have been produced by the same compiler
23714 binary as the current compilation is using.
23716 @item
23717 Any macros defined before the precompiled header is included must
23718 either be defined in the same way as when the precompiled header was
23719 generated, or must not affect the precompiled header, which usually
23720 means that they don't appear in the precompiled header at all.
23722 The @option{-D} option is one way to define a macro before a
23723 precompiled header is included; using a @code{#define} can also do it.
23724 There are also some options that define macros implicitly, like
23725 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23726 defined this way.
23728 @item If debugging information is output when using the precompiled
23729 header, using @option{-g} or similar, the same kind of debugging information
23730 must have been output when building the precompiled header.  However,
23731 a precompiled header built using @option{-g} can be used in a compilation
23732 when no debugging information is being output.
23734 @item The same @option{-m} options must generally be used when building
23735 and using the precompiled header.  @xref{Submodel Options},
23736 for any cases where this rule is relaxed.
23738 @item Each of the following options must be the same when building and using
23739 the precompiled header:
23741 @gccoptlist{-fexceptions}
23743 @item
23744 Some other command-line options starting with @option{-f},
23745 @option{-p}, or @option{-O} must be defined in the same way as when
23746 the precompiled header was generated.  At present, it's not clear
23747 which options are safe to change and which are not; the safest choice
23748 is to use exactly the same options when generating and using the
23749 precompiled header.  The following are known to be safe:
23751 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23752 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23753 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23754 -pedantic-errors}
23756 @end itemize
23758 For all of these except the last, the compiler automatically
23759 ignores the precompiled header if the conditions aren't met.  If you
23760 find an option combination that doesn't work and doesn't cause the
23761 precompiled header to be ignored, please consider filing a bug report,
23762 see @ref{Bugs}.
23764 If you do use differing options when generating and using the
23765 precompiled header, the actual behavior is a mixture of the
23766 behavior for the options.  For instance, if you use @option{-g} to
23767 generate the precompiled header but not when using it, you may or may
23768 not get debugging information for routines in the precompiled header.