2015-01-02 Sandra Loosemore <sandra@codesourcery.com>
[official-gcc.git] / gcc / doc / invoke.texi
blob1b3f1d6d50457e259a953b9537103c652f4dc83a
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 -devirtualize-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.
1945 @item -fplan9-extensions
1946 Accept some non-standard constructs used in Plan 9 code.
1948 This enables @option{-fms-extensions}, permits passing pointers to
1949 structures with anonymous fields to functions that expect pointers to
1950 elements of the type of the field, and permits referring to anonymous
1951 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1952 struct/union fields within structs/unions}, for details.  This is only
1953 supported for C, not C++.
1955 @item -trigraphs
1956 @opindex trigraphs
1957 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1958 options for strict ISO C conformance) implies @option{-trigraphs}.
1960 @cindex traditional C language
1961 @cindex C language, traditional
1962 @item -traditional
1963 @itemx -traditional-cpp
1964 @opindex traditional-cpp
1965 @opindex traditional
1966 Formerly, these options caused GCC to attempt to emulate a pre-standard
1967 C compiler.  They are now only supported with the @option{-E} switch.
1968 The preprocessor continues to support a pre-standard mode.  See the GNU
1969 CPP manual for details.
1971 @item -fcond-mismatch
1972 @opindex fcond-mismatch
1973 Allow conditional expressions with mismatched types in the second and
1974 third arguments.  The value of such an expression is void.  This option
1975 is not supported for C++.
1977 @item -flax-vector-conversions
1978 @opindex flax-vector-conversions
1979 Allow implicit conversions between vectors with differing numbers of
1980 elements and/or incompatible element types.  This option should not be
1981 used for new code.
1983 @item -funsigned-char
1984 @opindex funsigned-char
1985 Let the type @code{char} be unsigned, like @code{unsigned char}.
1987 Each kind of machine has a default for what @code{char} should
1988 be.  It is either like @code{unsigned char} by default or like
1989 @code{signed char} by default.
1991 Ideally, a portable program should always use @code{signed char} or
1992 @code{unsigned char} when it depends on the signedness of an object.
1993 But many programs have been written to use plain @code{char} and
1994 expect it to be signed, or expect it to be unsigned, depending on the
1995 machines they were written for.  This option, and its inverse, let you
1996 make such a program work with the opposite default.
1998 The type @code{char} is always a distinct type from each of
1999 @code{signed char} or @code{unsigned char}, even though its behavior
2000 is always just like one of those two.
2002 @item -fsigned-char
2003 @opindex fsigned-char
2004 Let the type @code{char} be signed, like @code{signed char}.
2006 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2007 the negative form of @option{-funsigned-char}.  Likewise, the option
2008 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2010 @item -fsigned-bitfields
2011 @itemx -funsigned-bitfields
2012 @itemx -fno-signed-bitfields
2013 @itemx -fno-unsigned-bitfields
2014 @opindex fsigned-bitfields
2015 @opindex funsigned-bitfields
2016 @opindex fno-signed-bitfields
2017 @opindex fno-unsigned-bitfields
2018 These options control whether a bit-field is signed or unsigned, when the
2019 declaration does not use either @code{signed} or @code{unsigned}.  By
2020 default, such a bit-field is signed, because this is consistent: the
2021 basic integer types such as @code{int} are signed types.
2022 @end table
2024 @node C++ Dialect Options
2025 @section Options Controlling C++ Dialect
2027 @cindex compiler options, C++
2028 @cindex C++ options, command-line
2029 @cindex options, C++
2030 This section describes the command-line options that are only meaningful
2031 for C++ programs.  You can also use most of the GNU compiler options
2032 regardless of what language your program is in.  For example, you
2033 might compile a file @code{firstClass.C} like this:
2035 @smallexample
2036 g++ -g -frepo -O -c firstClass.C
2037 @end smallexample
2039 @noindent
2040 In this example, only @option{-frepo} is an option meant
2041 only for C++ programs; you can use the other options with any
2042 language supported by GCC@.
2044 Here is a list of options that are @emph{only} for compiling C++ programs:
2046 @table @gcctabopt
2048 @item -fabi-version=@var{n}
2049 @opindex fabi-version
2050 Use version @var{n} of the C++ ABI@.  The default is version 0.
2052 Version 0 refers to the version conforming most closely to
2053 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2054 will change in different versions of G++ as ABI bugs are fixed.
2056 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2058 Version 2 is the version of the C++ ABI that first appeared in G++
2059 3.4, and was the default through G++ 4.9.
2061 Version 3 corrects an error in mangling a constant address as a
2062 template argument.
2064 Version 4, which first appeared in G++ 4.5, implements a standard
2065 mangling for vector types.
2067 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2068 attribute const/volatile on function pointer types, decltype of a
2069 plain decl, and use of a function parameter in the declaration of
2070 another parameter.
2072 Version 6, which first appeared in G++ 4.7, corrects the promotion
2073 behavior of C++11 scoped enums and the mangling of template argument
2074 packs, const/static_cast, prefix ++ and --, and a class scope function
2075 used as a template argument.
2077 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2078 builtin type and corrects the mangling of lambdas in default argument
2079 scope.
2081 Version 8, which first appeared in G++ 4.9, corrects the substitution
2082 behavior of function types with function-cv-qualifiers.
2084 See also @option{-Wabi}.
2086 @item -fabi-compat-version=@var{n}
2087 @opindex fabi-compat-version
2088 Starting with GCC 4.5, on targets that support strong aliases, G++
2089 works around mangling changes by creating an alias with the correct
2090 mangled name when defining a symbol with an incorrect mangled name.
2091 This switch specifies which ABI version to use for the alias.
2093 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2094 another ABI version is explicitly selected, this defaults to 0.
2096 The compatibility version is also set by @option{-Wabi=@var{n}}.
2098 @item -fno-access-control
2099 @opindex fno-access-control
2100 Turn off all access checking.  This switch is mainly useful for working
2101 around bugs in the access control code.
2103 @item -fcheck-new
2104 @opindex fcheck-new
2105 Check that the pointer returned by @code{operator new} is non-null
2106 before attempting to modify the storage allocated.  This check is
2107 normally unnecessary because the C++ standard specifies that
2108 @code{operator new} only returns @code{0} if it is declared
2109 @samp{throw()}, in which case the compiler always checks the
2110 return value even without this option.  In all other cases, when
2111 @code{operator new} has a non-empty exception specification, memory
2112 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2113 @samp{new (nothrow)}.
2115 @item -fconstexpr-depth=@var{n}
2116 @opindex fconstexpr-depth
2117 Set the maximum nested evaluation depth for C++11 constexpr functions
2118 to @var{n}.  A limit is needed to detect endless recursion during
2119 constant expression evaluation.  The minimum specified by the standard
2120 is 512.
2122 @item -fdeduce-init-list
2123 @opindex fdeduce-init-list
2124 Enable deduction of a template type parameter as
2125 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2127 @smallexample
2128 template <class T> auto forward(T t) -> decltype (realfn (t))
2130   return realfn (t);
2133 void f()
2135   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2137 @end smallexample
2139 This deduction was implemented as a possible extension to the
2140 originally proposed semantics for the C++11 standard, but was not part
2141 of the final standard, so it is disabled by default.  This option is
2142 deprecated, and may be removed in a future version of G++.
2144 @item -ffriend-injection
2145 @opindex ffriend-injection
2146 Inject friend functions into the enclosing namespace, so that they are
2147 visible outside the scope of the class in which they are declared.
2148 Friend functions were documented to work this way in the old Annotated
2149 C++ Reference Manual, and versions of G++ before 4.1 always worked
2150 that way.  However, in ISO C++ a friend function that is not declared
2151 in an enclosing scope can only be found using argument dependent
2152 lookup.  This option causes friends to be injected as they were in
2153 earlier releases.
2155 This option is for compatibility, and may be removed in a future
2156 release of G++.
2158 @item -fno-elide-constructors
2159 @opindex fno-elide-constructors
2160 The C++ standard allows an implementation to omit creating a temporary
2161 that is only used to initialize another object of the same type.
2162 Specifying this option disables that optimization, and forces G++ to
2163 call the copy constructor in all cases.
2165 @item -fno-enforce-eh-specs
2166 @opindex fno-enforce-eh-specs
2167 Don't generate code to check for violation of exception specifications
2168 at run time.  This option violates the C++ standard, but may be useful
2169 for reducing code size in production builds, much like defining
2170 @samp{NDEBUG}.  This does not give user code permission to throw
2171 exceptions in violation of the exception specifications; the compiler
2172 still optimizes based on the specifications, so throwing an
2173 unexpected exception results in undefined behavior at run time.
2175 @item -fextern-tls-init
2176 @itemx -fno-extern-tls-init
2177 @opindex fextern-tls-init
2178 @opindex fno-extern-tls-init
2179 The C++11 and OpenMP standards allow @samp{thread_local} and
2180 @samp{threadprivate} variables to have dynamic (runtime)
2181 initialization.  To support this, any use of such a variable goes
2182 through a wrapper function that performs any necessary initialization.
2183 When the use and definition of the variable are in the same
2184 translation unit, this overhead can be optimized away, but when the
2185 use is in a different translation unit there is significant overhead
2186 even if the variable doesn't actually need dynamic initialization.  If
2187 the programmer can be sure that no use of the variable in a
2188 non-defining TU needs to trigger dynamic initialization (either
2189 because the variable is statically initialized, or a use of the
2190 variable in the defining TU will be executed before any uses in
2191 another TU), they can avoid this overhead with the
2192 @option{-fno-extern-tls-init} option.
2194 On targets that support symbol aliases, the default is
2195 @option{-fextern-tls-init}.  On targets that do not support symbol
2196 aliases, the default is @option{-fno-extern-tls-init}.
2198 @item -ffor-scope
2199 @itemx -fno-for-scope
2200 @opindex ffor-scope
2201 @opindex fno-for-scope
2202 If @option{-ffor-scope} is specified, the scope of variables declared in
2203 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2204 as specified by the C++ standard.
2205 If @option{-fno-for-scope} is specified, the scope of variables declared in
2206 a @i{for-init-statement} extends to the end of the enclosing scope,
2207 as was the case in old versions of G++, and other (traditional)
2208 implementations of C++.
2210 If neither flag is given, the default is to follow the standard,
2211 but to allow and give a warning for old-style code that would
2212 otherwise be invalid, or have different behavior.
2214 @item -fno-gnu-keywords
2215 @opindex fno-gnu-keywords
2216 Do not recognize @code{typeof} as a keyword, so that code can use this
2217 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2218 @option{-ansi} implies @option{-fno-gnu-keywords}.
2220 @item -fno-implicit-templates
2221 @opindex fno-implicit-templates
2222 Never emit code for non-inline templates that are instantiated
2223 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2224 @xref{Template Instantiation}, for more information.
2226 @item -fno-implicit-inline-templates
2227 @opindex fno-implicit-inline-templates
2228 Don't emit code for implicit instantiations of inline templates, either.
2229 The default is to handle inlines differently so that compiles with and
2230 without optimization need the same set of explicit instantiations.
2232 @item -fno-implement-inlines
2233 @opindex fno-implement-inlines
2234 To save space, do not emit out-of-line copies of inline functions
2235 controlled by @samp{#pragma implementation}.  This causes linker
2236 errors if these functions are not inlined everywhere they are called.
2238 @item -fms-extensions
2239 @opindex fms-extensions
2240 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2241 int and getting a pointer to member function via non-standard syntax.
2243 @item -fno-nonansi-builtins
2244 @opindex fno-nonansi-builtins
2245 Disable built-in declarations of functions that are not mandated by
2246 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2247 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2249 @item -fnothrow-opt
2250 @opindex fnothrow-opt
2251 Treat a @code{throw()} exception specification as if it were a
2252 @code{noexcept} specification to reduce or eliminate the text size
2253 overhead relative to a function with no exception specification.  If
2254 the function has local variables of types with non-trivial
2255 destructors, the exception specification actually makes the
2256 function smaller because the EH cleanups for those variables can be
2257 optimized away.  The semantic effect is that an exception thrown out of
2258 a function with such an exception specification results in a call
2259 to @code{terminate} rather than @code{unexpected}.
2261 @item -fno-operator-names
2262 @opindex fno-operator-names
2263 Do not treat the operator name keywords @code{and}, @code{bitand},
2264 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2265 synonyms as keywords.
2267 @item -fno-optional-diags
2268 @opindex fno-optional-diags
2269 Disable diagnostics that the standard says a compiler does not need to
2270 issue.  Currently, the only such diagnostic issued by G++ is the one for
2271 a name having multiple meanings within a class.
2273 @item -fpermissive
2274 @opindex fpermissive
2275 Downgrade some diagnostics about nonconformant code from errors to
2276 warnings.  Thus, using @option{-fpermissive} allows some
2277 nonconforming code to compile.
2279 @item -fno-pretty-templates
2280 @opindex fno-pretty-templates
2281 When an error message refers to a specialization of a function
2282 template, the compiler normally prints the signature of the
2283 template followed by the template arguments and any typedefs or
2284 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2285 rather than @code{void f(int)}) so that it's clear which template is
2286 involved.  When an error message refers to a specialization of a class
2287 template, the compiler omits any template arguments that match
2288 the default template arguments for that template.  If either of these
2289 behaviors make it harder to understand the error message rather than
2290 easier, you can use @option{-fno-pretty-templates} to disable them.
2292 @item -frepo
2293 @opindex frepo
2294 Enable automatic template instantiation at link time.  This option also
2295 implies @option{-fno-implicit-templates}.  @xref{Template
2296 Instantiation}, for more information.
2298 @item -fno-rtti
2299 @opindex fno-rtti
2300 Disable generation of information about every class with virtual
2301 functions for use by the C++ run-time type identification features
2302 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2303 of the language, you can save some space by using this flag.  Note that
2304 exception handling uses the same information, but G++ generates it as
2305 needed. The @samp{dynamic_cast} operator can still be used for casts that
2306 do not require run-time type information, i.e.@: casts to @code{void *} or to
2307 unambiguous base classes.
2309 @item -fsized-deallocation
2310 @opindex fsized-deallocation
2311 Enable the built-in global declarations
2312 @smallexample
2313 void operator delete (void *, std::size_t) noexcept;
2314 void operator delete[] (void *, std::size_t) noexcept;
2315 @end smallexample
2316 as introduced in C++14.  This is useful for user-defined replacement
2317 deallocation functions that, for example, use the size of the object
2318 to make deallocation faster.  Enabled by default under
2319 @samp{-std=c++14} and above.  The flag @option{-Wsized-deallocation} will
2320 warn about places that might want to add a definition.
2322 @item -fstats
2323 @opindex fstats
2324 Emit statistics about front-end processing at the end of the compilation.
2325 This information is generally only useful to the G++ development team.
2327 @item -fstrict-enums
2328 @opindex fstrict-enums
2329 Allow the compiler to optimize using the assumption that a value of
2330 enumerated type can only be one of the values of the enumeration (as
2331 defined in the C++ standard; basically, a value that can be
2332 represented in the minimum number of bits needed to represent all the
2333 enumerators).  This assumption may not be valid if the program uses a
2334 cast to convert an arbitrary integer value to the enumerated type.
2336 @item -ftemplate-backtrace-limit=@var{n}
2337 @opindex ftemplate-backtrace-limit
2338 Set the maximum number of template instantiation notes for a single
2339 warning or error to @var{n}.  The default value is 10.
2341 @item -ftemplate-depth=@var{n}
2342 @opindex ftemplate-depth
2343 Set the maximum instantiation depth for template classes to @var{n}.
2344 A limit on the template instantiation depth is needed to detect
2345 endless recursions during template class instantiation.  ANSI/ISO C++
2346 conforming programs must not rely on a maximum depth greater than 17
2347 (changed to 1024 in C++11).  The default value is 900, as the compiler
2348 can run out of stack space before hitting 1024 in some situations.
2350 @item -fno-threadsafe-statics
2351 @opindex fno-threadsafe-statics
2352 Do not emit the extra code to use the routines specified in the C++
2353 ABI for thread-safe initialization of local statics.  You can use this
2354 option to reduce code size slightly in code that doesn't need to be
2355 thread-safe.
2357 @item -fuse-cxa-atexit
2358 @opindex fuse-cxa-atexit
2359 Register destructors for objects with static storage duration with the
2360 @code{__cxa_atexit} function rather than the @code{atexit} function.
2361 This option is required for fully standards-compliant handling of static
2362 destructors, but only works if your C library supports
2363 @code{__cxa_atexit}.
2365 @item -fno-use-cxa-get-exception-ptr
2366 @opindex fno-use-cxa-get-exception-ptr
2367 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2368 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2369 if the runtime routine is not available.
2371 @item -fvisibility-inlines-hidden
2372 @opindex fvisibility-inlines-hidden
2373 This switch declares that the user does not attempt to compare
2374 pointers to inline functions or methods where the addresses of the two functions
2375 are taken in different shared objects.
2377 The effect of this is that GCC may, effectively, mark inline methods with
2378 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2379 appear in the export table of a DSO and do not require a PLT indirection
2380 when used within the DSO@.  Enabling this option can have a dramatic effect
2381 on load and link times of a DSO as it massively reduces the size of the
2382 dynamic export table when the library makes heavy use of templates.
2384 The behavior of this switch is not quite the same as marking the
2385 methods as hidden directly, because it does not affect static variables
2386 local to the function or cause the compiler to deduce that
2387 the function is defined in only one shared object.
2389 You may mark a method as having a visibility explicitly to negate the
2390 effect of the switch for that method.  For example, if you do want to
2391 compare pointers to a particular inline method, you might mark it as
2392 having default visibility.  Marking the enclosing class with explicit
2393 visibility has no effect.
2395 Explicitly instantiated inline methods are unaffected by this option
2396 as their linkage might otherwise cross a shared library boundary.
2397 @xref{Template Instantiation}.
2399 @item -fvisibility-ms-compat
2400 @opindex fvisibility-ms-compat
2401 This flag attempts to use visibility settings to make GCC's C++
2402 linkage model compatible with that of Microsoft Visual Studio.
2404 The flag makes these changes to GCC's linkage model:
2406 @enumerate
2407 @item
2408 It sets the default visibility to @code{hidden}, like
2409 @option{-fvisibility=hidden}.
2411 @item
2412 Types, but not their members, are not hidden by default.
2414 @item
2415 The One Definition Rule is relaxed for types without explicit
2416 visibility specifications that are defined in more than one
2417 shared object: those declarations are permitted if they are
2418 permitted when this option is not used.
2419 @end enumerate
2421 In new code it is better to use @option{-fvisibility=hidden} and
2422 export those classes that are intended to be externally visible.
2423 Unfortunately it is possible for code to rely, perhaps accidentally,
2424 on the Visual Studio behavior.
2426 Among the consequences of these changes are that static data members
2427 of the same type with the same name but defined in different shared
2428 objects are different, so changing one does not change the other;
2429 and that pointers to function members defined in different shared
2430 objects may not compare equal.  When this flag is given, it is a
2431 violation of the ODR to define types with the same name differently.
2433 @item -fvtable-verify=@var{std|preinit|none}
2434 @opindex fvtable-verify
2435 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2436 feature that verifies at runtime, for every virtual call that is made, that
2437 the vtable pointer through which the call is made is valid for the type of
2438 the object, and has not been corrupted or overwritten.  If an invalid vtable
2439 pointer is detected (at runtime), an error is reported and execution of the
2440 program is immediately halted.
2442 This option causes runtime data structures to be built, at program start up,
2443 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2444 control the timing of when these data structures are built.  In both cases the
2445 data structures are built before execution reaches 'main'.  The
2446 @option{-fvtable-verify=std} causes these data structure to be built after the
2447 shared libraries have been loaded and initialized.
2448 @option{-fvtable-verify=preinit} causes them to be built before the shared
2449 libraries have been loaded and initialized.
2451 If this option appears multiple times in the compiler line, with different
2452 values specified, 'none' will take highest priority over both 'std' and
2453 'preinit'; 'preinit' will take priority over 'std'.
2455 @item -fvtv-debug
2456 @opindex (fvtv-debug)
2457 Causes debug versions of the runtime functions for the vtable verification 
2458 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2459 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2460 compiler to keep track of which vtable pointers it found for each class, and
2461 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2462 file directory on the user's machine.
2464 Note:  This feature APPENDS data to the log file. If you want a fresh log
2465 file, be sure to delete any existing one.
2467 @item -fvtv-counts
2468 @opindex fvtv-counts
2469 This is a debugging flag.  When used in conjunction with
2470 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2471 causes the compiler to keep track of the total number of virtual calls
2472 it encountered and the number of verifications it inserted.  It also
2473 counts the number of calls to certain runtime library functions
2474 that it inserts.  This information, for each compilation unit, is written
2475 to a file named ``vtv_count_data.log'', in the dump_file directory on
2476 the user's machine.   It also counts the size of the vtable pointer sets
2477 for each class, and writes this information to ``vtv_class_set_sizes.log''
2478 in the same directory.
2480 Note:  This feature APPENDS data to the log files.  To get a fresh log
2481 files, be sure to delete any existing ones.
2483 @item -fno-weak
2484 @opindex fno-weak
2485 Do not use weak symbol support, even if it is provided by the linker.
2486 By default, G++ uses weak symbols if they are available.  This
2487 option exists only for testing, and should not be used by end-users;
2488 it results in inferior code and has no benefits.  This option may
2489 be removed in a future release of G++.
2491 @item -nostdinc++
2492 @opindex nostdinc++
2493 Do not search for header files in the standard directories specific to
2494 C++, but do still search the other standard directories.  (This option
2495 is used when building the C++ library.)
2496 @end table
2498 In addition, these optimization, warning, and code generation options
2499 have meanings only for C++ programs:
2501 @table @gcctabopt
2502 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2503 @opindex Wabi
2504 @opindex Wno-abi
2505 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2506 G++ to warn when it generates code that is probably not compatible with the
2507 vendor-neutral C++ ABI@.  Since G++ now defaults to
2508 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2509 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2510 or an older compatibility version is selected (with
2511 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2513 Although an effort has been made to warn about
2514 all such cases, there are probably some cases that are not warned about,
2515 even though G++ is generating incompatible code.  There may also be
2516 cases where warnings are emitted even though the code that is generated
2517 is compatible.
2519 You should rewrite your code to avoid these warnings if you are
2520 concerned about the fact that code generated by G++ may not be binary
2521 compatible with code generated by other compilers.
2523 @option{-Wabi} can also be used with an explicit version number to
2524 warn about compatibility with a particular @option{-fabi-version}
2525 level, e.g. @option{-Wabi=2} to warn about changes relative to
2526 @option{-fabi-version=2}.  Specifying a version number also sets
2527 @option{-fabi-compat-version=@var{n}}.
2529 The known incompatibilities in @option{-fabi-version=2} (which was the
2530 default from GCC 3.4 to 4.9) include:
2532 @itemize @bullet
2534 @item
2535 A template with a non-type template parameter of reference type was
2536 mangled incorrectly:
2537 @smallexample
2538 extern int N;
2539 template <int &> struct S @{@};
2540 void n (S<N>) @{2@}
2541 @end smallexample
2543 This was fixed in @option{-fabi-version=3}.
2545 @item
2546 SIMD vector types declared using @code{__attribute ((vector_size))} were
2547 mangled in a non-standard way that does not allow for overloading of
2548 functions taking vectors of different sizes.
2550 The mangling was changed in @option{-fabi-version=4}.
2552 @item
2553 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2554 qualifiers, and @code{decltype} of a plain declaration was folded away.
2556 These mangling issues were fixed in @option{-fabi-version=5}.
2558 @item
2559 Scoped enumerators passed as arguments to a variadic function are
2560 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2561 On most targets this does not actually affect the parameter passing
2562 ABI, as there is no way to pass an argument smaller than @samp{int}.
2564 Also, the ABI changed the mangling of template argument packs,
2565 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2566 a class scope function used as a template argument.
2568 These issues were corrected in @option{-fabi-version=6}.
2570 @item
2571 Lambdas in default argument scope were mangled incorrectly, and the
2572 ABI changed the mangling of nullptr_t.
2574 These issues were corrected in @option{-fabi-version=7}.
2576 @item
2577 When mangling a function type with function-cv-qualifiers, the
2578 un-qualified function type was incorrectly treated as a substitution
2579 candidate.
2581 This was fixed in @option{-fabi-version=8}.
2582 @end itemize
2584 It also warns about psABI-related changes.  The known psABI changes at this
2585 point include:
2587 @itemize @bullet
2589 @item
2590 For SysV/x86-64, unions with @code{long double} members are 
2591 passed in memory as specified in psABI.  For example:
2593 @smallexample
2594 union U @{
2595   long double ld;
2596   int i;
2598 @end smallexample
2600 @noindent
2601 @code{union U} is always passed in memory.
2603 @end itemize
2605 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2606 @opindex Wctor-dtor-privacy
2607 @opindex Wno-ctor-dtor-privacy
2608 Warn when a class seems unusable because all the constructors or
2609 destructors in that class are private, and it has neither friends nor
2610 public static member functions.  Also warn if there are no non-private
2611 methods, and there's at least one private member function that isn't
2612 a constructor or destructor.
2614 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2615 @opindex Wdelete-non-virtual-dtor
2616 @opindex Wno-delete-non-virtual-dtor
2617 Warn when @samp{delete} is used to destroy an instance of a class that
2618 has virtual functions and non-virtual destructor. It is unsafe to delete
2619 an instance of a derived class through a pointer to a base class if the
2620 base class does not have a virtual destructor.  This warning is enabled
2621 by @option{-Wall}.
2623 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2624 @opindex Wliteral-suffix
2625 @opindex Wno-literal-suffix
2626 Warn when a string or character literal is followed by a ud-suffix which does
2627 not begin with an underscore.  As a conforming extension, GCC treats such
2628 suffixes as separate preprocessing tokens in order to maintain backwards
2629 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2630 For example:
2632 @smallexample
2633 #define __STDC_FORMAT_MACROS
2634 #include <inttypes.h>
2635 #include <stdio.h>
2637 int main() @{
2638   int64_t i64 = 123;
2639   printf("My int64: %"PRId64"\n", i64);
2641 @end smallexample
2643 In this case, @code{PRId64} is treated as a separate preprocessing token.
2645 This warning is enabled by default.
2647 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2648 @opindex Wnarrowing
2649 @opindex Wno-narrowing
2650 Warn when a narrowing conversion prohibited by C++11 occurs within
2651 @samp{@{ @}}, e.g.
2653 @smallexample
2654 int i = @{ 2.2 @}; // error: narrowing from double to int
2655 @end smallexample
2657 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2659 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2660 non-constants the diagnostic required by the standard.  Note that this
2661 does not affect the meaning of well-formed code; narrowing conversions
2662 are still considered ill-formed in SFINAE context.
2664 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2665 @opindex Wnoexcept
2666 @opindex Wno-noexcept
2667 Warn when a noexcept-expression evaluates to false because of a call
2668 to a function that does not have a non-throwing exception
2669 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2670 the compiler to never throw an exception.
2672 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2673 @opindex Wnon-virtual-dtor
2674 @opindex Wno-non-virtual-dtor
2675 Warn when a class has virtual functions and an accessible non-virtual
2676 destructor itself or in an accessible polymorphic base class, in which
2677 case it is possible but unsafe to delete an instance of a derived
2678 class through a pointer to the class itself or base class.  This
2679 warning is automatically enabled if @option{-Weffc++} is specified.
2681 @item -Wreorder @r{(C++ and Objective-C++ only)}
2682 @opindex Wreorder
2683 @opindex Wno-reorder
2684 @cindex reordering, warning
2685 @cindex warning for reordering of member initializers
2686 Warn when the order of member initializers given in the code does not
2687 match the order in which they must be executed.  For instance:
2689 @smallexample
2690 struct A @{
2691   int i;
2692   int j;
2693   A(): j (0), i (1) @{ @}
2695 @end smallexample
2697 @noindent
2698 The compiler rearranges the member initializers for @samp{i}
2699 and @samp{j} to match the declaration order of the members, emitting
2700 a warning to that effect.  This warning is enabled by @option{-Wall}.
2702 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2703 @opindex fext-numeric-literals
2704 @opindex fno-ext-numeric-literals
2705 Accept imaginary, fixed-point, or machine-defined
2706 literal number suffixes as GNU extensions.
2707 When this option is turned off these suffixes are treated
2708 as C++11 user-defined literal numeric suffixes.
2709 This is on by default for all pre-C++11 dialects and all GNU dialects:
2710 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2711 @option{-std=gnu++14}.
2712 This option is off by default
2713 for ISO C++11 onwards (@option{-std=c++11}, ...).
2714 @end table
2716 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2718 @table @gcctabopt
2719 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2720 @opindex Weffc++
2721 @opindex Wno-effc++
2722 Warn about violations of the following style guidelines from Scott Meyers'
2723 @cite{Effective C++} series of books:
2725 @itemize @bullet
2726 @item
2727 Define a copy constructor and an assignment operator for classes
2728 with dynamically-allocated memory.
2730 @item
2731 Prefer initialization to assignment in constructors.
2733 @item
2734 Have @code{operator=} return a reference to @code{*this}.
2736 @item
2737 Don't try to return a reference when you must return an object.
2739 @item
2740 Distinguish between prefix and postfix forms of increment and
2741 decrement operators.
2743 @item
2744 Never overload @code{&&}, @code{||}, or @code{,}.
2746 @end itemize
2748 This option also enables @option{-Wnon-virtual-dtor}, which is also
2749 one of the effective C++ recommendations.  However, the check is
2750 extended to warn about the lack of virtual destructor in accessible
2751 non-polymorphic bases classes too.
2753 When selecting this option, be aware that the standard library
2754 headers do not obey all of these guidelines; use @samp{grep -v}
2755 to filter out those warnings.
2757 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2758 @opindex Wstrict-null-sentinel
2759 @opindex Wno-strict-null-sentinel
2760 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2761 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2762 to @code{__null}.  Although it is a null pointer constant rather than a
2763 null pointer, it is guaranteed to be of the same size as a pointer.
2764 But this use is not portable across different compilers.
2766 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2767 @opindex Wno-non-template-friend
2768 @opindex Wnon-template-friend
2769 Disable warnings when non-templatized friend functions are declared
2770 within a template.  Since the advent of explicit template specification
2771 support in G++, if the name of the friend is an unqualified-id (i.e.,
2772 @samp{friend foo(int)}), the C++ language specification demands that the
2773 friend declare or define an ordinary, nontemplate function.  (Section
2774 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2775 could be interpreted as a particular specialization of a templatized
2776 function.  Because this non-conforming behavior is no longer the default
2777 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2778 check existing code for potential trouble spots and is on by default.
2779 This new compiler behavior can be turned off with
2780 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2781 but disables the helpful warning.
2783 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2784 @opindex Wold-style-cast
2785 @opindex Wno-old-style-cast
2786 Warn if an old-style (C-style) cast to a non-void type is used within
2787 a C++ program.  The new-style casts (@samp{dynamic_cast},
2788 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2789 less vulnerable to unintended effects and much easier to search for.
2791 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2792 @opindex Woverloaded-virtual
2793 @opindex Wno-overloaded-virtual
2794 @cindex overloaded virtual function, warning
2795 @cindex warning for overloaded virtual function
2796 Warn when a function declaration hides virtual functions from a
2797 base class.  For example, in:
2799 @smallexample
2800 struct A @{
2801   virtual void f();
2804 struct B: public A @{
2805   void f(int);
2807 @end smallexample
2809 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2810 like:
2812 @smallexample
2813 B* b;
2814 b->f();
2815 @end smallexample
2817 @noindent
2818 fails to compile.
2820 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2821 @opindex Wno-pmf-conversions
2822 @opindex Wpmf-conversions
2823 Disable the diagnostic for converting a bound pointer to member function
2824 to a plain pointer.
2826 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2827 @opindex Wsign-promo
2828 @opindex Wno-sign-promo
2829 Warn when overload resolution chooses a promotion from unsigned or
2830 enumerated type to a signed type, over a conversion to an unsigned type of
2831 the same size.  Previous versions of G++ tried to preserve
2832 unsignedness, but the standard mandates the current behavior.
2833 @end table
2835 @node Objective-C and Objective-C++ Dialect Options
2836 @section Options Controlling Objective-C and Objective-C++ Dialects
2838 @cindex compiler options, Objective-C and Objective-C++
2839 @cindex Objective-C and Objective-C++ options, command-line
2840 @cindex options, Objective-C and Objective-C++
2841 (NOTE: This manual does not describe the Objective-C and Objective-C++
2842 languages themselves.  @xref{Standards,,Language Standards
2843 Supported by GCC}, for references.)
2845 This section describes the command-line options that are only meaningful
2846 for Objective-C and Objective-C++ programs.  You can also use most of
2847 the language-independent GNU compiler options.
2848 For example, you might compile a file @code{some_class.m} like this:
2850 @smallexample
2851 gcc -g -fgnu-runtime -O -c some_class.m
2852 @end smallexample
2854 @noindent
2855 In this example, @option{-fgnu-runtime} is an option meant only for
2856 Objective-C and Objective-C++ programs; you can use the other options with
2857 any language supported by GCC@.
2859 Note that since Objective-C is an extension of the C language, Objective-C
2860 compilations may also use options specific to the C front-end (e.g.,
2861 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2862 C++-specific options (e.g., @option{-Wabi}).
2864 Here is a list of options that are @emph{only} for compiling Objective-C
2865 and Objective-C++ programs:
2867 @table @gcctabopt
2868 @item -fconstant-string-class=@var{class-name}
2869 @opindex fconstant-string-class
2870 Use @var{class-name} as the name of the class to instantiate for each
2871 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2872 class name is @code{NXConstantString} if the GNU runtime is being used, and
2873 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2874 @option{-fconstant-cfstrings} option, if also present, overrides the
2875 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2876 to be laid out as constant CoreFoundation strings.
2878 @item -fgnu-runtime
2879 @opindex fgnu-runtime
2880 Generate object code compatible with the standard GNU Objective-C
2881 runtime.  This is the default for most types of systems.
2883 @item -fnext-runtime
2884 @opindex fnext-runtime
2885 Generate output compatible with the NeXT runtime.  This is the default
2886 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2887 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2888 used.
2890 @item -fno-nil-receivers
2891 @opindex fno-nil-receivers
2892 Assume that all Objective-C message dispatches (@code{[receiver
2893 message:arg]}) in this translation unit ensure that the receiver is
2894 not @code{nil}.  This allows for more efficient entry points in the
2895 runtime to be used.  This option is only available in conjunction with
2896 the NeXT runtime and ABI version 0 or 1.
2898 @item -fobjc-abi-version=@var{n}
2899 @opindex fobjc-abi-version
2900 Use version @var{n} of the Objective-C ABI for the selected runtime.
2901 This option is currently supported only for the NeXT runtime.  In that
2902 case, Version 0 is the traditional (32-bit) ABI without support for
2903 properties and other Objective-C 2.0 additions.  Version 1 is the
2904 traditional (32-bit) ABI with support for properties and other
2905 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2906 nothing is specified, the default is Version 0 on 32-bit target
2907 machines, and Version 2 on 64-bit target machines.
2909 @item -fobjc-call-cxx-cdtors
2910 @opindex fobjc-call-cxx-cdtors
2911 For each Objective-C class, check if any of its instance variables is a
2912 C++ object with a non-trivial default constructor.  If so, synthesize a
2913 special @code{- (id) .cxx_construct} instance method which runs
2914 non-trivial default constructors on any such instance variables, in order,
2915 and then return @code{self}.  Similarly, check if any instance variable
2916 is a C++ object with a non-trivial destructor, and if so, synthesize a
2917 special @code{- (void) .cxx_destruct} method which runs
2918 all such default destructors, in reverse order.
2920 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2921 methods thusly generated only operate on instance variables
2922 declared in the current Objective-C class, and not those inherited
2923 from superclasses.  It is the responsibility of the Objective-C
2924 runtime to invoke all such methods in an object's inheritance
2925 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2926 by the runtime immediately after a new object instance is allocated;
2927 the @code{- (void) .cxx_destruct} methods are invoked immediately
2928 before the runtime deallocates an object instance.
2930 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2931 support for invoking the @code{- (id) .cxx_construct} and
2932 @code{- (void) .cxx_destruct} methods.
2934 @item -fobjc-direct-dispatch
2935 @opindex fobjc-direct-dispatch
2936 Allow fast jumps to the message dispatcher.  On Darwin this is
2937 accomplished via the comm page.
2939 @item -fobjc-exceptions
2940 @opindex fobjc-exceptions
2941 Enable syntactic support for structured exception handling in
2942 Objective-C, similar to what is offered by C++ and Java.  This option
2943 is required to use the Objective-C keywords @code{@@try},
2944 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2945 @code{@@synchronized}.  This option is available with both the GNU
2946 runtime and the NeXT runtime (but not available in conjunction with
2947 the NeXT runtime on Mac OS X 10.2 and earlier).
2949 @item -fobjc-gc
2950 @opindex fobjc-gc
2951 Enable garbage collection (GC) in Objective-C and Objective-C++
2952 programs.  This option is only available with the NeXT runtime; the
2953 GNU runtime has a different garbage collection implementation that
2954 does not require special compiler flags.
2956 @item -fobjc-nilcheck
2957 @opindex fobjc-nilcheck
2958 For the NeXT runtime with version 2 of the ABI, check for a nil
2959 receiver in method invocations before doing the actual method call.
2960 This is the default and can be disabled using
2961 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2962 checked for nil in this way no matter what this flag is set to.
2963 Currently this flag does nothing when the GNU runtime, or an older
2964 version of the NeXT runtime ABI, is used.
2966 @item -fobjc-std=objc1
2967 @opindex fobjc-std
2968 Conform to the language syntax of Objective-C 1.0, the language
2969 recognized by GCC 4.0.  This only affects the Objective-C additions to
2970 the C/C++ language; it does not affect conformance to C/C++ standards,
2971 which is controlled by the separate C/C++ dialect option flags.  When
2972 this option is used with the Objective-C or Objective-C++ compiler,
2973 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2974 This is useful if you need to make sure that your Objective-C code can
2975 be compiled with older versions of GCC@.
2977 @item -freplace-objc-classes
2978 @opindex freplace-objc-classes
2979 Emit a special marker instructing @command{ld(1)} not to statically link in
2980 the resulting object file, and allow @command{dyld(1)} to load it in at
2981 run time instead.  This is used in conjunction with the Fix-and-Continue
2982 debugging mode, where the object file in question may be recompiled and
2983 dynamically reloaded in the course of program execution, without the need
2984 to restart the program itself.  Currently, Fix-and-Continue functionality
2985 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2986 and later.
2988 @item -fzero-link
2989 @opindex fzero-link
2990 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2991 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2992 compile time) with static class references that get initialized at load time,
2993 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2994 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2995 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2996 for individual class implementations to be modified during program execution.
2997 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2998 regardless of command-line options.
3000 @item -fno-local-ivars
3001 @opindex fno-local-ivars
3002 @opindex flocal-ivars
3003 By default instance variables in Objective-C can be accessed as if
3004 they were local variables from within the methods of the class they're
3005 declared in.  This can lead to shadowing between instance variables
3006 and other variables declared either locally inside a class method or
3007 globally with the same name.  Specifying the @option{-fno-local-ivars}
3008 flag disables this behavior thus avoiding variable shadowing issues.
3010 @item -fivar-visibility=@var{public|protected|private|package}
3011 @opindex fivar-visibility
3012 Set the default instance variable visibility to the specified option
3013 so that instance variables declared outside the scope of any access
3014 modifier directives default to the specified visibility.
3016 @item -gen-decls
3017 @opindex gen-decls
3018 Dump interface declarations for all classes seen in the source file to a
3019 file named @file{@var{sourcename}.decl}.
3021 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3022 @opindex Wassign-intercept
3023 @opindex Wno-assign-intercept
3024 Warn whenever an Objective-C assignment is being intercepted by the
3025 garbage collector.
3027 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3028 @opindex Wno-protocol
3029 @opindex Wprotocol
3030 If a class is declared to implement a protocol, a warning is issued for
3031 every method in the protocol that is not implemented by the class.  The
3032 default behavior is to issue a warning for every method not explicitly
3033 implemented in the class, even if a method implementation is inherited
3034 from the superclass.  If you use the @option{-Wno-protocol} option, then
3035 methods inherited from the superclass are considered to be implemented,
3036 and no warning is issued for them.
3038 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3039 @opindex Wselector
3040 @opindex Wno-selector
3041 Warn if multiple methods of different types for the same selector are
3042 found during compilation.  The check is performed on the list of methods
3043 in the final stage of compilation.  Additionally, a check is performed
3044 for each selector appearing in a @code{@@selector(@dots{})}
3045 expression, and a corresponding method for that selector has been found
3046 during compilation.  Because these checks scan the method table only at
3047 the end of compilation, these warnings are not produced if the final
3048 stage of compilation is not reached, for example because an error is
3049 found during compilation, or because the @option{-fsyntax-only} option is
3050 being used.
3052 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3053 @opindex Wstrict-selector-match
3054 @opindex Wno-strict-selector-match
3055 Warn if multiple methods with differing argument and/or return types are
3056 found for a given selector when attempting to send a message using this
3057 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3058 is off (which is the default behavior), the compiler omits such warnings
3059 if any differences found are confined to types that share the same size
3060 and alignment.
3062 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3063 @opindex Wundeclared-selector
3064 @opindex Wno-undeclared-selector
3065 Warn if a @code{@@selector(@dots{})} expression referring to an
3066 undeclared selector is found.  A selector is considered undeclared if no
3067 method with that name has been declared before the
3068 @code{@@selector(@dots{})} expression, either explicitly in an
3069 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3070 an @code{@@implementation} section.  This option always performs its
3071 checks as soon as a @code{@@selector(@dots{})} expression is found,
3072 while @option{-Wselector} only performs its checks in the final stage of
3073 compilation.  This also enforces the coding style convention
3074 that methods and selectors must be declared before being used.
3076 @item -print-objc-runtime-info
3077 @opindex print-objc-runtime-info
3078 Generate C header describing the largest structure that is passed by
3079 value, if any.
3081 @end table
3083 @node Language Independent Options
3084 @section Options to Control Diagnostic Messages Formatting
3085 @cindex options to control diagnostics formatting
3086 @cindex diagnostic messages
3087 @cindex message formatting
3089 Traditionally, diagnostic messages have been formatted irrespective of
3090 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3091 options described below
3092 to control the formatting algorithm for diagnostic messages, 
3093 e.g.@: how many characters per line, how often source location
3094 information should be reported.  Note that some language front ends may not
3095 honor these options.
3097 @table @gcctabopt
3098 @item -fmessage-length=@var{n}
3099 @opindex fmessage-length
3100 Try to format error messages so that they fit on lines of about
3101 @var{n} characters.  If @var{n} is zero, then no line-wrapping will be
3102 done; each error message will appear on a single line.  This is the
3103 default for all front ends.
3105 @item -fdiagnostics-show-location=once
3106 @opindex fdiagnostics-show-location
3107 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3108 reporter to emit source location information @emph{once}; that is, in
3109 case the message is too long to fit on a single physical line and has to
3110 be wrapped, the source location won't be emitted (as prefix) again,
3111 over and over, in subsequent continuation lines.  This is the default
3112 behavior.
3114 @item -fdiagnostics-show-location=every-line
3115 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3116 messages reporter to emit the same source location information (as
3117 prefix) for physical lines that result from the process of breaking
3118 a message which is too long to fit on a single line.
3120 @item -fdiagnostics-color[=@var{WHEN}]
3121 @itemx -fno-diagnostics-color
3122 @opindex fdiagnostics-color
3123 @cindex highlight, color, colour
3124 @vindex GCC_COLORS @r{environment variable}
3125 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3126 or @samp{auto}.  The default depends on how the compiler has been configured,
3127 it can be any of the above @var{WHEN} options or also @samp{never}
3128 if @env{GCC_COLORS} environment variable isn't present in the environment,
3129 and @samp{auto} otherwise.
3130 @samp{auto} means to use color only when the standard error is a terminal.
3131 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3132 aliases for @option{-fdiagnostics-color=always} and
3133 @option{-fdiagnostics-color=never}, respectively.
3135 The colors are defined by the environment variable @env{GCC_COLORS}.
3136 Its value is a colon-separated list of capabilities and Select Graphic
3137 Rendition (SGR) substrings. SGR commands are interpreted by the
3138 terminal or terminal emulator.  (See the section in the documentation
3139 of your text terminal for permitted values and their meanings as
3140 character attributes.)  These substring values are integers in decimal
3141 representation and can be concatenated with semicolons.
3142 Common values to concatenate include
3143 @samp{1} for bold,
3144 @samp{4} for underline,
3145 @samp{5} for blink,
3146 @samp{7} for inverse,
3147 @samp{39} for default foreground color,
3148 @samp{30} to @samp{37} for foreground colors,
3149 @samp{90} to @samp{97} for 16-color mode foreground colors,
3150 @samp{38;5;0} to @samp{38;5;255}
3151 for 88-color and 256-color modes foreground colors,
3152 @samp{49} for default background color,
3153 @samp{40} to @samp{47} for background colors,
3154 @samp{100} to @samp{107} for 16-color mode background colors,
3155 and @samp{48;5;0} to @samp{48;5;255}
3156 for 88-color and 256-color modes background colors.
3158 The default @env{GCC_COLORS} is
3159 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3160 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3161 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3162 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3163 string disables colors.
3164 Supported capabilities are as follows.
3166 @table @code
3167 @item error=
3168 @vindex error GCC_COLORS @r{capability}
3169 SGR substring for error: markers.
3171 @item warning=
3172 @vindex warning GCC_COLORS @r{capability}
3173 SGR substring for warning: markers.
3175 @item note=
3176 @vindex note GCC_COLORS @r{capability}
3177 SGR substring for note: markers.
3179 @item caret=
3180 @vindex caret GCC_COLORS @r{capability}
3181 SGR substring for caret line.
3183 @item locus=
3184 @vindex locus GCC_COLORS @r{capability}
3185 SGR substring for location information, @samp{file:line} or
3186 @samp{file:line:column} etc.
3188 @item quote=
3189 @vindex quote GCC_COLORS @r{capability}
3190 SGR substring for information printed within quotes.
3191 @end table
3193 @item -fno-diagnostics-show-option
3194 @opindex fno-diagnostics-show-option
3195 @opindex fdiagnostics-show-option
3196 By default, each diagnostic emitted includes text indicating the
3197 command-line option that directly controls the diagnostic (if such an
3198 option is known to the diagnostic machinery).  Specifying the
3199 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3201 @item -fno-diagnostics-show-caret
3202 @opindex fno-diagnostics-show-caret
3203 @opindex fdiagnostics-show-caret
3204 By default, each diagnostic emitted includes the original source line
3205 and a caret '^' indicating the column.  This option suppresses this
3206 information.  The source line is truncated to @var{n} characters, if
3207 the @option{-fmessage-length=n} is given.  When the output is done
3208 to the terminal, the width is limited to the width given by the
3209 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3211 @end table
3213 @node Warning Options
3214 @section Options to Request or Suppress Warnings
3215 @cindex options to control warnings
3216 @cindex warning messages
3217 @cindex messages, warning
3218 @cindex suppressing warnings
3220 Warnings are diagnostic messages that report constructions that
3221 are not inherently erroneous but that are risky or suggest there
3222 may have been an error.
3224 The following language-independent options do not enable specific
3225 warnings but control the kinds of diagnostics produced by GCC@.
3227 @table @gcctabopt
3228 @cindex syntax checking
3229 @item -fsyntax-only
3230 @opindex fsyntax-only
3231 Check the code for syntax errors, but don't do anything beyond that.
3233 @item -fmax-errors=@var{n}
3234 @opindex fmax-errors
3235 Limits the maximum number of error messages to @var{n}, at which point
3236 GCC bails out rather than attempting to continue processing the source
3237 code.  If @var{n} is 0 (the default), there is no limit on the number
3238 of error messages produced.  If @option{-Wfatal-errors} is also
3239 specified, then @option{-Wfatal-errors} takes precedence over this
3240 option.
3242 @item -w
3243 @opindex w
3244 Inhibit all warning messages.
3246 @item -Werror
3247 @opindex Werror
3248 @opindex Wno-error
3249 Make all warnings into errors.
3251 @item -Werror=
3252 @opindex Werror=
3253 @opindex Wno-error=
3254 Make the specified warning into an error.  The specifier for a warning
3255 is appended; for example @option{-Werror=switch} turns the warnings
3256 controlled by @option{-Wswitch} into errors.  This switch takes a
3257 negative form, to be used to negate @option{-Werror} for specific
3258 warnings; for example @option{-Wno-error=switch} makes
3259 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3260 is in effect.
3262 The warning message for each controllable warning includes the
3263 option that controls the warning.  That option can then be used with
3264 @option{-Werror=} and @option{-Wno-error=} as described above.
3265 (Printing of the option in the warning message can be disabled using the
3266 @option{-fno-diagnostics-show-option} flag.)
3268 Note that specifying @option{-Werror=}@var{foo} automatically implies
3269 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3270 imply anything.
3272 @item -Wfatal-errors
3273 @opindex Wfatal-errors
3274 @opindex Wno-fatal-errors
3275 This option causes the compiler to abort compilation on the first error
3276 occurred rather than trying to keep going and printing further error
3277 messages.
3279 @end table
3281 You can request many specific warnings with options beginning with
3282 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3283 implicit declarations.  Each of these specific warning options also
3284 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3285 example, @option{-Wno-implicit}.  This manual lists only one of the
3286 two forms, whichever is not the default.  For further
3287 language-specific options also refer to @ref{C++ Dialect Options} and
3288 @ref{Objective-C and Objective-C++ Dialect Options}.
3290 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3291 options, such as @option{-Wunused}, which may turn on further options,
3292 such as @option{-Wunused-value}. The combined effect of positive and
3293 negative forms is that more specific options have priority over less
3294 specific ones, independently of their position in the command-line. For
3295 options of the same specificity, the last one takes effect. Options
3296 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3297 as if they appeared at the end of the command-line.
3299 When an unrecognized warning option is requested (e.g.,
3300 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3301 that the option is not recognized.  However, if the @option{-Wno-} form
3302 is used, the behavior is slightly different: no diagnostic is
3303 produced for @option{-Wno-unknown-warning} unless other diagnostics
3304 are being produced.  This allows the use of new @option{-Wno-} options
3305 with old compilers, but if something goes wrong, the compiler
3306 warns that an unrecognized option is present.
3308 @table @gcctabopt
3309 @item -Wpedantic
3310 @itemx -pedantic
3311 @opindex pedantic
3312 @opindex Wpedantic
3313 Issue all the warnings demanded by strict ISO C and ISO C++;
3314 reject all programs that use forbidden extensions, and some other
3315 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3316 version of the ISO C standard specified by any @option{-std} option used.
3318 Valid ISO C and ISO C++ programs should compile properly with or without
3319 this option (though a rare few require @option{-ansi} or a
3320 @option{-std} option specifying the required version of ISO C)@.  However,
3321 without this option, certain GNU extensions and traditional C and C++
3322 features are supported as well.  With this option, they are rejected.
3324 @option{-Wpedantic} does not cause warning messages for use of the
3325 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3326 warnings are also disabled in the expression that follows
3327 @code{__extension__}.  However, only system header files should use
3328 these escape routes; application programs should avoid them.
3329 @xref{Alternate Keywords}.
3331 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3332 C conformance.  They soon find that it does not do quite what they want:
3333 it finds some non-ISO practices, but not all---only those for which
3334 ISO C @emph{requires} a diagnostic, and some others for which
3335 diagnostics have been added.
3337 A feature to report any failure to conform to ISO C might be useful in
3338 some instances, but would require considerable additional work and would
3339 be quite different from @option{-Wpedantic}.  We don't have plans to
3340 support such a feature in the near future.
3342 Where the standard specified with @option{-std} represents a GNU
3343 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3344 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3345 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3346 where they are required by the base standard.  (It does not make sense
3347 for such warnings to be given only for features not in the specified GNU
3348 C dialect, since by definition the GNU dialects of C include all
3349 features the compiler supports with the given option, and there would be
3350 nothing to warn about.)
3352 @item -pedantic-errors
3353 @opindex pedantic-errors
3354 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3355 requires a diagnostic, in some cases where there is undefined behavior
3356 at compile-time and in some other cases that do not prevent compilation
3357 of programs that are valid according to the standard. This is not
3358 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3359 by this option and not enabled by the latter and vice versa.
3361 @item -Wall
3362 @opindex Wall
3363 @opindex Wno-all
3364 This enables all the warnings about constructions that some users
3365 consider questionable, and that are easy to avoid (or modify to
3366 prevent the warning), even in conjunction with macros.  This also
3367 enables some language-specific warnings described in @ref{C++ Dialect
3368 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3370 @option{-Wall} turns on the following warning flags:
3372 @gccoptlist{-Waddress   @gol
3373 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3374 -Wc++11-compat  -Wc++14-compat@gol
3375 -Wchar-subscripts  @gol
3376 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3377 -Wimplicit-int @r{(C and Objective-C only)} @gol
3378 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3379 -Wcomment  @gol
3380 -Wformat   @gol
3381 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3382 -Wmaybe-uninitialized @gol
3383 -Wmissing-braces @r{(only for C/ObjC)} @gol
3384 -Wnonnull  @gol
3385 -Wopenmp-simd @gol
3386 -Wparentheses  @gol
3387 -Wpointer-sign  @gol
3388 -Wreorder   @gol
3389 -Wreturn-type  @gol
3390 -Wsequence-point  @gol
3391 -Wsign-compare @r{(only in C++)}  @gol
3392 -Wstrict-aliasing  @gol
3393 -Wstrict-overflow=1  @gol
3394 -Wswitch  @gol
3395 -Wtrigraphs  @gol
3396 -Wuninitialized  @gol
3397 -Wunknown-pragmas  @gol
3398 -Wunused-function  @gol
3399 -Wunused-label     @gol
3400 -Wunused-value     @gol
3401 -Wunused-variable  @gol
3402 -Wvolatile-register-var @gol
3405 Note that some warning flags are not implied by @option{-Wall}.  Some of
3406 them warn about constructions that users generally do not consider
3407 questionable, but which occasionally you might wish to check for;
3408 others warn about constructions that are necessary or hard to avoid in
3409 some cases, and there is no simple way to modify the code to suppress
3410 the warning. Some of them are enabled by @option{-Wextra} but many of
3411 them must be enabled individually.
3413 @item -Wextra
3414 @opindex W
3415 @opindex Wextra
3416 @opindex Wno-extra
3417 This enables some extra warning flags that are not enabled by
3418 @option{-Wall}. (This option used to be called @option{-W}.  The older
3419 name is still supported, but the newer name is more descriptive.)
3421 @gccoptlist{-Wclobbered  @gol
3422 -Wempty-body  @gol
3423 -Wignored-qualifiers @gol
3424 -Wmissing-field-initializers  @gol
3425 -Wmissing-parameter-type @r{(C only)}  @gol
3426 -Wold-style-declaration @r{(C only)}  @gol
3427 -Woverride-init  @gol
3428 -Wsign-compare  @gol
3429 -Wtype-limits  @gol
3430 -Wuninitialized  @gol
3431 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3432 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3435 The option @option{-Wextra} also prints warning messages for the
3436 following cases:
3438 @itemize @bullet
3440 @item
3441 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3442 @samp{>}, or @samp{>=}.
3444 @item
3445 (C++ only) An enumerator and a non-enumerator both appear in a
3446 conditional expression.
3448 @item
3449 (C++ only) Ambiguous virtual bases.
3451 @item
3452 (C++ only) Subscripting an array that has been declared @samp{register}.
3454 @item
3455 (C++ only) Taking the address of a variable that has been declared
3456 @samp{register}.
3458 @item
3459 (C++ only) A base class is not initialized in a derived class's copy
3460 constructor.
3462 @end itemize
3464 @item -Wchar-subscripts
3465 @opindex Wchar-subscripts
3466 @opindex Wno-char-subscripts
3467 Warn if an array subscript has type @code{char}.  This is a common cause
3468 of error, as programmers often forget that this type is signed on some
3469 machines.
3470 This warning is enabled by @option{-Wall}.
3472 @item -Wcomment
3473 @opindex Wcomment
3474 @opindex Wno-comment
3475 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3476 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3477 This warning is enabled by @option{-Wall}.
3479 @item -Wno-coverage-mismatch
3480 @opindex Wno-coverage-mismatch
3481 Warn if feedback profiles do not match when using the
3482 @option{-fprofile-use} option.
3483 If a source file is changed between compiling with @option{-fprofile-gen} and
3484 with @option{-fprofile-use}, the files with the profile feedback can fail
3485 to match the source file and GCC cannot use the profile feedback
3486 information.  By default, this warning is enabled and is treated as an
3487 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3488 warning or @option{-Wno-error=coverage-mismatch} can be used to
3489 disable the error.  Disabling the error for this warning can result in
3490 poorly optimized code and is useful only in the
3491 case of very minor changes such as bug fixes to an existing code-base.
3492 Completely disabling the warning is not recommended.
3494 @item -Wno-cpp
3495 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3497 Suppress warning messages emitted by @code{#warning} directives.
3499 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3500 @opindex Wdouble-promotion
3501 @opindex Wno-double-promotion
3502 Give a warning when a value of type @code{float} is implicitly
3503 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3504 floating-point unit implement @code{float} in hardware, but emulate
3505 @code{double} in software.  On such a machine, doing computations
3506 using @code{double} values is much more expensive because of the
3507 overhead required for software emulation.
3509 It is easy to accidentally do computations with @code{double} because
3510 floating-point literals are implicitly of type @code{double}.  For
3511 example, in:
3512 @smallexample
3513 @group
3514 float area(float radius)
3516    return 3.14159 * radius * radius;
3518 @end group
3519 @end smallexample
3520 the compiler performs the entire computation with @code{double}
3521 because the floating-point literal is a @code{double}.
3523 @item -Wformat
3524 @itemx -Wformat=@var{n}
3525 @opindex Wformat
3526 @opindex Wno-format
3527 @opindex ffreestanding
3528 @opindex fno-builtin
3529 @opindex Wformat=
3530 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3531 the arguments supplied have types appropriate to the format string
3532 specified, and that the conversions specified in the format string make
3533 sense.  This includes standard functions, and others specified by format
3534 attributes (@pxref{Function Attributes}), in the @code{printf},
3535 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3536 not in the C standard) families (or other target-specific families).
3537 Which functions are checked without format attributes having been
3538 specified depends on the standard version selected, and such checks of
3539 functions without the attribute specified are disabled by
3540 @option{-ffreestanding} or @option{-fno-builtin}.
3542 The formats are checked against the format features supported by GNU
3543 libc version 2.2.  These include all ISO C90 and C99 features, as well
3544 as features from the Single Unix Specification and some BSD and GNU
3545 extensions.  Other library implementations may not support all these
3546 features; GCC does not support warning about features that go beyond a
3547 particular library's limitations.  However, if @option{-Wpedantic} is used
3548 with @option{-Wformat}, warnings are given about format features not
3549 in the selected standard version (but not for @code{strfmon} formats,
3550 since those are not in any version of the C standard).  @xref{C Dialect
3551 Options,,Options Controlling C Dialect}.
3553 @table @gcctabopt
3554 @item -Wformat=1
3555 @itemx -Wformat
3556 @opindex Wformat
3557 @opindex Wformat=1
3558 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3559 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3560 @option{-Wformat} also checks for null format arguments for several
3561 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3562 aspects of this level of format checking can be disabled by the
3563 options: @option{-Wno-format-contains-nul},
3564 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3565 @option{-Wformat} is enabled by @option{-Wall}.
3567 @item -Wno-format-contains-nul
3568 @opindex Wno-format-contains-nul
3569 @opindex Wformat-contains-nul
3570 If @option{-Wformat} is specified, do not warn about format strings that
3571 contain NUL bytes.
3573 @item -Wno-format-extra-args
3574 @opindex Wno-format-extra-args
3575 @opindex Wformat-extra-args
3576 If @option{-Wformat} is specified, do not warn about excess arguments to a
3577 @code{printf} or @code{scanf} format function.  The C standard specifies
3578 that such arguments are ignored.
3580 Where the unused arguments lie between used arguments that are
3581 specified with @samp{$} operand number specifications, normally
3582 warnings are still given, since the implementation could not know what
3583 type to pass to @code{va_arg} to skip the unused arguments.  However,
3584 in the case of @code{scanf} formats, this option suppresses the
3585 warning if the unused arguments are all pointers, since the Single
3586 Unix Specification says that such unused arguments are allowed.
3588 @item -Wno-format-zero-length
3589 @opindex Wno-format-zero-length
3590 @opindex Wformat-zero-length
3591 If @option{-Wformat} is specified, do not warn about zero-length formats.
3592 The C standard specifies that zero-length formats are allowed.
3595 @item -Wformat=2
3596 @opindex Wformat=2
3597 Enable @option{-Wformat} plus additional format checks.  Currently
3598 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3599 -Wformat-signedness -Wformat-y2k}.
3601 @item -Wformat-nonliteral
3602 @opindex Wformat-nonliteral
3603 @opindex Wno-format-nonliteral
3604 If @option{-Wformat} is specified, also warn if the format string is not a
3605 string literal and so cannot be checked, unless the format function
3606 takes its format arguments as a @code{va_list}.
3608 @item -Wformat-security
3609 @opindex Wformat-security
3610 @opindex Wno-format-security
3611 If @option{-Wformat} is specified, also warn about uses of format
3612 functions that represent possible security problems.  At present, this
3613 warns about calls to @code{printf} and @code{scanf} functions where the
3614 format string is not a string literal and there are no format arguments,
3615 as in @code{printf (foo);}.  This may be a security hole if the format
3616 string came from untrusted input and contains @samp{%n}.  (This is
3617 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3618 in future warnings may be added to @option{-Wformat-security} that are not
3619 included in @option{-Wformat-nonliteral}.)
3621 @item -Wformat-signedness
3622 @opindex Wformat-signedness
3623 @opindex Wno-format-signedness
3624 If @option{-Wformat} is specified, also warn if the format string
3625 requires an unsigned argument and the argument is signed and vice versa.
3627 @item -Wformat-y2k
3628 @opindex Wformat-y2k
3629 @opindex Wno-format-y2k
3630 If @option{-Wformat} is specified, also warn about @code{strftime}
3631 formats that may yield only a two-digit year.
3632 @end table
3634 @item -Wnonnull
3635 @opindex Wnonnull
3636 @opindex Wno-nonnull
3637 Warn about passing a null pointer for arguments marked as
3638 requiring a non-null value by the @code{nonnull} function attribute.
3640 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3641 can be disabled with the @option{-Wno-nonnull} option.
3643 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3644 @opindex Winit-self
3645 @opindex Wno-init-self
3646 Warn about uninitialized variables that are initialized with themselves.
3647 Note this option can only be used with the @option{-Wuninitialized} option.
3649 For example, GCC warns about @code{i} being uninitialized in the
3650 following snippet only when @option{-Winit-self} has been specified:
3651 @smallexample
3652 @group
3653 int f()
3655   int i = i;
3656   return i;
3658 @end group
3659 @end smallexample
3661 This warning is enabled by @option{-Wall} in C++.
3663 @item -Wimplicit-int @r{(C and Objective-C only)}
3664 @opindex Wimplicit-int
3665 @opindex Wno-implicit-int
3666 Warn when a declaration does not specify a type.
3667 This warning is enabled by @option{-Wall}.
3669 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3670 @opindex Wimplicit-function-declaration
3671 @opindex Wno-implicit-function-declaration
3672 Give a warning whenever a function is used before being declared. In
3673 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3674 enabled by default and it is made into an error by
3675 @option{-pedantic-errors}. This warning is also enabled by
3676 @option{-Wall}.
3678 @item -Wimplicit @r{(C and Objective-C only)}
3679 @opindex Wimplicit
3680 @opindex Wno-implicit
3681 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3682 This warning is enabled by @option{-Wall}.
3684 @item -Wignored-qualifiers @r{(C and C++ only)}
3685 @opindex Wignored-qualifiers
3686 @opindex Wno-ignored-qualifiers
3687 Warn if the return type of a function has a type qualifier
3688 such as @code{const}.  For ISO C such a type qualifier has no effect,
3689 since the value returned by a function is not an lvalue.
3690 For C++, the warning is only emitted for scalar types or @code{void}.
3691 ISO C prohibits qualified @code{void} return types on function
3692 definitions, so such return types always receive a warning
3693 even without this option.
3695 This warning is also enabled by @option{-Wextra}.
3697 @item -Wmain
3698 @opindex Wmain
3699 @opindex Wno-main
3700 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3701 a function with external linkage, returning int, taking either zero
3702 arguments, two, or three arguments of appropriate types.  This warning
3703 is enabled by default in C++ and is enabled by either @option{-Wall}
3704 or @option{-Wpedantic}.
3706 @item -Wmissing-braces
3707 @opindex Wmissing-braces
3708 @opindex Wno-missing-braces
3709 Warn if an aggregate or union initializer is not fully bracketed.  In
3710 the following example, the initializer for @samp{a} is not fully
3711 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3712 enabled by @option{-Wall} in C.
3714 @smallexample
3715 int a[2][2] = @{ 0, 1, 2, 3 @};
3716 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3717 @end smallexample
3719 This warning is enabled by @option{-Wall}.
3721 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3722 @opindex Wmissing-include-dirs
3723 @opindex Wno-missing-include-dirs
3724 Warn if a user-supplied include directory does not exist.
3726 @item -Wparentheses
3727 @opindex Wparentheses
3728 @opindex Wno-parentheses
3729 Warn if parentheses are omitted in certain contexts, such
3730 as when there is an assignment in a context where a truth value
3731 is expected, or when operators are nested whose precedence people
3732 often get confused about.
3734 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3735 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3736 interpretation from that of ordinary mathematical notation.
3738 Also warn about constructions where there may be confusion to which
3739 @code{if} statement an @code{else} branch belongs.  Here is an example of
3740 such a case:
3742 @smallexample
3743 @group
3745   if (a)
3746     if (b)
3747       foo ();
3748   else
3749     bar ();
3751 @end group
3752 @end smallexample
3754 In C/C++, every @code{else} branch belongs to the innermost possible
3755 @code{if} statement, which in this example is @code{if (b)}.  This is
3756 often not what the programmer expected, as illustrated in the above
3757 example by indentation the programmer chose.  When there is the
3758 potential for this confusion, GCC issues a warning when this flag
3759 is specified.  To eliminate the warning, add explicit braces around
3760 the innermost @code{if} statement so there is no way the @code{else}
3761 can belong to the enclosing @code{if}.  The resulting code
3762 looks like this:
3764 @smallexample
3765 @group
3767   if (a)
3768     @{
3769       if (b)
3770         foo ();
3771       else
3772         bar ();
3773     @}
3775 @end group
3776 @end smallexample
3778 Also warn for dangerous uses of the GNU extension to
3779 @code{?:} with omitted middle operand. When the condition
3780 in the @code{?}: operator is a boolean expression, the omitted value is
3781 always 1.  Often programmers expect it to be a value computed
3782 inside the conditional expression instead.
3784 This warning is enabled by @option{-Wall}.
3786 @item -Wsequence-point
3787 @opindex Wsequence-point
3788 @opindex Wno-sequence-point
3789 Warn about code that may have undefined semantics because of violations
3790 of sequence point rules in the C and C++ standards.
3792 The C and C++ standards define the order in which expressions in a C/C++
3793 program are evaluated in terms of @dfn{sequence points}, which represent
3794 a partial ordering between the execution of parts of the program: those
3795 executed before the sequence point, and those executed after it.  These
3796 occur after the evaluation of a full expression (one which is not part
3797 of a larger expression), after the evaluation of the first operand of a
3798 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3799 function is called (but after the evaluation of its arguments and the
3800 expression denoting the called function), and in certain other places.
3801 Other than as expressed by the sequence point rules, the order of
3802 evaluation of subexpressions of an expression is not specified.  All
3803 these rules describe only a partial order rather than a total order,
3804 since, for example, if two functions are called within one expression
3805 with no sequence point between them, the order in which the functions
3806 are called is not specified.  However, the standards committee have
3807 ruled that function calls do not overlap.
3809 It is not specified when between sequence points modifications to the
3810 values of objects take effect.  Programs whose behavior depends on this
3811 have undefined behavior; the C and C++ standards specify that ``Between
3812 the previous and next sequence point an object shall have its stored
3813 value modified at most once by the evaluation of an expression.
3814 Furthermore, the prior value shall be read only to determine the value
3815 to be stored.''.  If a program breaks these rules, the results on any
3816 particular implementation are entirely unpredictable.
3818 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3819 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3820 diagnosed by this option, and it may give an occasional false positive
3821 result, but in general it has been found fairly effective at detecting
3822 this sort of problem in programs.
3824 The standard is worded confusingly, therefore there is some debate
3825 over the precise meaning of the sequence point rules in subtle cases.
3826 Links to discussions of the problem, including proposed formal
3827 definitions, may be found on the GCC readings page, at
3828 @uref{http://gcc.gnu.org/@/readings.html}.
3830 This warning is enabled by @option{-Wall} for C and C++.
3832 @item -Wno-return-local-addr
3833 @opindex Wno-return-local-addr
3834 @opindex Wreturn-local-addr
3835 Do not warn about returning a pointer (or in C++, a reference) to a
3836 variable that goes out of scope after the function returns.
3838 @item -Wreturn-type
3839 @opindex Wreturn-type
3840 @opindex Wno-return-type
3841 Warn whenever a function is defined with a return type that defaults
3842 to @code{int}.  Also warn about any @code{return} statement with no
3843 return value in a function whose return type is not @code{void}
3844 (falling off the end of the function body is considered returning
3845 without a value), and about a @code{return} statement with an
3846 expression in a function whose return type is @code{void}.
3848 For C++, a function without return type always produces a diagnostic
3849 message, even when @option{-Wno-return-type} is specified.  The only
3850 exceptions are @samp{main} and functions defined in system headers.
3852 This warning is enabled by @option{-Wall}.
3854 @item -Wshift-count-negative
3855 @opindex Wshift-count-negative
3856 @opindex Wno-shift-count-negative
3857 Warn if shift count is negative. This warning is enabled by default.
3859 @item -Wshift-count-overflow
3860 @opindex Wshift-count-overflow
3861 @opindex Wno-shift-count-overflow
3862 Warn if shift count >= width of type. This warning is enabled by default.
3864 @item -Wswitch
3865 @opindex Wswitch
3866 @opindex Wno-switch
3867 Warn whenever a @code{switch} statement has an index of enumerated type
3868 and lacks a @code{case} for one or more of the named codes of that
3869 enumeration.  (The presence of a @code{default} label prevents this
3870 warning.)  @code{case} labels outside the enumeration range also
3871 provoke warnings when this option is used (even if there is a
3872 @code{default} label).
3873 This warning is enabled by @option{-Wall}.
3875 @item -Wswitch-default
3876 @opindex Wswitch-default
3877 @opindex Wno-switch-default
3878 Warn whenever a @code{switch} statement does not have a @code{default}
3879 case.
3881 @item -Wswitch-enum
3882 @opindex Wswitch-enum
3883 @opindex Wno-switch-enum
3884 Warn whenever a @code{switch} statement has an index of enumerated type
3885 and lacks a @code{case} for one or more of the named codes of that
3886 enumeration.  @code{case} labels outside the enumeration range also
3887 provoke warnings when this option is used.  The only difference
3888 between @option{-Wswitch} and this option is that this option gives a
3889 warning about an omitted enumeration code even if there is a
3890 @code{default} label.
3892 @item -Wswitch-bool
3893 @opindex Wswitch-bool
3894 @opindex Wno-switch-bool
3895 Warn whenever a @code{switch} statement has an index of boolean type.
3896 It is possible to suppress this warning by casting the controlling
3897 expression to a type other than @code{bool}.  For example:
3898 @smallexample
3899 @group
3900 switch ((int) (a == 4))
3901   @{
3902   @dots{}
3903   @}
3904 @end group
3905 @end smallexample
3906 This warning is enabled by default for C and C++ programs.
3908 @item -Wsync-nand @r{(C and C++ only)}
3909 @opindex Wsync-nand
3910 @opindex Wno-sync-nand
3911 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3912 built-in functions are used.  These functions changed semantics in GCC 4.4.
3914 @item -Wtrigraphs
3915 @opindex Wtrigraphs
3916 @opindex Wno-trigraphs
3917 Warn if any trigraphs are encountered that might change the meaning of
3918 the program (trigraphs within comments are not warned about).
3919 This warning is enabled by @option{-Wall}.
3921 @item -Wunused-but-set-parameter
3922 @opindex Wunused-but-set-parameter
3923 @opindex Wno-unused-but-set-parameter
3924 Warn whenever a function parameter is assigned to, but otherwise unused
3925 (aside from its declaration).
3927 To suppress this warning use the @samp{unused} attribute
3928 (@pxref{Variable Attributes}).
3930 This warning is also enabled by @option{-Wunused} together with
3931 @option{-Wextra}.
3933 @item -Wunused-but-set-variable
3934 @opindex Wunused-but-set-variable
3935 @opindex Wno-unused-but-set-variable
3936 Warn whenever a local variable is assigned to, but otherwise unused
3937 (aside from its declaration).
3938 This warning is enabled by @option{-Wall}.
3940 To suppress this warning use the @samp{unused} attribute
3941 (@pxref{Variable Attributes}).
3943 This warning is also enabled by @option{-Wunused}, which is enabled
3944 by @option{-Wall}.
3946 @item -Wunused-function
3947 @opindex Wunused-function
3948 @opindex Wno-unused-function
3949 Warn whenever a static function is declared but not defined or a
3950 non-inline static function is unused.
3951 This warning is enabled by @option{-Wall}.
3953 @item -Wunused-label
3954 @opindex Wunused-label
3955 @opindex Wno-unused-label
3956 Warn whenever a label is declared but not used.
3957 This warning is enabled by @option{-Wall}.
3959 To suppress this warning use the @samp{unused} attribute
3960 (@pxref{Variable Attributes}).
3962 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3963 @opindex Wunused-local-typedefs
3964 Warn when a typedef locally defined in a function is not used.
3965 This warning is enabled by @option{-Wall}.
3967 @item -Wunused-parameter
3968 @opindex Wunused-parameter
3969 @opindex Wno-unused-parameter
3970 Warn whenever a function parameter is unused aside from its declaration.
3972 To suppress this warning use the @samp{unused} attribute
3973 (@pxref{Variable Attributes}).
3975 @item -Wno-unused-result
3976 @opindex Wunused-result
3977 @opindex Wno-unused-result
3978 Do not warn if a caller of a function marked with attribute
3979 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3980 its return value. The default is @option{-Wunused-result}.
3982 @item -Wunused-variable
3983 @opindex Wunused-variable
3984 @opindex Wno-unused-variable
3985 Warn whenever a local variable or non-constant static variable is unused
3986 aside from its declaration.
3987 This warning is enabled by @option{-Wall}.
3989 To suppress this warning use the @samp{unused} attribute
3990 (@pxref{Variable Attributes}).
3992 @item -Wunused-value
3993 @opindex Wunused-value
3994 @opindex Wno-unused-value
3995 Warn whenever a statement computes a result that is explicitly not
3996 used. To suppress this warning cast the unused expression to
3997 @samp{void}. This includes an expression-statement or the left-hand
3998 side of a comma expression that contains no side effects. For example,
3999 an expression such as @samp{x[i,j]} causes a warning, while
4000 @samp{x[(void)i,j]} does not.
4002 This warning is enabled by @option{-Wall}.
4004 @item -Wunused
4005 @opindex Wunused
4006 @opindex Wno-unused
4007 All the above @option{-Wunused} options combined.
4009 In order to get a warning about an unused function parameter, you must
4010 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4011 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4013 @item -Wuninitialized
4014 @opindex Wuninitialized
4015 @opindex Wno-uninitialized
4016 Warn if an automatic variable is used without first being initialized
4017 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4018 warn if a non-static reference or non-static @samp{const} member
4019 appears in a class without constructors.
4021 If you want to warn about code that uses the uninitialized value of the
4022 variable in its own initializer, use the @option{-Winit-self} option.
4024 These warnings occur for individual uninitialized or clobbered
4025 elements of structure, union or array variables as well as for
4026 variables that are uninitialized or clobbered as a whole.  They do
4027 not occur for variables or elements declared @code{volatile}.  Because
4028 these warnings depend on optimization, the exact variables or elements
4029 for which there are warnings depends on the precise optimization
4030 options and version of GCC used.
4032 Note that there may be no warning about a variable that is used only
4033 to compute a value that itself is never used, because such
4034 computations may be deleted by data flow analysis before the warnings
4035 are printed.
4037 @item -Wmaybe-uninitialized
4038 @opindex Wmaybe-uninitialized
4039 @opindex Wno-maybe-uninitialized
4040 For an automatic variable, if there exists a path from the function
4041 entry to a use of the variable that is initialized, but there exist
4042 some other paths for which the variable is not initialized, the compiler
4043 emits a warning if it cannot prove the uninitialized paths are not
4044 executed at run time. These warnings are made optional because GCC is
4045 not smart enough to see all the reasons why the code might be correct
4046 in spite of appearing to have an error.  Here is one example of how
4047 this can happen:
4049 @smallexample
4050 @group
4052   int x;
4053   switch (y)
4054     @{
4055     case 1: x = 1;
4056       break;
4057     case 2: x = 4;
4058       break;
4059     case 3: x = 5;
4060     @}
4061   foo (x);
4063 @end group
4064 @end smallexample
4066 @noindent
4067 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4068 always initialized, but GCC doesn't know this. To suppress the
4069 warning, you need to provide a default case with assert(0) or
4070 similar code.
4072 @cindex @code{longjmp} warnings
4073 This option also warns when a non-volatile automatic variable might be
4074 changed by a call to @code{longjmp}.  These warnings as well are possible
4075 only in optimizing compilation.
4077 The compiler sees only the calls to @code{setjmp}.  It cannot know
4078 where @code{longjmp} will be called; in fact, a signal handler could
4079 call it at any point in the code.  As a result, you may get a warning
4080 even when there is in fact no problem because @code{longjmp} cannot
4081 in fact be called at the place that would cause a problem.
4083 Some spurious warnings can be avoided if you declare all the functions
4084 you use that never return as @code{noreturn}.  @xref{Function
4085 Attributes}.
4087 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4089 @item -Wunknown-pragmas
4090 @opindex Wunknown-pragmas
4091 @opindex Wno-unknown-pragmas
4092 @cindex warning for unknown pragmas
4093 @cindex unknown pragmas, warning
4094 @cindex pragmas, warning of unknown
4095 Warn when a @code{#pragma} directive is encountered that is not understood by 
4096 GCC@.  If this command-line option is used, warnings are even issued
4097 for unknown pragmas in system header files.  This is not the case if
4098 the warnings are only enabled by the @option{-Wall} command-line option.
4100 @item -Wno-pragmas
4101 @opindex Wno-pragmas
4102 @opindex Wpragmas
4103 Do not warn about misuses of pragmas, such as incorrect parameters,
4104 invalid syntax, or conflicts between pragmas.  See also
4105 @option{-Wunknown-pragmas}.
4107 @item -Wstrict-aliasing
4108 @opindex Wstrict-aliasing
4109 @opindex Wno-strict-aliasing
4110 This option is only active when @option{-fstrict-aliasing} is active.
4111 It warns about code that might break the strict aliasing rules that the
4112 compiler is using for optimization.  The warning does not catch all
4113 cases, but does attempt to catch the more common pitfalls.  It is
4114 included in @option{-Wall}.
4115 It is equivalent to @option{-Wstrict-aliasing=3}
4117 @item -Wstrict-aliasing=n
4118 @opindex Wstrict-aliasing=n
4119 This option is only active when @option{-fstrict-aliasing} is active.
4120 It warns about code that might break the strict aliasing rules that the
4121 compiler is using for optimization.
4122 Higher levels correspond to higher accuracy (fewer false positives).
4123 Higher levels also correspond to more effort, similar to the way @option{-O} 
4124 works.
4125 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4127 Level 1: Most aggressive, quick, least accurate.
4128 Possibly useful when higher levels
4129 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4130 false negatives.  However, it has many false positives.
4131 Warns for all pointer conversions between possibly incompatible types,
4132 even if never dereferenced.  Runs in the front end only.
4134 Level 2: Aggressive, quick, not too precise.
4135 May still have many false positives (not as many as level 1 though),
4136 and few false negatives (but possibly more than level 1).
4137 Unlike level 1, it only warns when an address is taken.  Warns about
4138 incomplete types.  Runs in the front end only.
4140 Level 3 (default for @option{-Wstrict-aliasing}):
4141 Should have very few false positives and few false
4142 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4143 Takes care of the common pun+dereference pattern in the front end:
4144 @code{*(int*)&some_float}.
4145 If optimization is enabled, it also runs in the back end, where it deals
4146 with multiple statement cases using flow-sensitive points-to information.
4147 Only warns when the converted pointer is dereferenced.
4148 Does not warn about incomplete types.
4150 @item -Wstrict-overflow
4151 @itemx -Wstrict-overflow=@var{n}
4152 @opindex Wstrict-overflow
4153 @opindex Wno-strict-overflow
4154 This option is only active when @option{-fstrict-overflow} is active.
4155 It warns about cases where the compiler optimizes based on the
4156 assumption that signed overflow does not occur.  Note that it does not
4157 warn about all cases where the code might overflow: it only warns
4158 about cases where the compiler implements some optimization.  Thus
4159 this warning depends on the optimization level.
4161 An optimization that assumes that signed overflow does not occur is
4162 perfectly safe if the values of the variables involved are such that
4163 overflow never does, in fact, occur.  Therefore this warning can
4164 easily give a false positive: a warning about code that is not
4165 actually a problem.  To help focus on important issues, several
4166 warning levels are defined.  No warnings are issued for the use of
4167 undefined signed overflow when estimating how many iterations a loop
4168 requires, in particular when determining whether a loop will be
4169 executed at all.
4171 @table @gcctabopt
4172 @item -Wstrict-overflow=1
4173 Warn about cases that are both questionable and easy to avoid.  For
4174 example,  with @option{-fstrict-overflow}, the compiler simplifies
4175 @code{x + 1 > x} to @code{1}.  This level of
4176 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4177 are not, and must be explicitly requested.
4179 @item -Wstrict-overflow=2
4180 Also warn about other cases where a comparison is simplified to a
4181 constant.  For example: @code{abs (x) >= 0}.  This can only be
4182 simplified when @option{-fstrict-overflow} is in effect, because
4183 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4184 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4185 @option{-Wstrict-overflow=2}.
4187 @item -Wstrict-overflow=3
4188 Also warn about other cases where a comparison is simplified.  For
4189 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4191 @item -Wstrict-overflow=4
4192 Also warn about other simplifications not covered by the above cases.
4193 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4195 @item -Wstrict-overflow=5
4196 Also warn about cases where the compiler reduces the magnitude of a
4197 constant involved in a comparison.  For example: @code{x + 2 > y} is
4198 simplified to @code{x + 1 >= y}.  This is reported only at the
4199 highest warning level because this simplification applies to many
4200 comparisons, so this warning level gives a very large number of
4201 false positives.
4202 @end table
4204 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4205 @opindex Wsuggest-attribute=
4206 @opindex Wno-suggest-attribute=
4207 Warn for cases where adding an attribute may be beneficial. The
4208 attributes currently supported are listed below.
4210 @table @gcctabopt
4211 @item -Wsuggest-attribute=pure
4212 @itemx -Wsuggest-attribute=const
4213 @itemx -Wsuggest-attribute=noreturn
4214 @opindex Wsuggest-attribute=pure
4215 @opindex Wno-suggest-attribute=pure
4216 @opindex Wsuggest-attribute=const
4217 @opindex Wno-suggest-attribute=const
4218 @opindex Wsuggest-attribute=noreturn
4219 @opindex Wno-suggest-attribute=noreturn
4221 Warn about functions that might be candidates for attributes
4222 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4223 functions visible in other compilation units or (in the case of @code{pure} and
4224 @code{const}) if it cannot prove that the function returns normally. A function
4225 returns normally if it doesn't contain an infinite loop or return abnormally
4226 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4227 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4228 higher.  Higher optimization levels improve the accuracy of the analysis.
4230 @item -Wsuggest-attribute=format
4231 @itemx -Wmissing-format-attribute
4232 @opindex Wsuggest-attribute=format
4233 @opindex Wmissing-format-attribute
4234 @opindex Wno-suggest-attribute=format
4235 @opindex Wno-missing-format-attribute
4236 @opindex Wformat
4237 @opindex Wno-format
4239 Warn about function pointers that might be candidates for @code{format}
4240 attributes.  Note these are only possible candidates, not absolute ones.
4241 GCC guesses that function pointers with @code{format} attributes that
4242 are used in assignment, initialization, parameter passing or return
4243 statements should have a corresponding @code{format} attribute in the
4244 resulting type.  I.e.@: the left-hand side of the assignment or
4245 initialization, the type of the parameter variable, or the return type
4246 of the containing function respectively should also have a @code{format}
4247 attribute to avoid the warning.
4249 GCC also warns about function definitions that might be
4250 candidates for @code{format} attributes.  Again, these are only
4251 possible candidates.  GCC guesses that @code{format} attributes
4252 might be appropriate for any function that calls a function like
4253 @code{vprintf} or @code{vscanf}, but this might not always be the
4254 case, and some functions for which @code{format} attributes are
4255 appropriate may not be detected.
4256 @end table
4258 @item -Wsuggest-final-types
4259 @opindex Wno-suggest-final-types
4260 @opindex Wsuggest-final-types
4261 Warn about types with virtual methods where code quality would be improved
4262 if the type was declared with the C++11 final specifier, or, if possible,
4263 declared in an anonymous namespace. This allows GCC to more aggressively
4264 devirtualize the polymorphic calls. This warning is more effective with link
4265 time optimization, where the information about the class hierarchy graph is
4266 more complete.
4268 @item -Wsuggest-final-methods
4269 @opindex Wno-suggest-final-methods
4270 @opindex Wsuggest-final-methods
4271 Warn about virtual methods where code quality would be improved if the method
4272 was declared with the C++11 final specifier, or, if possible, its type was
4273 declared in an anonymous namespace or with the final specifier. This warning is
4274 more effective with link time optimization, where the information about the
4275 class hierarchy graph is more complete. It is recommended to first consider
4276 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4277 annotations.
4279 @item -Warray-bounds
4280 @opindex Wno-array-bounds
4281 @opindex Warray-bounds
4282 This option is only active when @option{-ftree-vrp} is active
4283 (default for @option{-O2} and above). It warns about subscripts to arrays
4284 that are always out of bounds. This warning is enabled by @option{-Wall}.
4286 @item -Wbool-compare
4287 @opindex Wno-bool-compare
4288 @opindex Wbool-compare
4289 Warn about boolean expression compared with an integer value different from
4290 @code{true}/@code{false}.  For instance, the following comparison is
4291 always false:
4292 @smallexample
4293 int n = 5;
4294 @dots{}
4295 if ((n > 1) == 2) @{ @dots{} @}
4296 @end smallexample
4297 This warning is enabled by @option{-Wall}.
4299 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4300 @opindex Wno-discarded-qualifiers
4301 @opindex Wdiscarded-qualifiers
4302 Do not warn if type qualifiers on pointers are being discarded.
4303 Typically, the compiler will warn if a @code{const char *} variable is
4304 passed to a function that takes a @code{char *} parameter.  This option
4305 can be used to suppress such a warning.
4307 @item -Wno-discarded-array-qualifiers @r{(C and Objective-C only)}
4308 @opindex Wno-discarded-array-qualifiers
4309 @opindex Wdiscarded-array-qualifiers
4310 Do not warn if type qualifiers on arrays which are pointer targets
4311 are being discarded. Typically, the compiler will warn if a
4312 @code{const int (*)[]} variable is passed to a function that
4313 takes a @code{int (*)[]} parameter.  This option can be used to
4314 suppress such a warning.
4316 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4317 @opindex Wno-incompatible-pointer-types
4318 @opindex Wincompatible-pointer-types
4319 Do not warn when there is a conversion between pointers that have incompatible
4320 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4321 which warns for pointer argument passing or assignment with different
4322 signedness.
4324 @item -Wno-int-conversion @r{(C and Objective-C only)}
4325 @opindex Wno-int-conversion
4326 @opindex Wint-conversion
4327 Do not warn about incompatible integer to pointer and pointer to integer
4328 conversions.  This warning is about implicit conversions; for explicit
4329 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4330 @option{-Wno-pointer-to-int-cast} may be used.
4332 @item -Wno-div-by-zero
4333 @opindex Wno-div-by-zero
4334 @opindex Wdiv-by-zero
4335 Do not warn about compile-time integer division by zero.  Floating-point
4336 division by zero is not warned about, as it can be a legitimate way of
4337 obtaining infinities and NaNs.
4339 @item -Wsystem-headers
4340 @opindex Wsystem-headers
4341 @opindex Wno-system-headers
4342 @cindex warnings from system headers
4343 @cindex system headers, warnings from
4344 Print warning messages for constructs found in system header files.
4345 Warnings from system headers are normally suppressed, on the assumption
4346 that they usually do not indicate real problems and would only make the
4347 compiler output harder to read.  Using this command-line option tells
4348 GCC to emit warnings from system headers as if they occurred in user
4349 code.  However, note that using @option{-Wall} in conjunction with this
4350 option does @emph{not} warn about unknown pragmas in system
4351 headers---for that, @option{-Wunknown-pragmas} must also be used.
4353 @item -Wtrampolines
4354 @opindex Wtrampolines
4355 @opindex Wno-trampolines
4356 Warn about trampolines generated for pointers to nested functions.
4357 A trampoline is a small piece of data or code that is created at run
4358 time on the stack when the address of a nested function is taken, and is
4359 used to call the nested function indirectly.  For some targets, it is
4360 made up of data only and thus requires no special treatment.  But, for
4361 most targets, it is made up of code and thus requires the stack to be
4362 made executable in order for the program to work properly.
4364 @item -Wfloat-equal
4365 @opindex Wfloat-equal
4366 @opindex Wno-float-equal
4367 Warn if floating-point values are used in equality comparisons.
4369 The idea behind this is that sometimes it is convenient (for the
4370 programmer) to consider floating-point values as approximations to
4371 infinitely precise real numbers.  If you are doing this, then you need
4372 to compute (by analyzing the code, or in some other way) the maximum or
4373 likely maximum error that the computation introduces, and allow for it
4374 when performing comparisons (and when producing output, but that's a
4375 different problem).  In particular, instead of testing for equality, you
4376 should check to see whether the two values have ranges that overlap; and
4377 this is done with the relational operators, so equality comparisons are
4378 probably mistaken.
4380 @item -Wtraditional @r{(C and Objective-C only)}
4381 @opindex Wtraditional
4382 @opindex Wno-traditional
4383 Warn about certain constructs that behave differently in traditional and
4384 ISO C@.  Also warn about ISO C constructs that have no traditional C
4385 equivalent, and/or problematic constructs that should be avoided.
4387 @itemize @bullet
4388 @item
4389 Macro parameters that appear within string literals in the macro body.
4390 In traditional C macro replacement takes place within string literals,
4391 but in ISO C it does not.
4393 @item
4394 In traditional C, some preprocessor directives did not exist.
4395 Traditional preprocessors only considered a line to be a directive
4396 if the @samp{#} appeared in column 1 on the line.  Therefore
4397 @option{-Wtraditional} warns about directives that traditional C
4398 understands but ignores because the @samp{#} does not appear as the
4399 first character on the line.  It also suggests you hide directives like
4400 @samp{#pragma} not understood by traditional C by indenting them.  Some
4401 traditional implementations do not recognize @samp{#elif}, so this option
4402 suggests avoiding it altogether.
4404 @item
4405 A function-like macro that appears without arguments.
4407 @item
4408 The unary plus operator.
4410 @item
4411 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4412 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4413 constants.)  Note, these suffixes appear in macros defined in the system
4414 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4415 Use of these macros in user code might normally lead to spurious
4416 warnings, however GCC's integrated preprocessor has enough context to
4417 avoid warning in these cases.
4419 @item
4420 A function declared external in one block and then used after the end of
4421 the block.
4423 @item
4424 A @code{switch} statement has an operand of type @code{long}.
4426 @item
4427 A non-@code{static} function declaration follows a @code{static} one.
4428 This construct is not accepted by some traditional C compilers.
4430 @item
4431 The ISO type of an integer constant has a different width or
4432 signedness from its traditional type.  This warning is only issued if
4433 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4434 typically represent bit patterns, are not warned about.
4436 @item
4437 Usage of ISO string concatenation is detected.
4439 @item
4440 Initialization of automatic aggregates.
4442 @item
4443 Identifier conflicts with labels.  Traditional C lacks a separate
4444 namespace for labels.
4446 @item
4447 Initialization of unions.  If the initializer is zero, the warning is
4448 omitted.  This is done under the assumption that the zero initializer in
4449 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4450 initializer warnings and relies on default initialization to zero in the
4451 traditional C case.
4453 @item
4454 Conversions by prototypes between fixed/floating-point values and vice
4455 versa.  The absence of these prototypes when compiling with traditional
4456 C causes serious problems.  This is a subset of the possible
4457 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4459 @item
4460 Use of ISO C style function definitions.  This warning intentionally is
4461 @emph{not} issued for prototype declarations or variadic functions
4462 because these ISO C features appear in your code when using
4463 libiberty's traditional C compatibility macros, @code{PARAMS} and
4464 @code{VPARAMS}.  This warning is also bypassed for nested functions
4465 because that feature is already a GCC extension and thus not relevant to
4466 traditional C compatibility.
4467 @end itemize
4469 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4470 @opindex Wtraditional-conversion
4471 @opindex Wno-traditional-conversion
4472 Warn if a prototype causes a type conversion that is different from what
4473 would happen to the same argument in the absence of a prototype.  This
4474 includes conversions of fixed point to floating and vice versa, and
4475 conversions changing the width or signedness of a fixed-point argument
4476 except when the same as the default promotion.
4478 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4479 @opindex Wdeclaration-after-statement
4480 @opindex Wno-declaration-after-statement
4481 Warn when a declaration is found after a statement in a block.  This
4482 construct, known from C++, was introduced with ISO C99 and is by default
4483 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4484 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4486 @item -Wundef
4487 @opindex Wundef
4488 @opindex Wno-undef
4489 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4491 @item -Wno-endif-labels
4492 @opindex Wno-endif-labels
4493 @opindex Wendif-labels
4494 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4496 @item -Wshadow
4497 @opindex Wshadow
4498 @opindex Wno-shadow
4499 Warn whenever a local variable or type declaration shadows another
4500 variable, parameter, type, class member (in C++), or instance variable
4501 (in Objective-C) or whenever a built-in function is shadowed. Note
4502 that in C++, the compiler warns if a local variable shadows an
4503 explicit typedef, but not if it shadows a struct/class/enum.
4505 @item -Wno-shadow-ivar @r{(Objective-C only)}
4506 @opindex Wno-shadow-ivar
4507 @opindex Wshadow-ivar
4508 Do not warn whenever a local variable shadows an instance variable in an
4509 Objective-C method.
4511 @item -Wlarger-than=@var{len}
4512 @opindex Wlarger-than=@var{len}
4513 @opindex Wlarger-than-@var{len}
4514 Warn whenever an object of larger than @var{len} bytes is defined.
4516 @item -Wframe-larger-than=@var{len}
4517 @opindex Wframe-larger-than
4518 Warn if the size of a function frame is larger than @var{len} bytes.
4519 The computation done to determine the stack frame size is approximate
4520 and not conservative.
4521 The actual requirements may be somewhat greater than @var{len}
4522 even if you do not get a warning.  In addition, any space allocated
4523 via @code{alloca}, variable-length arrays, or related constructs
4524 is not included by the compiler when determining
4525 whether or not to issue a warning.
4527 @item -Wno-free-nonheap-object
4528 @opindex Wno-free-nonheap-object
4529 @opindex Wfree-nonheap-object
4530 Do not warn when attempting to free an object that was not allocated
4531 on the heap.
4533 @item -Wstack-usage=@var{len}
4534 @opindex Wstack-usage
4535 Warn if the stack usage of a function might be larger than @var{len} bytes.
4536 The computation done to determine the stack usage is conservative.
4537 Any space allocated via @code{alloca}, variable-length arrays, or related
4538 constructs is included by the compiler when determining whether or not to
4539 issue a warning.
4541 The message is in keeping with the output of @option{-fstack-usage}.
4543 @itemize
4544 @item
4545 If the stack usage is fully static but exceeds the specified amount, it's:
4547 @smallexample
4548   warning: stack usage is 1120 bytes
4549 @end smallexample
4550 @item
4551 If the stack usage is (partly) dynamic but bounded, it's:
4553 @smallexample
4554   warning: stack usage might be 1648 bytes
4555 @end smallexample
4556 @item
4557 If the stack usage is (partly) dynamic and not bounded, it's:
4559 @smallexample
4560   warning: stack usage might be unbounded
4561 @end smallexample
4562 @end itemize
4564 @item -Wunsafe-loop-optimizations
4565 @opindex Wunsafe-loop-optimizations
4566 @opindex Wno-unsafe-loop-optimizations
4567 Warn if the loop cannot be optimized because the compiler cannot
4568 assume anything on the bounds of the loop indices.  With
4569 @option{-funsafe-loop-optimizations} warn if the compiler makes
4570 such assumptions.
4572 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4573 @opindex Wno-pedantic-ms-format
4574 @opindex Wpedantic-ms-format
4575 When used in combination with @option{-Wformat}
4576 and @option{-pedantic} without GNU extensions, this option
4577 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4578 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4579 which depend on the MS runtime.
4581 @item -Wpointer-arith
4582 @opindex Wpointer-arith
4583 @opindex Wno-pointer-arith
4584 Warn about anything that depends on the ``size of'' a function type or
4585 of @code{void}.  GNU C assigns these types a size of 1, for
4586 convenience in calculations with @code{void *} pointers and pointers
4587 to functions.  In C++, warn also when an arithmetic operation involves
4588 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4590 @item -Wtype-limits
4591 @opindex Wtype-limits
4592 @opindex Wno-type-limits
4593 Warn if a comparison is always true or always false due to the limited
4594 range of the data type, but do not warn for constant expressions.  For
4595 example, warn if an unsigned variable is compared against zero with
4596 @samp{<} or @samp{>=}.  This warning is also enabled by
4597 @option{-Wextra}.
4599 @item -Wbad-function-cast @r{(C and Objective-C only)}
4600 @opindex Wbad-function-cast
4601 @opindex Wno-bad-function-cast
4602 Warn whenever a function call is cast to a non-matching type.
4603 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4605 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4606 @opindex Wc90-c99-compat
4607 @opindex Wno-c90-c99-compat
4608 Warn about features not present in ISO C90, but present in ISO C99.
4609 For instance, warn about use of variable length arrays, @code{long long}
4610 type, @code{bool} type, compound literals, designated initializers, and so
4611 on.  This option is independent of the standards mode.  Warnings are disabled
4612 in the expression that follows @code{__extension__}.
4614 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4615 @opindex Wc99-c11-compat
4616 @opindex Wno-c99-c11-compat
4617 Warn about features not present in ISO C99, but present in ISO C11.
4618 For instance, warn about use of anonymous structures and unions,
4619 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4620 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4621 and so on.  This option is independent of the standards mode.  Warnings are
4622 disabled in the expression that follows @code{__extension__}.
4624 @item -Wc++-compat @r{(C and Objective-C only)}
4625 Warn about ISO C constructs that are outside of the common subset of
4626 ISO C and ISO C++, e.g.@: request for implicit conversion from
4627 @code{void *} to a pointer to non-@code{void} type.
4629 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4630 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4631 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4632 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4633 enabled by @option{-Wall}.
4635 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4636 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4637 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4639 @item -Wcast-qual
4640 @opindex Wcast-qual
4641 @opindex Wno-cast-qual
4642 Warn whenever a pointer is cast so as to remove a type qualifier from
4643 the target type.  For example, warn if a @code{const char *} is cast
4644 to an ordinary @code{char *}.
4646 Also warn when making a cast that introduces a type qualifier in an
4647 unsafe way.  For example, casting @code{char **} to @code{const char **}
4648 is unsafe, as in this example:
4650 @smallexample
4651   /* p is char ** value.  */
4652   const char **q = (const char **) p;
4653   /* Assignment of readonly string to const char * is OK.  */
4654   *q = "string";
4655   /* Now char** pointer points to read-only memory.  */
4656   **p = 'b';
4657 @end smallexample
4659 @item -Wcast-align
4660 @opindex Wcast-align
4661 @opindex Wno-cast-align
4662 Warn whenever a pointer is cast such that the required alignment of the
4663 target is increased.  For example, warn if a @code{char *} is cast to
4664 an @code{int *} on machines where integers can only be accessed at
4665 two- or four-byte boundaries.
4667 @item -Wwrite-strings
4668 @opindex Wwrite-strings
4669 @opindex Wno-write-strings
4670 When compiling C, give string constants the type @code{const
4671 char[@var{length}]} so that copying the address of one into a
4672 non-@code{const} @code{char *} pointer produces a warning.  These
4673 warnings help you find at compile time code that can try to write
4674 into a string constant, but only if you have been very careful about
4675 using @code{const} in declarations and prototypes.  Otherwise, it is
4676 just a nuisance. This is why we did not make @option{-Wall} request
4677 these warnings.
4679 When compiling C++, warn about the deprecated conversion from string
4680 literals to @code{char *}.  This warning is enabled by default for C++
4681 programs.
4683 @item -Wclobbered
4684 @opindex Wclobbered
4685 @opindex Wno-clobbered
4686 Warn for variables that might be changed by @samp{longjmp} or
4687 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4689 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4690 @opindex Wconditionally-supported
4691 @opindex Wno-conditionally-supported
4692 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4694 @item -Wconversion
4695 @opindex Wconversion
4696 @opindex Wno-conversion
4697 Warn for implicit conversions that may alter a value. This includes
4698 conversions between real and integer, like @code{abs (x)} when
4699 @code{x} is @code{double}; conversions between signed and unsigned,
4700 like @code{unsigned ui = -1}; and conversions to smaller types, like
4701 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4702 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4703 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4704 conversions between signed and unsigned integers can be disabled by
4705 using @option{-Wno-sign-conversion}.
4707 For C++, also warn for confusing overload resolution for user-defined
4708 conversions; and conversions that never use a type conversion
4709 operator: conversions to @code{void}, the same type, a base class or a
4710 reference to them. Warnings about conversions between signed and
4711 unsigned integers are disabled by default in C++ unless
4712 @option{-Wsign-conversion} is explicitly enabled.
4714 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4715 @opindex Wconversion-null
4716 @opindex Wno-conversion-null
4717 Do not warn for conversions between @code{NULL} and non-pointer
4718 types. @option{-Wconversion-null} is enabled by default.
4720 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4721 @opindex Wzero-as-null-pointer-constant
4722 @opindex Wno-zero-as-null-pointer-constant
4723 Warn when a literal '0' is used as null pointer constant.  This can
4724 be useful to facilitate the conversion to @code{nullptr} in C++11.
4726 @item -Wdate-time
4727 @opindex Wdate-time
4728 @opindex Wno-date-time
4729 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4730 are encountered as they might prevent bit-wise-identical reproducible
4731 compilations.
4733 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4734 @opindex Wdelete-incomplete
4735 @opindex Wno-delete-incomplete
4736 Warn when deleting a pointer to incomplete type, which may cause
4737 undefined behavior at runtime.  This warning is enabled by default.
4739 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4740 @opindex Wuseless-cast
4741 @opindex Wno-useless-cast
4742 Warn when an expression is casted to its own type.
4744 @item -Wempty-body
4745 @opindex Wempty-body
4746 @opindex Wno-empty-body
4747 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4748 while} statement.  This warning is also enabled by @option{-Wextra}.
4750 @item -Wenum-compare
4751 @opindex Wenum-compare
4752 @opindex Wno-enum-compare
4753 Warn about a comparison between values of different enumerated types.
4754 In C++ enumeral mismatches in conditional expressions are also
4755 diagnosed and the warning is enabled by default.  In C this warning is 
4756 enabled by @option{-Wall}.
4758 @item -Wjump-misses-init @r{(C, Objective-C only)}
4759 @opindex Wjump-misses-init
4760 @opindex Wno-jump-misses-init
4761 Warn if a @code{goto} statement or a @code{switch} statement jumps
4762 forward across the initialization of a variable, or jumps backward to a
4763 label after the variable has been initialized.  This only warns about
4764 variables that are initialized when they are declared.  This warning is
4765 only supported for C and Objective-C; in C++ this sort of branch is an
4766 error in any case.
4768 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4769 can be disabled with the @option{-Wno-jump-misses-init} option.
4771 @item -Wsign-compare
4772 @opindex Wsign-compare
4773 @opindex Wno-sign-compare
4774 @cindex warning for comparison of signed and unsigned values
4775 @cindex comparison of signed and unsigned values, warning
4776 @cindex signed and unsigned values, comparison warning
4777 Warn when a comparison between signed and unsigned values could produce
4778 an incorrect result when the signed value is converted to unsigned.
4779 This warning is also enabled by @option{-Wextra}; to get the other warnings
4780 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4782 @item -Wsign-conversion
4783 @opindex Wsign-conversion
4784 @opindex Wno-sign-conversion
4785 Warn for implicit conversions that may change the sign of an integer
4786 value, like assigning a signed integer expression to an unsigned
4787 integer variable. An explicit cast silences the warning. In C, this
4788 option is enabled also by @option{-Wconversion}.
4790 @item -Wfloat-conversion
4791 @opindex Wfloat-conversion
4792 @opindex Wno-float-conversion
4793 Warn for implicit conversions that reduce the precision of a real value.
4794 This includes conversions from real to integer, and from higher precision
4795 real to lower precision real values.  This option is also enabled by
4796 @option{-Wconversion}.
4798 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4799 @opindex Wsized-deallocation
4800 @opindex -Wno-sized-deallocation
4801 Warn about a definition of an unsized deallocation function
4802 @smallexample
4803 void operator delete (void *) noexcept;
4804 void operator delete[] (void *) noexcept;
4805 @end smallexample
4806 without a definition of the corresponding sized deallocation function
4807 @smallexample
4808 void operator delete (void *, std::size_t) noexcept;
4809 void operator delete[] (void *, std::size_t) noexcept;
4810 @end smallexample
4811 or vice versa.  Enabled by @option{-Wextra} along with
4812 @option{-fsized-deallocation}.
4814 @item -Wsizeof-pointer-memaccess
4815 @opindex Wsizeof-pointer-memaccess
4816 @opindex Wno-sizeof-pointer-memaccess
4817 Warn for suspicious length parameters to certain string and memory built-in
4818 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4819 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4820 but a pointer, and suggests a possible fix, or about
4821 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4822 @option{-Wall}.
4824 @item -Wsizeof-array-argument
4825 @opindex Wsizeof-array-argument
4826 @opindex Wno-sizeof-array-argument
4827 Warn when the @code{sizeof} operator is applied to a parameter that is
4828 declared as an array in a function definition.  This warning is enabled by
4829 default for C and C++ programs.
4831 @item -Wmemset-transposed-args
4832 @opindex Wmemset-transposed-args
4833 @opindex Wno-memset-transposed-args
4834 Warn for suspicious calls to the @code{memset} built-in function, if the
4835 second argument is not zero and the third argument is zero.  This warns e.g.@
4836 about @code{memset (buf, sizeof buf, 0)} where most probably
4837 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4838 is only emitted if the third argument is literal zero, if it is some expression
4839 that is folded to zero, or e.g. a cast of zero to some type etc., it
4840 is far less likely that user has mistakenly exchanged the arguments and
4841 no warning is emitted.  This warning is enabled by @option{-Wall}.
4843 @item -Waddress
4844 @opindex Waddress
4845 @opindex Wno-address
4846 Warn about suspicious uses of memory addresses. These include using
4847 the address of a function in a conditional expression, such as
4848 @code{void func(void); if (func)}, and comparisons against the memory
4849 address of a string literal, such as @code{if (x == "abc")}.  Such
4850 uses typically indicate a programmer error: the address of a function
4851 always evaluates to true, so their use in a conditional usually
4852 indicate that the programmer forgot the parentheses in a function
4853 call; and comparisons against string literals result in unspecified
4854 behavior and are not portable in C, so they usually indicate that the
4855 programmer intended to use @code{strcmp}.  This warning is enabled by
4856 @option{-Wall}.
4858 @item -Wlogical-op
4859 @opindex Wlogical-op
4860 @opindex Wno-logical-op
4861 Warn about suspicious uses of logical operators in expressions.
4862 This includes using logical operators in contexts where a
4863 bit-wise operator is likely to be expected.
4865 @item -Wlogical-not-parentheses
4866 @opindex Wlogical-not-parentheses
4867 @opindex Wno-logical-not-parentheses
4868 Warn about logical not used on the left hand side operand of a comparison.
4869 This option does not warn if the RHS operand is of a boolean type.  Its
4870 purpose is to detect suspicious code like the following:
4871 @smallexample
4872 int a;
4873 @dots{}
4874 if (!a > 1) @{ @dots{} @}
4875 @end smallexample
4877 It is possible to suppress the warning by wrapping the LHS into
4878 parentheses:
4879 @smallexample
4880 if ((!a) > 1) @{ @dots{} @}
4881 @end smallexample
4883 This warning is enabled by @option{-Wall}.
4885 @item -Waggregate-return
4886 @opindex Waggregate-return
4887 @opindex Wno-aggregate-return
4888 Warn if any functions that return structures or unions are defined or
4889 called.  (In languages where you can return an array, this also elicits
4890 a warning.)
4892 @item -Wno-aggressive-loop-optimizations
4893 @opindex Wno-aggressive-loop-optimizations
4894 @opindex Waggressive-loop-optimizations
4895 Warn if in a loop with constant number of iterations the compiler detects
4896 undefined behavior in some statement during one or more of the iterations.
4898 @item -Wno-attributes
4899 @opindex Wno-attributes
4900 @opindex Wattributes
4901 Do not warn if an unexpected @code{__attribute__} is used, such as
4902 unrecognized attributes, function attributes applied to variables,
4903 etc.  This does not stop errors for incorrect use of supported
4904 attributes.
4906 @item -Wno-builtin-macro-redefined
4907 @opindex Wno-builtin-macro-redefined
4908 @opindex Wbuiltin-macro-redefined
4909 Do not warn if certain built-in macros are redefined.  This suppresses
4910 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4911 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4913 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4914 @opindex Wstrict-prototypes
4915 @opindex Wno-strict-prototypes
4916 Warn if a function is declared or defined without specifying the
4917 argument types.  (An old-style function definition is permitted without
4918 a warning if preceded by a declaration that specifies the argument
4919 types.)
4921 @item -Wold-style-declaration @r{(C and Objective-C only)}
4922 @opindex Wold-style-declaration
4923 @opindex Wno-old-style-declaration
4924 Warn for obsolescent usages, according to the C Standard, in a
4925 declaration. For example, warn if storage-class specifiers like
4926 @code{static} are not the first things in a declaration.  This warning
4927 is also enabled by @option{-Wextra}.
4929 @item -Wold-style-definition @r{(C and Objective-C only)}
4930 @opindex Wold-style-definition
4931 @opindex Wno-old-style-definition
4932 Warn if an old-style function definition is used.  A warning is given
4933 even if there is a previous prototype.
4935 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4936 @opindex Wmissing-parameter-type
4937 @opindex Wno-missing-parameter-type
4938 A function parameter is declared without a type specifier in K&R-style
4939 functions:
4941 @smallexample
4942 void foo(bar) @{ @}
4943 @end smallexample
4945 This warning is also enabled by @option{-Wextra}.
4947 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4948 @opindex Wmissing-prototypes
4949 @opindex Wno-missing-prototypes
4950 Warn if a global function is defined without a previous prototype
4951 declaration.  This warning is issued even if the definition itself
4952 provides a prototype.  Use this option to detect global functions
4953 that do not have a matching prototype declaration in a header file.
4954 This option is not valid for C++ because all function declarations
4955 provide prototypes and a non-matching declaration will declare an
4956 overload rather than conflict with an earlier declaration.
4957 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4959 @item -Wmissing-declarations
4960 @opindex Wmissing-declarations
4961 @opindex Wno-missing-declarations
4962 Warn if a global function is defined without a previous declaration.
4963 Do so even if the definition itself provides a prototype.
4964 Use this option to detect global functions that are not declared in
4965 header files.  In C, no warnings are issued for functions with previous
4966 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4967 missing prototypes.  In C++, no warnings are issued for function templates,
4968 or for inline functions, or for functions in anonymous namespaces.
4970 @item -Wmissing-field-initializers
4971 @opindex Wmissing-field-initializers
4972 @opindex Wno-missing-field-initializers
4973 @opindex W
4974 @opindex Wextra
4975 @opindex Wno-extra
4976 Warn if a structure's initializer has some fields missing.  For
4977 example, the following code causes such a warning, because
4978 @code{x.h} is implicitly zero:
4980 @smallexample
4981 struct s @{ int f, g, h; @};
4982 struct s x = @{ 3, 4 @};
4983 @end smallexample
4985 This option does not warn about designated initializers, so the following
4986 modification does not trigger a warning:
4988 @smallexample
4989 struct s @{ int f, g, h; @};
4990 struct s x = @{ .f = 3, .g = 4 @};
4991 @end smallexample
4993 In C++ this option does not warn either about the empty @{ @}
4994 initializer, for example:
4996 @smallexample
4997 struct s @{ int f, g, h; @};
4998 s x = @{ @};
4999 @end smallexample
5001 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
5002 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
5004 @item -Wno-multichar
5005 @opindex Wno-multichar
5006 @opindex Wmultichar
5007 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
5008 Usually they indicate a typo in the user's code, as they have
5009 implementation-defined values, and should not be used in portable code.
5011 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5012 @opindex Wnormalized=
5013 @opindex Wnormalized
5014 @opindex Wno-normalized
5015 @cindex NFC
5016 @cindex NFKC
5017 @cindex character set, input normalization
5018 In ISO C and ISO C++, two identifiers are different if they are
5019 different sequences of characters.  However, sometimes when characters
5020 outside the basic ASCII character set are used, you can have two
5021 different character sequences that look the same.  To avoid confusion,
5022 the ISO 10646 standard sets out some @dfn{normalization rules} which
5023 when applied ensure that two sequences that look the same are turned into
5024 the same sequence.  GCC can warn you if you are using identifiers that
5025 have not been normalized; this option controls that warning.
5027 There are four levels of warning supported by GCC@.  The default is
5028 @option{-Wnormalized=nfc}, which warns about any identifier that is
5029 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5030 recommended form for most uses.  It is equivalent to
5031 @option{-Wnormalized}.
5033 Unfortunately, there are some characters allowed in identifiers by
5034 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5035 identifiers.  That is, there's no way to use these symbols in portable
5036 ISO C or C++ and have all your identifiers in NFC@.
5037 @option{-Wnormalized=id} suppresses the warning for these characters.
5038 It is hoped that future versions of the standards involved will correct
5039 this, which is why this option is not the default.
5041 You can switch the warning off for all characters by writing
5042 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5043 only do this if you are using some other normalization scheme (like
5044 ``D''), because otherwise you can easily create bugs that are
5045 literally impossible to see.
5047 Some characters in ISO 10646 have distinct meanings but look identical
5048 in some fonts or display methodologies, especially once formatting has
5049 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5050 LETTER N'', displays just like a regular @code{n} that has been
5051 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5052 normalization scheme to convert all these into a standard form as
5053 well, and GCC warns if your code is not in NFKC if you use
5054 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5055 about every identifier that contains the letter O because it might be
5056 confused with the digit 0, and so is not the default, but may be
5057 useful as a local coding convention if the programming environment 
5058 cannot be fixed to display these characters distinctly.
5060 @item -Wno-deprecated
5061 @opindex Wno-deprecated
5062 @opindex Wdeprecated
5063 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5065 @item -Wno-deprecated-declarations
5066 @opindex Wno-deprecated-declarations
5067 @opindex Wdeprecated-declarations
5068 Do not warn about uses of functions (@pxref{Function Attributes}),
5069 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5070 Attributes}) marked as deprecated by using the @code{deprecated}
5071 attribute.
5073 @item -Wno-overflow
5074 @opindex Wno-overflow
5075 @opindex Woverflow
5076 Do not warn about compile-time overflow in constant expressions.
5078 @item -Wno-odr
5079 @opindex Wno-odr
5080 @opindex Wodr
5081 Warn about One Definition Rule violations during link-time optimization.
5082 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5084 @item -Wopenmp-simd
5085 @opindex Wopenm-simd
5086 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5087 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5088 be used to relax the cost model.
5090 @item -Woverride-init @r{(C and Objective-C only)}
5091 @opindex Woverride-init
5092 @opindex Wno-override-init
5093 @opindex W
5094 @opindex Wextra
5095 @opindex Wno-extra
5096 Warn if an initialized field without side effects is overridden when
5097 using designated initializers (@pxref{Designated Inits, , Designated
5098 Initializers}).
5100 This warning is included in @option{-Wextra}.  To get other
5101 @option{-Wextra} warnings without this one, use @option{-Wextra
5102 -Wno-override-init}.
5104 @item -Wpacked
5105 @opindex Wpacked
5106 @opindex Wno-packed
5107 Warn if a structure is given the packed attribute, but the packed
5108 attribute has no effect on the layout or size of the structure.
5109 Such structures may be mis-aligned for little benefit.  For
5110 instance, in this code, the variable @code{f.x} in @code{struct bar}
5111 is misaligned even though @code{struct bar} does not itself
5112 have the packed attribute:
5114 @smallexample
5115 @group
5116 struct foo @{
5117   int x;
5118   char a, b, c, d;
5119 @} __attribute__((packed));
5120 struct bar @{
5121   char z;
5122   struct foo f;
5124 @end group
5125 @end smallexample
5127 @item -Wpacked-bitfield-compat
5128 @opindex Wpacked-bitfield-compat
5129 @opindex Wno-packed-bitfield-compat
5130 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5131 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5132 the change can lead to differences in the structure layout.  GCC
5133 informs you when the offset of such a field has changed in GCC 4.4.
5134 For example there is no longer a 4-bit padding between field @code{a}
5135 and @code{b} in this structure:
5137 @smallexample
5138 struct foo
5140   char a:4;
5141   char b:8;
5142 @} __attribute__ ((packed));
5143 @end smallexample
5145 This warning is enabled by default.  Use
5146 @option{-Wno-packed-bitfield-compat} to disable this warning.
5148 @item -Wpadded
5149 @opindex Wpadded
5150 @opindex Wno-padded
5151 Warn if padding is included in a structure, either to align an element
5152 of the structure or to align the whole structure.  Sometimes when this
5153 happens it is possible to rearrange the fields of the structure to
5154 reduce the padding and so make the structure smaller.
5156 @item -Wredundant-decls
5157 @opindex Wredundant-decls
5158 @opindex Wno-redundant-decls
5159 Warn if anything is declared more than once in the same scope, even in
5160 cases where multiple declaration is valid and changes nothing.
5162 @item -Wnested-externs @r{(C and Objective-C only)}
5163 @opindex Wnested-externs
5164 @opindex Wno-nested-externs
5165 Warn if an @code{extern} declaration is encountered within a function.
5167 @item -Wno-inherited-variadic-ctor
5168 @opindex Winherited-variadic-ctor
5169 @opindex Wno-inherited-variadic-ctor
5170 Suppress warnings about use of C++11 inheriting constructors when the
5171 base class inherited from has a C variadic constructor; the warning is
5172 on by default because the ellipsis is not inherited.
5174 @item -Winline
5175 @opindex Winline
5176 @opindex Wno-inline
5177 Warn if a function that is declared as inline cannot be inlined.
5178 Even with this option, the compiler does not warn about failures to
5179 inline functions declared in system headers.
5181 The compiler uses a variety of heuristics to determine whether or not
5182 to inline a function.  For example, the compiler takes into account
5183 the size of the function being inlined and the amount of inlining
5184 that has already been done in the current function.  Therefore,
5185 seemingly insignificant changes in the source program can cause the
5186 warnings produced by @option{-Winline} to appear or disappear.
5188 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5189 @opindex Wno-invalid-offsetof
5190 @opindex Winvalid-offsetof
5191 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5192 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5193 to a non-standard-layout type is undefined.  In existing C++ implementations,
5194 however, @samp{offsetof} typically gives meaningful results.
5195 This flag is for users who are aware that they are
5196 writing nonportable code and who have deliberately chosen to ignore the
5197 warning about it.
5199 The restrictions on @samp{offsetof} may be relaxed in a future version
5200 of the C++ standard.
5202 @item -Wno-int-to-pointer-cast
5203 @opindex Wno-int-to-pointer-cast
5204 @opindex Wint-to-pointer-cast
5205 Suppress warnings from casts to pointer type of an integer of a
5206 different size. In C++, casting to a pointer type of smaller size is
5207 an error. @option{Wint-to-pointer-cast} is enabled by default.
5210 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5211 @opindex Wno-pointer-to-int-cast
5212 @opindex Wpointer-to-int-cast
5213 Suppress warnings from casts from a pointer to an integer type of a
5214 different size.
5216 @item -Winvalid-pch
5217 @opindex Winvalid-pch
5218 @opindex Wno-invalid-pch
5219 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5220 the search path but can't be used.
5222 @item -Wlong-long
5223 @opindex Wlong-long
5224 @opindex Wno-long-long
5225 Warn if @samp{long long} type is used.  This is enabled by either
5226 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5227 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5229 @item -Wvariadic-macros
5230 @opindex Wvariadic-macros
5231 @opindex Wno-variadic-macros
5232 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5233 alternate syntax is used in ISO C99 mode.  This is enabled by either
5234 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5235 messages, use @option{-Wno-variadic-macros}.
5237 @item -Wvarargs
5238 @opindex Wvarargs
5239 @opindex Wno-varargs
5240 Warn upon questionable usage of the macros used to handle variable
5241 arguments like @samp{va_start}.  This is default.  To inhibit the
5242 warning messages, use @option{-Wno-varargs}.
5244 @item -Wvector-operation-performance
5245 @opindex Wvector-operation-performance
5246 @opindex Wno-vector-operation-performance
5247 Warn if vector operation is not implemented via SIMD capabilities of the
5248 architecture.  Mainly useful for the performance tuning.
5249 Vector operation can be implemented @code{piecewise}, which means that the
5250 scalar operation is performed on every vector element; 
5251 @code{in parallel}, which means that the vector operation is implemented
5252 using scalars of wider type, which normally is more performance efficient;
5253 and @code{as a single scalar}, which means that vector fits into a
5254 scalar type.
5256 @item -Wno-virtual-move-assign
5257 @opindex Wvirtual-move-assign
5258 @opindex Wno-virtual-move-assign
5259 Suppress warnings about inheriting from a virtual base with a
5260 non-trivial C++11 move assignment operator.  This is dangerous because
5261 if the virtual base is reachable along more than one path, it will be
5262 moved multiple times, which can mean both objects end up in the
5263 moved-from state.  If the move assignment operator is written to avoid
5264 moving from a moved-from object, this warning can be disabled.
5266 @item -Wvla
5267 @opindex Wvla
5268 @opindex Wno-vla
5269 Warn if variable length array is used in the code.
5270 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5271 the variable length array.
5273 @item -Wvolatile-register-var
5274 @opindex Wvolatile-register-var
5275 @opindex Wno-volatile-register-var
5276 Warn if a register variable is declared volatile.  The volatile
5277 modifier does not inhibit all optimizations that may eliminate reads
5278 and/or writes to register variables.  This warning is enabled by
5279 @option{-Wall}.
5281 @item -Wdisabled-optimization
5282 @opindex Wdisabled-optimization
5283 @opindex Wno-disabled-optimization
5284 Warn if a requested optimization pass is disabled.  This warning does
5285 not generally indicate that there is anything wrong with your code; it
5286 merely indicates that GCC's optimizers are unable to handle the code
5287 effectively.  Often, the problem is that your code is too big or too
5288 complex; GCC refuses to optimize programs when the optimization
5289 itself is likely to take inordinate amounts of time.
5291 @item -Wpointer-sign @r{(C and Objective-C only)}
5292 @opindex Wpointer-sign
5293 @opindex Wno-pointer-sign
5294 Warn for pointer argument passing or assignment with different signedness.
5295 This option is only supported for C and Objective-C@.  It is implied by
5296 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5297 @option{-Wno-pointer-sign}.
5299 @item -Wstack-protector
5300 @opindex Wstack-protector
5301 @opindex Wno-stack-protector
5302 This option is only active when @option{-fstack-protector} is active.  It
5303 warns about functions that are not protected against stack smashing.
5305 @item -Woverlength-strings
5306 @opindex Woverlength-strings
5307 @opindex Wno-overlength-strings
5308 Warn about string constants that are longer than the ``minimum
5309 maximum'' length specified in the C standard.  Modern compilers
5310 generally allow string constants that are much longer than the
5311 standard's minimum limit, but very portable programs should avoid
5312 using longer strings.
5314 The limit applies @emph{after} string constant concatenation, and does
5315 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5316 C99, it was raised to 4095.  C++98 does not specify a normative
5317 minimum maximum, so we do not diagnose overlength strings in C++@.
5319 This option is implied by @option{-Wpedantic}, and can be disabled with
5320 @option{-Wno-overlength-strings}.
5322 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5323 @opindex Wunsuffixed-float-constants
5325 Issue a warning for any floating constant that does not have
5326 a suffix.  When used together with @option{-Wsystem-headers} it
5327 warns about such constants in system header files.  This can be useful
5328 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5329 from the decimal floating-point extension to C99.
5331 @item -Wno-designated-init @r{(C and Objective-C only)}
5332 Suppress warnings when a positional initializer is used to initialize
5333 a structure that has been marked with the @code{designated_init}
5334 attribute.
5336 @end table
5338 @node Debugging Options
5339 @section Options for Debugging Your Program or GCC
5340 @cindex options, debugging
5341 @cindex debugging information options
5343 GCC has various special options that are used for debugging
5344 either your program or GCC:
5346 @table @gcctabopt
5347 @item -g
5348 @opindex g
5349 Produce debugging information in the operating system's native format
5350 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5351 information.
5353 On most systems that use stabs format, @option{-g} enables use of extra
5354 debugging information that only GDB can use; this extra information
5355 makes debugging work better in GDB but probably makes other debuggers
5356 crash or
5357 refuse to read the program.  If you want to control for certain whether
5358 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5359 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5361 GCC allows you to use @option{-g} with
5362 @option{-O}.  The shortcuts taken by optimized code may occasionally
5363 produce surprising results: some variables you declared may not exist
5364 at all; flow of control may briefly move where you did not expect it;
5365 some statements may not be executed because they compute constant
5366 results or their values are already at hand; some statements may
5367 execute in different places because they have been moved out of loops.
5369 Nevertheless it proves possible to debug optimized output.  This makes
5370 it reasonable to use the optimizer for programs that might have bugs.
5372 The following options are useful when GCC is generated with the
5373 capability for more than one debugging format.
5375 @item -gsplit-dwarf
5376 @opindex gsplit-dwarf
5377 Separate as much dwarf debugging information as possible into a
5378 separate output file with the extension .dwo.  This option allows
5379 the build system to avoid linking files with debug information.  To
5380 be useful, this option requires a debugger capable of reading .dwo
5381 files.
5383 @item -ggdb
5384 @opindex ggdb
5385 Produce debugging information for use by GDB@.  This means to use the
5386 most expressive format available (DWARF 2, stabs, or the native format
5387 if neither of those are supported), including GDB extensions if at all
5388 possible.
5390 @item -gpubnames
5391 @opindex gpubnames
5392 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5394 @item -ggnu-pubnames
5395 @opindex ggnu-pubnames
5396 Generate .debug_pubnames and .debug_pubtypes sections in a format
5397 suitable for conversion into a GDB@ index.  This option is only useful
5398 with a linker that can produce GDB@ index version 7.
5400 @item -gstabs
5401 @opindex gstabs
5402 Produce debugging information in stabs format (if that is supported),
5403 without GDB extensions.  This is the format used by DBX on most BSD
5404 systems.  On MIPS, Alpha and System V Release 4 systems this option
5405 produces stabs debugging output that is not understood by DBX or SDB@.
5406 On System V Release 4 systems this option requires the GNU assembler.
5408 @item -feliminate-unused-debug-symbols
5409 @opindex feliminate-unused-debug-symbols
5410 Produce debugging information in stabs format (if that is supported),
5411 for only symbols that are actually used.
5413 @item -femit-class-debug-always
5414 Instead of emitting debugging information for a C++ class in only one
5415 object file, emit it in all object files using the class.  This option
5416 should be used only with debuggers that are unable to handle the way GCC
5417 normally emits debugging information for classes because using this
5418 option increases the size of debugging information by as much as a
5419 factor of two.
5421 @item -fdebug-types-section
5422 @opindex fdebug-types-section
5423 @opindex fno-debug-types-section
5424 When using DWARF Version 4 or higher, type DIEs can be put into
5425 their own @code{.debug_types} section instead of making them part of the
5426 @code{.debug_info} section.  It is more efficient to put them in a separate
5427 comdat sections since the linker can then remove duplicates.
5428 But not all DWARF consumers support @code{.debug_types} sections yet
5429 and on some objects @code{.debug_types} produces larger instead of smaller
5430 debugging information.
5432 @item -gstabs+
5433 @opindex gstabs+
5434 Produce debugging information in stabs format (if that is supported),
5435 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5436 use of these extensions is likely to make other debuggers crash or
5437 refuse to read the program.
5439 @item -gcoff
5440 @opindex gcoff
5441 Produce debugging information in COFF format (if that is supported).
5442 This is the format used by SDB on most System V systems prior to
5443 System V Release 4.
5445 @item -gxcoff
5446 @opindex gxcoff
5447 Produce debugging information in XCOFF format (if that is supported).
5448 This is the format used by the DBX debugger on IBM RS/6000 systems.
5450 @item -gxcoff+
5451 @opindex gxcoff+
5452 Produce debugging information in XCOFF format (if that is supported),
5453 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5454 use of these extensions is likely to make other debuggers crash or
5455 refuse to read the program, and may cause assemblers other than the GNU
5456 assembler (GAS) to fail with an error.
5458 @item -gdwarf-@var{version}
5459 @opindex gdwarf-@var{version}
5460 Produce debugging information in DWARF format (if that is supported).
5461 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5462 for most targets is 4.  DWARF Version 5 is only experimental.
5464 Note that with DWARF Version 2, some ports require and always
5465 use some non-conflicting DWARF 3 extensions in the unwind tables.
5467 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5468 for maximum benefit.
5470 @item -grecord-gcc-switches
5471 @opindex grecord-gcc-switches
5472 This switch causes the command-line options used to invoke the
5473 compiler that may affect code generation to be appended to the
5474 DW_AT_producer attribute in DWARF debugging information.  The options
5475 are concatenated with spaces separating them from each other and from
5476 the compiler version.  See also @option{-frecord-gcc-switches} for another
5477 way of storing compiler options into the object file.  This is the default.
5479 @item -gno-record-gcc-switches
5480 @opindex gno-record-gcc-switches
5481 Disallow appending command-line options to the DW_AT_producer attribute
5482 in DWARF debugging information.
5484 @item -gstrict-dwarf
5485 @opindex gstrict-dwarf
5486 Disallow using extensions of later DWARF standard version than selected
5487 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5488 DWARF extensions from later standard versions is allowed.
5490 @item -gno-strict-dwarf
5491 @opindex gno-strict-dwarf
5492 Allow using extensions of later DWARF standard version than selected with
5493 @option{-gdwarf-@var{version}}.
5495 @item -gz@r{[}=@var{type}@r{]}
5496 @opindex gz
5497 Produce compressed debug sections in DWARF format, if that is supported.
5498 If @var{type} is not given, the default type depends on the capabilities
5499 of the assembler and linker used.  @var{type} may be one of
5500 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5501 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5502 compression in traditional GNU format).  If the linker doesn't support
5503 writing compressed debug sections, the option is rejected.  Otherwise,
5504 if the assembler does not support them, @option{-gz} is silently ignored
5505 when producing object files.
5507 @item -gvms
5508 @opindex gvms
5509 Produce debugging information in Alpha/VMS debug format (if that is
5510 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5512 @item -g@var{level}
5513 @itemx -ggdb@var{level}
5514 @itemx -gstabs@var{level}
5515 @itemx -gcoff@var{level}
5516 @itemx -gxcoff@var{level}
5517 @itemx -gvms@var{level}
5518 Request debugging information and also use @var{level} to specify how
5519 much information.  The default level is 2.
5521 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5522 @option{-g}.
5524 Level 1 produces minimal information, enough for making backtraces in
5525 parts of the program that you don't plan to debug.  This includes
5526 descriptions of functions and external variables, and line number
5527 tables, but no information about local variables.
5529 Level 3 includes extra information, such as all the macro definitions
5530 present in the program.  Some debuggers support macro expansion when
5531 you use @option{-g3}.
5533 @option{-gdwarf-2} does not accept a concatenated debug level, because
5534 GCC used to support an option @option{-gdwarf} that meant to generate
5535 debug information in version 1 of the DWARF format (which is very
5536 different from version 2), and it would have been too confusing.  That
5537 debug format is long obsolete, but the option cannot be changed now.
5538 Instead use an additional @option{-g@var{level}} option to change the
5539 debug level for DWARF.
5541 @item -gtoggle
5542 @opindex gtoggle
5543 Turn off generation of debug info, if leaving out this option
5544 generates it, or turn it on at level 2 otherwise.  The position of this
5545 argument in the command line does not matter; it takes effect after all
5546 other options are processed, and it does so only once, no matter how
5547 many times it is given.  This is mainly intended to be used with
5548 @option{-fcompare-debug}.
5550 @item -fsanitize=address
5551 @opindex fsanitize=address
5552 Enable AddressSanitizer, a fast memory error detector.
5553 Memory access instructions will be instrumented to detect
5554 out-of-bounds and use-after-free bugs.
5555 See @uref{http://code.google.com/p/address-sanitizer/} for
5556 more details.  The run-time behavior can be influenced using the
5557 @env{ASAN_OPTIONS} environment variable; see
5558 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5559 a list of supported options.
5561 @item -fsanitize=kernel-address
5562 @opindex fsanitize=kernel-address
5563 Enable AddressSanitizer for Linux kernel.
5564 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5566 @item -fsanitize=thread
5567 @opindex fsanitize=thread
5568 Enable ThreadSanitizer, a fast data race detector.
5569 Memory access instructions will be instrumented to detect
5570 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5571 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5572 environment variable; see
5573 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5574 supported options.
5576 @item -fsanitize=leak
5577 @opindex fsanitize=leak
5578 Enable LeakSanitizer, a memory leak detector.
5579 This option only matters for linking of executables and if neither
5580 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5581 case it will link the executable against a library that overrides @code{malloc}
5582 and other allocator functions.  See
5583 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5584 details.  The run-time behavior can be influenced using the
5585 @env{LSAN_OPTIONS} environment variable.
5587 @item -fsanitize=undefined
5588 @opindex fsanitize=undefined
5589 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5590 Various computations will be instrumented to detect undefined behavior
5591 at runtime.  Current suboptions are:
5593 @table @gcctabopt
5595 @item -fsanitize=shift
5596 @opindex fsanitize=shift
5597 This option enables checking that the result of a shift operation is
5598 not undefined.  Note that what exactly is considered undefined differs
5599 slightly between C and C++, as well as between ISO C90 and C99, etc.
5601 @item -fsanitize=integer-divide-by-zero
5602 @opindex fsanitize=integer-divide-by-zero
5603 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5605 @item -fsanitize=unreachable
5606 @opindex fsanitize=unreachable
5607 With this option, the compiler will turn the @code{__builtin_unreachable}
5608 call into a diagnostics message call instead.  When reaching the
5609 @code{__builtin_unreachable} call, the behavior is undefined.
5611 @item -fsanitize=vla-bound
5612 @opindex fsanitize=vla-bound
5613 This option instructs the compiler to check that the size of a variable
5614 length array is positive.  This option does not have any effect in
5615 @option{-std=c++14} mode, as the standard requires the exception be thrown
5616 instead.
5618 @item -fsanitize=null
5619 @opindex fsanitize=null
5620 This option enables pointer checking.  Particularly, the application
5621 built with this option turned on will issue an error message when it
5622 tries to dereference a NULL pointer, or if a reference (possibly an
5623 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5624 on an object pointed by a NULL pointer.
5626 @item -fsanitize=return
5627 @opindex fsanitize=return
5628 This option enables return statement checking.  Programs
5629 built with this option turned on will issue an error message
5630 when the end of a non-void function is reached without actually
5631 returning a value.  This option works in C++ only.
5633 @item -fsanitize=signed-integer-overflow
5634 @opindex fsanitize=signed-integer-overflow
5635 This option enables signed integer overflow checking.  We check that
5636 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5637 does not overflow in the signed arithmetics.  Note, integer promotion
5638 rules must be taken into account.  That is, the following is not an
5639 overflow:
5640 @smallexample
5641 signed char a = SCHAR_MAX;
5642 a++;
5643 @end smallexample
5645 @item -fsanitize=bounds
5646 @opindex fsanitize=bounds
5647 This option enables instrumentation of array bounds.  Various out of bounds
5648 accesses are detected.  Flexible array members and initializers of variables
5649 with static storage are not instrumented.
5651 @item -fsanitize=alignment
5652 @opindex fsanitize=alignment
5654 This option enables checking of alignment of pointers when they are
5655 dereferenced, or when a reference is bound to insufficiently aligned target,
5656 or when a method or constructor is invoked on insufficiently aligned object.
5658 @item -fsanitize=object-size
5659 @opindex fsanitize=object-size
5660 This option enables instrumentation of memory references using the
5661 @code{__builtin_object_size} function.  Various out of bounds pointer
5662 accesses are detected.
5664 @item -fsanitize=float-divide-by-zero
5665 @opindex fsanitize=float-divide-by-zero
5666 Detect floating-point division by zero.  Unlike other similar options,
5667 @option{-fsanitize=float-divide-by-zero} is not enabled by
5668 @option{-fsanitize=undefined}, since floating-point division by zero can
5669 be a legitimate way of obtaining infinities and NaNs.
5671 @item -fsanitize=float-cast-overflow
5672 @opindex fsanitize=float-cast-overflow
5673 This option enables floating-point type to integer conversion checking.
5674 We check that the result of the conversion does not overflow.
5675 This option does not work well with @code{FE_INVALID} exceptions enabled.
5677 @item -fsanitize=nonnull-attribute
5678 @opindex fsanitize=nonnull-attribute
5680 This option enables instrumentation of calls, checking whether null values
5681 are not passed to arguments marked as requiring a non-null value by the
5682 @code{nonnull} function attribute.
5684 @item -fsanitize=returns-nonnull-attribute
5685 @opindex fsanitize=returns-nonnull-attribute
5687 This option enables instrumentation of return statements in functions
5688 marked with @code{returns_nonnull} function attribute, to detect returning
5689 of null values from such functions.
5691 @item -fsanitize=bool
5692 @opindex fsanitize=bool
5694 This option enables instrumentation of loads from bool.  If a value other
5695 than 0/1 is loaded, a run-time error is issued.
5697 @item -fsanitize=enum
5698 @opindex fsanitize=enum
5700 This option enables instrumentation of loads from an enum type.  If
5701 a value outside the range of values for the enum type is loaded,
5702 a run-time error is issued.
5704 @end table
5706 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5707 @option{-fsanitize=undefined} gives a diagnostic message.
5708 This currently works only for the C family of languages.
5710 @item -fasan-shadow-offset=@var{number}
5711 @opindex fasan-shadow-offset
5712 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5713 It is useful for experimenting with different shadow memory layouts in
5714 Kernel AddressSanitizer.
5716 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5717 @opindex fsanitize-recover
5718 @opindex fno-sanitize-recover
5719 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5720 mentioned in comma-separated list of @var{opts}.  Enabling this option
5721 for a sanitizer component would cause it to attempt to continue
5722 running the program as if no error happened.  This means multiple
5723 runtime errors can be reported in a single program run, and the exit
5724 code of the program may indicate success even when errors
5725 have been reported.  The @option{-fno-sanitize-recover=} can be used to alter
5726 this behavior, only the first detected error will be reported
5727 and program will exit after that with non-zero exit code.
5729 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5730 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5731 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5732 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5734 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5735 @option{-fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5736 Similarly @option{-fno-sanitize-recover} is equivalent to
5737 @option{-fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5739 @item -fsanitize-undefined-trap-on-error
5740 @opindex fsanitize-undefined-trap-on-error
5741 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5742 report undefined behavior using @code{__builtin_trap ()} rather than
5743 a @code{libubsan} library routine.  The advantage of this is that the
5744 @code{libubsan} library is not needed and will not be linked in, so this
5745 is usable even for use in freestanding environments.
5747 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5748 @opindex fdump-final-insns
5749 Dump the final internal representation (RTL) to @var{file}.  If the
5750 optional argument is omitted (or if @var{file} is @code{.}), the name
5751 of the dump file is determined by appending @code{.gkd} to the
5752 compilation output file name.
5754 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5755 @opindex fcompare-debug
5756 @opindex fno-compare-debug
5757 If no error occurs during compilation, run the compiler a second time,
5758 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5759 passed to the second compilation.  Dump the final internal
5760 representation in both compilations, and print an error if they differ.
5762 If the equal sign is omitted, the default @option{-gtoggle} is used.
5764 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5765 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5766 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5767 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5768 is used.
5770 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5771 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5772 of the final representation and the second compilation, preventing even
5773 @env{GCC_COMPARE_DEBUG} from taking effect.
5775 To verify full coverage during @option{-fcompare-debug} testing, set
5776 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5777 which GCC rejects as an invalid option in any actual compilation
5778 (rather than preprocessing, assembly or linking).  To get just a
5779 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5780 not overridden} will do.
5782 @item -fcompare-debug-second
5783 @opindex fcompare-debug-second
5784 This option is implicitly passed to the compiler for the second
5785 compilation requested by @option{-fcompare-debug}, along with options to
5786 silence warnings, and omitting other options that would cause
5787 side-effect compiler outputs to files or to the standard output.  Dump
5788 files and preserved temporary files are renamed so as to contain the
5789 @code{.gk} additional extension during the second compilation, to avoid
5790 overwriting those generated by the first.
5792 When this option is passed to the compiler driver, it causes the
5793 @emph{first} compilation to be skipped, which makes it useful for little
5794 other than debugging the compiler proper.
5796 @item -feliminate-dwarf2-dups
5797 @opindex feliminate-dwarf2-dups
5798 Compress DWARF 2 debugging information by eliminating duplicated
5799 information about each symbol.  This option only makes sense when
5800 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5802 @item -femit-struct-debug-baseonly
5803 @opindex femit-struct-debug-baseonly
5804 Emit debug information for struct-like types
5805 only when the base name of the compilation source file
5806 matches the base name of file in which the struct is defined.
5808 This option substantially reduces the size of debugging information,
5809 but at significant potential loss in type information to the debugger.
5810 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5811 See @option{-femit-struct-debug-detailed} for more detailed control.
5813 This option works only with DWARF 2.
5815 @item -femit-struct-debug-reduced
5816 @opindex femit-struct-debug-reduced
5817 Emit debug information for struct-like types
5818 only when the base name of the compilation source file
5819 matches the base name of file in which the type is defined,
5820 unless the struct is a template or defined in a system header.
5822 This option significantly reduces the size of debugging information,
5823 with some potential loss in type information to the debugger.
5824 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5825 See @option{-femit-struct-debug-detailed} for more detailed control.
5827 This option works only with DWARF 2.
5829 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5830 Specify the struct-like types
5831 for which the compiler generates debug information.
5832 The intent is to reduce duplicate struct debug information
5833 between different object files within the same program.
5835 This option is a detailed version of
5836 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5837 which serves for most needs.
5839 A specification has the syntax@*
5840 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5842 The optional first word limits the specification to
5843 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5844 A struct type is used directly when it is the type of a variable, member.
5845 Indirect uses arise through pointers to structs.
5846 That is, when use of an incomplete struct is valid, the use is indirect.
5847 An example is
5848 @samp{struct one direct; struct two * indirect;}.
5850 The optional second word limits the specification to
5851 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5852 Generic structs are a bit complicated to explain.
5853 For C++, these are non-explicit specializations of template classes,
5854 or non-template classes within the above.
5855 Other programming languages have generics,
5856 but @option{-femit-struct-debug-detailed} does not yet implement them.
5858 The third word specifies the source files for those
5859 structs for which the compiler should emit debug information.
5860 The values @samp{none} and @samp{any} have the normal meaning.
5861 The value @samp{base} means that
5862 the base of name of the file in which the type declaration appears
5863 must match the base of the name of the main compilation file.
5864 In practice, this means that when compiling @file{foo.c}, debug information
5865 is generated for types declared in that file and @file{foo.h},
5866 but not other header files.
5867 The value @samp{sys} means those types satisfying @samp{base}
5868 or declared in system or compiler headers.
5870 You may need to experiment to determine the best settings for your application.
5872 The default is @option{-femit-struct-debug-detailed=all}.
5874 This option works only with DWARF 2.
5876 @item -fno-merge-debug-strings
5877 @opindex fmerge-debug-strings
5878 @opindex fno-merge-debug-strings
5879 Direct the linker to not merge together strings in the debugging
5880 information that are identical in different object files.  Merging is
5881 not supported by all assemblers or linkers.  Merging decreases the size
5882 of the debug information in the output file at the cost of increasing
5883 link processing time.  Merging is enabled by default.
5885 @item -fdebug-prefix-map=@var{old}=@var{new}
5886 @opindex fdebug-prefix-map
5887 When compiling files in directory @file{@var{old}}, record debugging
5888 information describing them as in @file{@var{new}} instead.
5890 @item -fno-dwarf2-cfi-asm
5891 @opindex fdwarf2-cfi-asm
5892 @opindex fno-dwarf2-cfi-asm
5893 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5894 instead of using GAS @code{.cfi_*} directives.
5896 @cindex @command{prof}
5897 @item -p
5898 @opindex p
5899 Generate extra code to write profile information suitable for the
5900 analysis program @command{prof}.  You must use this option when compiling
5901 the source files you want data about, and you must also use it when
5902 linking.
5904 @cindex @command{gprof}
5905 @item -pg
5906 @opindex pg
5907 Generate extra code to write profile information suitable for the
5908 analysis program @command{gprof}.  You must use this option when compiling
5909 the source files you want data about, and you must also use it when
5910 linking.
5912 @item -Q
5913 @opindex Q
5914 Makes the compiler print out each function name as it is compiled, and
5915 print some statistics about each pass when it finishes.
5917 @item -ftime-report
5918 @opindex ftime-report
5919 Makes the compiler print some statistics about the time consumed by each
5920 pass when it finishes.
5922 @item -fmem-report
5923 @opindex fmem-report
5924 Makes the compiler print some statistics about permanent memory
5925 allocation when it finishes.
5927 @item -fmem-report-wpa
5928 @opindex fmem-report-wpa
5929 Makes the compiler print some statistics about permanent memory
5930 allocation for the WPA phase only.
5932 @item -fpre-ipa-mem-report
5933 @opindex fpre-ipa-mem-report
5934 @item -fpost-ipa-mem-report
5935 @opindex fpost-ipa-mem-report
5936 Makes the compiler print some statistics about permanent memory
5937 allocation before or after interprocedural optimization.
5939 @item -fprofile-report
5940 @opindex fprofile-report
5941 Makes the compiler print some statistics about consistency of the
5942 (estimated) profile and effect of individual passes.
5944 @item -fstack-usage
5945 @opindex fstack-usage
5946 Makes the compiler output stack usage information for the program, on a
5947 per-function basis.  The filename for the dump is made by appending
5948 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5949 the output file, if explicitly specified and it is not an executable,
5950 otherwise it is the basename of the source file.  An entry is made up
5951 of three fields:
5953 @itemize
5954 @item
5955 The name of the function.
5956 @item
5957 A number of bytes.
5958 @item
5959 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5960 @end itemize
5962 The qualifier @code{static} means that the function manipulates the stack
5963 statically: a fixed number of bytes are allocated for the frame on function
5964 entry and released on function exit; no stack adjustments are otherwise made
5965 in the function.  The second field is this fixed number of bytes.
5967 The qualifier @code{dynamic} means that the function manipulates the stack
5968 dynamically: in addition to the static allocation described above, stack
5969 adjustments are made in the body of the function, for example to push/pop
5970 arguments around function calls.  If the qualifier @code{bounded} is also
5971 present, the amount of these adjustments is bounded at compile time and
5972 the second field is an upper bound of the total amount of stack used by
5973 the function.  If it is not present, the amount of these adjustments is
5974 not bounded at compile time and the second field only represents the
5975 bounded part.
5977 @item -fprofile-arcs
5978 @opindex fprofile-arcs
5979 Add code so that program flow @dfn{arcs} are instrumented.  During
5980 execution the program records how many times each branch and call is
5981 executed and how many times it is taken or returns.  When the compiled
5982 program exits it saves this data to a file called
5983 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5984 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5985 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5986 @var{auxname} is generated from the name of the output file, if
5987 explicitly specified and it is not the final executable, otherwise it is
5988 the basename of the source file.  In both cases any suffix is removed
5989 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5990 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5991 @xref{Cross-profiling}.
5993 @cindex @command{gcov}
5994 @item --coverage
5995 @opindex coverage
5997 This option is used to compile and link code instrumented for coverage
5998 analysis.  The option is a synonym for @option{-fprofile-arcs}
5999 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
6000 linking).  See the documentation for those options for more details.
6002 @itemize
6004 @item
6005 Compile the source files with @option{-fprofile-arcs} plus optimization
6006 and code generation options.  For test coverage analysis, use the
6007 additional @option{-ftest-coverage} option.  You do not need to profile
6008 every source file in a program.
6010 @item
6011 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6012 (the latter implies the former).
6014 @item
6015 Run the program on a representative workload to generate the arc profile
6016 information.  This may be repeated any number of times.  You can run
6017 concurrent instances of your program, and provided that the file system
6018 supports locking, the data files will be correctly updated.  Also
6019 @code{fork} calls are detected and correctly handled (double counting
6020 will not happen).
6022 @item
6023 For profile-directed optimizations, compile the source files again with
6024 the same optimization and code generation options plus
6025 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6026 Control Optimization}).
6028 @item
6029 For test coverage analysis, use @command{gcov} to produce human readable
6030 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6031 @command{gcov} documentation for further information.
6033 @end itemize
6035 With @option{-fprofile-arcs}, for each function of your program GCC
6036 creates a program flow graph, then finds a spanning tree for the graph.
6037 Only arcs that are not on the spanning tree have to be instrumented: the
6038 compiler adds code to count the number of times that these arcs are
6039 executed.  When an arc is the only exit or only entrance to a block, the
6040 instrumentation code can be added to the block; otherwise, a new basic
6041 block must be created to hold the instrumentation code.
6043 @need 2000
6044 @item -ftest-coverage
6045 @opindex ftest-coverage
6046 Produce a notes file that the @command{gcov} code-coverage utility
6047 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6048 show program coverage.  Each source file's note file is called
6049 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6050 above for a description of @var{auxname} and instructions on how to
6051 generate test coverage data.  Coverage data matches the source files
6052 more closely if you do not optimize.
6054 @item -fdbg-cnt-list
6055 @opindex fdbg-cnt-list
6056 Print the name and the counter upper bound for all debug counters.
6059 @item -fdbg-cnt=@var{counter-value-list}
6060 @opindex fdbg-cnt
6061 Set the internal debug counter upper bound.  @var{counter-value-list}
6062 is a comma-separated list of @var{name}:@var{value} pairs
6063 which sets the upper bound of each debug counter @var{name} to @var{value}.
6064 All debug counters have the initial upper bound of @code{UINT_MAX};
6065 thus @code{dbg_cnt()} returns true always unless the upper bound
6066 is set by this option.
6067 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6068 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6070 @item -fenable-@var{kind}-@var{pass}
6071 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6072 @opindex fdisable-
6073 @opindex fenable-
6075 This is a set of options that are used to explicitly disable/enable
6076 optimization passes.  These options are intended for use for debugging GCC.
6077 Compiler users should use regular options for enabling/disabling
6078 passes instead.
6080 @table @gcctabopt
6082 @item -fdisable-ipa-@var{pass}
6083 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6084 statically invoked in the compiler multiple times, the pass name should be
6085 appended with a sequential number starting from 1.
6087 @item -fdisable-rtl-@var{pass}
6088 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6089 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6090 statically invoked in the compiler multiple times, the pass name should be
6091 appended with a sequential number starting from 1.  @var{range-list} is a 
6092 comma-separated list of function ranges or assembler names.  Each range is a number
6093 pair separated by a colon.  The range is inclusive in both ends.  If the range
6094 is trivial, the number pair can be simplified as a single number.  If the
6095 function's call graph node's @var{uid} falls within one of the specified ranges,
6096 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6097 function header of a dump file, and the pass names can be dumped by using
6098 option @option{-fdump-passes}.
6100 @item -fdisable-tree-@var{pass}
6101 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6102 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6103 option arguments.
6105 @item -fenable-ipa-@var{pass}
6106 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6107 statically invoked in the compiler multiple times, the pass name should be
6108 appended with a sequential number starting from 1.
6110 @item -fenable-rtl-@var{pass}
6111 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6112 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6113 description and examples.
6115 @item -fenable-tree-@var{pass}
6116 @itemx -fenable-tree-@var{pass}=@var{range-list}
6117 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6118 of option arguments.
6120 @end table
6122 Here are some examples showing uses of these options.
6124 @smallexample
6126 # disable ccp1 for all functions
6127    -fdisable-tree-ccp1
6128 # disable complete unroll for function whose cgraph node uid is 1
6129    -fenable-tree-cunroll=1
6130 # disable gcse2 for functions at the following ranges [1,1],
6131 # [300,400], and [400,1000]
6132 # disable gcse2 for functions foo and foo2
6133    -fdisable-rtl-gcse2=foo,foo2
6134 # disable early inlining
6135    -fdisable-tree-einline
6136 # disable ipa inlining
6137    -fdisable-ipa-inline
6138 # enable tree full unroll
6139    -fenable-tree-unroll
6141 @end smallexample
6143 @item -d@var{letters}
6144 @itemx -fdump-rtl-@var{pass}
6145 @itemx -fdump-rtl-@var{pass}=@var{filename}
6146 @opindex d
6147 @opindex fdump-rtl-@var{pass}
6148 Says to make debugging dumps during compilation at times specified by
6149 @var{letters}.  This is used for debugging the RTL-based passes of the
6150 compiler.  The file names for most of the dumps are made by appending
6151 a pass number and a word to the @var{dumpname}, and the files are
6152 created in the directory of the output file. In case of
6153 @option{=@var{filename}} option, the dump is output on the given file
6154 instead of the pass numbered dump files. Note that the pass number is
6155 computed statically as passes get registered into the pass manager.
6156 Thus the numbering is not related to the dynamic order of execution of
6157 passes.  In particular, a pass installed by a plugin could have a
6158 number over 200 even if it executed quite early.  @var{dumpname} is
6159 generated from the name of the output file, if explicitly specified
6160 and it is not an executable, otherwise it is the basename of the
6161 source file. These switches may have different effects when
6162 @option{-E} is used for preprocessing.
6164 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6165 @option{-d} option @var{letters}.  Here are the possible
6166 letters for use in @var{pass} and @var{letters}, and their meanings:
6168 @table @gcctabopt
6170 @item -fdump-rtl-alignments
6171 @opindex fdump-rtl-alignments
6172 Dump after branch alignments have been computed.
6174 @item -fdump-rtl-asmcons
6175 @opindex fdump-rtl-asmcons
6176 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6178 @item -fdump-rtl-auto_inc_dec
6179 @opindex fdump-rtl-auto_inc_dec
6180 Dump after auto-inc-dec discovery.  This pass is only run on
6181 architectures that have auto inc or auto dec instructions.
6183 @item -fdump-rtl-barriers
6184 @opindex fdump-rtl-barriers
6185 Dump after cleaning up the barrier instructions.
6187 @item -fdump-rtl-bbpart
6188 @opindex fdump-rtl-bbpart
6189 Dump after partitioning hot and cold basic blocks.
6191 @item -fdump-rtl-bbro
6192 @opindex fdump-rtl-bbro
6193 Dump after block reordering.
6195 @item -fdump-rtl-btl1
6196 @itemx -fdump-rtl-btl2
6197 @opindex fdump-rtl-btl2
6198 @opindex fdump-rtl-btl2
6199 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6200 after the two branch
6201 target load optimization passes.
6203 @item -fdump-rtl-bypass
6204 @opindex fdump-rtl-bypass
6205 Dump after jump bypassing and control flow optimizations.
6207 @item -fdump-rtl-combine
6208 @opindex fdump-rtl-combine
6209 Dump after the RTL instruction combination pass.
6211 @item -fdump-rtl-compgotos
6212 @opindex fdump-rtl-compgotos
6213 Dump after duplicating the computed gotos.
6215 @item -fdump-rtl-ce1
6216 @itemx -fdump-rtl-ce2
6217 @itemx -fdump-rtl-ce3
6218 @opindex fdump-rtl-ce1
6219 @opindex fdump-rtl-ce2
6220 @opindex fdump-rtl-ce3
6221 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6222 @option{-fdump-rtl-ce3} enable dumping after the three
6223 if conversion passes.
6225 @item -fdump-rtl-cprop_hardreg
6226 @opindex fdump-rtl-cprop_hardreg
6227 Dump after hard register copy propagation.
6229 @item -fdump-rtl-csa
6230 @opindex fdump-rtl-csa
6231 Dump after combining stack adjustments.
6233 @item -fdump-rtl-cse1
6234 @itemx -fdump-rtl-cse2
6235 @opindex fdump-rtl-cse1
6236 @opindex fdump-rtl-cse2
6237 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6238 the two common subexpression elimination passes.
6240 @item -fdump-rtl-dce
6241 @opindex fdump-rtl-dce
6242 Dump after the standalone dead code elimination passes.
6244 @item -fdump-rtl-dbr
6245 @opindex fdump-rtl-dbr
6246 Dump after delayed branch scheduling.
6248 @item -fdump-rtl-dce1
6249 @itemx -fdump-rtl-dce2
6250 @opindex fdump-rtl-dce1
6251 @opindex fdump-rtl-dce2
6252 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6253 the two dead store elimination passes.
6255 @item -fdump-rtl-eh
6256 @opindex fdump-rtl-eh
6257 Dump after finalization of EH handling code.
6259 @item -fdump-rtl-eh_ranges
6260 @opindex fdump-rtl-eh_ranges
6261 Dump after conversion of EH handling range regions.
6263 @item -fdump-rtl-expand
6264 @opindex fdump-rtl-expand
6265 Dump after RTL generation.
6267 @item -fdump-rtl-fwprop1
6268 @itemx -fdump-rtl-fwprop2
6269 @opindex fdump-rtl-fwprop1
6270 @opindex fdump-rtl-fwprop2
6271 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6272 dumping after the two forward propagation passes.
6274 @item -fdump-rtl-gcse1
6275 @itemx -fdump-rtl-gcse2
6276 @opindex fdump-rtl-gcse1
6277 @opindex fdump-rtl-gcse2
6278 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6279 after global common subexpression elimination.
6281 @item -fdump-rtl-init-regs
6282 @opindex fdump-rtl-init-regs
6283 Dump after the initialization of the registers.
6285 @item -fdump-rtl-initvals
6286 @opindex fdump-rtl-initvals
6287 Dump after the computation of the initial value sets.
6289 @item -fdump-rtl-into_cfglayout
6290 @opindex fdump-rtl-into_cfglayout
6291 Dump after converting to cfglayout mode.
6293 @item -fdump-rtl-ira
6294 @opindex fdump-rtl-ira
6295 Dump after iterated register allocation.
6297 @item -fdump-rtl-jump
6298 @opindex fdump-rtl-jump
6299 Dump after the second jump optimization.
6301 @item -fdump-rtl-loop2
6302 @opindex fdump-rtl-loop2
6303 @option{-fdump-rtl-loop2} enables dumping after the rtl
6304 loop optimization passes.
6306 @item -fdump-rtl-mach
6307 @opindex fdump-rtl-mach
6308 Dump after performing the machine dependent reorganization pass, if that
6309 pass exists.
6311 @item -fdump-rtl-mode_sw
6312 @opindex fdump-rtl-mode_sw
6313 Dump after removing redundant mode switches.
6315 @item -fdump-rtl-rnreg
6316 @opindex fdump-rtl-rnreg
6317 Dump after register renumbering.
6319 @item -fdump-rtl-outof_cfglayout
6320 @opindex fdump-rtl-outof_cfglayout
6321 Dump after converting from cfglayout mode.
6323 @item -fdump-rtl-peephole2
6324 @opindex fdump-rtl-peephole2
6325 Dump after the peephole pass.
6327 @item -fdump-rtl-postreload
6328 @opindex fdump-rtl-postreload
6329 Dump after post-reload optimizations.
6331 @item -fdump-rtl-pro_and_epilogue
6332 @opindex fdump-rtl-pro_and_epilogue
6333 Dump after generating the function prologues and epilogues.
6335 @item -fdump-rtl-sched1
6336 @itemx -fdump-rtl-sched2
6337 @opindex fdump-rtl-sched1
6338 @opindex fdump-rtl-sched2
6339 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6340 after the basic block scheduling passes.
6342 @item -fdump-rtl-ree
6343 @opindex fdump-rtl-ree
6344 Dump after sign/zero extension elimination.
6346 @item -fdump-rtl-seqabstr
6347 @opindex fdump-rtl-seqabstr
6348 Dump after common sequence discovery.
6350 @item -fdump-rtl-shorten
6351 @opindex fdump-rtl-shorten
6352 Dump after shortening branches.
6354 @item -fdump-rtl-sibling
6355 @opindex fdump-rtl-sibling
6356 Dump after sibling call optimizations.
6358 @item -fdump-rtl-split1
6359 @itemx -fdump-rtl-split2
6360 @itemx -fdump-rtl-split3
6361 @itemx -fdump-rtl-split4
6362 @itemx -fdump-rtl-split5
6363 @opindex fdump-rtl-split1
6364 @opindex fdump-rtl-split2
6365 @opindex fdump-rtl-split3
6366 @opindex fdump-rtl-split4
6367 @opindex fdump-rtl-split5
6368 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6369 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6370 @option{-fdump-rtl-split5} enable dumping after five rounds of
6371 instruction splitting.
6373 @item -fdump-rtl-sms
6374 @opindex fdump-rtl-sms
6375 Dump after modulo scheduling.  This pass is only run on some
6376 architectures.
6378 @item -fdump-rtl-stack
6379 @opindex fdump-rtl-stack
6380 Dump after conversion from GCC's ``flat register file'' registers to the
6381 x87's stack-like registers.  This pass is only run on x86 variants.
6383 @item -fdump-rtl-subreg1
6384 @itemx -fdump-rtl-subreg2
6385 @opindex fdump-rtl-subreg1
6386 @opindex fdump-rtl-subreg2
6387 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6388 the two subreg expansion passes.
6390 @item -fdump-rtl-unshare
6391 @opindex fdump-rtl-unshare
6392 Dump after all rtl has been unshared.
6394 @item -fdump-rtl-vartrack
6395 @opindex fdump-rtl-vartrack
6396 Dump after variable tracking.
6398 @item -fdump-rtl-vregs
6399 @opindex fdump-rtl-vregs
6400 Dump after converting virtual registers to hard registers.
6402 @item -fdump-rtl-web
6403 @opindex fdump-rtl-web
6404 Dump after live range splitting.
6406 @item -fdump-rtl-regclass
6407 @itemx -fdump-rtl-subregs_of_mode_init
6408 @itemx -fdump-rtl-subregs_of_mode_finish
6409 @itemx -fdump-rtl-dfinit
6410 @itemx -fdump-rtl-dfinish
6411 @opindex fdump-rtl-regclass
6412 @opindex fdump-rtl-subregs_of_mode_init
6413 @opindex fdump-rtl-subregs_of_mode_finish
6414 @opindex fdump-rtl-dfinit
6415 @opindex fdump-rtl-dfinish
6416 These dumps are defined but always produce empty files.
6418 @item -da
6419 @itemx -fdump-rtl-all
6420 @opindex da
6421 @opindex fdump-rtl-all
6422 Produce all the dumps listed above.
6424 @item -dA
6425 @opindex dA
6426 Annotate the assembler output with miscellaneous debugging information.
6428 @item -dD
6429 @opindex dD
6430 Dump all macro definitions, at the end of preprocessing, in addition to
6431 normal output.
6433 @item -dH
6434 @opindex dH
6435 Produce a core dump whenever an error occurs.
6437 @item -dp
6438 @opindex dp
6439 Annotate the assembler output with a comment indicating which
6440 pattern and alternative is used.  The length of each instruction is
6441 also printed.
6443 @item -dP
6444 @opindex dP
6445 Dump the RTL in the assembler output as a comment before each instruction.
6446 Also turns on @option{-dp} annotation.
6448 @item -dx
6449 @opindex dx
6450 Just generate RTL for a function instead of compiling it.  Usually used
6451 with @option{-fdump-rtl-expand}.
6452 @end table
6454 @item -fdump-noaddr
6455 @opindex fdump-noaddr
6456 When doing debugging dumps, suppress address output.  This makes it more
6457 feasible to use diff on debugging dumps for compiler invocations with
6458 different compiler binaries and/or different
6459 text / bss / data / heap / stack / dso start locations.
6461 @item -freport-bug
6462 @opindex freport-bug
6463 Collect and dump debug information into temporary file if ICE in C/C++
6464 compiler occured.
6466 @item -fdump-unnumbered
6467 @opindex fdump-unnumbered
6468 When doing debugging dumps, suppress instruction numbers and address output.
6469 This makes it more feasible to use diff on debugging dumps for compiler
6470 invocations with different options, in particular with and without
6471 @option{-g}.
6473 @item -fdump-unnumbered-links
6474 @opindex fdump-unnumbered-links
6475 When doing debugging dumps (see @option{-d} option above), suppress
6476 instruction numbers for the links to the previous and next instructions
6477 in a sequence.
6479 @item -fdump-translation-unit @r{(C++ only)}
6480 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6481 @opindex fdump-translation-unit
6482 Dump a representation of the tree structure for the entire translation
6483 unit to a file.  The file name is made by appending @file{.tu} to the
6484 source file name, and the file is created in the same directory as the
6485 output file.  If the @samp{-@var{options}} form is used, @var{options}
6486 controls the details of the dump as described for the
6487 @option{-fdump-tree} options.
6489 @item -fdump-class-hierarchy @r{(C++ only)}
6490 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6491 @opindex fdump-class-hierarchy
6492 Dump a representation of each class's hierarchy and virtual function
6493 table layout to a file.  The file name is made by appending
6494 @file{.class} to the source file name, and the file is created in the
6495 same directory as the output file.  If the @samp{-@var{options}} form
6496 is used, @var{options} controls the details of the dump as described
6497 for the @option{-fdump-tree} options.
6499 @item -fdump-ipa-@var{switch}
6500 @opindex fdump-ipa
6501 Control the dumping at various stages of inter-procedural analysis
6502 language tree to a file.  The file name is generated by appending a
6503 switch specific suffix to the source file name, and the file is created
6504 in the same directory as the output file.  The following dumps are
6505 possible:
6507 @table @samp
6508 @item all
6509 Enables all inter-procedural analysis dumps.
6511 @item cgraph
6512 Dumps information about call-graph optimization, unused function removal,
6513 and inlining decisions.
6515 @item inline
6516 Dump after function inlining.
6518 @end table
6520 @item -fdump-passes
6521 @opindex fdump-passes
6522 Dump the list of optimization passes that are turned on and off by
6523 the current command-line options.
6525 @item -fdump-statistics-@var{option}
6526 @opindex fdump-statistics
6527 Enable and control dumping of pass statistics in a separate file.  The
6528 file name is generated by appending a suffix ending in
6529 @samp{.statistics} to the source file name, and the file is created in
6530 the same directory as the output file.  If the @samp{-@var{option}}
6531 form is used, @samp{-stats} causes counters to be summed over the
6532 whole compilation unit while @samp{-details} dumps every event as
6533 the passes generate them.  The default with no option is to sum
6534 counters for each function compiled.
6536 @item -fdump-tree-@var{switch}
6537 @itemx -fdump-tree-@var{switch}-@var{options}
6538 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6539 @opindex fdump-tree
6540 Control the dumping at various stages of processing the intermediate
6541 language tree to a file.  The file name is generated by appending a
6542 switch-specific suffix to the source file name, and the file is
6543 created in the same directory as the output file. In case of
6544 @option{=@var{filename}} option, the dump is output on the given file
6545 instead of the auto named dump files.  If the @samp{-@var{options}}
6546 form is used, @var{options} is a list of @samp{-} separated options
6547 which control the details of the dump.  Not all options are applicable
6548 to all dumps; those that are not meaningful are ignored.  The
6549 following options are available
6551 @table @samp
6552 @item address
6553 Print the address of each node.  Usually this is not meaningful as it
6554 changes according to the environment and source file.  Its primary use
6555 is for tying up a dump file with a debug environment.
6556 @item asmname
6557 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6558 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6559 use working backward from mangled names in the assembly file.
6560 @item slim
6561 When dumping front-end intermediate representations, inhibit dumping
6562 of members of a scope or body of a function merely because that scope
6563 has been reached.  Only dump such items when they are directly reachable
6564 by some other path.
6566 When dumping pretty-printed trees, this option inhibits dumping the
6567 bodies of control structures.
6569 When dumping RTL, print the RTL in slim (condensed) form instead of
6570 the default LISP-like representation.
6571 @item raw
6572 Print a raw representation of the tree.  By default, trees are
6573 pretty-printed into a C-like representation.
6574 @item details
6575 Enable more detailed dumps (not honored by every dump option). Also
6576 include information from the optimization passes.
6577 @item stats
6578 Enable dumping various statistics about the pass (not honored by every dump
6579 option).
6580 @item blocks
6581 Enable showing basic block boundaries (disabled in raw dumps).
6582 @item graph
6583 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6584 dump a representation of the control flow graph suitable for viewing with
6585 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6586 the file is pretty-printed as a subgraph, so that GraphViz can render them
6587 all in a single plot.
6589 This option currently only works for RTL dumps, and the RTL is always
6590 dumped in slim form.
6591 @item vops
6592 Enable showing virtual operands for every statement.
6593 @item lineno
6594 Enable showing line numbers for statements.
6595 @item uid
6596 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6597 @item verbose
6598 Enable showing the tree dump for each statement.
6599 @item eh
6600 Enable showing the EH region number holding each statement.
6601 @item scev
6602 Enable showing scalar evolution analysis details.
6603 @item optimized
6604 Enable showing optimization information (only available in certain
6605 passes).
6606 @item missed
6607 Enable showing missed optimization information (only available in certain
6608 passes).
6609 @item note
6610 Enable other detailed optimization information (only available in
6611 certain passes).
6612 @item =@var{filename}
6613 Instead of an auto named dump file, output into the given file
6614 name. The file names @file{stdout} and @file{stderr} are treated
6615 specially and are considered already open standard streams. For
6616 example,
6618 @smallexample
6619 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6620      -fdump-tree-pre=stderr file.c
6621 @end smallexample
6623 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6624 output on to @file{stderr}. If two conflicting dump filenames are
6625 given for the same pass, then the latter option overrides the earlier
6626 one.
6628 @item all
6629 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6630 and @option{lineno}.
6632 @item optall
6633 Turn on all optimization options, i.e., @option{optimized},
6634 @option{missed}, and @option{note}.
6635 @end table
6637 The following tree dumps are possible:
6638 @table @samp
6640 @item original
6641 @opindex fdump-tree-original
6642 Dump before any tree based optimization, to @file{@var{file}.original}.
6644 @item optimized
6645 @opindex fdump-tree-optimized
6646 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6648 @item gimple
6649 @opindex fdump-tree-gimple
6650 Dump each function before and after the gimplification pass to a file.  The
6651 file name is made by appending @file{.gimple} to the source file name.
6653 @item cfg
6654 @opindex fdump-tree-cfg
6655 Dump the control flow graph of each function to a file.  The file name is
6656 made by appending @file{.cfg} to the source file name.
6658 @item ch
6659 @opindex fdump-tree-ch
6660 Dump each function after copying loop headers.  The file name is made by
6661 appending @file{.ch} to the source file name.
6663 @item ssa
6664 @opindex fdump-tree-ssa
6665 Dump SSA related information to a file.  The file name is made by appending
6666 @file{.ssa} to the source file name.
6668 @item alias
6669 @opindex fdump-tree-alias
6670 Dump aliasing information for each function.  The file name is made by
6671 appending @file{.alias} to the source file name.
6673 @item ccp
6674 @opindex fdump-tree-ccp
6675 Dump each function after CCP@.  The file name is made by appending
6676 @file{.ccp} to the source file name.
6678 @item storeccp
6679 @opindex fdump-tree-storeccp
6680 Dump each function after STORE-CCP@.  The file name is made by appending
6681 @file{.storeccp} to the source file name.
6683 @item pre
6684 @opindex fdump-tree-pre
6685 Dump trees after partial redundancy elimination.  The file name is made
6686 by appending @file{.pre} to the source file name.
6688 @item fre
6689 @opindex fdump-tree-fre
6690 Dump trees after full redundancy elimination.  The file name is made
6691 by appending @file{.fre} to the source file name.
6693 @item copyprop
6694 @opindex fdump-tree-copyprop
6695 Dump trees after copy propagation.  The file name is made
6696 by appending @file{.copyprop} to the source file name.
6698 @item store_copyprop
6699 @opindex fdump-tree-store_copyprop
6700 Dump trees after store copy-propagation.  The file name is made
6701 by appending @file{.store_copyprop} to the source file name.
6703 @item dce
6704 @opindex fdump-tree-dce
6705 Dump each function after dead code elimination.  The file name is made by
6706 appending @file{.dce} to the source file name.
6708 @item sra
6709 @opindex fdump-tree-sra
6710 Dump each function after performing scalar replacement of aggregates.  The
6711 file name is made by appending @file{.sra} to the source file name.
6713 @item sink
6714 @opindex fdump-tree-sink
6715 Dump each function after performing code sinking.  The file name is made
6716 by appending @file{.sink} to the source file name.
6718 @item dom
6719 @opindex fdump-tree-dom
6720 Dump each function after applying dominator tree optimizations.  The file
6721 name is made by appending @file{.dom} to the source file name.
6723 @item dse
6724 @opindex fdump-tree-dse
6725 Dump each function after applying dead store elimination.  The file
6726 name is made by appending @file{.dse} to the source file name.
6728 @item phiopt
6729 @opindex fdump-tree-phiopt
6730 Dump each function after optimizing PHI nodes into straightline code.  The file
6731 name is made by appending @file{.phiopt} to the source file name.
6733 @item forwprop
6734 @opindex fdump-tree-forwprop
6735 Dump each function after forward propagating single use variables.  The file
6736 name is made by appending @file{.forwprop} to the source file name.
6738 @item copyrename
6739 @opindex fdump-tree-copyrename
6740 Dump each function after applying the copy rename optimization.  The file
6741 name is made by appending @file{.copyrename} to the source file name.
6743 @item nrv
6744 @opindex fdump-tree-nrv
6745 Dump each function after applying the named return value optimization on
6746 generic trees.  The file name is made by appending @file{.nrv} to the source
6747 file name.
6749 @item vect
6750 @opindex fdump-tree-vect
6751 Dump each function after applying vectorization of loops.  The file name is
6752 made by appending @file{.vect} to the source file name.
6754 @item slp
6755 @opindex fdump-tree-slp
6756 Dump each function after applying vectorization of basic blocks.  The file name
6757 is made by appending @file{.slp} to the source file name.
6759 @item vrp
6760 @opindex fdump-tree-vrp
6761 Dump each function after Value Range Propagation (VRP).  The file name
6762 is made by appending @file{.vrp} to the source file name.
6764 @item all
6765 @opindex fdump-tree-all
6766 Enable all the available tree dumps with the flags provided in this option.
6767 @end table
6769 @item -fopt-info
6770 @itemx -fopt-info-@var{options}
6771 @itemx -fopt-info-@var{options}=@var{filename}
6772 @opindex fopt-info
6773 Controls optimization dumps from various optimization passes. If the
6774 @samp{-@var{options}} form is used, @var{options} is a list of
6775 @samp{-} separated option keywords to select the dump details and
6776 optimizations.  
6778 The @var{options} can be divided into two groups: options describing the
6779 verbosity of the dump, and options describing which optimizations
6780 should be included. The options from both the groups can be freely
6781 mixed as they are non-overlapping. However, in case of any conflicts,
6782 the later options override the earlier options on the command
6783 line. 
6785 The following options control the dump verbosity:
6787 @table @samp
6788 @item optimized
6789 Print information when an optimization is successfully applied. It is
6790 up to a pass to decide which information is relevant. For example, the
6791 vectorizer passes print the source location of loops which are
6792 successfully vectorized.
6793 @item missed
6794 Print information about missed optimizations. Individual passes
6795 control which information to include in the output. 
6796 @item note
6797 Print verbose information about optimizations, such as certain
6798 transformations, more detailed messages about decisions etc.
6799 @item all
6800 Print detailed optimization information. This includes
6801 @samp{optimized}, @samp{missed}, and @samp{note}.
6802 @end table
6804 One or more of the following option keywords can be used to describe a
6805 group of optimizations:
6807 @table @samp
6808 @item ipa
6809 Enable dumps from all interprocedural optimizations.
6810 @item loop
6811 Enable dumps from all loop optimizations.
6812 @item inline
6813 Enable dumps from all inlining optimizations.
6814 @item vec
6815 Enable dumps from all vectorization optimizations.
6816 @item optall
6817 Enable dumps from all optimizations. This is a superset of
6818 the optimization groups listed above.
6819 @end table
6821 If @var{options} is
6822 omitted, it defaults to @samp{optimized-optall}, which means to dump all
6823 info about successful optimizations from all the passes.  
6825 If the @var{filename} is provided, then the dumps from all the
6826 applicable optimizations are concatenated into the @var{filename}.
6827 Otherwise the dump is output onto @file{stderr}. Though multiple
6828 @option{-fopt-info} options are accepted, only one of them can include
6829 a @var{filename}. If other filenames are provided then all but the
6830 first such option are ignored.
6832 Note that the output @var{filename} is overwritten
6833 in case of multiple translation units. If a combined output from
6834 multiple translation units is desired, @file{stderr} should be used
6835 instead.
6837 In the following example, the optimization info is output to
6838 @file{stderr}:
6840 @smallexample
6841 gcc -O3 -fopt-info
6842 @end smallexample
6844 This example:
6845 @smallexample
6846 gcc -O3 -fopt-info-missed=missed.all
6847 @end smallexample
6849 @noindent
6850 outputs missed optimization report from all the passes into
6851 @file{missed.all}, and this one:
6853 @smallexample
6854 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6855 @end smallexample
6857 @noindent
6858 prints information about missed optimization opportunities from
6859 vectorization passes on @file{stderr}.  
6860 Note that @option{-fopt-info-vec-missed} is equivalent to 
6861 @option{-fopt-info-missed-vec}.
6863 As another example,
6864 @smallexample
6865 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6866 @end smallexample
6868 @noindent
6869 outputs information about missed optimizations as well as
6870 optimized locations from all the inlining passes into
6871 @file{inline.txt}.
6873 Finally, consider:
6875 @smallexample
6876 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6877 @end smallexample
6879 @noindent
6880 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6881 in conflict since only one output file is allowed. In this case, only
6882 the first option takes effect and the subsequent options are
6883 ignored. Thus only @file{vec.miss} is produced which contains
6884 dumps from the vectorizer about missed opportunities.
6886 @item -frandom-seed=@var{number}
6887 @opindex frandom-seed
6888 This option provides a seed that GCC uses in place of
6889 random numbers in generating certain symbol names
6890 that have to be different in every compiled file.  It is also used to
6891 place unique stamps in coverage data files and the object files that
6892 produce them.  You can use the @option{-frandom-seed} option to produce
6893 reproducibly identical object files.
6895 The @var{number} should be different for every file you compile.
6897 @item -fsched-verbose=@var{n}
6898 @opindex fsched-verbose
6899 On targets that use instruction scheduling, this option controls the
6900 amount of debugging output the scheduler prints.  This information is
6901 written to standard error, unless @option{-fdump-rtl-sched1} or
6902 @option{-fdump-rtl-sched2} is specified, in which case it is output
6903 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6904 respectively.  However for @var{n} greater than nine, the output is
6905 always printed to standard error.
6907 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6908 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6909 For @var{n} greater than one, it also output basic block probabilities,
6910 detailed ready list information and unit/insn info.  For @var{n} greater
6911 than two, it includes RTL at abort point, control-flow and regions info.
6912 And for @var{n} over four, @option{-fsched-verbose} also includes
6913 dependence info.
6915 @item -save-temps
6916 @itemx -save-temps=cwd
6917 @opindex save-temps
6918 Store the usual ``temporary'' intermediate files permanently; place them
6919 in the current directory and name them based on the source file.  Thus,
6920 compiling @file{foo.c} with @option{-c -save-temps} produces files
6921 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6922 preprocessed @file{foo.i} output file even though the compiler now
6923 normally uses an integrated preprocessor.
6925 When used in combination with the @option{-x} command-line option,
6926 @option{-save-temps} is sensible enough to avoid over writing an
6927 input source file with the same extension as an intermediate file.
6928 The corresponding intermediate file may be obtained by renaming the
6929 source file before using @option{-save-temps}.
6931 If you invoke GCC in parallel, compiling several different source
6932 files that share a common base name in different subdirectories or the
6933 same source file compiled for multiple output destinations, it is
6934 likely that the different parallel compilers will interfere with each
6935 other, and overwrite the temporary files.  For instance:
6937 @smallexample
6938 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6939 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6940 @end smallexample
6942 may result in @file{foo.i} and @file{foo.o} being written to
6943 simultaneously by both compilers.
6945 @item -save-temps=obj
6946 @opindex save-temps=obj
6947 Store the usual ``temporary'' intermediate files permanently.  If the
6948 @option{-o} option is used, the temporary files are based on the
6949 object file.  If the @option{-o} option is not used, the
6950 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6952 For example:
6954 @smallexample
6955 gcc -save-temps=obj -c foo.c
6956 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6957 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6958 @end smallexample
6960 @noindent
6961 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6962 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6963 @file{dir2/yfoobar.o}.
6965 @item -time@r{[}=@var{file}@r{]}
6966 @opindex time
6967 Report the CPU time taken by each subprocess in the compilation
6968 sequence.  For C source files, this is the compiler proper and assembler
6969 (plus the linker if linking is done).
6971 Without the specification of an output file, the output looks like this:
6973 @smallexample
6974 # cc1 0.12 0.01
6975 # as 0.00 0.01
6976 @end smallexample
6978 The first number on each line is the ``user time'', that is time spent
6979 executing the program itself.  The second number is ``system time'',
6980 time spent executing operating system routines on behalf of the program.
6981 Both numbers are in seconds.
6983 With the specification of an output file, the output is appended to the
6984 named file, and it looks like this:
6986 @smallexample
6987 0.12 0.01 cc1 @var{options}
6988 0.00 0.01 as @var{options}
6989 @end smallexample
6991 The ``user time'' and the ``system time'' are moved before the program
6992 name, and the options passed to the program are displayed, so that one
6993 can later tell what file was being compiled, and with which options.
6995 @item -fvar-tracking
6996 @opindex fvar-tracking
6997 Run variable tracking pass.  It computes where variables are stored at each
6998 position in code.  Better debugging information is then generated
6999 (if the debugging information format supports this information).
7001 It is enabled by default when compiling with optimization (@option{-Os},
7002 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
7003 the debug info format supports it.
7005 @item -fvar-tracking-assignments
7006 @opindex fvar-tracking-assignments
7007 @opindex fno-var-tracking-assignments
7008 Annotate assignments to user variables early in the compilation and
7009 attempt to carry the annotations over throughout the compilation all the
7010 way to the end, in an attempt to improve debug information while
7011 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
7013 It can be enabled even if var-tracking is disabled, in which case
7014 annotations are created and maintained, but discarded at the end.
7016 @item -fvar-tracking-assignments-toggle
7017 @opindex fvar-tracking-assignments-toggle
7018 @opindex fno-var-tracking-assignments-toggle
7019 Toggle @option{-fvar-tracking-assignments}, in the same way that
7020 @option{-gtoggle} toggles @option{-g}.
7022 @item -print-file-name=@var{library}
7023 @opindex print-file-name
7024 Print the full absolute name of the library file @var{library} that
7025 would be used when linking---and don't do anything else.  With this
7026 option, GCC does not compile or link anything; it just prints the
7027 file name.
7029 @item -print-multi-directory
7030 @opindex print-multi-directory
7031 Print the directory name corresponding to the multilib selected by any
7032 other switches present in the command line.  This directory is supposed
7033 to exist in @env{GCC_EXEC_PREFIX}.
7035 @item -print-multi-lib
7036 @opindex print-multi-lib
7037 Print the mapping from multilib directory names to compiler switches
7038 that enable them.  The directory name is separated from the switches by
7039 @samp{;}, and each switch starts with an @samp{@@} instead of the
7040 @samp{-}, without spaces between multiple switches.  This is supposed to
7041 ease shell processing.
7043 @item -print-multi-os-directory
7044 @opindex print-multi-os-directory
7045 Print the path to OS libraries for the selected
7046 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7047 present in the @file{lib} subdirectory and no multilibs are used, this is
7048 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7049 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7050 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7051 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7053 @item -print-multiarch
7054 @opindex print-multiarch
7055 Print the path to OS libraries for the selected multiarch,
7056 relative to some @file{lib} subdirectory.
7058 @item -print-prog-name=@var{program}
7059 @opindex print-prog-name
7060 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
7062 @item -print-libgcc-file-name
7063 @opindex print-libgcc-file-name
7064 Same as @option{-print-file-name=libgcc.a}.
7066 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7067 but you do want to link with @file{libgcc.a}.  You can do:
7069 @smallexample
7070 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7071 @end smallexample
7073 @item -print-search-dirs
7074 @opindex print-search-dirs
7075 Print the name of the configured installation directory and a list of
7076 program and library directories @command{gcc} searches---and don't do anything else.
7078 This is useful when @command{gcc} prints the error message
7079 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7080 To resolve this you either need to put @file{cpp0} and the other compiler
7081 components where @command{gcc} expects to find them, or you can set the environment
7082 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7083 Don't forget the trailing @samp{/}.
7084 @xref{Environment Variables}.
7086 @item -print-sysroot
7087 @opindex print-sysroot
7088 Print the target sysroot directory that is used during
7089 compilation.  This is the target sysroot specified either at configure
7090 time or using the @option{--sysroot} option, possibly with an extra
7091 suffix that depends on compilation options.  If no target sysroot is
7092 specified, the option prints nothing.
7094 @item -print-sysroot-headers-suffix
7095 @opindex print-sysroot-headers-suffix
7096 Print the suffix added to the target sysroot when searching for
7097 headers, or give an error if the compiler is not configured with such
7098 a suffix---and don't do anything else.
7100 @item -dumpmachine
7101 @opindex dumpmachine
7102 Print the compiler's target machine (for example,
7103 @samp{i686-pc-linux-gnu})---and don't do anything else.
7105 @item -dumpversion
7106 @opindex dumpversion
7107 Print the compiler version (for example, @samp{3.0})---and don't do
7108 anything else.
7110 @item -dumpspecs
7111 @opindex dumpspecs
7112 Print the compiler's built-in specs---and don't do anything else.  (This
7113 is used when GCC itself is being built.)  @xref{Spec Files}.
7115 @item -fno-eliminate-unused-debug-types
7116 @opindex feliminate-unused-debug-types
7117 @opindex fno-eliminate-unused-debug-types
7118 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7119 output for types that are nowhere used in the source file being compiled.
7120 Sometimes it is useful to have GCC emit debugging
7121 information for all types declared in a compilation
7122 unit, regardless of whether or not they are actually used
7123 in that compilation unit, for example 
7124 if, in the debugger, you want to cast a value to a type that is
7125 not actually used in your program (but is declared).  More often,
7126 however, this results in a significant amount of wasted space.
7127 @end table
7129 @node Optimize Options
7130 @section Options That Control Optimization
7131 @cindex optimize options
7132 @cindex options, optimization
7134 These options control various sorts of optimizations.
7136 Without any optimization option, the compiler's goal is to reduce the
7137 cost of compilation and to make debugging produce the expected
7138 results.  Statements are independent: if you stop the program with a
7139 breakpoint between statements, you can then assign a new value to any
7140 variable or change the program counter to any other statement in the
7141 function and get exactly the results you expect from the source
7142 code.
7144 Turning on optimization flags makes the compiler attempt to improve
7145 the performance and/or code size at the expense of compilation time
7146 and possibly the ability to debug the program.
7148 The compiler performs optimization based on the knowledge it has of the
7149 program.  Compiling multiple files at once to a single output file mode allows
7150 the compiler to use information gained from all of the files when compiling
7151 each of them.
7153 Not all optimizations are controlled directly by a flag.  Only
7154 optimizations that have a flag are listed in this section.
7156 Most optimizations are only enabled if an @option{-O} level is set on
7157 the command line.  Otherwise they are disabled, even if individual
7158 optimization flags are specified.
7160 Depending on the target and how GCC was configured, a slightly different
7161 set of optimizations may be enabled at each @option{-O} level than
7162 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7163 to find out the exact set of optimizations that are enabled at each level.
7164 @xref{Overall Options}, for examples.
7166 @table @gcctabopt
7167 @item -O
7168 @itemx -O1
7169 @opindex O
7170 @opindex O1
7171 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7172 more memory for a large function.
7174 With @option{-O}, the compiler tries to reduce code size and execution
7175 time, without performing any optimizations that take a great deal of
7176 compilation time.
7178 @option{-O} turns on the following optimization flags:
7179 @gccoptlist{
7180 -fauto-inc-dec @gol
7181 -fbranch-count-reg @gol
7182 -fcombine-stack-adjustments @gol
7183 -fcompare-elim @gol
7184 -fcprop-registers @gol
7185 -fdce @gol
7186 -fdefer-pop @gol
7187 -fdelayed-branch @gol
7188 -fdse @gol
7189 -fforward-propagate @gol
7190 -fguess-branch-probability @gol
7191 -fif-conversion2 @gol
7192 -fif-conversion @gol
7193 -finline-functions-called-once @gol
7194 -fipa-pure-const @gol
7195 -fipa-profile @gol
7196 -fipa-reference @gol
7197 -fmerge-constants @gol
7198 -fmove-loop-invariants @gol
7199 -fshrink-wrap @gol
7200 -fsplit-wide-types @gol
7201 -ftree-bit-ccp @gol
7202 -ftree-ccp @gol
7203 -fssa-phiopt @gol
7204 -ftree-ch @gol
7205 -ftree-copy-prop @gol
7206 -ftree-copyrename @gol
7207 -ftree-dce @gol
7208 -ftree-dominator-opts @gol
7209 -ftree-dse @gol
7210 -ftree-forwprop @gol
7211 -ftree-fre @gol
7212 -ftree-phiprop @gol
7213 -ftree-sink @gol
7214 -ftree-slsr @gol
7215 -ftree-sra @gol
7216 -ftree-pta @gol
7217 -ftree-ter @gol
7218 -funit-at-a-time}
7220 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7221 where doing so does not interfere with debugging.
7223 @item -O2
7224 @opindex O2
7225 Optimize even more.  GCC performs nearly all supported optimizations
7226 that do not involve a space-speed tradeoff.
7227 As compared to @option{-O}, this option increases both compilation time
7228 and the performance of the generated code.
7230 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7231 also turns on the following optimization flags:
7232 @gccoptlist{-fthread-jumps @gol
7233 -falign-functions  -falign-jumps @gol
7234 -falign-loops  -falign-labels @gol
7235 -fcaller-saves @gol
7236 -fcrossjumping @gol
7237 -fcse-follow-jumps  -fcse-skip-blocks @gol
7238 -fdelete-null-pointer-checks @gol
7239 -fdevirtualize -fdevirtualize-speculatively @gol
7240 -fexpensive-optimizations @gol
7241 -fgcse  -fgcse-lm  @gol
7242 -fhoist-adjacent-loads @gol
7243 -finline-small-functions @gol
7244 -findirect-inlining @gol
7245 -fipa-cp @gol
7246 -fipa-sra @gol
7247 -fipa-icf @gol
7248 -fisolate-erroneous-paths-dereference @gol
7249 -flra-remat @gol
7250 -foptimize-sibling-calls @gol
7251 -foptimize-strlen @gol
7252 -fpartial-inlining @gol
7253 -fpeephole2 @gol
7254 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7255 -frerun-cse-after-loop  @gol
7256 -fsched-interblock  -fsched-spec @gol
7257 -fschedule-insns  -fschedule-insns2 @gol
7258 -fstrict-aliasing -fstrict-overflow @gol
7259 -ftree-builtin-call-dce @gol
7260 -ftree-switch-conversion -ftree-tail-merge @gol
7261 -ftree-pre @gol
7262 -ftree-vrp @gol
7263 -fipa-ra}
7265 Please note the warning under @option{-fgcse} about
7266 invoking @option{-O2} on programs that use computed gotos.
7268 @item -O3
7269 @opindex O3
7270 Optimize yet more.  @option{-O3} turns on all optimizations specified
7271 by @option{-O2} and also turns on the @option{-finline-functions},
7272 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7273 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7274 @option{-ftree-loop-distribute-patterns},
7275 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7276 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7278 @item -O0
7279 @opindex O0
7280 Reduce compilation time and make debugging produce the expected
7281 results.  This is the default.
7283 @item -Os
7284 @opindex Os
7285 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7286 do not typically increase code size.  It also performs further
7287 optimizations designed to reduce code size.
7289 @option{-Os} disables the following optimization flags:
7290 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7291 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7292 -fprefetch-loop-arrays}
7294 @item -Ofast
7295 @opindex Ofast
7296 Disregard strict standards compliance.  @option{-Ofast} enables all
7297 @option{-O3} optimizations.  It also enables optimizations that are not
7298 valid for all standard-compliant programs.
7299 It turns on @option{-ffast-math} and the Fortran-specific
7300 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7302 @item -Og
7303 @opindex Og
7304 Optimize debugging experience.  @option{-Og} enables optimizations
7305 that do not interfere with debugging. It should be the optimization
7306 level of choice for the standard edit-compile-debug cycle, offering
7307 a reasonable level of optimization while maintaining fast compilation
7308 and a good debugging experience.
7310 If you use multiple @option{-O} options, with or without level numbers,
7311 the last such option is the one that is effective.
7312 @end table
7314 Options of the form @option{-f@var{flag}} specify machine-independent
7315 flags.  Most flags have both positive and negative forms; the negative
7316 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7317 below, only one of the forms is listed---the one you typically 
7318 use.  You can figure out the other form by either removing @samp{no-}
7319 or adding it.
7321 The following options control specific optimizations.  They are either
7322 activated by @option{-O} options or are related to ones that are.  You
7323 can use the following flags in the rare cases when ``fine-tuning'' of
7324 optimizations to be performed is desired.
7326 @table @gcctabopt
7327 @item -fno-defer-pop
7328 @opindex fno-defer-pop
7329 Always pop the arguments to each function call as soon as that function
7330 returns.  For machines that must pop arguments after a function call,
7331 the compiler normally lets arguments accumulate on the stack for several
7332 function calls and pops them all at once.
7334 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7336 @item -fforward-propagate
7337 @opindex fforward-propagate
7338 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7339 instructions and checks if the result can be simplified.  If loop unrolling
7340 is active, two passes are performed and the second is scheduled after
7341 loop unrolling.
7343 This option is enabled by default at optimization levels @option{-O},
7344 @option{-O2}, @option{-O3}, @option{-Os}.
7346 @item -ffp-contract=@var{style}
7347 @opindex ffp-contract
7348 @option{-ffp-contract=off} disables floating-point expression contraction.
7349 @option{-ffp-contract=fast} enables floating-point expression contraction
7350 such as forming of fused multiply-add operations if the target has
7351 native support for them.
7352 @option{-ffp-contract=on} enables floating-point expression contraction
7353 if allowed by the language standard.  This is currently not implemented
7354 and treated equal to @option{-ffp-contract=off}.
7356 The default is @option{-ffp-contract=fast}.
7358 @item -fomit-frame-pointer
7359 @opindex fomit-frame-pointer
7360 Don't keep the frame pointer in a register for functions that
7361 don't need one.  This avoids the instructions to save, set up and
7362 restore frame pointers; it also makes an extra register available
7363 in many functions.  @strong{It also makes debugging impossible on
7364 some machines.}
7366 On some machines, such as the VAX, this flag has no effect, because
7367 the standard calling sequence automatically handles the frame pointer
7368 and nothing is saved by pretending it doesn't exist.  The
7369 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7370 whether a target machine supports this flag.  @xref{Registers,,Register
7371 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7373 Starting with GCC version 4.6, the default setting (when not optimizing for
7374 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7375 @option{-fomit-frame-pointer}.  The default can be reverted to
7376 @option{-fno-omit-frame-pointer} by configuring GCC with the
7377 @option{--enable-frame-pointer} configure option.
7379 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7381 @item -foptimize-sibling-calls
7382 @opindex foptimize-sibling-calls
7383 Optimize sibling and tail recursive calls.
7385 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7387 @item -foptimize-strlen
7388 @opindex foptimize-strlen
7389 Optimize various standard C string functions (e.g. @code{strlen},
7390 @code{strchr} or @code{strcpy}) and
7391 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7393 Enabled at levels @option{-O2}, @option{-O3}.
7395 @item -fno-inline
7396 @opindex fno-inline
7397 Do not expand any functions inline apart from those marked with
7398 the @code{always_inline} attribute.  This is the default when not
7399 optimizing.
7401 Single functions can be exempted from inlining by marking them
7402 with the @code{noinline} attribute.
7404 @item -finline-small-functions
7405 @opindex finline-small-functions
7406 Integrate functions into their callers when their body is smaller than expected
7407 function call code (so overall size of program gets smaller).  The compiler
7408 heuristically decides which functions are simple enough to be worth integrating
7409 in this way.  This inlining applies to all functions, even those not declared
7410 inline.
7412 Enabled at level @option{-O2}.
7414 @item -findirect-inlining
7415 @opindex findirect-inlining
7416 Inline also indirect calls that are discovered to be known at compile
7417 time thanks to previous inlining.  This option has any effect only
7418 when inlining itself is turned on by the @option{-finline-functions}
7419 or @option{-finline-small-functions} options.
7421 Enabled at level @option{-O2}.
7423 @item -finline-functions
7424 @opindex finline-functions
7425 Consider all functions for inlining, even if they are not declared inline.
7426 The compiler heuristically decides which functions are worth integrating
7427 in this way.
7429 If all calls to a given function are integrated, and the function is
7430 declared @code{static}, then the function is normally not output as
7431 assembler code in its own right.
7433 Enabled at level @option{-O3}.
7435 @item -finline-functions-called-once
7436 @opindex finline-functions-called-once
7437 Consider all @code{static} functions called once for inlining into their
7438 caller even if they are not marked @code{inline}.  If a call to a given
7439 function is integrated, then the function is not output as assembler code
7440 in its own right.
7442 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7444 @item -fearly-inlining
7445 @opindex fearly-inlining
7446 Inline functions marked by @code{always_inline} and functions whose body seems
7447 smaller than the function call overhead early before doing
7448 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7449 makes profiling significantly cheaper and usually inlining faster on programs
7450 having large chains of nested wrapper functions.
7452 Enabled by default.
7454 @item -fipa-sra
7455 @opindex fipa-sra
7456 Perform interprocedural scalar replacement of aggregates, removal of
7457 unused parameters and replacement of parameters passed by reference
7458 by parameters passed by value.
7460 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7462 @item -finline-limit=@var{n}
7463 @opindex finline-limit
7464 By default, GCC limits the size of functions that can be inlined.  This flag
7465 allows coarse control of this limit.  @var{n} is the size of functions that
7466 can be inlined in number of pseudo instructions.
7468 Inlining is actually controlled by a number of parameters, which may be
7469 specified individually by using @option{--param @var{name}=@var{value}}.
7470 The @option{-finline-limit=@var{n}} option sets some of these parameters
7471 as follows:
7473 @table @gcctabopt
7474 @item max-inline-insns-single
7475 is set to @var{n}/2.
7476 @item max-inline-insns-auto
7477 is set to @var{n}/2.
7478 @end table
7480 See below for a documentation of the individual
7481 parameters controlling inlining and for the defaults of these parameters.
7483 @emph{Note:} there may be no value to @option{-finline-limit} that results
7484 in default behavior.
7486 @emph{Note:} pseudo instruction represents, in this particular context, an
7487 abstract measurement of function's size.  In no way does it represent a count
7488 of assembly instructions and as such its exact meaning might change from one
7489 release to an another.
7491 @item -fno-keep-inline-dllexport
7492 @opindex -fno-keep-inline-dllexport
7493 This is a more fine-grained version of @option{-fkeep-inline-functions},
7494 which applies only to functions that are declared using the @code{dllexport}
7495 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7496 Functions}.)
7498 @item -fkeep-inline-functions
7499 @opindex fkeep-inline-functions
7500 In C, emit @code{static} functions that are declared @code{inline}
7501 into the object file, even if the function has been inlined into all
7502 of its callers.  This switch does not affect functions using the
7503 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7504 inline functions into the object file.
7506 @item -fkeep-static-consts
7507 @opindex fkeep-static-consts
7508 Emit variables declared @code{static const} when optimization isn't turned
7509 on, even if the variables aren't referenced.
7511 GCC enables this option by default.  If you want to force the compiler to
7512 check if a variable is referenced, regardless of whether or not
7513 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7515 @item -fmerge-constants
7516 @opindex fmerge-constants
7517 Attempt to merge identical constants (string constants and floating-point
7518 constants) across compilation units.
7520 This option is the default for optimized compilation if the assembler and
7521 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7522 behavior.
7524 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7526 @item -fmerge-all-constants
7527 @opindex fmerge-all-constants
7528 Attempt to merge identical constants and identical variables.
7530 This option implies @option{-fmerge-constants}.  In addition to
7531 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7532 arrays or initialized constant variables with integral or floating-point
7533 types.  Languages like C or C++ require each variable, including multiple
7534 instances of the same variable in recursive calls, to have distinct locations,
7535 so using this option results in non-conforming
7536 behavior.
7538 @item -fmodulo-sched
7539 @opindex fmodulo-sched
7540 Perform swing modulo scheduling immediately before the first scheduling
7541 pass.  This pass looks at innermost loops and reorders their
7542 instructions by overlapping different iterations.
7544 @item -fmodulo-sched-allow-regmoves
7545 @opindex fmodulo-sched-allow-regmoves
7546 Perform more aggressive SMS-based modulo scheduling with register moves
7547 allowed.  By setting this flag certain anti-dependences edges are
7548 deleted, which triggers the generation of reg-moves based on the
7549 life-range analysis.  This option is effective only with
7550 @option{-fmodulo-sched} enabled.
7552 @item -fno-branch-count-reg
7553 @opindex fno-branch-count-reg
7554 Do not use ``decrement and branch'' instructions on a count register,
7555 but instead generate a sequence of instructions that decrement a
7556 register, compare it against zero, then branch based upon the result.
7557 This option is only meaningful on architectures that support such
7558 instructions, which include x86, PowerPC, IA-64 and S/390.
7560 Enabled by default at @option{-O1} and higher.
7562 The default is @option{-fbranch-count-reg}.
7564 @item -fno-function-cse
7565 @opindex fno-function-cse
7566 Do not put function addresses in registers; make each instruction that
7567 calls a constant function contain the function's address explicitly.
7569 This option results in less efficient code, but some strange hacks
7570 that alter the assembler output may be confused by the optimizations
7571 performed when this option is not used.
7573 The default is @option{-ffunction-cse}
7575 @item -fno-zero-initialized-in-bss
7576 @opindex fno-zero-initialized-in-bss
7577 If the target supports a BSS section, GCC by default puts variables that
7578 are initialized to zero into BSS@.  This can save space in the resulting
7579 code.
7581 This option turns off this behavior because some programs explicitly
7582 rely on variables going to the data section---e.g., so that the
7583 resulting executable can find the beginning of that section and/or make
7584 assumptions based on that.
7586 The default is @option{-fzero-initialized-in-bss}.
7588 @item -fthread-jumps
7589 @opindex fthread-jumps
7590 Perform optimizations that check to see if a jump branches to a
7591 location where another comparison subsumed by the first is found.  If
7592 so, the first branch is redirected to either the destination of the
7593 second branch or a point immediately following it, depending on whether
7594 the condition is known to be true or false.
7596 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7598 @item -fsplit-wide-types
7599 @opindex fsplit-wide-types
7600 When using a type that occupies multiple registers, such as @code{long
7601 long} on a 32-bit system, split the registers apart and allocate them
7602 independently.  This normally generates better code for those types,
7603 but may make debugging more difficult.
7605 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7606 @option{-Os}.
7608 @item -fcse-follow-jumps
7609 @opindex fcse-follow-jumps
7610 In common subexpression elimination (CSE), scan through jump instructions
7611 when the target of the jump is not reached by any other path.  For
7612 example, when CSE encounters an @code{if} statement with an
7613 @code{else} clause, CSE follows the jump when the condition
7614 tested is false.
7616 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7618 @item -fcse-skip-blocks
7619 @opindex fcse-skip-blocks
7620 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7621 follow jumps that conditionally skip over blocks.  When CSE
7622 encounters a simple @code{if} statement with no else clause,
7623 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7624 body of the @code{if}.
7626 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7628 @item -frerun-cse-after-loop
7629 @opindex frerun-cse-after-loop
7630 Re-run common subexpression elimination after loop optimizations are
7631 performed.
7633 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7635 @item -fgcse
7636 @opindex fgcse
7637 Perform a global common subexpression elimination pass.
7638 This pass also performs global constant and copy propagation.
7640 @emph{Note:} When compiling a program using computed gotos, a GCC
7641 extension, you may get better run-time performance if you disable
7642 the global common subexpression elimination pass by adding
7643 @option{-fno-gcse} to the command line.
7645 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7647 @item -fgcse-lm
7648 @opindex fgcse-lm
7649 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7650 attempts to move loads that are only killed by stores into themselves.  This
7651 allows a loop containing a load/store sequence to be changed to a load outside
7652 the loop, and a copy/store within the loop.
7654 Enabled by default when @option{-fgcse} is enabled.
7656 @item -fgcse-sm
7657 @opindex fgcse-sm
7658 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7659 global common subexpression elimination.  This pass attempts to move
7660 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7661 loops containing a load/store sequence can be changed to a load before
7662 the loop and a store after the loop.
7664 Not enabled at any optimization level.
7666 @item -fgcse-las
7667 @opindex fgcse-las
7668 When @option{-fgcse-las} is enabled, the global common subexpression
7669 elimination pass eliminates redundant loads that come after stores to the
7670 same memory location (both partial and full redundancies).
7672 Not enabled at any optimization level.
7674 @item -fgcse-after-reload
7675 @opindex fgcse-after-reload
7676 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7677 pass is performed after reload.  The purpose of this pass is to clean up
7678 redundant spilling.
7680 @item -faggressive-loop-optimizations
7681 @opindex faggressive-loop-optimizations
7682 This option tells the loop optimizer to use language constraints to
7683 derive bounds for the number of iterations of a loop.  This assumes that
7684 loop code does not invoke undefined behavior by for example causing signed
7685 integer overflows or out-of-bound array accesses.  The bounds for the
7686 number of iterations of a loop are used to guide loop unrolling and peeling
7687 and loop exit test optimizations.
7688 This option is enabled by default.
7690 @item -funsafe-loop-optimizations
7691 @opindex funsafe-loop-optimizations
7692 This option tells the loop optimizer to assume that loop indices do not
7693 overflow, and that loops with nontrivial exit condition are not
7694 infinite.  This enables a wider range of loop optimizations even if
7695 the loop optimizer itself cannot prove that these assumptions are valid.
7696 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7697 if it finds this kind of loop.
7699 @item -fcrossjumping
7700 @opindex fcrossjumping
7701 Perform cross-jumping transformation.
7702 This transformation unifies equivalent code and saves code size.  The
7703 resulting code may or may not perform better than without cross-jumping.
7705 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7707 @item -fauto-inc-dec
7708 @opindex fauto-inc-dec
7709 Combine increments or decrements of addresses with memory accesses.
7710 This pass is always skipped on architectures that do not have
7711 instructions to support this.  Enabled by default at @option{-O} and
7712 higher on architectures that support this.
7714 @item -fdce
7715 @opindex fdce
7716 Perform dead code elimination (DCE) on RTL@.
7717 Enabled by default at @option{-O} and higher.
7719 @item -fdse
7720 @opindex fdse
7721 Perform dead store elimination (DSE) on RTL@.
7722 Enabled by default at @option{-O} and higher.
7724 @item -fif-conversion
7725 @opindex fif-conversion
7726 Attempt to transform conditional jumps into branch-less equivalents.  This
7727 includes use of conditional moves, min, max, set flags and abs instructions, and
7728 some tricks doable by standard arithmetics.  The use of conditional execution
7729 on chips where it is available is controlled by @code{if-conversion2}.
7731 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7733 @item -fif-conversion2
7734 @opindex fif-conversion2
7735 Use conditional execution (where available) to transform conditional jumps into
7736 branch-less equivalents.
7738 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7740 @item -fdeclone-ctor-dtor
7741 @opindex fdeclone-ctor-dtor
7742 The C++ ABI requires multiple entry points for constructors and
7743 destructors: one for a base subobject, one for a complete object, and
7744 one for a virtual destructor that calls operator delete afterwards.
7745 For a hierarchy with virtual bases, the base and complete variants are
7746 clones, which means two copies of the function.  With this option, the
7747 base and complete variants are changed to be thunks that call a common
7748 implementation.
7750 Enabled by @option{-Os}.
7752 @item -fdelete-null-pointer-checks
7753 @opindex fdelete-null-pointer-checks
7754 Assume that programs cannot safely dereference null pointers, and that
7755 no code or data element resides there.  This enables simple constant
7756 folding optimizations at all optimization levels.  In addition, other
7757 optimization passes in GCC use this flag to control global dataflow
7758 analyses that eliminate useless checks for null pointers; these assume
7759 that if a pointer is checked after it has already been dereferenced,
7760 it cannot be null.
7762 Note however that in some environments this assumption is not true.
7763 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7764 for programs that depend on that behavior.
7766 Some targets, especially embedded ones, disable this option at all levels.
7767 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7768 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7769 are enabled independently at different optimization levels.
7771 @item -fdevirtualize
7772 @opindex fdevirtualize
7773 Attempt to convert calls to virtual functions to direct calls.  This
7774 is done both within a procedure and interprocedurally as part of
7775 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7776 propagation (@option{-fipa-cp}).
7777 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7779 @item -fdevirtualize-speculatively
7780 @opindex fdevirtualize-speculatively
7781 Attempt to convert calls to virtual functions to speculative direct calls.
7782 Based on the analysis of the type inheritance graph, determine for a given call
7783 the set of likely targets. If the set is small, preferably of size 1, change
7784 the call into an conditional deciding on direct and indirect call.  The
7785 speculative calls enable more optimizations, such as inlining.  When they seem
7786 useless after further optimization, they are converted back into original form.
7788 @item -fdevirtualize-at-ltrans
7789 @opindex fdevirtualize-at-ltrans
7790 Perform extra streaming needed for agressive devirtualization during LTO local
7791 transformation stage. This option enables more devirtualization but
7792 significantly increases the size of streamed data. For this reason it is
7793 disabled by default.
7795 @item -fexpensive-optimizations
7796 @opindex fexpensive-optimizations
7797 Perform a number of minor optimizations that are relatively expensive.
7799 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7801 @item -free
7802 @opindex free
7803 Attempt to remove redundant extension instructions.  This is especially
7804 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7805 registers after writing to their lower 32-bit half.
7807 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7808 @option{-O3}, @option{-Os}.
7810 @item -flive-range-shrinkage
7811 @opindex flive-range-shrinkage
7812 Attempt to decrease register pressure through register live range
7813 shrinkage.  This is helpful for fast processors with small or moderate
7814 size register sets.
7816 @item -fira-algorithm=@var{algorithm}
7817 Use the specified coloring algorithm for the integrated register
7818 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7819 specifies Chow's priority coloring, or @samp{CB}, which specifies
7820 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7821 for all architectures, but for those targets that do support it, it is
7822 the default because it generates better code.
7824 @item -fira-region=@var{region}
7825 Use specified regions for the integrated register allocator.  The
7826 @var{region} argument should be one of the following:
7828 @table @samp
7830 @item all
7831 Use all loops as register allocation regions.
7832 This can give the best results for machines with a small and/or
7833 irregular register set.
7835 @item mixed
7836 Use all loops except for loops with small register pressure 
7837 as the regions.  This value usually gives
7838 the best results in most cases and for most architectures,
7839 and is enabled by default when compiling with optimization for speed
7840 (@option{-O}, @option{-O2}, @dots{}).
7842 @item one
7843 Use all functions as a single region.  
7844 This typically results in the smallest code size, and is enabled by default for
7845 @option{-Os} or @option{-O0}.
7847 @end table
7849 @item -fira-hoist-pressure
7850 @opindex fira-hoist-pressure
7851 Use IRA to evaluate register pressure in the code hoisting pass for
7852 decisions to hoist expressions.  This option usually results in smaller
7853 code, but it can slow the compiler down.
7855 This option is enabled at level @option{-Os} for all targets.
7857 @item -fira-loop-pressure
7858 @opindex fira-loop-pressure
7859 Use IRA to evaluate register pressure in loops for decisions to move
7860 loop invariants.  This option usually results in generation
7861 of faster and smaller code on machines with large register files (>= 32
7862 registers), but it can slow the compiler down.
7864 This option is enabled at level @option{-O3} for some targets.
7866 @item -fno-ira-share-save-slots
7867 @opindex fno-ira-share-save-slots
7868 Disable sharing of stack slots used for saving call-used hard
7869 registers living through a call.  Each hard register gets a
7870 separate stack slot, and as a result function stack frames are
7871 larger.
7873 @item -fno-ira-share-spill-slots
7874 @opindex fno-ira-share-spill-slots
7875 Disable sharing of stack slots allocated for pseudo-registers.  Each
7876 pseudo-register that does not get a hard register gets a separate
7877 stack slot, and as a result function stack frames are larger.
7879 @item -fira-verbose=@var{n}
7880 @opindex fira-verbose
7881 Control the verbosity of the dump file for the integrated register allocator.
7882 The default value is 5.  If the value @var{n} is greater or equal to 10,
7883 the dump output is sent to stderr using the same format as @var{n} minus 10.
7885 @item -flra-remat
7886 @opindex fcaller-saves
7887 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7888 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7889 values if it is profitable.
7891 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7893 @item -fdelayed-branch
7894 @opindex fdelayed-branch
7895 If supported for the target machine, attempt to reorder instructions
7896 to exploit instruction slots available after delayed branch
7897 instructions.
7899 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7901 @item -fschedule-insns
7902 @opindex fschedule-insns
7903 If supported for the target machine, attempt to reorder instructions to
7904 eliminate execution stalls due to required data being unavailable.  This
7905 helps machines that have slow floating point or memory load instructions
7906 by allowing other instructions to be issued until the result of the load
7907 or floating-point instruction is required.
7909 Enabled at levels @option{-O2}, @option{-O3}.
7911 @item -fschedule-insns2
7912 @opindex fschedule-insns2
7913 Similar to @option{-fschedule-insns}, but requests an additional pass of
7914 instruction scheduling after register allocation has been done.  This is
7915 especially useful on machines with a relatively small number of
7916 registers and where memory load instructions take more than one cycle.
7918 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7920 @item -fno-sched-interblock
7921 @opindex fno-sched-interblock
7922 Don't schedule instructions across basic blocks.  This is normally
7923 enabled by default when scheduling before register allocation, i.e.@:
7924 with @option{-fschedule-insns} or at @option{-O2} or higher.
7926 @item -fno-sched-spec
7927 @opindex fno-sched-spec
7928 Don't allow speculative motion of non-load instructions.  This is normally
7929 enabled by default when scheduling before register allocation, i.e.@:
7930 with @option{-fschedule-insns} or at @option{-O2} or higher.
7932 @item -fsched-pressure
7933 @opindex fsched-pressure
7934 Enable register pressure sensitive insn scheduling before register
7935 allocation.  This only makes sense when scheduling before register
7936 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7937 @option{-O2} or higher.  Usage of this option can improve the
7938 generated code and decrease its size by preventing register pressure
7939 increase above the number of available hard registers and subsequent
7940 spills in register allocation.
7942 @item -fsched-spec-load
7943 @opindex fsched-spec-load
7944 Allow speculative motion of some load instructions.  This only makes
7945 sense when scheduling before register allocation, i.e.@: with
7946 @option{-fschedule-insns} or at @option{-O2} or higher.
7948 @item -fsched-spec-load-dangerous
7949 @opindex fsched-spec-load-dangerous
7950 Allow speculative motion of more load instructions.  This only makes
7951 sense when scheduling before register allocation, i.e.@: with
7952 @option{-fschedule-insns} or at @option{-O2} or higher.
7954 @item -fsched-stalled-insns
7955 @itemx -fsched-stalled-insns=@var{n}
7956 @opindex fsched-stalled-insns
7957 Define how many insns (if any) can be moved prematurely from the queue
7958 of stalled insns into the ready list during the second scheduling pass.
7959 @option{-fno-sched-stalled-insns} means that no insns are moved
7960 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7961 on how many queued insns can be moved prematurely.
7962 @option{-fsched-stalled-insns} without a value is equivalent to
7963 @option{-fsched-stalled-insns=1}.
7965 @item -fsched-stalled-insns-dep
7966 @itemx -fsched-stalled-insns-dep=@var{n}
7967 @opindex fsched-stalled-insns-dep
7968 Define how many insn groups (cycles) are examined for a dependency
7969 on a stalled insn that is a candidate for premature removal from the queue
7970 of stalled insns.  This has an effect only during the second scheduling pass,
7971 and only if @option{-fsched-stalled-insns} is used.
7972 @option{-fno-sched-stalled-insns-dep} is equivalent to
7973 @option{-fsched-stalled-insns-dep=0}.
7974 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7975 @option{-fsched-stalled-insns-dep=1}.
7977 @item -fsched2-use-superblocks
7978 @opindex fsched2-use-superblocks
7979 When scheduling after register allocation, use superblock scheduling.
7980 This allows motion across basic block boundaries,
7981 resulting in faster schedules.  This option is experimental, as not all machine
7982 descriptions used by GCC model the CPU closely enough to avoid unreliable
7983 results from the algorithm.
7985 This only makes sense when scheduling after register allocation, i.e.@: with
7986 @option{-fschedule-insns2} or at @option{-O2} or higher.
7988 @item -fsched-group-heuristic
7989 @opindex fsched-group-heuristic
7990 Enable the group heuristic in the scheduler.  This heuristic favors
7991 the instruction that belongs to a schedule group.  This is enabled
7992 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7993 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7995 @item -fsched-critical-path-heuristic
7996 @opindex fsched-critical-path-heuristic
7997 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7998 instructions on the critical path.  This is enabled by default when
7999 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
8000 or @option{-fschedule-insns2} or at @option{-O2} or higher.
8002 @item -fsched-spec-insn-heuristic
8003 @opindex fsched-spec-insn-heuristic
8004 Enable the speculative instruction heuristic in the scheduler.  This
8005 heuristic favors speculative instructions with greater dependency weakness.
8006 This is enabled by default when scheduling is enabled, i.e.@:
8007 with @option{-fschedule-insns} or @option{-fschedule-insns2}
8008 or at @option{-O2} or higher.
8010 @item -fsched-rank-heuristic
8011 @opindex fsched-rank-heuristic
8012 Enable the rank heuristic in the scheduler.  This heuristic favors
8013 the instruction belonging to a basic block with greater size or frequency.
8014 This is enabled by default when scheduling is enabled, i.e.@:
8015 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8016 at @option{-O2} or higher.
8018 @item -fsched-last-insn-heuristic
8019 @opindex fsched-last-insn-heuristic
8020 Enable the last-instruction heuristic in the scheduler.  This heuristic
8021 favors the instruction that is less dependent on the last instruction
8022 scheduled.  This is enabled by default when scheduling is enabled,
8023 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8024 at @option{-O2} or higher.
8026 @item -fsched-dep-count-heuristic
8027 @opindex fsched-dep-count-heuristic
8028 Enable the dependent-count heuristic in the scheduler.  This heuristic
8029 favors the instruction that has more instructions depending on it.
8030 This is enabled by default when scheduling is enabled, i.e.@:
8031 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8032 at @option{-O2} or higher.
8034 @item -freschedule-modulo-scheduled-loops
8035 @opindex freschedule-modulo-scheduled-loops
8036 Modulo scheduling is performed before traditional scheduling.  If a loop
8037 is modulo scheduled, later scheduling passes may change its schedule.  
8038 Use this option to control that behavior.
8040 @item -fselective-scheduling
8041 @opindex fselective-scheduling
8042 Schedule instructions using selective scheduling algorithm.  Selective
8043 scheduling runs instead of the first scheduler pass.
8045 @item -fselective-scheduling2
8046 @opindex fselective-scheduling2
8047 Schedule instructions using selective scheduling algorithm.  Selective
8048 scheduling runs instead of the second scheduler pass.
8050 @item -fsel-sched-pipelining
8051 @opindex fsel-sched-pipelining
8052 Enable software pipelining of innermost loops during selective scheduling.
8053 This option has no effect unless one of @option{-fselective-scheduling} or
8054 @option{-fselective-scheduling2} is turned on.
8056 @item -fsel-sched-pipelining-outer-loops
8057 @opindex fsel-sched-pipelining-outer-loops
8058 When pipelining loops during selective scheduling, also pipeline outer loops.
8059 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8061 @item -fsemantic-interposition
8062 @opindex fsemantic-interposition
8063 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
8064 This means that for symbols exported from the DSO compiler can not perform
8065 inter-procedural propagation, inlining and other optimizations in anticipation
8066 that the function or variable in question may change. While this feature is
8067 useful, for example, to rewrite memory allocation functions by a debugging
8068 implementation, it is expensive in the terms of code quality.
8069 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
8070 happens for functions the overwritting function will have
8071 precisely same semantics (and side effects). Similarly if interposition happens
8072 for variables, the constructor of the variable will be the same. The flag
8073 has no effect for functions explicitly declared inline, where
8074 interposition changing semantic is never allowed and for symbols explicitly
8075 declared weak.
8077 @item -fshrink-wrap
8078 @opindex fshrink-wrap
8079 Emit function prologues only before parts of the function that need it,
8080 rather than at the top of the function.  This flag is enabled by default at
8081 @option{-O} and higher.
8083 @item -fcaller-saves
8084 @opindex fcaller-saves
8085 Enable allocation of values to registers that are clobbered by
8086 function calls, by emitting extra instructions to save and restore the
8087 registers around such calls.  Such allocation is done only when it
8088 seems to result in better code.
8090 This option is always enabled by default on certain machines, usually
8091 those which have no call-preserved registers to use instead.
8093 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8095 @item -fcombine-stack-adjustments
8096 @opindex fcombine-stack-adjustments
8097 Tracks stack adjustments (pushes and pops) and stack memory references
8098 and then tries to find ways to combine them.
8100 Enabled by default at @option{-O1} and higher.
8102 @item -fipa-ra
8103 Use caller save registers for allocation if those registers are not used by
8104 any called function.  In that case it is not necessary to save and restore
8105 them around calls.  This is only possible if called functions are part of
8106 same compilation unit as current function and they are compiled before it.
8108 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8110 @item -fconserve-stack
8111 @opindex fconserve-stack
8112 Attempt to minimize stack usage.  The compiler attempts to use less
8113 stack space, even if that makes the program slower.  This option
8114 implies setting the @option{large-stack-frame} parameter to 100
8115 and the @option{large-stack-frame-growth} parameter to 400.
8117 @item -ftree-reassoc
8118 @opindex ftree-reassoc
8119 Perform reassociation on trees.  This flag is enabled by default
8120 at @option{-O} and higher.
8122 @item -ftree-pre
8123 @opindex ftree-pre
8124 Perform partial redundancy elimination (PRE) on trees.  This flag is
8125 enabled by default at @option{-O2} and @option{-O3}.
8127 @item -ftree-partial-pre
8128 @opindex ftree-partial-pre
8129 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8130 enabled by default at @option{-O3}.
8132 @item -ftree-forwprop
8133 @opindex ftree-forwprop
8134 Perform forward propagation on trees.  This flag is enabled by default
8135 at @option{-O} and higher.
8137 @item -ftree-fre
8138 @opindex ftree-fre
8139 Perform full redundancy elimination (FRE) on trees.  The difference
8140 between FRE and PRE is that FRE only considers expressions
8141 that are computed on all paths leading to the redundant computation.
8142 This analysis is faster than PRE, though it exposes fewer redundancies.
8143 This flag is enabled by default at @option{-O} and higher.
8145 @item -ftree-phiprop
8146 @opindex ftree-phiprop
8147 Perform hoisting of loads from conditional pointers on trees.  This
8148 pass is enabled by default at @option{-O} and higher.
8150 @item -fhoist-adjacent-loads
8151 @opindex hoist-adjacent-loads
8152 Speculatively hoist loads from both branches of an if-then-else if the
8153 loads are from adjacent locations in the same structure and the target
8154 architecture has a conditional move instruction.  This flag is enabled
8155 by default at @option{-O2} and higher.
8157 @item -ftree-copy-prop
8158 @opindex ftree-copy-prop
8159 Perform copy propagation on trees.  This pass eliminates unnecessary
8160 copy operations.  This flag is enabled by default at @option{-O} and
8161 higher.
8163 @item -fipa-pure-const
8164 @opindex fipa-pure-const
8165 Discover which functions are pure or constant.
8166 Enabled by default at @option{-O} and higher.
8168 @item -fipa-reference
8169 @opindex fipa-reference
8170 Discover which static variables do not escape the
8171 compilation unit.
8172 Enabled by default at @option{-O} and higher.
8174 @item -fipa-pta
8175 @opindex fipa-pta
8176 Perform interprocedural pointer analysis and interprocedural modification
8177 and reference analysis.  This option can cause excessive memory and
8178 compile-time usage on large compilation units.  It is not enabled by
8179 default at any optimization level.
8181 @item -fipa-profile
8182 @opindex fipa-profile
8183 Perform interprocedural profile propagation.  The functions called only from
8184 cold functions are marked as cold. Also functions executed once (such as
8185 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8186 functions and loop less parts of functions executed once are then optimized for
8187 size.
8188 Enabled by default at @option{-O} and higher.
8190 @item -fipa-cp
8191 @opindex fipa-cp
8192 Perform interprocedural constant propagation.
8193 This optimization analyzes the program to determine when values passed
8194 to functions are constants and then optimizes accordingly.
8195 This optimization can substantially increase performance
8196 if the application has constants passed to functions.
8197 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8199 @item -fipa-cp-clone
8200 @opindex fipa-cp-clone
8201 Perform function cloning to make interprocedural constant propagation stronger.
8202 When enabled, interprocedural constant propagation performs function cloning
8203 when externally visible function can be called with constant arguments.
8204 Because this optimization can create multiple copies of functions,
8205 it may significantly increase code size
8206 (see @option{--param ipcp-unit-growth=@var{value}}).
8207 This flag is enabled by default at @option{-O3}.
8209 @item -fipa-icf
8210 @opindex fipa-icf
8211 Perform Identical Code Folding for functions and read-only variables.
8212 The optimization reduces code size and may disturb unwind stacks by replacing
8213 a function by equivalent one with a different name. The optimization works
8214 more effectively with link time optimization enabled.
8216 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8217 works on different levels and thus the optimizations are not same - there are
8218 equivalences that are found only by GCC and equivalences found only by Gold.
8220 This flag is enabled by default at @option{-O2} and @option{-Os}.
8222 @item -fisolate-erroneous-paths-dereference
8223 Detect paths which trigger erroneous or undefined behaviour due to
8224 dereferencing a NULL pointer.  Isolate those paths from the main control
8225 flow and turn the statement with erroneous or undefined behaviour into a trap.
8227 @item -fisolate-erroneous-paths-attribute
8228 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8229 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8230 attribute.  Isolate those paths from the main control flow and turn the
8231 statement with erroneous or undefined behaviour into a trap.  This is not
8232 currently enabled, but may be enabled by @code{-O2} in the future.
8234 @item -ftree-sink
8235 @opindex ftree-sink
8236 Perform forward store motion  on trees.  This flag is
8237 enabled by default at @option{-O} and higher.
8239 @item -ftree-bit-ccp
8240 @opindex ftree-bit-ccp
8241 Perform sparse conditional bit constant propagation on trees and propagate
8242 pointer alignment information.
8243 This pass only operates on local scalar variables and is enabled by default
8244 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8246 @item -ftree-ccp
8247 @opindex ftree-ccp
8248 Perform sparse conditional constant propagation (CCP) on trees.  This
8249 pass only operates on local scalar variables and is enabled by default
8250 at @option{-O} and higher.
8252 @item -fssa-phiopt
8253 @opindex fssa-phiopt
8254 Perform pattern matching on SSA PHI nodes to optimize conditional
8255 code.  This pass is enabled by default at @option{-O} and higher.
8257 @item -ftree-switch-conversion
8258 Perform conversion of simple initializations in a switch to
8259 initializations from a scalar array.  This flag is enabled by default
8260 at @option{-O2} and higher.
8262 @item -ftree-tail-merge
8263 Look for identical code sequences.  When found, replace one with a jump to the
8264 other.  This optimization is known as tail merging or cross jumping.  This flag
8265 is enabled by default at @option{-O2} and higher.  The compilation time
8266 in this pass can
8267 be limited using @option{max-tail-merge-comparisons} parameter and
8268 @option{max-tail-merge-iterations} parameter.
8270 @item -ftree-dce
8271 @opindex ftree-dce
8272 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8273 default at @option{-O} and higher.
8275 @item -ftree-builtin-call-dce
8276 @opindex ftree-builtin-call-dce
8277 Perform conditional dead code elimination (DCE) for calls to built-in functions
8278 that may set @code{errno} but are otherwise side-effect free.  This flag is
8279 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8280 specified.
8282 @item -ftree-dominator-opts
8283 @opindex ftree-dominator-opts
8284 Perform a variety of simple scalar cleanups (constant/copy
8285 propagation, redundancy elimination, range propagation and expression
8286 simplification) based on a dominator tree traversal.  This also
8287 performs jump threading (to reduce jumps to jumps). This flag is
8288 enabled by default at @option{-O} and higher.
8290 @item -ftree-dse
8291 @opindex ftree-dse
8292 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8293 a memory location that is later overwritten by another store without
8294 any intervening loads.  In this case the earlier store can be deleted.  This
8295 flag is enabled by default at @option{-O} and higher.
8297 @item -ftree-ch
8298 @opindex ftree-ch
8299 Perform loop header copying on trees.  This is beneficial since it increases
8300 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8301 is enabled by default at @option{-O} and higher.  It is not enabled
8302 for @option{-Os}, since it usually increases code size.
8304 @item -ftree-loop-optimize
8305 @opindex ftree-loop-optimize
8306 Perform loop optimizations on trees.  This flag is enabled by default
8307 at @option{-O} and higher.
8309 @item -ftree-loop-linear
8310 @opindex ftree-loop-linear
8311 Perform loop interchange transformations on tree.  Same as
8312 @option{-floop-interchange}.  To use this code transformation, GCC has
8313 to be configured with @option{--with-isl} to enable the Graphite loop
8314 transformation infrastructure.
8316 @item -floop-interchange
8317 @opindex floop-interchange
8318 Perform loop interchange transformations on loops.  Interchanging two
8319 nested loops switches the inner and outer loops.  For example, given a
8320 loop like:
8321 @smallexample
8322 DO J = 1, M
8323   DO I = 1, N
8324     A(J, I) = A(J, I) * C
8325   ENDDO
8326 ENDDO
8327 @end smallexample
8328 loop interchange transforms the loop as if it were written:
8329 @smallexample
8330 DO I = 1, N
8331   DO J = 1, M
8332     A(J, I) = A(J, I) * C
8333   ENDDO
8334 ENDDO
8335 @end smallexample
8336 which can be beneficial when @code{N} is larger than the caches,
8337 because in Fortran, the elements of an array are stored in memory
8338 contiguously by column, and the original loop iterates over rows,
8339 potentially creating at each access a cache miss.  This optimization
8340 applies to all the languages supported by GCC and is not limited to
8341 Fortran.  To use this code transformation, GCC has to be configured
8342 with @option{--with-isl} to enable the Graphite loop transformation
8343 infrastructure.
8345 @item -floop-strip-mine
8346 @opindex floop-strip-mine
8347 Perform loop strip mining transformations on loops.  Strip mining
8348 splits a loop into two nested loops.  The outer loop has strides
8349 equal to the strip size and the inner loop has strides of the
8350 original loop within a strip.  The strip length can be changed
8351 using the @option{loop-block-tile-size} parameter.  For example,
8352 given a loop like:
8353 @smallexample
8354 DO I = 1, N
8355   A(I) = A(I) + C
8356 ENDDO
8357 @end smallexample
8358 loop strip mining transforms the loop as if it were written:
8359 @smallexample
8360 DO II = 1, N, 51
8361   DO I = II, min (II + 50, N)
8362     A(I) = A(I) + C
8363   ENDDO
8364 ENDDO
8365 @end smallexample
8366 This optimization applies to all the languages supported by GCC and is
8367 not limited to Fortran.  To use this code transformation, GCC has to
8368 be configured with @option{--with-isl} to enable the Graphite loop
8369 transformation infrastructure.
8371 @item -floop-block
8372 @opindex floop-block
8373 Perform loop blocking transformations on loops.  Blocking strip mines
8374 each loop in the loop nest such that the memory accesses of the
8375 element loops fit inside caches.  The strip length can be changed
8376 using the @option{loop-block-tile-size} parameter.  For example, given
8377 a loop like:
8378 @smallexample
8379 DO I = 1, N
8380   DO J = 1, M
8381     A(J, I) = B(I) + C(J)
8382   ENDDO
8383 ENDDO
8384 @end smallexample
8385 loop blocking transforms the loop as if it were written:
8386 @smallexample
8387 DO II = 1, N, 51
8388   DO JJ = 1, M, 51
8389     DO I = II, min (II + 50, N)
8390       DO J = JJ, min (JJ + 50, M)
8391         A(J, I) = B(I) + C(J)
8392       ENDDO
8393     ENDDO
8394   ENDDO
8395 ENDDO
8396 @end smallexample
8397 which can be beneficial when @code{M} is larger than the caches,
8398 because the innermost loop iterates over a smaller amount of data
8399 which can be kept in the caches.  This optimization applies to all the
8400 languages supported by GCC and is not limited to Fortran.  To use this
8401 code transformation, GCC has to be configured with @option{--with-isl}
8402 to enable the Graphite loop transformation infrastructure.
8404 @item -fgraphite-identity
8405 @opindex fgraphite-identity
8406 Enable the identity transformation for graphite.  For every SCoP we generate
8407 the polyhedral representation and transform it back to gimple.  Using
8408 @option{-fgraphite-identity} we can check the costs or benefits of the
8409 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8410 are also performed by the code generator ISL, like index splitting and
8411 dead code elimination in loops.
8413 @item -floop-nest-optimize
8414 @opindex floop-nest-optimize
8415 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8416 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8417 structure optimized for data-locality and parallelism.  This option
8418 is experimental.
8420 @item -floop-unroll-and-jam
8421 @opindex floop-unroll-and-jam
8422 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8423 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8424 The unrolled dimension (counting from the most inner one) can be changed 
8425 using the @option{loop-unroll-jam-depth} parameter.                 .
8427 @item -floop-parallelize-all
8428 @opindex floop-parallelize-all
8429 Use the Graphite data dependence analysis to identify loops that can
8430 be parallelized.  Parallelize all the loops that can be analyzed to
8431 not contain loop carried dependences without checking that it is
8432 profitable to parallelize the loops.
8434 @item -fcheck-data-deps
8435 @opindex fcheck-data-deps
8436 Compare the results of several data dependence analyzers.  This option
8437 is used for debugging the data dependence analyzers.
8439 @item -ftree-loop-if-convert
8440 Attempt to transform conditional jumps in the innermost loops to
8441 branch-less equivalents.  The intent is to remove control-flow from
8442 the innermost loops in order to improve the ability of the
8443 vectorization pass to handle these loops.  This is enabled by default
8444 if vectorization is enabled.
8446 @item -ftree-loop-if-convert-stores
8447 Attempt to also if-convert conditional jumps containing memory writes.
8448 This transformation can be unsafe for multi-threaded programs as it
8449 transforms conditional memory writes into unconditional memory writes.
8450 For example,
8451 @smallexample
8452 for (i = 0; i < N; i++)
8453   if (cond)
8454     A[i] = expr;
8455 @end smallexample
8456 is transformed to
8457 @smallexample
8458 for (i = 0; i < N; i++)
8459   A[i] = cond ? expr : A[i];
8460 @end smallexample
8461 potentially producing data races.
8463 @item -ftree-loop-distribution
8464 Perform loop distribution.  This flag can improve cache performance on
8465 big loop bodies and allow further loop optimizations, like
8466 parallelization or vectorization, to take place.  For example, the loop
8467 @smallexample
8468 DO I = 1, N
8469   A(I) = B(I) + C
8470   D(I) = E(I) * F
8471 ENDDO
8472 @end smallexample
8473 is transformed to
8474 @smallexample
8475 DO I = 1, N
8476    A(I) = B(I) + C
8477 ENDDO
8478 DO I = 1, N
8479    D(I) = E(I) * F
8480 ENDDO
8481 @end smallexample
8483 @item -ftree-loop-distribute-patterns
8484 Perform loop distribution of patterns that can be code generated with
8485 calls to a library.  This flag is enabled by default at @option{-O3}.
8487 This pass distributes the initialization loops and generates a call to
8488 memset zero.  For example, the loop
8489 @smallexample
8490 DO I = 1, N
8491   A(I) = 0
8492   B(I) = A(I) + I
8493 ENDDO
8494 @end smallexample
8495 is transformed to
8496 @smallexample
8497 DO I = 1, N
8498    A(I) = 0
8499 ENDDO
8500 DO I = 1, N
8501    B(I) = A(I) + I
8502 ENDDO
8503 @end smallexample
8504 and the initialization loop is transformed into a call to memset zero.
8506 @item -ftree-loop-im
8507 @opindex ftree-loop-im
8508 Perform loop invariant motion on trees.  This pass moves only invariants that
8509 are hard to handle at RTL level (function calls, operations that expand to
8510 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8511 operands of conditions that are invariant out of the loop, so that we can use
8512 just trivial invariantness analysis in loop unswitching.  The pass also includes
8513 store motion.
8515 @item -ftree-loop-ivcanon
8516 @opindex ftree-loop-ivcanon
8517 Create a canonical counter for number of iterations in loops for which
8518 determining number of iterations requires complicated analysis.  Later
8519 optimizations then may determine the number easily.  Useful especially
8520 in connection with unrolling.
8522 @item -fivopts
8523 @opindex fivopts
8524 Perform induction variable optimizations (strength reduction, induction
8525 variable merging and induction variable elimination) on trees.
8527 @item -ftree-parallelize-loops=n
8528 @opindex ftree-parallelize-loops
8529 Parallelize loops, i.e., split their iteration space to run in n threads.
8530 This is only possible for loops whose iterations are independent
8531 and can be arbitrarily reordered.  The optimization is only
8532 profitable on multiprocessor machines, for loops that are CPU-intensive,
8533 rather than constrained e.g.@: by memory bandwidth.  This option
8534 implies @option{-pthread}, and thus is only supported on targets
8535 that have support for @option{-pthread}.
8537 @item -ftree-pta
8538 @opindex ftree-pta
8539 Perform function-local points-to analysis on trees.  This flag is
8540 enabled by default at @option{-O} and higher.
8542 @item -ftree-sra
8543 @opindex ftree-sra
8544 Perform scalar replacement of aggregates.  This pass replaces structure
8545 references with scalars to prevent committing structures to memory too
8546 early.  This flag is enabled by default at @option{-O} and higher.
8548 @item -ftree-copyrename
8549 @opindex ftree-copyrename
8550 Perform copy renaming on trees.  This pass attempts to rename compiler
8551 temporaries to other variables at copy locations, usually resulting in
8552 variable names which more closely resemble the original variables.  This flag
8553 is enabled by default at @option{-O} and higher.
8555 @item -ftree-coalesce-inlined-vars
8556 @opindex ftree-coalesce-inlined-vars
8557 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8558 combine small user-defined variables too, but only if they were inlined
8559 from other functions.  It is a more limited form of
8560 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8561 inlined variables, but it will keep variables of the inlined-into
8562 function apart from each other, such that they are more likely to
8563 contain the expected values in a debugging session.  This was the
8564 default in GCC versions older than 4.7.
8566 @item -ftree-coalesce-vars
8567 @opindex ftree-coalesce-vars
8568 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8569 combine small user-defined variables too, instead of just compiler
8570 temporaries.  This may severely limit the ability to debug an optimized
8571 program compiled with @option{-fno-var-tracking-assignments}.  In the
8572 negated form, this flag prevents SSA coalescing of user variables,
8573 including inlined ones.  This option is enabled by default.
8575 @item -ftree-ter
8576 @opindex ftree-ter
8577 Perform temporary expression replacement during the SSA->normal phase.  Single
8578 use/single def temporaries are replaced at their use location with their
8579 defining expression.  This results in non-GIMPLE code, but gives the expanders
8580 much more complex trees to work on resulting in better RTL generation.  This is
8581 enabled by default at @option{-O} and higher.
8583 @item -ftree-slsr
8584 @opindex ftree-slsr
8585 Perform straight-line strength reduction on trees.  This recognizes related
8586 expressions involving multiplications and replaces them by less expensive
8587 calculations when possible.  This is enabled by default at @option{-O} and
8588 higher.
8590 @item -ftree-vectorize
8591 @opindex ftree-vectorize
8592 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8593 and @option{-ftree-slp-vectorize} if not explicitly specified.
8595 @item -ftree-loop-vectorize
8596 @opindex ftree-loop-vectorize
8597 Perform loop vectorization on trees. This flag is enabled by default at
8598 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8600 @item -ftree-slp-vectorize
8601 @opindex ftree-slp-vectorize
8602 Perform basic block vectorization on trees. This flag is enabled by default at
8603 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8605 @item -fvect-cost-model=@var{model}
8606 @opindex fvect-cost-model
8607 Alter the cost model used for vectorization.  The @var{model} argument
8608 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8609 With the @code{unlimited} model the vectorized code-path is assumed
8610 to be profitable while with the @code{dynamic} model a runtime check
8611 will guard the vectorized code-path to enable it only for iteration
8612 counts that will likely execute faster than when executing the original
8613 scalar loop.  The @code{cheap} model will disable vectorization of
8614 loops where doing so would be cost prohibitive for example due to
8615 required runtime checks for data dependence or alignment but otherwise
8616 is equal to the @code{dynamic} model.
8617 The default cost model depends on other optimization flags and is
8618 either @code{dynamic} or @code{cheap}.
8620 @item -fsimd-cost-model=@var{model}
8621 @opindex fsimd-cost-model
8622 Alter the cost model used for vectorization of loops marked with the OpenMP
8623 or Cilk Plus simd directive.  The @var{model} argument should be one of
8624 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8625 have the same meaning as described in @option{-fvect-cost-model} and by
8626 default a cost model defined with @option{-fvect-cost-model} is used.
8628 @item -ftree-vrp
8629 @opindex ftree-vrp
8630 Perform Value Range Propagation on trees.  This is similar to the
8631 constant propagation pass, but instead of values, ranges of values are
8632 propagated.  This allows the optimizers to remove unnecessary range
8633 checks like array bound checks and null pointer checks.  This is
8634 enabled by default at @option{-O2} and higher.  Null pointer check
8635 elimination is only done if @option{-fdelete-null-pointer-checks} is
8636 enabled.
8638 @item -ftracer
8639 @opindex ftracer
8640 Perform tail duplication to enlarge superblock size.  This transformation
8641 simplifies the control flow of the function allowing other optimizations to do
8642 a better job.
8644 @item -funroll-loops
8645 @opindex funroll-loops
8646 Unroll loops whose number of iterations can be determined at compile
8647 time or upon entry to the loop.  @option{-funroll-loops} implies
8648 @option{-frerun-cse-after-loop}.  This option makes code larger,
8649 and may or may not make it run faster.
8651 @item -funroll-all-loops
8652 @opindex funroll-all-loops
8653 Unroll all loops, even if their number of iterations is uncertain when
8654 the loop is entered.  This usually makes programs run more slowly.
8655 @option{-funroll-all-loops} implies the same options as
8656 @option{-funroll-loops},
8658 @item -fsplit-ivs-in-unroller
8659 @opindex fsplit-ivs-in-unroller
8660 Enables expression of values of induction variables in later iterations
8661 of the unrolled loop using the value in the first iteration.  This breaks
8662 long dependency chains, thus improving efficiency of the scheduling passes.
8664 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8665 same effect.  However, that is not reliable in cases where the loop body
8666 is more complicated than a single basic block.  It also does not work at all
8667 on some architectures due to restrictions in the CSE pass.
8669 This optimization is enabled by default.
8671 @item -fvariable-expansion-in-unroller
8672 @opindex fvariable-expansion-in-unroller
8673 With this option, the compiler creates multiple copies of some
8674 local variables when unrolling a loop, which can result in superior code.
8676 @item -fpartial-inlining
8677 @opindex fpartial-inlining
8678 Inline parts of functions.  This option has any effect only
8679 when inlining itself is turned on by the @option{-finline-functions}
8680 or @option{-finline-small-functions} options.
8682 Enabled at level @option{-O2}.
8684 @item -fpredictive-commoning
8685 @opindex fpredictive-commoning
8686 Perform predictive commoning optimization, i.e., reusing computations
8687 (especially memory loads and stores) performed in previous
8688 iterations of loops.
8690 This option is enabled at level @option{-O3}.
8692 @item -fprefetch-loop-arrays
8693 @opindex fprefetch-loop-arrays
8694 If supported by the target machine, generate instructions to prefetch
8695 memory to improve the performance of loops that access large arrays.
8697 This option may generate better or worse code; results are highly
8698 dependent on the structure of loops within the source code.
8700 Disabled at level @option{-Os}.
8702 @item -fno-peephole
8703 @itemx -fno-peephole2
8704 @opindex fno-peephole
8705 @opindex fno-peephole2
8706 Disable any machine-specific peephole optimizations.  The difference
8707 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8708 are implemented in the compiler; some targets use one, some use the
8709 other, a few use both.
8711 @option{-fpeephole} is enabled by default.
8712 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8714 @item -fno-guess-branch-probability
8715 @opindex fno-guess-branch-probability
8716 Do not guess branch probabilities using heuristics.
8718 GCC uses heuristics to guess branch probabilities if they are
8719 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8720 heuristics are based on the control flow graph.  If some branch probabilities
8721 are specified by @samp{__builtin_expect}, then the heuristics are
8722 used to guess branch probabilities for the rest of the control flow graph,
8723 taking the @samp{__builtin_expect} info into account.  The interactions
8724 between the heuristics and @samp{__builtin_expect} can be complex, and in
8725 some cases, it may be useful to disable the heuristics so that the effects
8726 of @samp{__builtin_expect} are easier to understand.
8728 The default is @option{-fguess-branch-probability} at levels
8729 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8731 @item -freorder-blocks
8732 @opindex freorder-blocks
8733 Reorder basic blocks in the compiled function in order to reduce number of
8734 taken branches and improve code locality.
8736 Enabled at levels @option{-O2}, @option{-O3}.
8738 @item -freorder-blocks-and-partition
8739 @opindex freorder-blocks-and-partition
8740 In addition to reordering basic blocks in the compiled function, in order
8741 to reduce number of taken branches, partitions hot and cold basic blocks
8742 into separate sections of the assembly and .o files, to improve
8743 paging and cache locality performance.
8745 This optimization is automatically turned off in the presence of
8746 exception handling, for linkonce sections, for functions with a user-defined
8747 section attribute and on any architecture that does not support named
8748 sections.
8750 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8752 @item -freorder-functions
8753 @opindex freorder-functions
8754 Reorder functions in the object file in order to
8755 improve code locality.  This is implemented by using special
8756 subsections @code{.text.hot} for most frequently executed functions and
8757 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8758 the linker so object file format must support named sections and linker must
8759 place them in a reasonable way.
8761 Also profile feedback must be available to make this option effective.  See
8762 @option{-fprofile-arcs} for details.
8764 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8766 @item -fstrict-aliasing
8767 @opindex fstrict-aliasing
8768 Allow the compiler to assume the strictest aliasing rules applicable to
8769 the language being compiled.  For C (and C++), this activates
8770 optimizations based on the type of expressions.  In particular, an
8771 object of one type is assumed never to reside at the same address as an
8772 object of a different type, unless the types are almost the same.  For
8773 example, an @code{unsigned int} can alias an @code{int}, but not a
8774 @code{void*} or a @code{double}.  A character type may alias any other
8775 type.
8777 @anchor{Type-punning}Pay special attention to code like this:
8778 @smallexample
8779 union a_union @{
8780   int i;
8781   double d;
8784 int f() @{
8785   union a_union t;
8786   t.d = 3.0;
8787   return t.i;
8789 @end smallexample
8790 The practice of reading from a different union member than the one most
8791 recently written to (called ``type-punning'') is common.  Even with
8792 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8793 is accessed through the union type.  So, the code above works as
8794 expected.  @xref{Structures unions enumerations and bit-fields
8795 implementation}.  However, this code might not:
8796 @smallexample
8797 int f() @{
8798   union a_union t;
8799   int* ip;
8800   t.d = 3.0;
8801   ip = &t.i;
8802   return *ip;
8804 @end smallexample
8806 Similarly, access by taking the address, casting the resulting pointer
8807 and dereferencing the result has undefined behavior, even if the cast
8808 uses a union type, e.g.:
8809 @smallexample
8810 int f() @{
8811   double d = 3.0;
8812   return ((union a_union *) &d)->i;
8814 @end smallexample
8816 The @option{-fstrict-aliasing} option is enabled at levels
8817 @option{-O2}, @option{-O3}, @option{-Os}.
8819 @item -fstrict-overflow
8820 @opindex fstrict-overflow
8821 Allow the compiler to assume strict signed overflow rules, depending
8822 on the language being compiled.  For C (and C++) this means that
8823 overflow when doing arithmetic with signed numbers is undefined, which
8824 means that the compiler may assume that it does not happen.  This
8825 permits various optimizations.  For example, the compiler assumes
8826 that an expression like @code{i + 10 > i} is always true for
8827 signed @code{i}.  This assumption is only valid if signed overflow is
8828 undefined, as the expression is false if @code{i + 10} overflows when
8829 using twos complement arithmetic.  When this option is in effect any
8830 attempt to determine whether an operation on signed numbers 
8831 overflows must be written carefully to not actually involve overflow.
8833 This option also allows the compiler to assume strict pointer
8834 semantics: given a pointer to an object, if adding an offset to that
8835 pointer does not produce a pointer to the same object, the addition is
8836 undefined.  This permits the compiler to conclude that @code{p + u >
8837 p} is always true for a pointer @code{p} and unsigned integer
8838 @code{u}.  This assumption is only valid because pointer wraparound is
8839 undefined, as the expression is false if @code{p + u} overflows using
8840 twos complement arithmetic.
8842 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8843 that integer signed overflow is fully defined: it wraps.  When
8844 @option{-fwrapv} is used, there is no difference between
8845 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8846 integers.  With @option{-fwrapv} certain types of overflow are
8847 permitted.  For example, if the compiler gets an overflow when doing
8848 arithmetic on constants, the overflowed value can still be used with
8849 @option{-fwrapv}, but not otherwise.
8851 The @option{-fstrict-overflow} option is enabled at levels
8852 @option{-O2}, @option{-O3}, @option{-Os}.
8854 @item -falign-functions
8855 @itemx -falign-functions=@var{n}
8856 @opindex falign-functions
8857 Align the start of functions to the next power-of-two greater than
8858 @var{n}, skipping up to @var{n} bytes.  For instance,
8859 @option{-falign-functions=32} aligns functions to the next 32-byte
8860 boundary, but @option{-falign-functions=24} aligns to the next
8861 32-byte boundary only if this can be done by skipping 23 bytes or less.
8863 @option{-fno-align-functions} and @option{-falign-functions=1} are
8864 equivalent and mean that functions are not aligned.
8866 Some assemblers only support this flag when @var{n} is a power of two;
8867 in that case, it is rounded up.
8869 If @var{n} is not specified or is zero, use a machine-dependent default.
8871 Enabled at levels @option{-O2}, @option{-O3}.
8873 @item -falign-labels
8874 @itemx -falign-labels=@var{n}
8875 @opindex falign-labels
8876 Align all branch targets to a power-of-two boundary, skipping up to
8877 @var{n} bytes like @option{-falign-functions}.  This option can easily
8878 make code slower, because it must insert dummy operations for when the
8879 branch target is reached in the usual flow of the code.
8881 @option{-fno-align-labels} and @option{-falign-labels=1} are
8882 equivalent and mean that labels are not aligned.
8884 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8885 are greater than this value, then their values are used instead.
8887 If @var{n} is not specified or is zero, use a machine-dependent default
8888 which is very likely to be @samp{1}, meaning no alignment.
8890 Enabled at levels @option{-O2}, @option{-O3}.
8892 @item -falign-loops
8893 @itemx -falign-loops=@var{n}
8894 @opindex falign-loops
8895 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8896 like @option{-falign-functions}.  If the loops are
8897 executed many times, this makes up for any execution of the dummy
8898 operations.
8900 @option{-fno-align-loops} and @option{-falign-loops=1} are
8901 equivalent and mean that loops are not aligned.
8903 If @var{n} is not specified or is zero, use a machine-dependent default.
8905 Enabled at levels @option{-O2}, @option{-O3}.
8907 @item -falign-jumps
8908 @itemx -falign-jumps=@var{n}
8909 @opindex falign-jumps
8910 Align branch targets to a power-of-two boundary, for branch targets
8911 where the targets can only be reached by jumping, skipping up to @var{n}
8912 bytes like @option{-falign-functions}.  In this case, no dummy operations
8913 need be executed.
8915 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8916 equivalent and mean that loops are not aligned.
8918 If @var{n} is not specified or is zero, use a machine-dependent default.
8920 Enabled at levels @option{-O2}, @option{-O3}.
8922 @item -funit-at-a-time
8923 @opindex funit-at-a-time
8924 This option is left for compatibility reasons. @option{-funit-at-a-time}
8925 has no effect, while @option{-fno-unit-at-a-time} implies
8926 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8928 Enabled by default.
8930 @item -fno-toplevel-reorder
8931 @opindex fno-toplevel-reorder
8932 Do not reorder top-level functions, variables, and @code{asm}
8933 statements.  Output them in the same order that they appear in the
8934 input file.  When this option is used, unreferenced static variables
8935 are not removed.  This option is intended to support existing code
8936 that relies on a particular ordering.  For new code, it is better to
8937 use attributes when possible.
8939 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8940 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8941 targets.
8943 @item -fweb
8944 @opindex fweb
8945 Constructs webs as commonly used for register allocation purposes and assign
8946 each web individual pseudo register.  This allows the register allocation pass
8947 to operate on pseudos directly, but also strengthens several other optimization
8948 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8949 however, make debugging impossible, since variables no longer stay in a
8950 ``home register''.
8952 Enabled by default with @option{-funroll-loops}.
8954 @item -fwhole-program
8955 @opindex fwhole-program
8956 Assume that the current compilation unit represents the whole program being
8957 compiled.  All public functions and variables with the exception of @code{main}
8958 and those merged by attribute @code{externally_visible} become static functions
8959 and in effect are optimized more aggressively by interprocedural optimizers.
8961 This option should not be used in combination with @code{-flto}.
8962 Instead relying on a linker plugin should provide safer and more precise
8963 information.
8965 @item -flto[=@var{n}]
8966 @opindex flto
8967 This option runs the standard link-time optimizer.  When invoked
8968 with source code, it generates GIMPLE (one of GCC's internal
8969 representations) and writes it to special ELF sections in the object
8970 file.  When the object files are linked together, all the function
8971 bodies are read from these ELF sections and instantiated as if they
8972 had been part of the same translation unit.
8974 To use the link-time optimizer, @option{-flto} and optimization
8975 options should be specified at compile time and during the final link.
8976 For example:
8978 @smallexample
8979 gcc -c -O2 -flto foo.c
8980 gcc -c -O2 -flto bar.c
8981 gcc -o myprog -flto -O2 foo.o bar.o
8982 @end smallexample
8984 The first two invocations to GCC save a bytecode representation
8985 of GIMPLE into special ELF sections inside @file{foo.o} and
8986 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8987 @file{foo.o} and @file{bar.o}, merges the two files into a single
8988 internal image, and compiles the result as usual.  Since both
8989 @file{foo.o} and @file{bar.o} are merged into a single image, this
8990 causes all the interprocedural analyses and optimizations in GCC to
8991 work across the two files as if they were a single one.  This means,
8992 for example, that the inliner is able to inline functions in
8993 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8995 Another (simpler) way to enable link-time optimization is:
8997 @smallexample
8998 gcc -o myprog -flto -O2 foo.c bar.c
8999 @end smallexample
9001 The above generates bytecode for @file{foo.c} and @file{bar.c},
9002 merges them together into a single GIMPLE representation and optimizes
9003 them as usual to produce @file{myprog}.
9005 The only important thing to keep in mind is that to enable link-time
9006 optimizations you need to use the GCC driver to perform the link-step.
9007 GCC then automatically performs link-time optimization if any of the
9008 objects involved were compiled with the @option{-flto}.  You generally
9009 should specify the optimization options to be used for link-time
9010 optimization though GCC will try to be clever at guessing an
9011 optimization level to use from the options used at compile-time
9012 if you fail to specify one at link-time.  You can always override
9013 the automatic decision to do link-time optimization at link-time
9014 by passing @option{-fno-lto} to the link command.
9016 To make whole program optimization effective, it is necessary to make
9017 certain whole program assumptions.  The compiler needs to know
9018 what functions and variables can be accessed by libraries and runtime
9019 outside of the link-time optimized unit.  When supported by the linker,
9020 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9021 to the compiler about used and externally visible symbols.  When
9022 the linker plugin is not available, @option{-fwhole-program} should be
9023 used to allow the compiler to make these assumptions, which leads
9024 to more aggressive optimization decisions.
9026 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9027 compiled with @option{-flto}, the generated object file is larger than
9028 a regular object file because it contains GIMPLE bytecodes and the usual
9029 final code (see @option{-ffat-lto-objects}.  This means that
9030 object files with LTO information can be linked as normal object
9031 files; if @option{-fno-lto} is passed to the linker, no
9032 interprocedural optimizations are applied.  Note that when
9033 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9034 but you cannot perform a regular, non-LTO link on them.
9036 Additionally, the optimization flags used to compile individual files
9037 are not necessarily related to those used at link time.  For instance,
9039 @smallexample
9040 gcc -c -O0 -ffat-lto-objects -flto foo.c
9041 gcc -c -O0 -ffat-lto-objects -flto bar.c
9042 gcc -o myprog -O3 foo.o bar.o
9043 @end smallexample
9045 This produces individual object files with unoptimized assembler
9046 code, but the resulting binary @file{myprog} is optimized at
9047 @option{-O3}.  If, instead, the final binary is generated with
9048 @option{-fno-lto}, then @file{myprog} is not optimized.
9050 When producing the final binary, GCC only
9051 applies link-time optimizations to those files that contain bytecode.
9052 Therefore, you can mix and match object files and libraries with
9053 GIMPLE bytecodes and final object code.  GCC automatically selects
9054 which files to optimize in LTO mode and which files to link without
9055 further processing.
9057 There are some code generation flags preserved by GCC when
9058 generating bytecodes, as they need to be used during the final link
9059 stage.  Generally options specified at link-time override those
9060 specified at compile-time.
9062 If you do not specify an optimization level option @option{-O} at
9063 link-time then GCC will compute one based on the optimization levels
9064 used when compiling the object files.  The highest optimization
9065 level will win here.
9067 Currently, the following options and their setting are take from
9068 the first object file that explicitely specified it: 
9069 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9070 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9071 and all the @option{-m} target flags.
9073 Certain ABI changing flags are required to match in all compilation-units
9074 and trying to override this at link-time with a conflicting value
9075 is ignored.  This includes options such as @option{-freg-struct-return}
9076 and @option{-fpcc-struct-return}. 
9078 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9079 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9080 are passed through to the link stage and merged conservatively for
9081 conflicting translation units.  Specifically
9082 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9083 precedence and for example @option{-ffp-contract=off} takes precedence
9084 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9086 It is recommended that you compile all the files participating in the
9087 same link with the same options and also specify those options at
9088 link time.
9090 If LTO encounters objects with C linkage declared with incompatible
9091 types in separate translation units to be linked together (undefined
9092 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9093 issued.  The behavior is still undefined at run time.  Similar
9094 diagnostics may be raised for other languages.
9096 Another feature of LTO is that it is possible to apply interprocedural
9097 optimizations on files written in different languages:
9099 @smallexample
9100 gcc -c -flto foo.c
9101 g++ -c -flto bar.cc
9102 gfortran -c -flto baz.f90
9103 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9104 @end smallexample
9106 Notice that the final link is done with @command{g++} to get the C++
9107 runtime libraries and @option{-lgfortran} is added to get the Fortran
9108 runtime libraries.  In general, when mixing languages in LTO mode, you
9109 should use the same link command options as when mixing languages in a
9110 regular (non-LTO) compilation.
9112 If object files containing GIMPLE bytecode are stored in a library archive, say
9113 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9114 are using a linker with plugin support.  To create static libraries suitable
9115 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9116 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
9117 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9118 and @command{nm} have been compiled with plugin support.  At link time, use the the
9119 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9120 the LTO optimization process:
9122 @smallexample
9123 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9124 @end smallexample
9126 With the linker plugin enabled, the linker extracts the needed
9127 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9128 to make them part of the aggregated GIMPLE image to be optimized.
9130 If you are not using a linker with plugin support and/or do not
9131 enable the linker plugin, then the objects inside @file{libfoo.a}
9132 are extracted and linked as usual, but they do not participate
9133 in the LTO optimization process.  In order to make a static library suitable
9134 for both LTO optimization and usual linkage, compile its object files with
9135 @option{-flto} @code{-ffat-lto-objects}.
9137 Link-time optimizations do not require the presence of the whole program to
9138 operate.  If the program does not require any symbols to be exported, it is
9139 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9140 the interprocedural optimizers to use more aggressive assumptions which may
9141 lead to improved optimization opportunities.
9142 Use of @option{-fwhole-program} is not needed when linker plugin is
9143 active (see @option{-fuse-linker-plugin}).
9145 The current implementation of LTO makes no
9146 attempt to generate bytecode that is portable between different
9147 types of hosts.  The bytecode files are versioned and there is a
9148 strict version check, so bytecode files generated in one version of
9149 GCC will not work with an older or newer version of GCC.
9151 Link-time optimization does not work well with generation of debugging
9152 information.  Combining @option{-flto} with
9153 @option{-g} is currently experimental and expected to produce unexpected
9154 results.
9156 If you specify the optional @var{n}, the optimization and code
9157 generation done at link time is executed in parallel using @var{n}
9158 parallel jobs by utilizing an installed @command{make} program.  The
9159 environment variable @env{MAKE} may be used to override the program
9160 used.  The default value for @var{n} is 1.
9162 You can also specify @option{-flto=jobserver} to use GNU make's
9163 job server mode to determine the number of parallel jobs. This
9164 is useful when the Makefile calling GCC is already executing in parallel.
9165 You must prepend a @samp{+} to the command recipe in the parent Makefile
9166 for this to work.  This option likely only works if @env{MAKE} is
9167 GNU make.
9169 @item -flto-partition=@var{alg}
9170 @opindex flto-partition
9171 Specify the partitioning algorithm used by the link-time optimizer.
9172 The value is either @code{1to1} to specify a partitioning mirroring
9173 the original source files or @code{balanced} to specify partitioning
9174 into equally sized chunks (whenever possible) or @code{max} to create
9175 new partition for every symbol where possible.  Specifying @code{none}
9176 as an algorithm disables partitioning and streaming completely. 
9177 The default value is @code{balanced}. While @code{1to1} can be used
9178 as an workaround for various code ordering issues, the @code{max}
9179 partitioning is intended for internal testing only.
9180 The value @code{one} specifies that exactly one partition should be
9181 used while the value @code{none} bypasses partitioning and executes
9182 the link-time optimization step directly from the WPA phase.
9184 @item -flto-odr-type-merging
9185 @opindex flto-odr-type-merging
9186 Enable streaming of mangled types names of C++ types and their unification
9187 at linktime.  This increases size of LTO object files, but enable
9188 diagnostics about One Definition Rule violations.
9190 @item -flto-compression-level=@var{n}
9191 This option specifies the level of compression used for intermediate
9192 language written to LTO object files, and is only meaningful in
9193 conjunction with LTO mode (@option{-flto}).  Valid
9194 values are 0 (no compression) to 9 (maximum compression).  Values
9195 outside this range are clamped to either 0 or 9.  If the option is not
9196 given, a default balanced compression setting is used.
9198 @item -flto-report
9199 Prints a report with internal details on the workings of the link-time
9200 optimizer.  The contents of this report vary from version to version.
9201 It is meant to be useful to GCC developers when processing object
9202 files in LTO mode (via @option{-flto}).
9204 Disabled by default.
9206 @item -flto-report-wpa
9207 Like @option{-flto-report}, but only print for the WPA phase of Link
9208 Time Optimization.
9210 @item -fuse-linker-plugin
9211 Enables the use of a linker plugin during link-time optimization.  This
9212 option relies on plugin support in the linker, which is available in gold
9213 or in GNU ld 2.21 or newer.
9215 This option enables the extraction of object files with GIMPLE bytecode out
9216 of library archives. This improves the quality of optimization by exposing
9217 more code to the link-time optimizer.  This information specifies what
9218 symbols can be accessed externally (by non-LTO object or during dynamic
9219 linking).  Resulting code quality improvements on binaries (and shared
9220 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9221 See @option{-flto} for a description of the effect of this flag and how to
9222 use it.
9224 This option is enabled by default when LTO support in GCC is enabled
9225 and GCC was configured for use with
9226 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9228 @item -ffat-lto-objects
9229 @opindex ffat-lto-objects
9230 Fat LTO objects are object files that contain both the intermediate language
9231 and the object code. This makes them usable for both LTO linking and normal
9232 linking. This option is effective only when compiling with @option{-flto}
9233 and is ignored at link time.
9235 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9236 requires the complete toolchain to be aware of LTO. It requires a linker with
9237 linker plugin support for basic functionality.  Additionally,
9238 @command{nm}, @command{ar} and @command{ranlib}
9239 need to support linker plugins to allow a full-featured build environment
9240 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9241 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9242 to these tools. With non fat LTO makefiles need to be modified to use them.
9244 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9245 support.
9247 @item -fcompare-elim
9248 @opindex fcompare-elim
9249 After register allocation and post-register allocation instruction splitting,
9250 identify arithmetic instructions that compute processor flags similar to a
9251 comparison operation based on that arithmetic.  If possible, eliminate the
9252 explicit comparison operation.
9254 This pass only applies to certain targets that cannot explicitly represent
9255 the comparison operation before register allocation is complete.
9257 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9259 @item -fuse-ld=bfd
9260 @opindex fuse-ld=bfd
9261 Use the @command{bfd} linker instead of the default linker.
9263 @item -fuse-ld=gold
9264 @opindex fuse-ld=gold
9265 Use the @command{gold} linker instead of the default linker.
9267 @item -fcprop-registers
9268 @opindex fcprop-registers
9269 After register allocation and post-register allocation instruction splitting,
9270 perform a copy-propagation pass to try to reduce scheduling dependencies
9271 and occasionally eliminate the copy.
9273 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9275 @item -fprofile-correction
9276 @opindex fprofile-correction
9277 Profiles collected using an instrumented binary for multi-threaded programs may
9278 be inconsistent due to missed counter updates. When this option is specified,
9279 GCC uses heuristics to correct or smooth out such inconsistencies. By
9280 default, GCC emits an error message when an inconsistent profile is detected.
9282 @item -fprofile-dir=@var{path}
9283 @opindex fprofile-dir
9285 Set the directory to search for the profile data files in to @var{path}.
9286 This option affects only the profile data generated by
9287 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9288 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9289 and its related options.  Both absolute and relative paths can be used.
9290 By default, GCC uses the current directory as @var{path}, thus the
9291 profile data file appears in the same directory as the object file.
9293 @item -fprofile-generate
9294 @itemx -fprofile-generate=@var{path}
9295 @opindex fprofile-generate
9297 Enable options usually used for instrumenting application to produce
9298 profile useful for later recompilation with profile feedback based
9299 optimization.  You must use @option{-fprofile-generate} both when
9300 compiling and when linking your program.
9302 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9304 If @var{path} is specified, GCC looks at the @var{path} to find
9305 the profile feedback data files. See @option{-fprofile-dir}.
9307 @item -fprofile-use
9308 @itemx -fprofile-use=@var{path}
9309 @opindex fprofile-use
9310 Enable profile feedback directed optimizations, and optimizations
9311 generally profitable only with profile feedback available.
9313 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9314 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9315 @code{ftree-loop-distribute-patterns}
9317 By default, GCC emits an error message if the feedback profiles do not
9318 match the source code.  This error can be turned into a warning by using
9319 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9320 code.
9322 If @var{path} is specified, GCC looks at the @var{path} to find
9323 the profile feedback data files. See @option{-fprofile-dir}.
9325 @item -fauto-profile
9326 @itemx -fauto-profile=@var{path}
9327 @opindex fauto-profile
9328 Enable sampling based feedback directed optimizations, and optimizations
9329 generally profitable only with profile feedback available.
9331 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9332 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9333 @code{-finline-functions}, @code{-fipa-cp}, @code{-fipa-cp-clone},
9334 @code{-fpredictive-commoning}, @code{-funswitch-loops},
9335 @code{-fgcse-after-reload}, @code{-ftree-loop-distribute-patterns},
9337 If @var{path} is specified, GCC looks at the @var{path} to find
9338 the profile feedback data files.
9340 In order to collect AutoFDO profile, you need to have:
9342 1. A linux system with linux perf support
9343 2. (optional) An Intel processor with last branch record (LBR) support. This is
9344    to guarantee accurate instruction level profile, which is important for
9345    AutoFDO performance.
9347 To collect the profile, first use linux perf to collect raw profile
9348 (see @uref{https://perf.wiki.kernel.org/}).
9350 E.g.
9351 @code{perf record -e br_inst_retired:near_taken -b -o perf.data -- your_program}
9353 Then use create_gcov tool, which takes raw profile and unstripped binary to
9354 generate AutoFDO profile that can be used by GCC.
9355 (see @uref{https://github.com/google/autofdo}).
9357 E.g.
9358 @code{create_gcov --binary=your_program.unstripped --profile=perf.data --gcov=profile.afdo}
9359 @end table
9361 The following options control compiler behavior regarding floating-point 
9362 arithmetic.  These options trade off between speed and
9363 correctness.  All must be specifically enabled.
9365 @table @gcctabopt
9366 @item -ffloat-store
9367 @opindex ffloat-store
9368 Do not store floating-point variables in registers, and inhibit other
9369 options that might change whether a floating-point value is taken from a
9370 register or memory.
9372 @cindex floating-point precision
9373 This option prevents undesirable excess precision on machines such as
9374 the 68000 where the floating registers (of the 68881) keep more
9375 precision than a @code{double} is supposed to have.  Similarly for the
9376 x86 architecture.  For most programs, the excess precision does only
9377 good, but a few programs rely on the precise definition of IEEE floating
9378 point.  Use @option{-ffloat-store} for such programs, after modifying
9379 them to store all pertinent intermediate computations into variables.
9381 @item -fexcess-precision=@var{style}
9382 @opindex fexcess-precision
9383 This option allows further control over excess precision on machines
9384 where floating-point registers have more precision than the IEEE
9385 @code{float} and @code{double} types and the processor does not
9386 support operations rounding to those types.  By default,
9387 @option{-fexcess-precision=fast} is in effect; this means that
9388 operations are carried out in the precision of the registers and that
9389 it is unpredictable when rounding to the types specified in the source
9390 code takes place.  When compiling C, if
9391 @option{-fexcess-precision=standard} is specified then excess
9392 precision follows the rules specified in ISO C99; in particular,
9393 both casts and assignments cause values to be rounded to their
9394 semantic types (whereas @option{-ffloat-store} only affects
9395 assignments).  This option is enabled by default for C if a strict
9396 conformance option such as @option{-std=c99} is used.
9398 @opindex mfpmath
9399 @option{-fexcess-precision=standard} is not implemented for languages
9400 other than C, and has no effect if
9401 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9402 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9403 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9404 semantics apply without excess precision, and in the latter, rounding
9405 is unpredictable.
9407 @item -ffast-math
9408 @opindex ffast-math
9409 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9410 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9411 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9413 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9415 This option is not turned on by any @option{-O} option besides
9416 @option{-Ofast} since it can result in incorrect output for programs
9417 that depend on an exact implementation of IEEE or ISO rules/specifications
9418 for math functions. It may, however, yield faster code for programs
9419 that do not require the guarantees of these specifications.
9421 @item -fno-math-errno
9422 @opindex fno-math-errno
9423 Do not set @code{errno} after calling math functions that are executed
9424 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9425 IEEE exceptions for math error handling may want to use this flag
9426 for speed while maintaining IEEE arithmetic compatibility.
9428 This option is not turned on by any @option{-O} option since
9429 it can result in incorrect output for programs that depend on
9430 an exact implementation of IEEE or ISO rules/specifications for
9431 math functions. It may, however, yield faster code for programs
9432 that do not require the guarantees of these specifications.
9434 The default is @option{-fmath-errno}.
9436 On Darwin systems, the math library never sets @code{errno}.  There is
9437 therefore no reason for the compiler to consider the possibility that
9438 it might, and @option{-fno-math-errno} is the default.
9440 @item -funsafe-math-optimizations
9441 @opindex funsafe-math-optimizations
9443 Allow optimizations for floating-point arithmetic that (a) assume
9444 that arguments and results are valid and (b) may violate IEEE or
9445 ANSI standards.  When used at link-time, it may include libraries
9446 or startup files that change the default FPU control word or other
9447 similar optimizations.
9449 This option is not turned on by any @option{-O} option since
9450 it can result in incorrect output for programs that depend on
9451 an exact implementation of IEEE or ISO rules/specifications for
9452 math functions. It may, however, yield faster code for programs
9453 that do not require the guarantees of these specifications.
9454 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9455 @option{-fassociative-math} and @option{-freciprocal-math}.
9457 The default is @option{-fno-unsafe-math-optimizations}.
9459 @item -fassociative-math
9460 @opindex fassociative-math
9462 Allow re-association of operands in series of floating-point operations.
9463 This violates the ISO C and C++ language standard by possibly changing
9464 computation result.  NOTE: re-ordering may change the sign of zero as
9465 well as ignore NaNs and inhibit or create underflow or overflow (and
9466 thus cannot be used on code that relies on rounding behavior like
9467 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9468 and thus may not be used when ordered comparisons are required.
9469 This option requires that both @option{-fno-signed-zeros} and
9470 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9471 much sense with @option{-frounding-math}. For Fortran the option
9472 is automatically enabled when both @option{-fno-signed-zeros} and
9473 @option{-fno-trapping-math} are in effect.
9475 The default is @option{-fno-associative-math}.
9477 @item -freciprocal-math
9478 @opindex freciprocal-math
9480 Allow the reciprocal of a value to be used instead of dividing by
9481 the value if this enables optimizations.  For example @code{x / y}
9482 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9483 is subject to common subexpression elimination.  Note that this loses
9484 precision and increases the number of flops operating on the value.
9486 The default is @option{-fno-reciprocal-math}.
9488 @item -ffinite-math-only
9489 @opindex ffinite-math-only
9490 Allow optimizations for floating-point arithmetic that assume
9491 that arguments and results are not NaNs or +-Infs.
9493 This option is not turned on by any @option{-O} option since
9494 it can result in incorrect output for programs that depend on
9495 an exact implementation of IEEE or ISO rules/specifications for
9496 math functions. It may, however, yield faster code for programs
9497 that do not require the guarantees of these specifications.
9499 The default is @option{-fno-finite-math-only}.
9501 @item -fno-signed-zeros
9502 @opindex fno-signed-zeros
9503 Allow optimizations for floating-point arithmetic that ignore the
9504 signedness of zero.  IEEE arithmetic specifies the behavior of
9505 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9506 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9507 This option implies that the sign of a zero result isn't significant.
9509 The default is @option{-fsigned-zeros}.
9511 @item -fno-trapping-math
9512 @opindex fno-trapping-math
9513 Compile code assuming that floating-point operations cannot generate
9514 user-visible traps.  These traps include division by zero, overflow,
9515 underflow, inexact result and invalid operation.  This option requires
9516 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9517 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9519 This option should never be turned on by any @option{-O} option since
9520 it can result in incorrect output for programs that depend on
9521 an exact implementation of IEEE or ISO rules/specifications for
9522 math functions.
9524 The default is @option{-ftrapping-math}.
9526 @item -frounding-math
9527 @opindex frounding-math
9528 Disable transformations and optimizations that assume default floating-point
9529 rounding behavior.  This is round-to-zero for all floating point
9530 to integer conversions, and round-to-nearest for all other arithmetic
9531 truncations.  This option should be specified for programs that change
9532 the FP rounding mode dynamically, or that may be executed with a
9533 non-default rounding mode.  This option disables constant folding of
9534 floating-point expressions at compile time (which may be affected by
9535 rounding mode) and arithmetic transformations that are unsafe in the
9536 presence of sign-dependent rounding modes.
9538 The default is @option{-fno-rounding-math}.
9540 This option is experimental and does not currently guarantee to
9541 disable all GCC optimizations that are affected by rounding mode.
9542 Future versions of GCC may provide finer control of this setting
9543 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9544 will be used to specify the default state for @code{FENV_ACCESS}.
9546 @item -fsignaling-nans
9547 @opindex fsignaling-nans
9548 Compile code assuming that IEEE signaling NaNs may generate user-visible
9549 traps during floating-point operations.  Setting this option disables
9550 optimizations that may change the number of exceptions visible with
9551 signaling NaNs.  This option implies @option{-ftrapping-math}.
9553 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9554 be defined.
9556 The default is @option{-fno-signaling-nans}.
9558 This option is experimental and does not currently guarantee to
9559 disable all GCC optimizations that affect signaling NaN behavior.
9561 @item -fsingle-precision-constant
9562 @opindex fsingle-precision-constant
9563 Treat floating-point constants as single precision instead of
9564 implicitly converting them to double-precision constants.
9566 @item -fcx-limited-range
9567 @opindex fcx-limited-range
9568 When enabled, this option states that a range reduction step is not
9569 needed when performing complex division.  Also, there is no checking
9570 whether the result of a complex multiplication or division is @code{NaN
9571 + I*NaN}, with an attempt to rescue the situation in that case.  The
9572 default is @option{-fno-cx-limited-range}, but is enabled by
9573 @option{-ffast-math}.
9575 This option controls the default setting of the ISO C99
9576 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9577 all languages.
9579 @item -fcx-fortran-rules
9580 @opindex fcx-fortran-rules
9581 Complex multiplication and division follow Fortran rules.  Range
9582 reduction is done as part of complex division, but there is no checking
9583 whether the result of a complex multiplication or division is @code{NaN
9584 + I*NaN}, with an attempt to rescue the situation in that case.
9586 The default is @option{-fno-cx-fortran-rules}.
9588 @end table
9590 The following options control optimizations that may improve
9591 performance, but are not enabled by any @option{-O} options.  This
9592 section includes experimental options that may produce broken code.
9594 @table @gcctabopt
9595 @item -fbranch-probabilities
9596 @opindex fbranch-probabilities
9597 After running a program compiled with @option{-fprofile-arcs}
9598 (@pxref{Debugging Options,, Options for Debugging Your Program or
9599 @command{gcc}}), you can compile it a second time using
9600 @option{-fbranch-probabilities}, to improve optimizations based on
9601 the number of times each branch was taken.  When a program
9602 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9603 counts to a file called @file{@var{sourcename}.gcda} for each source
9604 file.  The information in this data file is very dependent on the
9605 structure of the generated code, so you must use the same source code
9606 and the same optimization options for both compilations.
9608 With @option{-fbranch-probabilities}, GCC puts a
9609 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9610 These can be used to improve optimization.  Currently, they are only
9611 used in one place: in @file{reorg.c}, instead of guessing which path a
9612 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9613 exactly determine which path is taken more often.
9615 @item -fprofile-values
9616 @opindex fprofile-values
9617 If combined with @option{-fprofile-arcs}, it adds code so that some
9618 data about values of expressions in the program is gathered.
9620 With @option{-fbranch-probabilities}, it reads back the data gathered
9621 from profiling values of expressions for usage in optimizations.
9623 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9625 @item -fprofile-reorder-functions
9626 @opindex fprofile-reorder-functions
9627 Function reordering based on profile instrumentation collects
9628 first time of execution of a function and orders these functions
9629 in ascending order.
9631 Enabled with @option{-fprofile-use}.
9633 @item -fvpt
9634 @opindex fvpt
9635 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9636 to add code to gather information about values of expressions.
9638 With @option{-fbranch-probabilities}, it reads back the data gathered
9639 and actually performs the optimizations based on them.
9640 Currently the optimizations include specialization of division operations
9641 using the knowledge about the value of the denominator.
9643 @item -frename-registers
9644 @opindex frename-registers
9645 Attempt to avoid false dependencies in scheduled code by making use
9646 of registers left over after register allocation.  This optimization
9647 most benefits processors with lots of registers.  Depending on the
9648 debug information format adopted by the target, however, it can
9649 make debugging impossible, since variables no longer stay in
9650 a ``home register''.
9652 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9654 @item -fschedule-fusion
9655 @opindex fschedule-fusion
9656 Performs a target dependent pass over the instruction stream to schedule
9657 instructions of same type together because target machine can execute them
9658 more efficiently if they are adjacent to each other in the instruction flow.
9660 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9662 @item -ftracer
9663 @opindex ftracer
9664 Perform tail duplication to enlarge superblock size.  This transformation
9665 simplifies the control flow of the function allowing other optimizations to do
9666 a better job.
9668 Enabled with @option{-fprofile-use}.
9670 @item -funroll-loops
9671 @opindex funroll-loops
9672 Unroll loops whose number of iterations can be determined at compile time or
9673 upon entry to the loop.  @option{-funroll-loops} implies
9674 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9675 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9676 a small constant number of iterations).  This option makes code larger, and may
9677 or may not make it run faster.
9679 Enabled with @option{-fprofile-use}.
9681 @item -funroll-all-loops
9682 @opindex funroll-all-loops
9683 Unroll all loops, even if their number of iterations is uncertain when
9684 the loop is entered.  This usually makes programs run more slowly.
9685 @option{-funroll-all-loops} implies the same options as
9686 @option{-funroll-loops}.
9688 @item -fpeel-loops
9689 @opindex fpeel-loops
9690 Peels loops for which there is enough information that they do not
9691 roll much (from profile feedback).  It also turns on complete loop peeling
9692 (i.e.@: complete removal of loops with small constant number of iterations).
9694 Enabled with @option{-fprofile-use}.
9696 @item -fmove-loop-invariants
9697 @opindex fmove-loop-invariants
9698 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9699 at level @option{-O1}
9701 @item -funswitch-loops
9702 @opindex funswitch-loops
9703 Move branches with loop invariant conditions out of the loop, with duplicates
9704 of the loop on both branches (modified according to result of the condition).
9706 @item -ffunction-sections
9707 @itemx -fdata-sections
9708 @opindex ffunction-sections
9709 @opindex fdata-sections
9710 Place each function or data item into its own section in the output
9711 file if the target supports arbitrary sections.  The name of the
9712 function or the name of the data item determines the section's name
9713 in the output file.
9715 Use these options on systems where the linker can perform optimizations
9716 to improve locality of reference in the instruction space.  Most systems
9717 using the ELF object format and SPARC processors running Solaris 2 have
9718 linkers with such optimizations.  AIX may have these optimizations in
9719 the future.
9721 Only use these options when there are significant benefits from doing
9722 so.  When you specify these options, the assembler and linker
9723 create larger object and executable files and are also slower.
9724 You cannot use @code{gprof} on all systems if you
9725 specify this option, and you may have problems with debugging if
9726 you specify both this option and @option{-g}.
9728 @item -fbranch-target-load-optimize
9729 @opindex fbranch-target-load-optimize
9730 Perform branch target register load optimization before prologue / epilogue
9731 threading.
9732 The use of target registers can typically be exposed only during reload,
9733 thus hoisting loads out of loops and doing inter-block scheduling needs
9734 a separate optimization pass.
9736 @item -fbranch-target-load-optimize2
9737 @opindex fbranch-target-load-optimize2
9738 Perform branch target register load optimization after prologue / epilogue
9739 threading.
9741 @item -fbtr-bb-exclusive
9742 @opindex fbtr-bb-exclusive
9743 When performing branch target register load optimization, don't reuse
9744 branch target registers within any basic block.
9746 @item -fstack-protector
9747 @opindex fstack-protector
9748 Emit extra code to check for buffer overflows, such as stack smashing
9749 attacks.  This is done by adding a guard variable to functions with
9750 vulnerable objects.  This includes functions that call @code{alloca}, and
9751 functions with buffers larger than 8 bytes.  The guards are initialized
9752 when a function is entered and then checked when the function exits.
9753 If a guard check fails, an error message is printed and the program exits.
9755 @item -fstack-protector-all
9756 @opindex fstack-protector-all
9757 Like @option{-fstack-protector} except that all functions are protected.
9759 @item -fstack-protector-strong
9760 @opindex fstack-protector-strong
9761 Like @option{-fstack-protector} but includes additional functions to
9762 be protected --- those that have local array definitions, or have
9763 references to local frame addresses.
9765 @item -fsection-anchors
9766 @opindex fsection-anchors
9767 Try to reduce the number of symbolic address calculations by using
9768 shared ``anchor'' symbols to address nearby objects.  This transformation
9769 can help to reduce the number of GOT entries and GOT accesses on some
9770 targets.
9772 For example, the implementation of the following function @code{foo}:
9774 @smallexample
9775 static int a, b, c;
9776 int foo (void) @{ return a + b + c; @}
9777 @end smallexample
9779 @noindent
9780 usually calculates the addresses of all three variables, but if you
9781 compile it with @option{-fsection-anchors}, it accesses the variables
9782 from a common anchor point instead.  The effect is similar to the
9783 following pseudocode (which isn't valid C):
9785 @smallexample
9786 int foo (void)
9788   register int *xr = &x;
9789   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9791 @end smallexample
9793 Not all targets support this option.
9795 @item --param @var{name}=@var{value}
9796 @opindex param
9797 In some places, GCC uses various constants to control the amount of
9798 optimization that is done.  For example, GCC does not inline functions
9799 that contain more than a certain number of instructions.  You can
9800 control some of these constants on the command line using the
9801 @option{--param} option.
9803 The names of specific parameters, and the meaning of the values, are
9804 tied to the internals of the compiler, and are subject to change
9805 without notice in future releases.
9807 In each case, the @var{value} is an integer.  The allowable choices for
9808 @var{name} are:
9810 @table @gcctabopt
9811 @item predictable-branch-outcome
9812 When branch is predicted to be taken with probability lower than this threshold
9813 (in percent), then it is considered well predictable. The default is 10.
9815 @item max-crossjump-edges
9816 The maximum number of incoming edges to consider for cross-jumping.
9817 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9818 the number of edges incoming to each block.  Increasing values mean
9819 more aggressive optimization, making the compilation time increase with
9820 probably small improvement in executable size.
9822 @item min-crossjump-insns
9823 The minimum number of instructions that must be matched at the end
9824 of two blocks before cross-jumping is performed on them.  This
9825 value is ignored in the case where all instructions in the block being
9826 cross-jumped from are matched.  The default value is 5.
9828 @item max-grow-copy-bb-insns
9829 The maximum code size expansion factor when copying basic blocks
9830 instead of jumping.  The expansion is relative to a jump instruction.
9831 The default value is 8.
9833 @item max-goto-duplication-insns
9834 The maximum number of instructions to duplicate to a block that jumps
9835 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9836 passes, GCC factors computed gotos early in the compilation process,
9837 and unfactors them as late as possible.  Only computed jumps at the
9838 end of a basic blocks with no more than max-goto-duplication-insns are
9839 unfactored.  The default value is 8.
9841 @item max-delay-slot-insn-search
9842 The maximum number of instructions to consider when looking for an
9843 instruction to fill a delay slot.  If more than this arbitrary number of
9844 instructions are searched, the time savings from filling the delay slot
9845 are minimal, so stop searching.  Increasing values mean more
9846 aggressive optimization, making the compilation time increase with probably
9847 small improvement in execution time.
9849 @item max-delay-slot-live-search
9850 When trying to fill delay slots, the maximum number of instructions to
9851 consider when searching for a block with valid live register
9852 information.  Increasing this arbitrarily chosen value means more
9853 aggressive optimization, increasing the compilation time.  This parameter
9854 should be removed when the delay slot code is rewritten to maintain the
9855 control-flow graph.
9857 @item max-gcse-memory
9858 The approximate maximum amount of memory that can be allocated in
9859 order to perform the global common subexpression elimination
9860 optimization.  If more memory than specified is required, the
9861 optimization is not done.
9863 @item max-gcse-insertion-ratio
9864 If the ratio of expression insertions to deletions is larger than this value
9865 for any expression, then RTL PRE inserts or removes the expression and thus
9866 leaves partially redundant computations in the instruction stream.  The default value is 20.
9868 @item max-pending-list-length
9869 The maximum number of pending dependencies scheduling allows
9870 before flushing the current state and starting over.  Large functions
9871 with few branches or calls can create excessively large lists which
9872 needlessly consume memory and resources.
9874 @item max-modulo-backtrack-attempts
9875 The maximum number of backtrack attempts the scheduler should make
9876 when modulo scheduling a loop.  Larger values can exponentially increase
9877 compilation time.
9879 @item max-inline-insns-single
9880 Several parameters control the tree inliner used in GCC@.
9881 This number sets the maximum number of instructions (counted in GCC's
9882 internal representation) in a single function that the tree inliner
9883 considers for inlining.  This only affects functions declared
9884 inline and methods implemented in a class declaration (C++).
9885 The default value is 400.
9887 @item max-inline-insns-auto
9888 When you use @option{-finline-functions} (included in @option{-O3}),
9889 a lot of functions that would otherwise not be considered for inlining
9890 by the compiler are investigated.  To those functions, a different
9891 (more restrictive) limit compared to functions declared inline can
9892 be applied.
9893 The default value is 40.
9895 @item inline-min-speedup
9896 When estimated performance improvement of caller + callee runtime exceeds this
9897 threshold (in precent), the function can be inlined regardless the limit on
9898 @option{--param max-inline-insns-single} and @option{--param
9899 max-inline-insns-auto}.
9901 @item large-function-insns
9902 The limit specifying really large functions.  For functions larger than this
9903 limit after inlining, inlining is constrained by
9904 @option{--param large-function-growth}.  This parameter is useful primarily
9905 to avoid extreme compilation time caused by non-linear algorithms used by the
9906 back end.
9907 The default value is 2700.
9909 @item large-function-growth
9910 Specifies maximal growth of large function caused by inlining in percents.
9911 The default value is 100 which limits large function growth to 2.0 times
9912 the original size.
9914 @item large-unit-insns
9915 The limit specifying large translation unit.  Growth caused by inlining of
9916 units larger than this limit is limited by @option{--param inline-unit-growth}.
9917 For small units this might be too tight.
9918 For example, consider a unit consisting of function A
9919 that is inline and B that just calls A three times.  If B is small relative to
9920 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9921 large units consisting of small inlineable functions, however, the overall unit
9922 growth limit is needed to avoid exponential explosion of code size.  Thus for
9923 smaller units, the size is increased to @option{--param large-unit-insns}
9924 before applying @option{--param inline-unit-growth}.  The default is 10000.
9926 @item inline-unit-growth
9927 Specifies maximal overall growth of the compilation unit caused by inlining.
9928 The default value is 30 which limits unit growth to 1.3 times the original
9929 size. Cold functions (either marked cold via an attribute or by profile
9930 feedback) are not accounted into the unit size.
9932 @item ipcp-unit-growth
9933 Specifies maximal overall growth of the compilation unit caused by
9934 interprocedural constant propagation.  The default value is 10 which limits
9935 unit growth to 1.1 times the original size.
9937 @item large-stack-frame
9938 The limit specifying large stack frames.  While inlining the algorithm is trying
9939 to not grow past this limit too much.  The default value is 256 bytes.
9941 @item large-stack-frame-growth
9942 Specifies maximal growth of large stack frames caused by inlining in percents.
9943 The default value is 1000 which limits large stack frame growth to 11 times
9944 the original size.
9946 @item max-inline-insns-recursive
9947 @itemx max-inline-insns-recursive-auto
9948 Specifies the maximum number of instructions an out-of-line copy of a
9949 self-recursive inline
9950 function can grow into by performing recursive inlining.
9952 For functions declared inline, @option{--param max-inline-insns-recursive} is
9953 taken into account.  For functions not declared inline, recursive inlining
9954 happens only when @option{-finline-functions} (included in @option{-O3}) is
9955 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9956 default value is 450.
9958 @item max-inline-recursive-depth
9959 @itemx max-inline-recursive-depth-auto
9960 Specifies the maximum recursion depth used for recursive inlining.
9962 For functions declared inline, @option{--param max-inline-recursive-depth} is
9963 taken into account.  For functions not declared inline, recursive inlining
9964 happens only when @option{-finline-functions} (included in @option{-O3}) is
9965 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9966 default value is 8.
9968 @item min-inline-recursive-probability
9969 Recursive inlining is profitable only for function having deep recursion
9970 in average and can hurt for function having little recursion depth by
9971 increasing the prologue size or complexity of function body to other
9972 optimizers.
9974 When profile feedback is available (see @option{-fprofile-generate}) the actual
9975 recursion depth can be guessed from probability that function recurses via a
9976 given call expression.  This parameter limits inlining only to call expressions
9977 whose probability exceeds the given threshold (in percents).
9978 The default value is 10.
9980 @item early-inlining-insns
9981 Specify growth that the early inliner can make.  In effect it increases
9982 the amount of inlining for code having a large abstraction penalty.
9983 The default value is 10.
9985 @item max-early-inliner-iterations
9986 @itemx max-early-inliner-iterations
9987 Limit of iterations of the early inliner.  This basically bounds
9988 the number of nested indirect calls the early inliner can resolve.
9989 Deeper chains are still handled by late inlining.
9991 @item comdat-sharing-probability
9992 @itemx comdat-sharing-probability
9993 Probability (in percent) that C++ inline function with comdat visibility
9994 are shared across multiple compilation units.  The default value is 20.
9996 @item profile-func-internal-id
9997 @itemx profile-func-internal-id
9998 A parameter to control whether to use function internal id in profile
9999 database lookup. If the value is 0, the compiler will use id that
10000 is based on function assembler name and filename, which makes old profile
10001 data more tolerant to source changes such as function reordering etc.
10002 The default value is 0.
10004 @item min-vect-loop-bound
10005 The minimum number of iterations under which loops are not vectorized
10006 when @option{-ftree-vectorize} is used.  The number of iterations after
10007 vectorization needs to be greater than the value specified by this option
10008 to allow vectorization.  The default value is 0.
10010 @item gcse-cost-distance-ratio
10011 Scaling factor in calculation of maximum distance an expression
10012 can be moved by GCSE optimizations.  This is currently supported only in the
10013 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
10014 is with simple expressions, i.e., the expressions that have cost
10015 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
10016 hoisting of simple expressions.  The default value is 10.
10018 @item gcse-unrestricted-cost
10019 Cost, roughly measured as the cost of a single typical machine
10020 instruction, at which GCSE optimizations do not constrain
10021 the distance an expression can travel.  This is currently
10022 supported only in the code hoisting pass.  The lesser the cost,
10023 the more aggressive code hoisting is.  Specifying 0 
10024 allows all expressions to travel unrestricted distances.
10025 The default value is 3.
10027 @item max-hoist-depth
10028 The depth of search in the dominator tree for expressions to hoist.
10029 This is used to avoid quadratic behavior in hoisting algorithm.
10030 The value of 0 does not limit on the search, but may slow down compilation
10031 of huge functions.  The default value is 30.
10033 @item max-tail-merge-comparisons
10034 The maximum amount of similar bbs to compare a bb with.  This is used to
10035 avoid quadratic behavior in tree tail merging.  The default value is 10.
10037 @item max-tail-merge-iterations
10038 The maximum amount of iterations of the pass over the function.  This is used to
10039 limit compilation time in tree tail merging.  The default value is 2.
10041 @item max-unrolled-insns
10042 The maximum number of instructions that a loop may have to be unrolled.
10043 If a loop is unrolled, this parameter also determines how many times
10044 the loop code is unrolled.
10046 @item max-average-unrolled-insns
10047 The maximum number of instructions biased by probabilities of their execution
10048 that a loop may have to be unrolled.  If a loop is unrolled,
10049 this parameter also determines how many times the loop code is unrolled.
10051 @item max-unroll-times
10052 The maximum number of unrollings of a single loop.
10054 @item max-peeled-insns
10055 The maximum number of instructions that a loop may have to be peeled.
10056 If a loop is peeled, this parameter also determines how many times
10057 the loop code is peeled.
10059 @item max-peel-times
10060 The maximum number of peelings of a single loop.
10062 @item max-peel-branches
10063 The maximum number of branches on the hot path through the peeled sequence.
10065 @item max-completely-peeled-insns
10066 The maximum number of insns of a completely peeled loop.
10068 @item max-completely-peel-times
10069 The maximum number of iterations of a loop to be suitable for complete peeling.
10071 @item max-completely-peel-loop-nest-depth
10072 The maximum depth of a loop nest suitable for complete peeling.
10074 @item max-unswitch-insns
10075 The maximum number of insns of an unswitched loop.
10077 @item max-unswitch-level
10078 The maximum number of branches unswitched in a single loop.
10080 @item lim-expensive
10081 The minimum cost of an expensive expression in the loop invariant motion.
10083 @item iv-consider-all-candidates-bound
10084 Bound on number of candidates for induction variables, below which
10085 all candidates are considered for each use in induction variable
10086 optimizations.  If there are more candidates than this,
10087 only the most relevant ones are considered to avoid quadratic time complexity.
10089 @item iv-max-considered-uses
10090 The induction variable optimizations give up on loops that contain more
10091 induction variable uses.
10093 @item iv-always-prune-cand-set-bound
10094 If the number of candidates in the set is smaller than this value,
10095 always try to remove unnecessary ivs from the set
10096 when adding a new one.
10098 @item scev-max-expr-size
10099 Bound on size of expressions used in the scalar evolutions analyzer.
10100 Large expressions slow the analyzer.
10102 @item scev-max-expr-complexity
10103 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10104 Complex expressions slow the analyzer.
10106 @item omega-max-vars
10107 The maximum number of variables in an Omega constraint system.
10108 The default value is 128.
10110 @item omega-max-geqs
10111 The maximum number of inequalities in an Omega constraint system.
10112 The default value is 256.
10114 @item omega-max-eqs
10115 The maximum number of equalities in an Omega constraint system.
10116 The default value is 128.
10118 @item omega-max-wild-cards
10119 The maximum number of wildcard variables that the Omega solver is
10120 able to insert.  The default value is 18.
10122 @item omega-hash-table-size
10123 The size of the hash table in the Omega solver.  The default value is
10124 550.
10126 @item omega-max-keys
10127 The maximal number of keys used by the Omega solver.  The default
10128 value is 500.
10130 @item omega-eliminate-redundant-constraints
10131 When set to 1, use expensive methods to eliminate all redundant
10132 constraints.  The default value is 0.
10134 @item vect-max-version-for-alignment-checks
10135 The maximum number of run-time checks that can be performed when
10136 doing loop versioning for alignment in the vectorizer.
10138 @item vect-max-version-for-alias-checks
10139 The maximum number of run-time checks that can be performed when
10140 doing loop versioning for alias in the vectorizer.
10142 @item vect-max-peeling-for-alignment
10143 The maximum number of loop peels to enhance access alignment
10144 for vectorizer. Value -1 means 'no limit'.
10146 @item max-iterations-to-track
10147 The maximum number of iterations of a loop the brute-force algorithm
10148 for analysis of the number of iterations of the loop tries to evaluate.
10150 @item hot-bb-count-ws-permille
10151 A basic block profile count is considered hot if it contributes to 
10152 the given permillage (i.e. 0...1000) of the entire profiled execution.
10154 @item hot-bb-frequency-fraction
10155 Select fraction of the entry block frequency of executions of basic block in
10156 function given basic block needs to have to be considered hot.
10158 @item max-predicted-iterations
10159 The maximum number of loop iterations we predict statically.  This is useful
10160 in cases where a function contains a single loop with known bound and
10161 another loop with unknown bound.
10162 The known number of iterations is predicted correctly, while
10163 the unknown number of iterations average to roughly 10.  This means that the
10164 loop without bounds appears artificially cold relative to the other one.
10166 @item builtin-expect-probability
10167 Control the probability of the expression having the specified value. This
10168 parameter takes a percentage (i.e. 0 ... 100) as input.
10169 The default probability of 90 is obtained empirically.
10171 @item align-threshold
10173 Select fraction of the maximal frequency of executions of a basic block in
10174 a function to align the basic block.
10176 @item align-loop-iterations
10178 A loop expected to iterate at least the selected number of iterations is
10179 aligned.
10181 @item tracer-dynamic-coverage
10182 @itemx tracer-dynamic-coverage-feedback
10184 This value is used to limit superblock formation once the given percentage of
10185 executed instructions is covered.  This limits unnecessary code size
10186 expansion.
10188 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10189 feedback is available.  The real profiles (as opposed to statically estimated
10190 ones) are much less balanced allowing the threshold to be larger value.
10192 @item tracer-max-code-growth
10193 Stop tail duplication once code growth has reached given percentage.  This is
10194 a rather artificial limit, as most of the duplicates are eliminated later in
10195 cross jumping, so it may be set to much higher values than is the desired code
10196 growth.
10198 @item tracer-min-branch-ratio
10200 Stop reverse growth when the reverse probability of best edge is less than this
10201 threshold (in percent).
10203 @item tracer-min-branch-ratio
10204 @itemx tracer-min-branch-ratio-feedback
10206 Stop forward growth if the best edge has probability lower than this
10207 threshold.
10209 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10210 compilation for profile feedback and one for compilation without.  The value
10211 for compilation with profile feedback needs to be more conservative (higher) in
10212 order to make tracer effective.
10214 @item max-cse-path-length
10216 The maximum number of basic blocks on path that CSE considers.
10217 The default is 10.
10219 @item max-cse-insns
10220 The maximum number of instructions CSE processes before flushing.
10221 The default is 1000.
10223 @item ggc-min-expand
10225 GCC uses a garbage collector to manage its own memory allocation.  This
10226 parameter specifies the minimum percentage by which the garbage
10227 collector's heap should be allowed to expand between collections.
10228 Tuning this may improve compilation speed; it has no effect on code
10229 generation.
10231 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10232 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10233 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10234 GCC is not able to calculate RAM on a particular platform, the lower
10235 bound of 30% is used.  Setting this parameter and
10236 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10237 every opportunity.  This is extremely slow, but can be useful for
10238 debugging.
10240 @item ggc-min-heapsize
10242 Minimum size of the garbage collector's heap before it begins bothering
10243 to collect garbage.  The first collection occurs after the heap expands
10244 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10245 tuning this may improve compilation speed, and has no effect on code
10246 generation.
10248 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10249 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10250 with a lower bound of 4096 (four megabytes) and an upper bound of
10251 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10252 particular platform, the lower bound is used.  Setting this parameter
10253 very large effectively disables garbage collection.  Setting this
10254 parameter and @option{ggc-min-expand} to zero causes a full collection
10255 to occur at every opportunity.
10257 @item max-reload-search-insns
10258 The maximum number of instruction reload should look backward for equivalent
10259 register.  Increasing values mean more aggressive optimization, making the
10260 compilation time increase with probably slightly better performance.
10261 The default value is 100.
10263 @item max-cselib-memory-locations
10264 The maximum number of memory locations cselib should take into account.
10265 Increasing values mean more aggressive optimization, making the compilation time
10266 increase with probably slightly better performance.  The default value is 500.
10268 @item reorder-blocks-duplicate
10269 @itemx reorder-blocks-duplicate-feedback
10271 Used by the basic block reordering pass to decide whether to use unconditional
10272 branch or duplicate the code on its destination.  Code is duplicated when its
10273 estimated size is smaller than this value multiplied by the estimated size of
10274 unconditional jump in the hot spots of the program.
10276 The @option{reorder-block-duplicate-feedback} is used only when profile
10277 feedback is available.  It may be set to higher values than
10278 @option{reorder-block-duplicate} since information about the hot spots is more
10279 accurate.
10281 @item max-sched-ready-insns
10282 The maximum number of instructions ready to be issued the scheduler should
10283 consider at any given time during the first scheduling pass.  Increasing
10284 values mean more thorough searches, making the compilation time increase
10285 with probably little benefit.  The default value is 100.
10287 @item max-sched-region-blocks
10288 The maximum number of blocks in a region to be considered for
10289 interblock scheduling.  The default value is 10.
10291 @item max-pipeline-region-blocks
10292 The maximum number of blocks in a region to be considered for
10293 pipelining in the selective scheduler.  The default value is 15.
10295 @item max-sched-region-insns
10296 The maximum number of insns in a region to be considered for
10297 interblock scheduling.  The default value is 100.
10299 @item max-pipeline-region-insns
10300 The maximum number of insns in a region to be considered for
10301 pipelining in the selective scheduler.  The default value is 200.
10303 @item min-spec-prob
10304 The minimum probability (in percents) of reaching a source block
10305 for interblock speculative scheduling.  The default value is 40.
10307 @item max-sched-extend-regions-iters
10308 The maximum number of iterations through CFG to extend regions.
10309 A value of 0 (the default) disables region extensions.
10311 @item max-sched-insn-conflict-delay
10312 The maximum conflict delay for an insn to be considered for speculative motion.
10313 The default value is 3.
10315 @item sched-spec-prob-cutoff
10316 The minimal probability of speculation success (in percents), so that
10317 speculative insns are scheduled.
10318 The default value is 40.
10320 @item sched-spec-state-edge-prob-cutoff
10321 The minimum probability an edge must have for the scheduler to save its
10322 state across it.
10323 The default value is 10.
10325 @item sched-mem-true-dep-cost
10326 Minimal distance (in CPU cycles) between store and load targeting same
10327 memory locations.  The default value is 1.
10329 @item selsched-max-lookahead
10330 The maximum size of the lookahead window of selective scheduling.  It is a
10331 depth of search for available instructions.
10332 The default value is 50.
10334 @item selsched-max-sched-times
10335 The maximum number of times that an instruction is scheduled during
10336 selective scheduling.  This is the limit on the number of iterations
10337 through which the instruction may be pipelined.  The default value is 2.
10339 @item selsched-max-insns-to-rename
10340 The maximum number of best instructions in the ready list that are considered
10341 for renaming in the selective scheduler.  The default value is 2.
10343 @item sms-min-sc
10344 The minimum value of stage count that swing modulo scheduler
10345 generates.  The default value is 2.
10347 @item max-last-value-rtl
10348 The maximum size measured as number of RTLs that can be recorded in an expression
10349 in combiner for a pseudo register as last known value of that register.  The default
10350 is 10000.
10352 @item max-combine-insns
10353 The maximum number of instructions the RTL combiner tries to combine.
10354 The default value is 2 at @option{-Og} and 4 otherwise.
10356 @item integer-share-limit
10357 Small integer constants can use a shared data structure, reducing the
10358 compiler's memory usage and increasing its speed.  This sets the maximum
10359 value of a shared integer constant.  The default value is 256.
10361 @item ssp-buffer-size
10362 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10363 protection when @option{-fstack-protection} is used.
10365 @item min-size-for-stack-sharing
10366 The minimum size of variables taking part in stack slot sharing when not
10367 optimizing. The default value is 32.
10369 @item max-jump-thread-duplication-stmts
10370 Maximum number of statements allowed in a block that needs to be
10371 duplicated when threading jumps.
10373 @item max-fields-for-field-sensitive
10374 Maximum number of fields in a structure treated in
10375 a field sensitive manner during pointer analysis.  The default is zero
10376 for @option{-O0} and @option{-O1},
10377 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10379 @item prefetch-latency
10380 Estimate on average number of instructions that are executed before
10381 prefetch finishes.  The distance prefetched ahead is proportional
10382 to this constant.  Increasing this number may also lead to less
10383 streams being prefetched (see @option{simultaneous-prefetches}).
10385 @item simultaneous-prefetches
10386 Maximum number of prefetches that can run at the same time.
10388 @item l1-cache-line-size
10389 The size of cache line in L1 cache, in bytes.
10391 @item l1-cache-size
10392 The size of L1 cache, in kilobytes.
10394 @item l2-cache-size
10395 The size of L2 cache, in kilobytes.
10397 @item min-insn-to-prefetch-ratio
10398 The minimum ratio between the number of instructions and the
10399 number of prefetches to enable prefetching in a loop.
10401 @item prefetch-min-insn-to-mem-ratio
10402 The minimum ratio between the number of instructions and the
10403 number of memory references to enable prefetching in a loop.
10405 @item use-canonical-types
10406 Whether the compiler should use the ``canonical'' type system.  By
10407 default, this should always be 1, which uses a more efficient internal
10408 mechanism for comparing types in C++ and Objective-C++.  However, if
10409 bugs in the canonical type system are causing compilation failures,
10410 set this value to 0 to disable canonical types.
10412 @item switch-conversion-max-branch-ratio
10413 Switch initialization conversion refuses to create arrays that are
10414 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10415 branches in the switch.
10417 @item max-partial-antic-length
10418 Maximum length of the partial antic set computed during the tree
10419 partial redundancy elimination optimization (@option{-ftree-pre}) when
10420 optimizing at @option{-O3} and above.  For some sorts of source code
10421 the enhanced partial redundancy elimination optimization can run away,
10422 consuming all of the memory available on the host machine.  This
10423 parameter sets a limit on the length of the sets that are computed,
10424 which prevents the runaway behavior.  Setting a value of 0 for
10425 this parameter allows an unlimited set length.
10427 @item sccvn-max-scc-size
10428 Maximum size of a strongly connected component (SCC) during SCCVN
10429 processing.  If this limit is hit, SCCVN processing for the whole
10430 function is not done and optimizations depending on it are
10431 disabled.  The default maximum SCC size is 10000.
10433 @item sccvn-max-alias-queries-per-access
10434 Maximum number of alias-oracle queries we perform when looking for
10435 redundancies for loads and stores.  If this limit is hit the search
10436 is aborted and the load or store is not considered redundant.  The
10437 number of queries is algorithmically limited to the number of
10438 stores on all paths from the load to the function entry.
10439 The default maxmimum number of queries is 1000.
10441 @item ira-max-loops-num
10442 IRA uses regional register allocation by default.  If a function
10443 contains more loops than the number given by this parameter, only at most
10444 the given number of the most frequently-executed loops form regions
10445 for regional register allocation.  The default value of the
10446 parameter is 100.
10448 @item ira-max-conflict-table-size 
10449 Although IRA uses a sophisticated algorithm to compress the conflict
10450 table, the table can still require excessive amounts of memory for
10451 huge functions.  If the conflict table for a function could be more
10452 than the size in MB given by this parameter, the register allocator
10453 instead uses a faster, simpler, and lower-quality
10454 algorithm that does not require building a pseudo-register conflict table.  
10455 The default value of the parameter is 2000.
10457 @item ira-loop-reserved-regs
10458 IRA can be used to evaluate more accurate register pressure in loops
10459 for decisions to move loop invariants (see @option{-O3}).  The number
10460 of available registers reserved for some other purposes is given
10461 by this parameter.  The default value of the parameter is 2, which is
10462 the minimal number of registers needed by typical instructions.
10463 This value is the best found from numerous experiments.
10465 @item loop-invariant-max-bbs-in-loop
10466 Loop invariant motion can be very expensive, both in compilation time and
10467 in amount of needed compile-time memory, with very large loops.  Loops
10468 with more basic blocks than this parameter won't have loop invariant
10469 motion optimization performed on them.  The default value of the
10470 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10472 @item loop-max-datarefs-for-datadeps
10473 Building data dapendencies is expensive for very large loops.  This
10474 parameter limits the number of data references in loops that are
10475 considered for data dependence analysis.  These large loops are no
10476 handled by the optimizations using loop data dependencies.
10477 The default value is 1000.
10479 @item max-vartrack-size
10480 Sets a maximum number of hash table slots to use during variable
10481 tracking dataflow analysis of any function.  If this limit is exceeded
10482 with variable tracking at assignments enabled, analysis for that
10483 function is retried without it, after removing all debug insns from
10484 the function.  If the limit is exceeded even without debug insns, var
10485 tracking analysis is completely disabled for the function.  Setting
10486 the parameter to zero makes it unlimited.
10488 @item max-vartrack-expr-depth
10489 Sets a maximum number of recursion levels when attempting to map
10490 variable names or debug temporaries to value expressions.  This trades
10491 compilation time for more complete debug information.  If this is set too
10492 low, value expressions that are available and could be represented in
10493 debug information may end up not being used; setting this higher may
10494 enable the compiler to find more complex debug expressions, but compile
10495 time and memory use may grow.  The default is 12.
10497 @item min-nondebug-insn-uid
10498 Use uids starting at this parameter for nondebug insns.  The range below
10499 the parameter is reserved exclusively for debug insns created by
10500 @option{-fvar-tracking-assignments}, but debug insns may get
10501 (non-overlapping) uids above it if the reserved range is exhausted.
10503 @item ipa-sra-ptr-growth-factor
10504 IPA-SRA replaces a pointer to an aggregate with one or more new
10505 parameters only when their cumulative size is less or equal to
10506 @option{ipa-sra-ptr-growth-factor} times the size of the original
10507 pointer parameter.
10509 @item sra-max-scalarization-size-Ospeed
10510 @item sra-max-scalarization-size-Osize
10511 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10512 replace scalar parts of aggregates with uses of independent scalar
10513 variables.  These parameters control the maximum size, in storage units,
10514 of aggregate which will be considered for replacement when compiling for
10515 speed
10516 (@option{sra-max-scalarization-size-Ospeed}) or size
10517 (@option{sra-max-scalarization-size-Osize}) respectively.
10519 @item tm-max-aggregate-size
10520 When making copies of thread-local variables in a transaction, this
10521 parameter specifies the size in bytes after which variables are
10522 saved with the logging functions as opposed to save/restore code
10523 sequence pairs.  This option only applies when using
10524 @option{-fgnu-tm}.
10526 @item graphite-max-nb-scop-params
10527 To avoid exponential effects in the Graphite loop transforms, the
10528 number of parameters in a Static Control Part (SCoP) is bounded.  The
10529 default value is 10 parameters.  A variable whose value is unknown at
10530 compilation time and defined outside a SCoP is a parameter of the SCoP.
10532 @item graphite-max-bbs-per-function
10533 To avoid exponential effects in the detection of SCoPs, the size of
10534 the functions analyzed by Graphite is bounded.  The default value is
10535 100 basic blocks.
10537 @item loop-block-tile-size
10538 Loop blocking or strip mining transforms, enabled with
10539 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10540 loop in the loop nest by a given number of iterations.  The strip
10541 length can be changed using the @option{loop-block-tile-size}
10542 parameter.  The default value is 51 iterations.
10544 @item loop-unroll-jam-size
10545 Specify the unroll factor for the @option{-floop-unroll-and-jam}.  The 
10546 default value is 4.
10548 @item loop-unroll-jam-depth
10549 Specify the dimension to be unrolled (counting from the most inner loop)
10550 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10552 @item ipa-cp-value-list-size
10553 IPA-CP attempts to track all possible values and types passed to a function's
10554 parameter in order to propagate them and perform devirtualization.
10555 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10556 stores per one formal parameter of a function.
10558 @item ipa-cp-eval-threshold
10559 IPA-CP calculates its own score of cloning profitability heuristics
10560 and performs those cloning opportunities with scores that exceed
10561 @option{ipa-cp-eval-threshold}.
10563 @item ipa-max-agg-items
10564 IPA-CP is also capable to propagate a number of scalar values passed
10565 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10566 number of such values per one parameter.
10568 @item ipa-cp-loop-hint-bonus
10569 When IPA-CP determines that a cloning candidate would make the number
10570 of iterations of a loop known, it adds a bonus of
10571 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10572 the candidate.
10574 @item ipa-cp-array-index-hint-bonus
10575 When IPA-CP determines that a cloning candidate would make the index of
10576 an array access known, it adds a bonus of
10577 @option{ipa-cp-array-index-hint-bonus} to the profitability
10578 score of the candidate.
10580 @item ipa-max-aa-steps
10581 During its analysis of function bodies, IPA-CP employs alias analysis
10582 in order to track values pointed to by function parameters.  In order
10583 not spend too much time analyzing huge functions, it will give up and
10584 consider all memory clobbered after examining
10585 @option{ipa-max-aa-steps} statements modifying memory.
10587 @item lto-partitions
10588 Specify desired number of partitions produced during WHOPR compilation.
10589 The number of partitions should exceed the number of CPUs used for compilation.
10590 The default value is 32.
10592 @item lto-minpartition
10593 Size of minimal partition for WHOPR (in estimated instructions).
10594 This prevents expenses of splitting very small programs into too many
10595 partitions.
10597 @item cxx-max-namespaces-for-diagnostic-help
10598 The maximum number of namespaces to consult for suggestions when C++
10599 name lookup fails for an identifier.  The default is 1000.
10601 @item sink-frequency-threshold
10602 The maximum relative execution frequency (in percents) of the target block
10603 relative to a statement's original block to allow statement sinking of a
10604 statement.  Larger numbers result in more aggressive statement sinking.
10605 The default value is 75.  A small positive adjustment is applied for
10606 statements with memory operands as those are even more profitable so sink.
10608 @item max-stores-to-sink
10609 The maximum number of conditional stores paires that can be sunk.  Set to 0
10610 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10611 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10613 @item allow-store-data-races
10614 Allow optimizers to introduce new data races on stores.
10615 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10616 at optimization level @option{-Ofast}.
10618 @item case-values-threshold
10619 The smallest number of different values for which it is best to use a
10620 jump-table instead of a tree of conditional branches.  If the value is
10621 0, use the default for the machine.  The default is 0.
10623 @item tree-reassoc-width
10624 Set the maximum number of instructions executed in parallel in
10625 reassociated tree. This parameter overrides target dependent
10626 heuristics used by default if has non zero value.
10628 @item sched-pressure-algorithm
10629 Choose between the two available implementations of
10630 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10631 and is the more likely to prevent instructions from being reordered.
10632 Algorithm 2 was designed to be a compromise between the relatively
10633 conservative approach taken by algorithm 1 and the rather aggressive
10634 approach taken by the default scheduler.  It relies more heavily on
10635 having a regular register file and accurate register pressure classes.
10636 See @file{haifa-sched.c} in the GCC sources for more details.
10638 The default choice depends on the target.
10640 @item max-slsr-cand-scan
10641 Set the maximum number of existing candidates that will be considered when
10642 seeking a basis for a new straight-line strength reduction candidate.
10644 @item asan-globals
10645 Enable buffer overflow detection for global objects.  This kind
10646 of protection is enabled by default if you are using
10647 @option{-fsanitize=address} option.
10648 To disable global objects protection use @option{--param asan-globals=0}.
10650 @item asan-stack
10651 Enable buffer overflow detection for stack objects.  This kind of
10652 protection is enabled by default when using@option{-fsanitize=address}.
10653 To disable stack protection use @option{--param asan-stack=0} option.
10655 @item asan-instrument-reads
10656 Enable buffer overflow detection for memory reads.  This kind of
10657 protection is enabled by default when using @option{-fsanitize=address}.
10658 To disable memory reads protection use
10659 @option{--param asan-instrument-reads=0}.
10661 @item asan-instrument-writes
10662 Enable buffer overflow detection for memory writes.  This kind of
10663 protection is enabled by default when using @option{-fsanitize=address}.
10664 To disable memory writes protection use
10665 @option{--param asan-instrument-writes=0} option.
10667 @item asan-memintrin
10668 Enable detection for built-in functions.  This kind of protection
10669 is enabled by default when using @option{-fsanitize=address}.
10670 To disable built-in functions protection use
10671 @option{--param asan-memintrin=0}.
10673 @item asan-use-after-return
10674 Enable detection of use-after-return.  This kind of protection
10675 is enabled by default when using @option{-fsanitize=address} option.
10676 To disable use-after-return detection use 
10677 @option{--param asan-use-after-return=0}.
10679 @item asan-instrumentation-with-call-threshold
10680 If number of memory accesses in function being instrumented
10681 is greater or equal to this number, use callbacks instead of inline checks.
10682 E.g. to disable inline code use
10683 @option{--param asan-instrumentation-with-call-threshold=0}.
10685 @item chkp-max-ctor-size
10686 Static constructors generated by Pointer Bounds Checker may become very
10687 large and significantly increase compile time at optimization level
10688 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10689 in a single generated constructor.  Default value is 5000.
10691 @item max-fsm-thread-path-insns
10692 Maximum number of instructions to copy when duplicating blocks on a
10693 finite state automaton jump thread path.  The default is 100.
10695 @item max-fsm-thread-length
10696 Maximum number of basic blocks on a finite state automaton jump thread
10697 path.  The default is 10.
10699 @item max-fsm-thread-paths
10700 Maximum number of new jump thread paths to create for a finite state
10701 automaton.  The default is 50.
10703 @end table
10704 @end table
10706 @node Preprocessor Options
10707 @section Options Controlling the Preprocessor
10708 @cindex preprocessor options
10709 @cindex options, preprocessor
10711 These options control the C preprocessor, which is run on each C source
10712 file before actual compilation.
10714 If you use the @option{-E} option, nothing is done except preprocessing.
10715 Some of these options make sense only together with @option{-E} because
10716 they cause the preprocessor output to be unsuitable for actual
10717 compilation.
10719 @table @gcctabopt
10720 @item -Wp,@var{option}
10721 @opindex Wp
10722 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10723 and pass @var{option} directly through to the preprocessor.  If
10724 @var{option} contains commas, it is split into multiple options at the
10725 commas.  However, many options are modified, translated or interpreted
10726 by the compiler driver before being passed to the preprocessor, and
10727 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10728 interface is undocumented and subject to change, so whenever possible
10729 you should avoid using @option{-Wp} and let the driver handle the
10730 options instead.
10732 @item -Xpreprocessor @var{option}
10733 @opindex Xpreprocessor
10734 Pass @var{option} as an option to the preprocessor.  You can use this to
10735 supply system-specific preprocessor options that GCC does not 
10736 recognize.
10738 If you want to pass an option that takes an argument, you must use
10739 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10741 @item -no-integrated-cpp
10742 @opindex no-integrated-cpp
10743 Perform preprocessing as a separate pass before compilation.
10744 By default, GCC performs preprocessing as an integrated part of
10745 input tokenization and parsing.
10746 If this option is provided, the appropriate language front end
10747 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10748 and Objective-C, respectively) is instead invoked twice,
10749 once for preprocessing only and once for actual compilation
10750 of the preprocessed input.
10751 This option may be useful in conjunction with the @option{-B} or
10752 @option{-wrapper} options to specify an alternate preprocessor or
10753 perform additional processing of the program source between
10754 normal preprocessing and compilation.
10755 @end table
10757 @include cppopts.texi
10759 @node Assembler Options
10760 @section Passing Options to the Assembler
10762 @c prevent bad page break with this line
10763 You can pass options to the assembler.
10765 @table @gcctabopt
10766 @item -Wa,@var{option}
10767 @opindex Wa
10768 Pass @var{option} as an option to the assembler.  If @var{option}
10769 contains commas, it is split into multiple options at the commas.
10771 @item -Xassembler @var{option}
10772 @opindex Xassembler
10773 Pass @var{option} as an option to the assembler.  You can use this to
10774 supply system-specific assembler options that GCC does not
10775 recognize.
10777 If you want to pass an option that takes an argument, you must use
10778 @option{-Xassembler} twice, once for the option and once for the argument.
10780 @end table
10782 @node Link Options
10783 @section Options for Linking
10784 @cindex link options
10785 @cindex options, linking
10787 These options come into play when the compiler links object files into
10788 an executable output file.  They are meaningless if the compiler is
10789 not doing a link step.
10791 @table @gcctabopt
10792 @cindex file names
10793 @item @var{object-file-name}
10794 A file name that does not end in a special recognized suffix is
10795 considered to name an object file or library.  (Object files are
10796 distinguished from libraries by the linker according to the file
10797 contents.)  If linking is done, these object files are used as input
10798 to the linker.
10800 @item -c
10801 @itemx -S
10802 @itemx -E
10803 @opindex c
10804 @opindex S
10805 @opindex E
10806 If any of these options is used, then the linker is not run, and
10807 object file names should not be used as arguments.  @xref{Overall
10808 Options}.
10810 @cindex Libraries
10811 @item -l@var{library}
10812 @itemx -l @var{library}
10813 @opindex l
10814 Search the library named @var{library} when linking.  (The second
10815 alternative with the library as a separate argument is only for
10816 POSIX compliance and is not recommended.)
10818 It makes a difference where in the command you write this option; the
10819 linker searches and processes libraries and object files in the order they
10820 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10821 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10822 to functions in @samp{z}, those functions may not be loaded.
10824 The linker searches a standard list of directories for the library,
10825 which is actually a file named @file{lib@var{library}.a}.  The linker
10826 then uses this file as if it had been specified precisely by name.
10828 The directories searched include several standard system directories
10829 plus any that you specify with @option{-L}.
10831 Normally the files found this way are library files---archive files
10832 whose members are object files.  The linker handles an archive file by
10833 scanning through it for members which define symbols that have so far
10834 been referenced but not defined.  But if the file that is found is an
10835 ordinary object file, it is linked in the usual fashion.  The only
10836 difference between using an @option{-l} option and specifying a file name
10837 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10838 and searches several directories.
10840 @item -lobjc
10841 @opindex lobjc
10842 You need this special case of the @option{-l} option in order to
10843 link an Objective-C or Objective-C++ program.
10845 @item -nostartfiles
10846 @opindex nostartfiles
10847 Do not use the standard system startup files when linking.
10848 The standard system libraries are used normally, unless @option{-nostdlib}
10849 or @option{-nodefaultlibs} is used.
10851 @item -nodefaultlibs
10852 @opindex nodefaultlibs
10853 Do not use the standard system libraries when linking.
10854 Only the libraries you specify are passed to the linker, and options
10855 specifying linkage of the system libraries, such as @code{-static-libgcc}
10856 or @code{-shared-libgcc}, are ignored.  
10857 The standard startup files are used normally, unless @option{-nostartfiles}
10858 is used.  
10860 The compiler may generate calls to @code{memcmp},
10861 @code{memset}, @code{memcpy} and @code{memmove}.
10862 These entries are usually resolved by entries in
10863 libc.  These entry points should be supplied through some other
10864 mechanism when this option is specified.
10866 @item -nostdlib
10867 @opindex nostdlib
10868 Do not use the standard system startup files or libraries when linking.
10869 No startup files and only the libraries you specify are passed to
10870 the linker, and options specifying linkage of the system libraries, such as
10871 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10873 The compiler may generate calls to @code{memcmp}, @code{memset},
10874 @code{memcpy} and @code{memmove}.
10875 These entries are usually resolved by entries in
10876 libc.  These entry points should be supplied through some other
10877 mechanism when this option is specified.
10879 @cindex @option{-lgcc}, use with @option{-nostdlib}
10880 @cindex @option{-nostdlib} and unresolved references
10881 @cindex unresolved references and @option{-nostdlib}
10882 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10883 @cindex @option{-nodefaultlibs} and unresolved references
10884 @cindex unresolved references and @option{-nodefaultlibs}
10885 One of the standard libraries bypassed by @option{-nostdlib} and
10886 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10887 which GCC uses to overcome shortcomings of particular machines, or special
10888 needs for some languages.
10889 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10890 Collection (GCC) Internals},
10891 for more discussion of @file{libgcc.a}.)
10892 In most cases, you need @file{libgcc.a} even when you want to avoid
10893 other standard libraries.  In other words, when you specify @option{-nostdlib}
10894 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10895 This ensures that you have no unresolved references to internal GCC
10896 library subroutines.
10897 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10898 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10899 GNU Compiler Collection (GCC) Internals}.)
10901 @item -pie
10902 @opindex pie
10903 Produce a position independent executable on targets that support it.
10904 For predictable results, you must also specify the same set of options
10905 used for compilation (@option{-fpie}, @option{-fPIE},
10906 or model suboptions) when you specify this linker option.
10908 @item -rdynamic
10909 @opindex rdynamic
10910 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10911 that support it. This instructs the linker to add all symbols, not
10912 only used ones, to the dynamic symbol table. This option is needed
10913 for some uses of @code{dlopen} or to allow obtaining backtraces
10914 from within a program.
10916 @item -s
10917 @opindex s
10918 Remove all symbol table and relocation information from the executable.
10920 @item -static
10921 @opindex static
10922 On systems that support dynamic linking, this prevents linking with the shared
10923 libraries.  On other systems, this option has no effect.
10925 @item -shared
10926 @opindex shared
10927 Produce a shared object which can then be linked with other objects to
10928 form an executable.  Not all systems support this option.  For predictable
10929 results, you must also specify the same set of options used for compilation
10930 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10931 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10932 needs to build supplementary stub code for constructors to work.  On
10933 multi-libbed systems, @samp{gcc -shared} must select the correct support
10934 libraries to link against.  Failing to supply the correct flags may lead
10935 to subtle defects.  Supplying them in cases where they are not necessary
10936 is innocuous.}
10938 @item -shared-libgcc
10939 @itemx -static-libgcc
10940 @opindex shared-libgcc
10941 @opindex static-libgcc
10942 On systems that provide @file{libgcc} as a shared library, these options
10943 force the use of either the shared or static version, respectively.
10944 If no shared version of @file{libgcc} was built when the compiler was
10945 configured, these options have no effect.
10947 There are several situations in which an application should use the
10948 shared @file{libgcc} instead of the static version.  The most common
10949 of these is when the application wishes to throw and catch exceptions
10950 across different shared libraries.  In that case, each of the libraries
10951 as well as the application itself should use the shared @file{libgcc}.
10953 Therefore, the G++ and GCJ drivers automatically add
10954 @option{-shared-libgcc} whenever you build a shared library or a main
10955 executable, because C++ and Java programs typically use exceptions, so
10956 this is the right thing to do.
10958 If, instead, you use the GCC driver to create shared libraries, you may
10959 find that they are not always linked with the shared @file{libgcc}.
10960 If GCC finds, at its configuration time, that you have a non-GNU linker
10961 or a GNU linker that does not support option @option{--eh-frame-hdr},
10962 it links the shared version of @file{libgcc} into shared libraries
10963 by default.  Otherwise, it takes advantage of the linker and optimizes
10964 away the linking with the shared version of @file{libgcc}, linking with
10965 the static version of libgcc by default.  This allows exceptions to
10966 propagate through such shared libraries, without incurring relocation
10967 costs at library load time.
10969 However, if a library or main executable is supposed to throw or catch
10970 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10971 for the languages used in the program, or using the option
10972 @option{-shared-libgcc}, such that it is linked with the shared
10973 @file{libgcc}.
10975 @item -static-libasan
10976 @opindex static-libasan
10977 When the @option{-fsanitize=address} option is used to link a program,
10978 the GCC driver automatically links against @option{libasan}.  If
10979 @file{libasan} is available as a shared library, and the @option{-static}
10980 option is not used, then this links against the shared version of
10981 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10982 driver to link @file{libasan} statically, without necessarily linking
10983 other libraries statically.
10985 @item -static-libtsan
10986 @opindex static-libtsan
10987 When the @option{-fsanitize=thread} option is used to link a program,
10988 the GCC driver automatically links against @option{libtsan}.  If
10989 @file{libtsan} is available as a shared library, and the @option{-static}
10990 option is not used, then this links against the shared version of
10991 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10992 driver to link @file{libtsan} statically, without necessarily linking
10993 other libraries statically.
10995 @item -static-liblsan
10996 @opindex static-liblsan
10997 When the @option{-fsanitize=leak} option is used to link a program,
10998 the GCC driver automatically links against @option{liblsan}.  If
10999 @file{liblsan} is available as a shared library, and the @option{-static}
11000 option is not used, then this links against the shared version of
11001 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
11002 driver to link @file{liblsan} statically, without necessarily linking
11003 other libraries statically.
11005 @item -static-libubsan
11006 @opindex static-libubsan
11007 When the @option{-fsanitize=undefined} option is used to link a program,
11008 the GCC driver automatically links against @option{libubsan}.  If
11009 @file{libubsan} is available as a shared library, and the @option{-static}
11010 option is not used, then this links against the shared version of
11011 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
11012 driver to link @file{libubsan} statically, without necessarily linking
11013 other libraries statically.
11015 @item -static-libstdc++
11016 @opindex static-libstdc++
11017 When the @command{g++} program is used to link a C++ program, it
11018 normally automatically links against @option{libstdc++}.  If
11019 @file{libstdc++} is available as a shared library, and the
11020 @option{-static} option is not used, then this links against the
11021 shared version of @file{libstdc++}.  That is normally fine.  However, it
11022 is sometimes useful to freeze the version of @file{libstdc++} used by
11023 the program without going all the way to a fully static link.  The
11024 @option{-static-libstdc++} option directs the @command{g++} driver to
11025 link @file{libstdc++} statically, without necessarily linking other
11026 libraries statically.
11028 @item -symbolic
11029 @opindex symbolic
11030 Bind references to global symbols when building a shared object.  Warn
11031 about any unresolved references (unless overridden by the link editor
11032 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11033 this option.
11035 @item -T @var{script}
11036 @opindex T
11037 @cindex linker script
11038 Use @var{script} as the linker script.  This option is supported by most
11039 systems using the GNU linker.  On some targets, such as bare-board
11040 targets without an operating system, the @option{-T} option may be required
11041 when linking to avoid references to undefined symbols.
11043 @item -Xlinker @var{option}
11044 @opindex Xlinker
11045 Pass @var{option} as an option to the linker.  You can use this to
11046 supply system-specific linker options that GCC does not recognize.
11048 If you want to pass an option that takes a separate argument, you must use
11049 @option{-Xlinker} twice, once for the option and once for the argument.
11050 For example, to pass @option{-assert definitions}, you must write
11051 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11052 @option{-Xlinker "-assert definitions"}, because this passes the entire
11053 string as a single argument, which is not what the linker expects.
11055 When using the GNU linker, it is usually more convenient to pass
11056 arguments to linker options using the @option{@var{option}=@var{value}}
11057 syntax than as separate arguments.  For example, you can specify
11058 @option{-Xlinker -Map=output.map} rather than
11059 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11060 this syntax for command-line options.
11062 @item -Wl,@var{option}
11063 @opindex Wl
11064 Pass @var{option} as an option to the linker.  If @var{option} contains
11065 commas, it is split into multiple options at the commas.  You can use this
11066 syntax to pass an argument to the option.
11067 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11068 linker.  When using the GNU linker, you can also get the same effect with
11069 @option{-Wl,-Map=output.map}.
11071 @item -u @var{symbol}
11072 @opindex u
11073 Pretend the symbol @var{symbol} is undefined, to force linking of
11074 library modules to define it.  You can use @option{-u} multiple times with
11075 different symbols to force loading of additional library modules.
11077 @item -z @var{keyword}
11078 @opindex z
11079 @option{-z} is passed directly on to the linker along with the keyword
11080 @var{keyword}. See the section in the documentation of your linker for
11081 permitted values and their meanings.
11082 @end table
11084 @node Directory Options
11085 @section Options for Directory Search
11086 @cindex directory options
11087 @cindex options, directory search
11088 @cindex search path
11090 These options specify directories to search for header files, for
11091 libraries and for parts of the compiler:
11093 @table @gcctabopt
11094 @item -I@var{dir}
11095 @opindex I
11096 Add the directory @var{dir} to the head of the list of directories to be
11097 searched for header files.  This can be used to override a system header
11098 file, substituting your own version, since these directories are
11099 searched before the system header file directories.  However, you should
11100 not use this option to add directories that contain vendor-supplied
11101 system header files (use @option{-isystem} for that).  If you use more than
11102 one @option{-I} option, the directories are scanned in left-to-right
11103 order; the standard system directories come after.
11105 If a standard system include directory, or a directory specified with
11106 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11107 option is ignored.  The directory is still searched but as a
11108 system directory at its normal position in the system include chain.
11109 This is to ensure that GCC's procedure to fix buggy system headers and
11110 the ordering for the @code{include_next} directive are not inadvertently changed.
11111 If you really need to change the search order for system directories,
11112 use the @option{-nostdinc} and/or @option{-isystem} options.
11114 @item -iplugindir=@var{dir}
11115 @opindex iplugindir=
11116 Set the directory to search for plugins that are passed
11117 by @option{-fplugin=@var{name}} instead of
11118 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11119 to be used by the user, but only passed by the driver.
11121 @item -iquote@var{dir}
11122 @opindex iquote
11123 Add the directory @var{dir} to the head of the list of directories to
11124 be searched for header files only for the case of @samp{#include
11125 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
11126 otherwise just like @option{-I}.
11128 @item -L@var{dir}
11129 @opindex L
11130 Add directory @var{dir} to the list of directories to be searched
11131 for @option{-l}.
11133 @item -B@var{prefix}
11134 @opindex B
11135 This option specifies where to find the executables, libraries,
11136 include files, and data files of the compiler itself.
11138 The compiler driver program runs one or more of the subprograms
11139 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11140 @var{prefix} as a prefix for each program it tries to run, both with and
11141 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11143 For each subprogram to be run, the compiler driver first tries the
11144 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11145 is not specified, the driver tries two standard prefixes, 
11146 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11147 those results in a file name that is found, the unmodified program
11148 name is searched for using the directories specified in your
11149 @env{PATH} environment variable.
11151 The compiler checks to see if the path provided by the @option{-B}
11152 refers to a directory, and if necessary it adds a directory
11153 separator character at the end of the path.
11155 @option{-B} prefixes that effectively specify directory names also apply
11156 to libraries in the linker, because the compiler translates these
11157 options into @option{-L} options for the linker.  They also apply to
11158 include files in the preprocessor, because the compiler translates these
11159 options into @option{-isystem} options for the preprocessor.  In this case,
11160 the compiler appends @samp{include} to the prefix.
11162 The runtime support file @file{libgcc.a} can also be searched for using
11163 the @option{-B} prefix, if needed.  If it is not found there, the two
11164 standard prefixes above are tried, and that is all.  The file is left
11165 out of the link if it is not found by those means.
11167 Another way to specify a prefix much like the @option{-B} prefix is to use
11168 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11169 Variables}.
11171 As a special kludge, if the path provided by @option{-B} is
11172 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11173 9, then it is replaced by @file{[dir/]include}.  This is to help
11174 with boot-strapping the compiler.
11176 @item -specs=@var{file}
11177 @opindex specs
11178 Process @var{file} after the compiler reads in the standard @file{specs}
11179 file, in order to override the defaults which the @command{gcc} driver
11180 program uses when determining what switches to pass to @command{cc1},
11181 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11182 @option{-specs=@var{file}} can be specified on the command line, and they
11183 are processed in order, from left to right.
11185 @item --sysroot=@var{dir}
11186 @opindex sysroot
11187 Use @var{dir} as the logical root directory for headers and libraries.
11188 For example, if the compiler normally searches for headers in
11189 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11190 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11192 If you use both this option and the @option{-isysroot} option, then
11193 the @option{--sysroot} option applies to libraries, but the
11194 @option{-isysroot} option applies to header files.
11196 The GNU linker (beginning with version 2.16) has the necessary support
11197 for this option.  If your linker does not support this option, the
11198 header file aspect of @option{--sysroot} still works, but the
11199 library aspect does not.
11201 @item --no-sysroot-suffix
11202 @opindex no-sysroot-suffix
11203 For some targets, a suffix is added to the root directory specified
11204 with @option{--sysroot}, depending on the other options used, so that
11205 headers may for example be found in
11206 @file{@var{dir}/@var{suffix}/usr/include} instead of
11207 @file{@var{dir}/usr/include}.  This option disables the addition of
11208 such a suffix.
11210 @item -I-
11211 @opindex I-
11212 This option has been deprecated.  Please use @option{-iquote} instead for
11213 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
11214 Any directories you specify with @option{-I} options before the @option{-I-}
11215 option are searched only for the case of @samp{#include "@var{file}"};
11216 they are not searched for @samp{#include <@var{file}>}.
11218 If additional directories are specified with @option{-I} options after
11219 the @option{-I-}, these directories are searched for all @samp{#include}
11220 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11221 this way.)
11223 In addition, the @option{-I-} option inhibits the use of the current
11224 directory (where the current input file came from) as the first search
11225 directory for @samp{#include "@var{file}"}.  There is no way to
11226 override this effect of @option{-I-}.  With @option{-I.} you can specify
11227 searching the directory that is current when the compiler is
11228 invoked.  That is not exactly the same as what the preprocessor does
11229 by default, but it is often satisfactory.
11231 @option{-I-} does not inhibit the use of the standard system directories
11232 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11233 independent.
11234 @end table
11236 @c man end
11238 @node Spec Files
11239 @section Specifying subprocesses and the switches to pass to them
11240 @cindex Spec Files
11242 @command{gcc} is a driver program.  It performs its job by invoking a
11243 sequence of other programs to do the work of compiling, assembling and
11244 linking.  GCC interprets its command-line parameters and uses these to
11245 deduce which programs it should invoke, and which command-line options
11246 it ought to place on their command lines.  This behavior is controlled
11247 by @dfn{spec strings}.  In most cases there is one spec string for each
11248 program that GCC can invoke, but a few programs have multiple spec
11249 strings to control their behavior.  The spec strings built into GCC can
11250 be overridden by using the @option{-specs=} command-line switch to specify
11251 a spec file.
11253 @dfn{Spec files} are plaintext files that are used to construct spec
11254 strings.  They consist of a sequence of directives separated by blank
11255 lines.  The type of directive is determined by the first non-whitespace
11256 character on the line, which can be one of the following:
11258 @table @code
11259 @item %@var{command}
11260 Issues a @var{command} to the spec file processor.  The commands that can
11261 appear here are:
11263 @table @code
11264 @item %include <@var{file}>
11265 @cindex @code{%include}
11266 Search for @var{file} and insert its text at the current point in the
11267 specs file.
11269 @item %include_noerr <@var{file}>
11270 @cindex @code{%include_noerr}
11271 Just like @samp{%include}, but do not generate an error message if the include
11272 file cannot be found.
11274 @item %rename @var{old_name} @var{new_name}
11275 @cindex @code{%rename}
11276 Rename the spec string @var{old_name} to @var{new_name}.
11278 @end table
11280 @item *[@var{spec_name}]:
11281 This tells the compiler to create, override or delete the named spec
11282 string.  All lines after this directive up to the next directive or
11283 blank line are considered to be the text for the spec string.  If this
11284 results in an empty string then the spec is deleted.  (Or, if the
11285 spec did not exist, then nothing happens.)  Otherwise, if the spec
11286 does not currently exist a new spec is created.  If the spec does
11287 exist then its contents are overridden by the text of this
11288 directive, unless the first character of that text is the @samp{+}
11289 character, in which case the text is appended to the spec.
11291 @item [@var{suffix}]:
11292 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11293 and up to the next directive or blank line are considered to make up the
11294 spec string for the indicated suffix.  When the compiler encounters an
11295 input file with the named suffix, it processes the spec string in
11296 order to work out how to compile that file.  For example:
11298 @smallexample
11299 .ZZ:
11300 z-compile -input %i
11301 @end smallexample
11303 This says that any input file whose name ends in @samp{.ZZ} should be
11304 passed to the program @samp{z-compile}, which should be invoked with the
11305 command-line switch @option{-input} and with the result of performing the
11306 @samp{%i} substitution.  (See below.)
11308 As an alternative to providing a spec string, the text following a
11309 suffix directive can be one of the following:
11311 @table @code
11312 @item @@@var{language}
11313 This says that the suffix is an alias for a known @var{language}.  This is
11314 similar to using the @option{-x} command-line switch to GCC to specify a
11315 language explicitly.  For example:
11317 @smallexample
11318 .ZZ:
11319 @@c++
11320 @end smallexample
11322 Says that .ZZ files are, in fact, C++ source files.
11324 @item #@var{name}
11325 This causes an error messages saying:
11327 @smallexample
11328 @var{name} compiler not installed on this system.
11329 @end smallexample
11330 @end table
11332 GCC already has an extensive list of suffixes built into it.
11333 This directive adds an entry to the end of the list of suffixes, but
11334 since the list is searched from the end backwards, it is effectively
11335 possible to override earlier entries using this technique.
11337 @end table
11339 GCC has the following spec strings built into it.  Spec files can
11340 override these strings or create their own.  Note that individual
11341 targets can also add their own spec strings to this list.
11343 @smallexample
11344 asm          Options to pass to the assembler
11345 asm_final    Options to pass to the assembler post-processor
11346 cpp          Options to pass to the C preprocessor
11347 cc1          Options to pass to the C compiler
11348 cc1plus      Options to pass to the C++ compiler
11349 endfile      Object files to include at the end of the link
11350 link         Options to pass to the linker
11351 lib          Libraries to include on the command line to the linker
11352 libgcc       Decides which GCC support library to pass to the linker
11353 linker       Sets the name of the linker
11354 predefines   Defines to be passed to the C preprocessor
11355 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11356              by default
11357 startfile    Object files to include at the start of the link
11358 @end smallexample
11360 Here is a small example of a spec file:
11362 @smallexample
11363 %rename lib                 old_lib
11365 *lib:
11366 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11367 @end smallexample
11369 This example renames the spec called @samp{lib} to @samp{old_lib} and
11370 then overrides the previous definition of @samp{lib} with a new one.
11371 The new definition adds in some extra command-line options before
11372 including the text of the old definition.
11374 @dfn{Spec strings} are a list of command-line options to be passed to their
11375 corresponding program.  In addition, the spec strings can contain
11376 @samp{%}-prefixed sequences to substitute variable text or to
11377 conditionally insert text into the command line.  Using these constructs
11378 it is possible to generate quite complex command lines.
11380 Here is a table of all defined @samp{%}-sequences for spec
11381 strings.  Note that spaces are not generated automatically around the
11382 results of expanding these sequences.  Therefore you can concatenate them
11383 together or combine them with constant text in a single argument.
11385 @table @code
11386 @item %%
11387 Substitute one @samp{%} into the program name or argument.
11389 @item %i
11390 Substitute the name of the input file being processed.
11392 @item %b
11393 Substitute the basename of the input file being processed.
11394 This is the substring up to (and not including) the last period
11395 and not including the directory.
11397 @item %B
11398 This is the same as @samp{%b}, but include the file suffix (text after
11399 the last period).
11401 @item %d
11402 Marks the argument containing or following the @samp{%d} as a
11403 temporary file name, so that that file is deleted if GCC exits
11404 successfully.  Unlike @samp{%g}, this contributes no text to the
11405 argument.
11407 @item %g@var{suffix}
11408 Substitute a file name that has suffix @var{suffix} and is chosen
11409 once per compilation, and mark the argument in the same way as
11410 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11411 name is now chosen in a way that is hard to predict even when previously
11412 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11413 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11414 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11415 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11416 was simply substituted with a file name chosen once per compilation,
11417 without regard to any appended suffix (which was therefore treated
11418 just like ordinary text), making such attacks more likely to succeed.
11420 @item %u@var{suffix}
11421 Like @samp{%g}, but generates a new temporary file name
11422 each time it appears instead of once per compilation.
11424 @item %U@var{suffix}
11425 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11426 new one if there is no such last file name.  In the absence of any
11427 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11428 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11429 involves the generation of two distinct file names, one
11430 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11431 simply substituted with a file name chosen for the previous @samp{%u},
11432 without regard to any appended suffix.
11434 @item %j@var{suffix}
11435 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11436 writable, and if @option{-save-temps} is not used; 
11437 otherwise, substitute the name
11438 of a temporary file, just like @samp{%u}.  This temporary file is not
11439 meant for communication between processes, but rather as a junk
11440 disposal mechanism.
11442 @item %|@var{suffix}
11443 @itemx %m@var{suffix}
11444 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11445 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11446 all.  These are the two most common ways to instruct a program that it
11447 should read from standard input or write to standard output.  If you
11448 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11449 construct: see for example @file{f/lang-specs.h}.
11451 @item %.@var{SUFFIX}
11452 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11453 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11454 terminated by the next space or %.
11456 @item %w
11457 Marks the argument containing or following the @samp{%w} as the
11458 designated output file of this compilation.  This puts the argument
11459 into the sequence of arguments that @samp{%o} substitutes.
11461 @item %o
11462 Substitutes the names of all the output files, with spaces
11463 automatically placed around them.  You should write spaces
11464 around the @samp{%o} as well or the results are undefined.
11465 @samp{%o} is for use in the specs for running the linker.
11466 Input files whose names have no recognized suffix are not compiled
11467 at all, but they are included among the output files, so they are
11468 linked.
11470 @item %O
11471 Substitutes the suffix for object files.  Note that this is
11472 handled specially when it immediately follows @samp{%g, %u, or %U},
11473 because of the need for those to form complete file names.  The
11474 handling is such that @samp{%O} is treated exactly as if it had already
11475 been substituted, except that @samp{%g, %u, and %U} do not currently
11476 support additional @var{suffix} characters following @samp{%O} as they do
11477 following, for example, @samp{.o}.
11479 @item %p
11480 Substitutes the standard macro predefinitions for the
11481 current target machine.  Use this when running @code{cpp}.
11483 @item %P
11484 Like @samp{%p}, but puts @samp{__} before and after the name of each
11485 predefined macro, except for macros that start with @samp{__} or with
11486 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11489 @item %I
11490 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11491 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11492 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11493 and @option{-imultilib} as necessary.
11495 @item %s
11496 Current argument is the name of a library or startup file of some sort.
11497 Search for that file in a standard list of directories and substitute
11498 the full name found.  The current working directory is included in the
11499 list of directories scanned.
11501 @item %T
11502 Current argument is the name of a linker script.  Search for that file
11503 in the current list of directories to scan for libraries. If the file
11504 is located insert a @option{--script} option into the command line
11505 followed by the full path name found.  If the file is not found then
11506 generate an error message.  Note: the current working directory is not
11507 searched.
11509 @item %e@var{str}
11510 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11511 Use this when inconsistent options are detected.
11513 @item %(@var{name})
11514 Substitute the contents of spec string @var{name} at this point.
11516 @item %x@{@var{option}@}
11517 Accumulate an option for @samp{%X}.
11519 @item %X
11520 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11521 spec string.
11523 @item %Y
11524 Output the accumulated assembler options specified by @option{-Wa}.
11526 @item %Z
11527 Output the accumulated preprocessor options specified by @option{-Wp}.
11529 @item %a
11530 Process the @code{asm} spec.  This is used to compute the
11531 switches to be passed to the assembler.
11533 @item %A
11534 Process the @code{asm_final} spec.  This is a spec string for
11535 passing switches to an assembler post-processor, if such a program is
11536 needed.
11538 @item %l
11539 Process the @code{link} spec.  This is the spec for computing the
11540 command line passed to the linker.  Typically it makes use of the
11541 @samp{%L %G %S %D and %E} sequences.
11543 @item %D
11544 Dump out a @option{-L} option for each directory that GCC believes might
11545 contain startup files.  If the target supports multilibs then the
11546 current multilib directory is prepended to each of these paths.
11548 @item %L
11549 Process the @code{lib} spec.  This is a spec string for deciding which
11550 libraries are included on the command line to the linker.
11552 @item %G
11553 Process the @code{libgcc} spec.  This is a spec string for deciding
11554 which GCC support library is included on the command line to the linker.
11556 @item %S
11557 Process the @code{startfile} spec.  This is a spec for deciding which
11558 object files are the first ones passed to the linker.  Typically
11559 this might be a file named @file{crt0.o}.
11561 @item %E
11562 Process the @code{endfile} spec.  This is a spec string that specifies
11563 the last object files that are passed to the linker.
11565 @item %C
11566 Process the @code{cpp} spec.  This is used to construct the arguments
11567 to be passed to the C preprocessor.
11569 @item %1
11570 Process the @code{cc1} spec.  This is used to construct the options to be
11571 passed to the actual C compiler (@samp{cc1}).
11573 @item %2
11574 Process the @code{cc1plus} spec.  This is used to construct the options to be
11575 passed to the actual C++ compiler (@samp{cc1plus}).
11577 @item %*
11578 Substitute the variable part of a matched option.  See below.
11579 Note that each comma in the substituted string is replaced by
11580 a single space.
11582 @item %<@code{S}
11583 Remove all occurrences of @code{-S} from the command line.  Note---this
11584 command is position dependent.  @samp{%} commands in the spec string
11585 before this one see @code{-S}, @samp{%} commands in the spec string
11586 after this one do not.
11588 @item %:@var{function}(@var{args})
11589 Call the named function @var{function}, passing it @var{args}.
11590 @var{args} is first processed as a nested spec string, then split
11591 into an argument vector in the usual fashion.  The function returns
11592 a string which is processed as if it had appeared literally as part
11593 of the current spec.
11595 The following built-in spec functions are provided:
11597 @table @code
11598 @item @code{getenv}
11599 The @code{getenv} spec function takes two arguments: an environment
11600 variable name and a string.  If the environment variable is not
11601 defined, a fatal error is issued.  Otherwise, the return value is the
11602 value of the environment variable concatenated with the string.  For
11603 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11605 @smallexample
11606 %:getenv(TOPDIR /include)
11607 @end smallexample
11609 expands to @file{/path/to/top/include}.
11611 @item @code{if-exists}
11612 The @code{if-exists} spec function takes one argument, an absolute
11613 pathname to a file.  If the file exists, @code{if-exists} returns the
11614 pathname.  Here is a small example of its usage:
11616 @smallexample
11617 *startfile:
11618 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11619 @end smallexample
11621 @item @code{if-exists-else}
11622 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11623 spec function, except that it takes two arguments.  The first argument is
11624 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11625 returns the pathname.  If it does not exist, it returns the second argument.
11626 This way, @code{if-exists-else} can be used to select one file or another,
11627 based on the existence of the first.  Here is a small example of its usage:
11629 @smallexample
11630 *startfile:
11631 crt0%O%s %:if-exists(crti%O%s) \
11632 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11633 @end smallexample
11635 @item @code{replace-outfile}
11636 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11637 first argument in the outfiles array and replaces it with the second argument.  Here
11638 is a small example of its usage:
11640 @smallexample
11641 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11642 @end smallexample
11644 @item @code{remove-outfile}
11645 The @code{remove-outfile} spec function takes one argument.  It looks for the
11646 first argument in the outfiles array and removes it.  Here is a small example
11647 its usage:
11649 @smallexample
11650 %:remove-outfile(-lm)
11651 @end smallexample
11653 @item @code{pass-through-libs}
11654 The @code{pass-through-libs} spec function takes any number of arguments.  It
11655 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11656 assumes are the names of linker input library archive files) and returns a
11657 result containing all the found arguments each prepended by
11658 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11659 intended to be passed to the LTO linker plugin.
11661 @smallexample
11662 %:pass-through-libs(%G %L %G)
11663 @end smallexample
11665 @item @code{print-asm-header}
11666 The @code{print-asm-header} function takes no arguments and simply
11667 prints a banner like:
11669 @smallexample
11670 Assembler options
11671 =================
11673 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11674 @end smallexample
11676 It is used to separate compiler options from assembler options
11677 in the @option{--target-help} output.
11678 @end table
11680 @item %@{@code{S}@}
11681 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11682 If that switch is not specified, this substitutes nothing.  Note that
11683 the leading dash is omitted when specifying this option, and it is
11684 automatically inserted if the substitution is performed.  Thus the spec
11685 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11686 and outputs the command-line option @option{-foo}.
11688 @item %W@{@code{S}@}
11689 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11690 deleted on failure.
11692 @item %@{@code{S}*@}
11693 Substitutes all the switches specified to GCC whose names start
11694 with @code{-S}, but which also take an argument.  This is used for
11695 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11696 GCC considers @option{-o foo} as being
11697 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11698 text, including the space.  Thus two arguments are generated.
11700 @item %@{@code{S}*&@code{T}*@}
11701 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11702 (the order of @code{S} and @code{T} in the spec is not significant).
11703 There can be any number of ampersand-separated variables; for each the
11704 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11706 @item %@{@code{S}:@code{X}@}
11707 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11709 @item %@{!@code{S}:@code{X}@}
11710 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11712 @item %@{@code{S}*:@code{X}@}
11713 Substitutes @code{X} if one or more switches whose names start with
11714 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11715 once, no matter how many such switches appeared.  However, if @code{%*}
11716 appears somewhere in @code{X}, then @code{X} is substituted once
11717 for each matching switch, with the @code{%*} replaced by the part of
11718 that switch matching the @code{*}.
11720 If @code{%*} appears as the last part of a spec sequence then a space
11721 will be added after the end of the last substitution.  If there is more
11722 text in the sequence however then a space will not be generated.  This
11723 allows the @code{%*} substitution to be used as part of a larger
11724 string.  For example, a spec string like this:
11726 @smallexample
11727 %@{mcu=*:--script=%*/memory.ld@}
11728 @end smallexample
11730 when matching an option like @code{-mcu=newchip} will produce:
11732 @smallexample
11733 --script=newchip/memory.ld
11734 @end smallexample
11736 @item %@{.@code{S}:@code{X}@}
11737 Substitutes @code{X}, if processing a file with suffix @code{S}.
11739 @item %@{!.@code{S}:@code{X}@}
11740 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11742 @item %@{,@code{S}:@code{X}@}
11743 Substitutes @code{X}, if processing a file for language @code{S}.
11745 @item %@{!,@code{S}:@code{X}@}
11746 Substitutes @code{X}, if not processing a file for language @code{S}.
11748 @item %@{@code{S}|@code{P}:@code{X}@}
11749 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11750 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11751 @code{*} sequences as well, although they have a stronger binding than
11752 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11753 alternatives must be starred, and only the first matching alternative
11754 is substituted.
11756 For example, a spec string like this:
11758 @smallexample
11759 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11760 @end smallexample
11762 @noindent
11763 outputs the following command-line options from the following input
11764 command-line options:
11766 @smallexample
11767 fred.c        -foo -baz
11768 jim.d         -bar -boggle
11769 -d fred.c     -foo -baz -boggle
11770 -d jim.d      -bar -baz -boggle
11771 @end smallexample
11773 @item %@{S:X; T:Y; :D@}
11775 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11776 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11777 be as many clauses as you need.  This may be combined with @code{.},
11778 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11781 @end table
11783 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11784 construct may contain other nested @samp{%} constructs or spaces, or
11785 even newlines.  They are processed as usual, as described above.
11786 Trailing white space in @code{X} is ignored.  White space may also
11787 appear anywhere on the left side of the colon in these constructs,
11788 except between @code{.} or @code{*} and the corresponding word.
11790 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11791 handled specifically in these constructs.  If another value of
11792 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11793 @option{-W} switch is found later in the command line, the earlier
11794 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11795 just one letter, which passes all matching options.
11797 The character @samp{|} at the beginning of the predicate text is used to
11798 indicate that a command should be piped to the following command, but
11799 only if @option{-pipe} is specified.
11801 It is built into GCC which switches take arguments and which do not.
11802 (You might think it would be useful to generalize this to allow each
11803 compiler's spec to say which switches take arguments.  But this cannot
11804 be done in a consistent fashion.  GCC cannot even decide which input
11805 files have been specified without knowing which switches take arguments,
11806 and it must know which input files to compile in order to tell which
11807 compilers to run).
11809 GCC also knows implicitly that arguments starting in @option{-l} are to be
11810 treated as compiler output files, and passed to the linker in their
11811 proper position among the other output files.
11813 @c man begin OPTIONS
11815 @node Target Options
11816 @section Specifying Target Machine and Compiler Version
11817 @cindex target options
11818 @cindex cross compiling
11819 @cindex specifying machine version
11820 @cindex specifying compiler version and target machine
11821 @cindex compiler version, specifying
11822 @cindex target machine, specifying
11824 The usual way to run GCC is to run the executable called @command{gcc}, or
11825 @command{@var{machine}-gcc} when cross-compiling, or
11826 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11827 one that was installed last.
11829 @node Submodel Options
11830 @section Hardware Models and Configurations
11831 @cindex submodel options
11832 @cindex specifying hardware config
11833 @cindex hardware models and configurations, specifying
11834 @cindex machine dependent options
11836 Each target machine types can have its own
11837 special options, starting with @samp{-m}, to choose among various
11838 hardware models or configurations---for example, 68010 vs 68020,
11839 floating coprocessor or none.  A single installed version of the
11840 compiler can compile for any model or configuration, according to the
11841 options specified.
11843 Some configurations of the compiler also support additional special
11844 options, usually for compatibility with other compilers on the same
11845 platform.
11847 @c This list is ordered alphanumerically by subsection name.
11848 @c It should be the same order and spelling as these options are listed
11849 @c in Machine Dependent Options
11851 @menu
11852 * AArch64 Options::
11853 * Adapteva Epiphany Options::
11854 * ARC Options::
11855 * ARM Options::
11856 * AVR Options::
11857 * Blackfin Options::
11858 * C6X Options::
11859 * CRIS Options::
11860 * CR16 Options::
11861 * Darwin Options::
11862 * DEC Alpha Options::
11863 * FR30 Options::
11864 * FRV Options::
11865 * GNU/Linux Options::
11866 * H8/300 Options::
11867 * HPPA Options::
11868 * i386 and x86-64 Options::
11869 * i386 and x86-64 Windows Options::
11870 * IA-64 Options::
11871 * LM32 Options::
11872 * M32C Options::
11873 * M32R/D Options::
11874 * M680x0 Options::
11875 * MCore Options::
11876 * MeP Options::
11877 * MicroBlaze Options::
11878 * MIPS Options::
11879 * MMIX Options::
11880 * MN10300 Options::
11881 * Moxie Options::
11882 * MSP430 Options::
11883 * NDS32 Options::
11884 * Nios II Options::
11885 * PDP-11 Options::
11886 * picoChip Options::
11887 * PowerPC Options::
11888 * RL78 Options::
11889 * RS/6000 and PowerPC Options::
11890 * RX Options::
11891 * S/390 and zSeries Options::
11892 * Score Options::
11893 * SH Options::
11894 * Solaris 2 Options::
11895 * SPARC Options::
11896 * SPU Options::
11897 * System V Options::
11898 * TILE-Gx Options::
11899 * TILEPro Options::
11900 * V850 Options::
11901 * VAX Options::
11902 * VMS Options::
11903 * VxWorks Options::
11904 * x86-64 Options::
11905 * Xstormy16 Options::
11906 * Xtensa Options::
11907 * zSeries Options::
11908 @end menu
11910 @node AArch64 Options
11911 @subsection AArch64 Options
11912 @cindex AArch64 Options
11914 These options are defined for AArch64 implementations:
11916 @table @gcctabopt
11918 @item -mabi=@var{name}
11919 @opindex mabi
11920 Generate code for the specified data model.  Permissible values
11921 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11922 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11923 but long int and pointer are 64-bit.
11925 The default depends on the specific target configuration.  Note that
11926 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11927 entire program with the same ABI, and link with a compatible set of libraries.
11929 @item -mbig-endian
11930 @opindex mbig-endian
11931 Generate big-endian code.  This is the default when GCC is configured for an
11932 @samp{aarch64_be-*-*} target.
11934 @item -mgeneral-regs-only
11935 @opindex mgeneral-regs-only
11936 Generate code which uses only the general registers.
11938 @item -mlittle-endian
11939 @opindex mlittle-endian
11940 Generate little-endian code.  This is the default when GCC is configured for an
11941 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11943 @item -mcmodel=tiny
11944 @opindex mcmodel=tiny
11945 Generate code for the tiny code model.  The program and its statically defined
11946 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11947 be statically or dynamically linked.  This model is not fully implemented and
11948 mostly treated as @samp{small}.
11950 @item -mcmodel=small
11951 @opindex mcmodel=small
11952 Generate code for the small code model.  The program and its statically defined
11953 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11954 be statically or dynamically linked.  This is the default code model.
11956 @item -mcmodel=large
11957 @opindex mcmodel=large
11958 Generate code for the large code model.  This makes no assumptions about
11959 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11960 statically linked only.
11962 @item -mstrict-align
11963 @opindex mstrict-align
11964 Do not assume that unaligned memory references will be handled by the system.
11966 @item -momit-leaf-frame-pointer
11967 @itemx -mno-omit-leaf-frame-pointer
11968 @opindex momit-leaf-frame-pointer
11969 @opindex mno-omit-leaf-frame-pointer
11970 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11971 default.
11973 @item -mtls-dialect=desc
11974 @opindex mtls-dialect=desc
11975 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11976 of TLS variables.  This is the default.
11978 @item -mtls-dialect=traditional
11979 @opindex mtls-dialect=traditional
11980 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11981 of TLS variables.
11983 @item -mfix-cortex-a53-835769
11984 @itemx -mno-fix-cortex-a53-835769
11985 @opindex -mfix-cortex-a53-835769
11986 @opindex -mno-fix-cortex-a53-835769
11987 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11988 This will involve inserting a NOP instruction between memory instructions and
11989 64-bit integer multiply-accumulate instructions.
11991 @item -march=@var{name}
11992 @opindex march
11993 Specify the name of the target architecture, optionally suffixed by one or
11994 more feature modifiers.  This option has the form
11995 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11996 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11997 values for @var{feature} are documented in the sub-section below.
11999 Where conflicting feature modifiers are specified, the right-most feature is
12000 used.
12002 GCC uses this name to determine what kind of instructions it can emit when
12003 generating assembly code.
12005 Where @option{-march} is specified without either of @option{-mtune}
12006 or @option{-mcpu} also being specified, the code will be tuned to perform
12007 well across a range of target processors implementing the target
12008 architecture.
12010 @item -mtune=@var{name}
12011 @opindex mtune
12012 Specify the name of the target processor for which GCC should tune the
12013 performance of the code.  Permissible values for this option are:
12014 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{thunderx}.
12016 Additionally, this option can specify that GCC should tune the performance
12017 of the code for a big.LITTLE system.  The only permissible value is
12018 @samp{cortex-a57.cortex-a53}.
12020 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12021 are specified, the code will be tuned to perform well across a range
12022 of target processors.
12024 This option cannot be suffixed by feature modifiers.
12026 @item -mcpu=@var{name}
12027 @opindex mcpu
12028 Specify the name of the target processor, optionally suffixed by one or more
12029 feature modifiers.  This option has the form
12030 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12031 permissible values for @var{cpu} are the same as those available for
12032 @option{-mtune}.
12034 The permissible values for @var{feature} are documented in the sub-section
12035 below.
12037 Where conflicting feature modifiers are specified, the right-most feature is
12038 used.
12040 GCC uses this name to determine what kind of instructions it can emit when
12041 generating assembly code (as if by @option{-march}) and to determine
12042 the target processor for which to tune for performance (as if
12043 by @option{-mtune}).  Where this option is used in conjunction
12044 with @option{-march} or @option{-mtune}, those options take precedence
12045 over the appropriate part of this option.
12046 @end table
12048 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
12049 @cindex @option{-march} feature modifiers
12050 @cindex @option{-mcpu} feature modifiers
12051 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12052 the following:
12054 @table @samp
12055 @item crc
12056 Enable CRC extension.
12057 @item crypto
12058 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12059 @item fp
12060 Enable floating-point instructions.
12061 @item simd
12062 Enable Advanced SIMD instructions.  This implies floating-point instructions
12063 are enabled.  This is the default for all current possible values for options
12064 @option{-march} and @option{-mcpu=}.
12065 @end table
12067 @node Adapteva Epiphany Options
12068 @subsection Adapteva Epiphany Options
12070 These @samp{-m} options are defined for Adapteva Epiphany:
12072 @table @gcctabopt
12073 @item -mhalf-reg-file
12074 @opindex mhalf-reg-file
12075 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12076 That allows code to run on hardware variants that lack these registers.
12078 @item -mprefer-short-insn-regs
12079 @opindex mprefer-short-insn-regs
12080 Preferrentially allocate registers that allow short instruction generation.
12081 This can result in increased instruction count, so this may either reduce or
12082 increase overall code size.
12084 @item -mbranch-cost=@var{num}
12085 @opindex mbranch-cost
12086 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12087 This cost is only a heuristic and is not guaranteed to produce
12088 consistent results across releases.
12090 @item -mcmove
12091 @opindex mcmove
12092 Enable the generation of conditional moves.
12094 @item -mnops=@var{num}
12095 @opindex mnops
12096 Emit @var{num} NOPs before every other generated instruction.
12098 @item -mno-soft-cmpsf
12099 @opindex mno-soft-cmpsf
12100 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12101 and test the flags.  This is faster than a software comparison, but can
12102 get incorrect results in the presence of NaNs, or when two different small
12103 numbers are compared such that their difference is calculated as zero.
12104 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12105 software comparisons.
12107 @item -mstack-offset=@var{num}
12108 @opindex mstack-offset
12109 Set the offset between the top of the stack and the stack pointer.
12110 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12111 can be used by leaf functions without stack allocation.
12112 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12113 Note also that this option changes the ABI; compiling a program with a
12114 different stack offset than the libraries have been compiled with
12115 generally does not work.
12116 This option can be useful if you want to evaluate if a different stack
12117 offset would give you better code, but to actually use a different stack
12118 offset to build working programs, it is recommended to configure the
12119 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12121 @item -mno-round-nearest
12122 @opindex mno-round-nearest
12123 Make the scheduler assume that the rounding mode has been set to
12124 truncating.  The default is @option{-mround-nearest}.
12126 @item -mlong-calls
12127 @opindex mlong-calls
12128 If not otherwise specified by an attribute, assume all calls might be beyond
12129 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12130 function address into a register before performing a (otherwise direct) call.
12131 This is the default.
12133 @item -mshort-calls
12134 @opindex short-calls
12135 If not otherwise specified by an attribute, assume all direct calls are
12136 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12137 for direct calls.  The default is @option{-mlong-calls}.
12139 @item -msmall16
12140 @opindex msmall16
12141 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12142 apply to function addresses for which @option{-mlong-calls} semantics
12143 are in effect.
12145 @item -mfp-mode=@var{mode}
12146 @opindex mfp-mode
12147 Set the prevailing mode of the floating-point unit.
12148 This determines the floating-point mode that is provided and expected
12149 at function call and return time.  Making this mode match the mode you
12150 predominantly need at function start can make your programs smaller and
12151 faster by avoiding unnecessary mode switches.
12153 @var{mode} can be set to one the following values:
12155 @table @samp
12156 @item caller
12157 Any mode at function entry is valid, and retained or restored when
12158 the function returns, and when it calls other functions.
12159 This mode is useful for compiling libraries or other compilation units
12160 you might want to incorporate into different programs with different
12161 prevailing FPU modes, and the convenience of being able to use a single
12162 object file outweighs the size and speed overhead for any extra
12163 mode switching that might be needed, compared with what would be needed
12164 with a more specific choice of prevailing FPU mode.
12166 @item truncate
12167 This is the mode used for floating-point calculations with
12168 truncating (i.e.@: round towards zero) rounding mode.  That includes
12169 conversion from floating point to integer.
12171 @item round-nearest
12172 This is the mode used for floating-point calculations with
12173 round-to-nearest-or-even rounding mode.
12175 @item int
12176 This is the mode used to perform integer calculations in the FPU, e.g.@:
12177 integer multiply, or integer multiply-and-accumulate.
12178 @end table
12180 The default is @option{-mfp-mode=caller}
12182 @item -mnosplit-lohi
12183 @itemx -mno-postinc
12184 @itemx -mno-postmodify
12185 @opindex mnosplit-lohi
12186 @opindex mno-postinc
12187 @opindex mno-postmodify
12188 Code generation tweaks that disable, respectively, splitting of 32-bit
12189 loads, generation of post-increment addresses, and generation of
12190 post-modify addresses.  The defaults are @option{msplit-lohi},
12191 @option{-mpost-inc}, and @option{-mpost-modify}.
12193 @item -mnovect-double
12194 @opindex mno-vect-double
12195 Change the preferred SIMD mode to SImode.  The default is
12196 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12198 @item -max-vect-align=@var{num}
12199 @opindex max-vect-align
12200 The maximum alignment for SIMD vector mode types.
12201 @var{num} may be 4 or 8.  The default is 8.
12202 Note that this is an ABI change, even though many library function
12203 interfaces are unaffected if they don't use SIMD vector modes
12204 in places that affect size and/or alignment of relevant types.
12206 @item -msplit-vecmove-early
12207 @opindex msplit-vecmove-early
12208 Split vector moves into single word moves before reload.  In theory this
12209 can give better register allocation, but so far the reverse seems to be
12210 generally the case.
12212 @item -m1reg-@var{reg}
12213 @opindex m1reg-
12214 Specify a register to hold the constant @minus{}1, which makes loading small negative
12215 constants and certain bitmasks faster.
12216 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12217 which specify use of that register as a fixed register,
12218 and @samp{none}, which means that no register is used for this
12219 purpose.  The default is @option{-m1reg-none}.
12221 @end table
12223 @node ARC Options
12224 @subsection ARC Options
12225 @cindex ARC options
12227 The following options control the architecture variant for which code
12228 is being compiled:
12230 @c architecture variants
12231 @table @gcctabopt
12233 @item -mbarrel-shifter
12234 @opindex mbarrel-shifter
12235 Generate instructions supported by barrel shifter.  This is the default
12236 unless @samp{-mcpu=ARC601} is in effect.
12238 @item -mcpu=@var{cpu}
12239 @opindex mcpu
12240 Set architecture type, register usage, and instruction scheduling
12241 parameters for @var{cpu}.  There are also shortcut alias options
12242 available for backward compatibility and convenience.  Supported
12243 values for @var{cpu} are
12245 @table @samp
12246 @opindex mA6
12247 @opindex mARC600
12248 @item ARC600
12249 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12251 @item ARC601
12252 @opindex mARC601
12253 Compile for ARC601.  Alias: @option{-mARC601}.
12255 @item ARC700
12256 @opindex mA7
12257 @opindex mARC700
12258 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12259 This is the default when configured with @samp{--with-cpu=arc700}@.
12260 @end table
12262 @item -mdpfp
12263 @opindex mdpfp
12264 @itemx -mdpfp-compact
12265 @opindex mdpfp-compact
12266 FPX: Generate Double Precision FPX instructions, tuned for the compact
12267 implementation.
12269 @item -mdpfp-fast
12270 @opindex mdpfp-fast
12271 FPX: Generate Double Precision FPX instructions, tuned for the fast
12272 implementation.
12274 @item -mno-dpfp-lrsr
12275 @opindex mno-dpfp-lrsr
12276 Disable LR and SR instructions from using FPX extension aux registers.
12278 @item -mea
12279 @opindex mea
12280 Generate Extended arithmetic instructions.  Currently only
12281 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12282 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12284 @item -mno-mpy
12285 @opindex mno-mpy
12286 Do not generate mpy instructions for ARC700.
12288 @item -mmul32x16
12289 @opindex mmul32x16
12290 Generate 32x16 bit multiply and mac instructions.
12292 @item -mmul64
12293 @opindex mmul64
12294 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12296 @item -mnorm
12297 @opindex mnorm
12298 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12299 is in effect.
12301 @item -mspfp
12302 @opindex mspfp
12303 @itemx -mspfp-compact
12304 @opindex mspfp-compact
12305 FPX: Generate Single Precision FPX instructions, tuned for the compact
12306 implementation.
12308 @item -mspfp-fast
12309 @opindex mspfp-fast
12310 FPX: Generate Single Precision FPX instructions, tuned for the fast
12311 implementation.
12313 @item -msimd
12314 @opindex msimd
12315 Enable generation of ARC SIMD instructions via target-specific
12316 builtins.  Only valid for @samp{-mcpu=ARC700}.
12318 @item -msoft-float
12319 @opindex msoft-float
12320 This option ignored; it is provided for compatibility purposes only.
12321 Software floating point code is emitted by default, and this default
12322 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12323 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12324 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12326 @item -mswap
12327 @opindex mswap
12328 Generate swap instructions.
12330 @end table
12332 The following options are passed through to the assembler, and also
12333 define preprocessor macro symbols.
12335 @c Flags used by the assembler, but for which we define preprocessor
12336 @c macro symbols as well.
12337 @table @gcctabopt
12338 @item -mdsp-packa
12339 @opindex mdsp-packa
12340 Passed down to the assembler to enable the DSP Pack A extensions.
12341 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12343 @item -mdvbf
12344 @opindex mdvbf
12345 Passed down to the assembler to enable the dual viterbi butterfly
12346 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12348 @c ARC700 4.10 extension instruction
12349 @item -mlock
12350 @opindex mlock
12351 Passed down to the assembler to enable the Locked Load/Store
12352 Conditional extension.  Also sets the preprocessor symbol
12353 @code{__Xlock}.
12355 @item -mmac-d16
12356 @opindex mmac-d16
12357 Passed down to the assembler.  Also sets the preprocessor symbol
12358 @code{__Xxmac_d16}.
12360 @item -mmac-24
12361 @opindex mmac-24
12362 Passed down to the assembler.  Also sets the preprocessor symbol
12363 @code{__Xxmac_24}.
12365 @c ARC700 4.10 extension instruction
12366 @item -mrtsc
12367 @opindex mrtsc
12368 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12369 extension instruction.  Also sets the preprocessor symbol
12370 @code{__Xrtsc}.
12372 @c ARC700 4.10 extension instruction
12373 @item -mswape
12374 @opindex mswape
12375 Passed down to the assembler to enable the swap byte ordering
12376 extension instruction.  Also sets the preprocessor symbol
12377 @code{__Xswape}.
12379 @item -mtelephony
12380 @opindex mtelephony
12381 Passed down to the assembler to enable dual and single operand
12382 instructions for telephony.  Also sets the preprocessor symbol
12383 @code{__Xtelephony}.
12385 @item -mxy
12386 @opindex mxy
12387 Passed down to the assembler to enable the XY Memory extension.  Also
12388 sets the preprocessor symbol @code{__Xxy}.
12390 @end table
12392 The following options control how the assembly code is annotated:
12394 @c Assembly annotation options
12395 @table @gcctabopt
12396 @item -misize
12397 @opindex misize
12398 Annotate assembler instructions with estimated addresses.
12400 @item -mannotate-align
12401 @opindex mannotate-align
12402 Explain what alignment considerations lead to the decision to make an
12403 instruction short or long.
12405 @end table
12407 The following options are passed through to the linker:
12409 @c options passed through to the linker
12410 @table @gcctabopt
12411 @item -marclinux
12412 @opindex marclinux
12413 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12414 This option is enabled by default in tool chains built for
12415 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12416 when profiling is not requested.
12418 @item -marclinux_prof
12419 @opindex marclinux_prof
12420 Passed through to the linker, to specify use of the
12421 @code{arclinux_prof} emulation.  This option is enabled by default in
12422 tool chains built for @w{@code{arc-linux-uclibc}} and
12423 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12425 @end table
12427 The following options control the semantics of generated code:
12429 @c semantically relevant code generation options
12430 @table @gcctabopt
12431 @item -mepilogue-cfi
12432 @opindex mepilogue-cfi
12433 Enable generation of call frame information for epilogues.
12435 @item -mno-epilogue-cfi
12436 @opindex mno-epilogue-cfi
12437 Disable generation of call frame information for epilogues.
12439 @item -mlong-calls
12440 @opindex mlong-calls
12441 Generate call insns as register indirect calls, thus providing access
12442 to the full 32-bit address range.
12444 @item -mmedium-calls
12445 @opindex mmedium-calls
12446 Don't use less than 25 bit addressing range for calls, which is the
12447 offset available for an unconditional branch-and-link
12448 instruction.  Conditional execution of function calls is suppressed, to
12449 allow use of the 25-bit range, rather than the 21-bit range with
12450 conditional branch-and-link.  This is the default for tool chains built
12451 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12453 @item -mno-sdata
12454 @opindex mno-sdata
12455 Do not generate sdata references.  This is the default for tool chains
12456 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12457 targets.
12459 @item -mucb-mcount
12460 @opindex mucb-mcount
12461 Instrument with mcount calls as used in UCB code.  I.e. do the
12462 counting in the callee, not the caller.  By default ARC instrumentation
12463 counts in the caller.
12465 @item -mvolatile-cache
12466 @opindex mvolatile-cache
12467 Use ordinarily cached memory accesses for volatile references.  This is the
12468 default.
12470 @item -mno-volatile-cache
12471 @opindex mno-volatile-cache
12472 Enable cache bypass for volatile references.
12474 @end table
12476 The following options fine tune code generation:
12477 @c code generation tuning options
12478 @table @gcctabopt
12479 @item -malign-call
12480 @opindex malign-call
12481 Do alignment optimizations for call instructions.
12483 @item -mauto-modify-reg
12484 @opindex mauto-modify-reg
12485 Enable the use of pre/post modify with register displacement.
12487 @item -mbbit-peephole
12488 @opindex mbbit-peephole
12489 Enable bbit peephole2.
12491 @item -mno-brcc
12492 @opindex mno-brcc
12493 This option disables a target-specific pass in @file{arc_reorg} to
12494 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12495 generation driven by the combiner pass.
12497 @item -mcase-vector-pcrel
12498 @opindex mcase-vector-pcrel
12499 Use pc-relative switch case tables - this enables case table shortening.
12500 This is the default for @option{-Os}.
12502 @item -mcompact-casesi
12503 @opindex mcompact-casesi
12504 Enable compact casesi pattern.
12505 This is the default for @option{-Os}.
12507 @item -mno-cond-exec
12508 @opindex mno-cond-exec
12509 Disable ARCompact specific pass to generate conditional execution instructions.
12510 Due to delay slot scheduling and interactions between operand numbers,
12511 literal sizes, instruction lengths, and the support for conditional execution,
12512 the target-independent pass to generate conditional execution is often lacking,
12513 so the ARC port has kept a special pass around that tries to find more
12514 conditional execution generating opportunities after register allocation,
12515 branch shortening, and delay slot scheduling have been done.  This pass
12516 generally, but not always, improves performance and code size, at the cost of
12517 extra compilation time, which is why there is an option to switch it off.
12518 If you have a problem with call instructions exceeding their allowable
12519 offset range because they are conditionalized, you should consider using
12520 @option{-mmedium-calls} instead.
12522 @item -mearly-cbranchsi
12523 @opindex mearly-cbranchsi
12524 Enable pre-reload use of the cbranchsi pattern.
12526 @item -mexpand-adddi
12527 @opindex mexpand-adddi
12528 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12529 @code{add.f}, @code{adc} etc.
12531 @item -mindexed-loads
12532 @opindex mindexed-loads
12533 Enable the use of indexed loads.  This can be problematic because some
12534 optimizers will then assume the that indexed stores exist, which is not
12535 the case.
12537 @item -mlra
12538 @opindex mlra
12539 Enable Local Register Allocation.  This is still experimental for ARC,
12540 so by default the compiler uses standard reload
12541 (i.e. @samp{-mno-lra}).
12543 @item -mlra-priority-none
12544 @opindex mlra-priority-none
12545 Don't indicate any priority for target registers.
12547 @item -mlra-priority-compact
12548 @opindex mlra-priority-compact
12549 Indicate target register priority for r0..r3 / r12..r15.
12551 @item -mlra-priority-noncompact
12552 @opindex mlra-priority-noncompact
12553 Reduce target regsiter priority for r0..r3 / r12..r15.
12555 @item -mno-millicode
12556 @opindex mno-millicode
12557 When optimizing for size (using @option{-Os}), prologues and epilogues
12558 that have to save or restore a large number of registers are often
12559 shortened by using call to a special function in libgcc; this is
12560 referred to as a @emph{millicode} call.  As these calls can pose
12561 performance issues, and/or cause linking issues when linking in a
12562 nonstandard way, this option is provided to turn off millicode call
12563 generation.
12565 @item -mmixed-code
12566 @opindex mmixed-code
12567 Tweak register allocation to help 16-bit instruction generation.
12568 This generally has the effect of decreasing the average instruction size
12569 while increasing the instruction count.
12571 @item -mq-class
12572 @opindex mq-class
12573 Enable 'q' instruction alternatives.
12574 This is the default for @option{-Os}.
12576 @item -mRcq
12577 @opindex mRcq
12578 Enable Rcq constraint handling - most short code generation depends on this.
12579 This is the default.
12581 @item -mRcw
12582 @opindex mRcw
12583 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12584 This is the default.
12586 @item -msize-level=@var{level}
12587 @opindex msize-level
12588 Fine-tune size optimization with regards to instruction lengths and alignment.
12589 The recognized values for @var{level} are:
12590 @table @samp
12591 @item 0
12592 No size optimization.  This level is deprecated and treated like @samp{1}.
12594 @item 1
12595 Short instructions are used opportunistically.
12597 @item 2
12598 In addition, alignment of loops and of code after barriers are dropped.
12600 @item 3
12601 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12603 @end table
12605 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12606 the behavior when this is not set is equivalent to level @samp{1}.
12608 @item -mtune=@var{cpu}
12609 @opindex mtune
12610 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12611 by @option{-mcpu=}.
12613 Supported values for @var{cpu} are
12615 @table @samp
12616 @item ARC600
12617 Tune for ARC600 cpu.
12619 @item ARC601
12620 Tune for ARC601 cpu.
12622 @item ARC700
12623 Tune for ARC700 cpu with standard multiplier block.
12625 @item ARC700-xmac
12626 Tune for ARC700 cpu with XMAC block.
12628 @item ARC725D
12629 Tune for ARC725D cpu.
12631 @item ARC750D
12632 Tune for ARC750D cpu.
12634 @end table
12636 @item -mmultcost=@var{num}
12637 @opindex mmultcost
12638 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12639 normal instruction.
12641 @item -munalign-prob-threshold=@var{probability}
12642 @opindex munalign-prob-threshold
12643 Set probability threshold for unaligning branches.
12644 When tuning for @samp{ARC700} and optimizing for speed, branches without
12645 filled delay slot are preferably emitted unaligned and long, unless
12646 profiling indicates that the probability for the branch to be taken
12647 is below @var{probability}.  @xref{Cross-profiling}.
12648 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12650 @end table
12652 The following options are maintained for backward compatibility, but
12653 are now deprecated and will be removed in a future release:
12655 @c Deprecated options
12656 @table @gcctabopt
12658 @item -margonaut
12659 @opindex margonaut
12660 Obsolete FPX.
12662 @item -mbig-endian
12663 @opindex mbig-endian
12664 @itemx -EB
12665 @opindex EB
12666 Compile code for big endian targets.  Use of these options is now
12667 deprecated.  Users wanting big-endian code, should use the
12668 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12669 building the tool chain, for which big-endian is the default.
12671 @item -mlittle-endian
12672 @opindex mlittle-endian
12673 @itemx -EL
12674 @opindex EL
12675 Compile code for little endian targets.  Use of these options is now
12676 deprecated.  Users wanting little-endian code should use the
12677 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12678 building the tool chain, for which little-endian is the default.
12680 @item -mbarrel_shifter
12681 @opindex mbarrel_shifter
12682 Replaced by @samp{-mbarrel-shifter}
12684 @item -mdpfp_compact
12685 @opindex mdpfp_compact
12686 Replaced by @samp{-mdpfp-compact}
12688 @item -mdpfp_fast
12689 @opindex mdpfp_fast
12690 Replaced by @samp{-mdpfp-fast}
12692 @item -mdsp_packa
12693 @opindex mdsp_packa
12694 Replaced by @samp{-mdsp-packa}
12696 @item -mEA
12697 @opindex mEA
12698 Replaced by @samp{-mea}
12700 @item -mmac_24
12701 @opindex mmac_24
12702 Replaced by @samp{-mmac-24}
12704 @item -mmac_d16
12705 @opindex mmac_d16
12706 Replaced by @samp{-mmac-d16}
12708 @item -mspfp_compact
12709 @opindex mspfp_compact
12710 Replaced by @samp{-mspfp-compact}
12712 @item -mspfp_fast
12713 @opindex mspfp_fast
12714 Replaced by @samp{-mspfp-fast}
12716 @item -mtune=@var{cpu}
12717 @opindex mtune
12718 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12719 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12720 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12722 @item -multcost=@var{num}
12723 @opindex multcost
12724 Replaced by @samp{-mmultcost}.
12726 @end table
12728 @node ARM Options
12729 @subsection ARM Options
12730 @cindex ARM options
12732 These @samp{-m} options are defined for the ARM port:
12734 @table @gcctabopt
12735 @item -mabi=@var{name}
12736 @opindex mabi
12737 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12738 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12740 @item -mapcs-frame
12741 @opindex mapcs-frame
12742 Generate a stack frame that is compliant with the ARM Procedure Call
12743 Standard for all functions, even if this is not strictly necessary for
12744 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12745 with this option causes the stack frames not to be generated for
12746 leaf functions.  The default is @option{-mno-apcs-frame}.
12748 @item -mapcs
12749 @opindex mapcs
12750 This is a synonym for @option{-mapcs-frame}.
12752 @ignore
12753 @c not currently implemented
12754 @item -mapcs-stack-check
12755 @opindex mapcs-stack-check
12756 Generate code to check the amount of stack space available upon entry to
12757 every function (that actually uses some stack space).  If there is
12758 insufficient space available then either the function
12759 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12760 called, depending upon the amount of stack space required.  The runtime
12761 system is required to provide these functions.  The default is
12762 @option{-mno-apcs-stack-check}, since this produces smaller code.
12764 @c not currently implemented
12765 @item -mapcs-float
12766 @opindex mapcs-float
12767 Pass floating-point arguments using the floating-point registers.  This is
12768 one of the variants of the APCS@.  This option is recommended if the
12769 target hardware has a floating-point unit or if a lot of floating-point
12770 arithmetic is going to be performed by the code.  The default is
12771 @option{-mno-apcs-float}, since the size of integer-only code is 
12772 slightly increased if @option{-mapcs-float} is used.
12774 @c not currently implemented
12775 @item -mapcs-reentrant
12776 @opindex mapcs-reentrant
12777 Generate reentrant, position-independent code.  The default is
12778 @option{-mno-apcs-reentrant}.
12779 @end ignore
12781 @item -mthumb-interwork
12782 @opindex mthumb-interwork
12783 Generate code that supports calling between the ARM and Thumb
12784 instruction sets.  Without this option, on pre-v5 architectures, the
12785 two instruction sets cannot be reliably used inside one program.  The
12786 default is @option{-mno-thumb-interwork}, since slightly larger code
12787 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12788 configurations this option is meaningless.
12790 @item -mno-sched-prolog
12791 @opindex mno-sched-prolog
12792 Prevent the reordering of instructions in the function prologue, or the
12793 merging of those instruction with the instructions in the function's
12794 body.  This means that all functions start with a recognizable set
12795 of instructions (or in fact one of a choice from a small set of
12796 different function prologues), and this information can be used to
12797 locate the start of functions inside an executable piece of code.  The
12798 default is @option{-msched-prolog}.
12800 @item -mfloat-abi=@var{name}
12801 @opindex mfloat-abi
12802 Specifies which floating-point ABI to use.  Permissible values
12803 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12805 Specifying @samp{soft} causes GCC to generate output containing
12806 library calls for floating-point operations.
12807 @samp{softfp} allows the generation of code using hardware floating-point
12808 instructions, but still uses the soft-float calling conventions.
12809 @samp{hard} allows generation of floating-point instructions
12810 and uses FPU-specific calling conventions.
12812 The default depends on the specific target configuration.  Note that
12813 the hard-float and soft-float ABIs are not link-compatible; you must
12814 compile your entire program with the same ABI, and link with a
12815 compatible set of libraries.
12817 @item -mlittle-endian
12818 @opindex mlittle-endian
12819 Generate code for a processor running in little-endian mode.  This is
12820 the default for all standard configurations.
12822 @item -mbig-endian
12823 @opindex mbig-endian
12824 Generate code for a processor running in big-endian mode; the default is
12825 to compile code for a little-endian processor.
12827 @item -march=@var{name}
12828 @opindex march
12829 This specifies the name of the target ARM architecture.  GCC uses this
12830 name to determine what kind of instructions it can emit when generating
12831 assembly code.  This option can be used in conjunction with or instead
12832 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12833 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12834 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12835 @samp{armv6}, @samp{armv6j},
12836 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12837 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12838 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12839 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12841 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12842 extensions.
12844 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12845 architecture together with the optional CRC32 extensions.
12847 @option{-march=native} causes the compiler to auto-detect the architecture
12848 of the build computer.  At present, this feature is only supported on
12849 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12850 is unsuccessful the option has no effect.
12852 @item -mtune=@var{name}
12853 @opindex mtune
12854 This option specifies the name of the target ARM processor for
12855 which GCC should tune the performance of the code.
12856 For some ARM implementations better performance can be obtained by using
12857 this option.
12858 Permissible names are: @samp{arm2}, @samp{arm250},
12859 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12860 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12861 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12862 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12863 @samp{arm720},
12864 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12865 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12866 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12867 @samp{strongarm1110},
12868 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12869 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12870 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12871 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12872 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12873 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12874 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12875 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12876 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12877 @samp{cortex-r4},
12878 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12879 @samp{cortex-m4},
12880 @samp{cortex-m3},
12881 @samp{cortex-m1},
12882 @samp{cortex-m0},
12883 @samp{cortex-m0plus},
12884 @samp{cortex-m1.small-multiply},
12885 @samp{cortex-m0.small-multiply},
12886 @samp{cortex-m0plus.small-multiply},
12887 @samp{marvell-pj4},
12888 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12889 @samp{fa526}, @samp{fa626},
12890 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12892 Additionally, this option can specify that GCC should tune the performance
12893 of the code for a big.LITTLE system.  Permissible names are:
12894 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12896 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12897 performance for a blend of processors within architecture @var{arch}.
12898 The aim is to generate code that run well on the current most popular
12899 processors, balancing between optimizations that benefit some CPUs in the
12900 range, and avoiding performance pitfalls of other CPUs.  The effects of
12901 this option may change in future GCC versions as CPU models come and go.
12903 @option{-mtune=native} causes the compiler to auto-detect the CPU
12904 of the build computer.  At present, this feature is only supported on
12905 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12906 unsuccessful the option has no effect.
12908 @item -mcpu=@var{name}
12909 @opindex mcpu
12910 This specifies the name of the target ARM processor.  GCC uses this name
12911 to derive the name of the target ARM architecture (as if specified
12912 by @option{-march}) and the ARM processor type for which to tune for
12913 performance (as if specified by @option{-mtune}).  Where this option
12914 is used in conjunction with @option{-march} or @option{-mtune},
12915 those options take precedence over the appropriate part of this option.
12917 Permissible names for this option are the same as those for
12918 @option{-mtune}.
12920 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12921 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12922 See @option{-mtune} for more information.
12924 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12925 of the build computer.  At present, this feature is only supported on
12926 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12927 is unsuccessful the option has no effect.
12929 @item -mfpu=@var{name}
12930 @opindex mfpu
12931 This specifies what floating-point hardware (or hardware emulation) is
12932 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12933 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12934 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12935 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12936 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12937 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12939 If @option{-msoft-float} is specified this specifies the format of
12940 floating-point values.
12942 If the selected floating-point hardware includes the NEON extension
12943 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12944 operations are not generated by GCC's auto-vectorization pass unless
12945 @option{-funsafe-math-optimizations} is also specified.  This is
12946 because NEON hardware does not fully implement the IEEE 754 standard for
12947 floating-point arithmetic (in particular denormal values are treated as
12948 zero), so the use of NEON instructions may lead to a loss of precision.
12950 @item -mfp16-format=@var{name}
12951 @opindex mfp16-format
12952 Specify the format of the @code{__fp16} half-precision floating-point type.
12953 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12954 the default is @samp{none}, in which case the @code{__fp16} type is not
12955 defined.  @xref{Half-Precision}, for more information.
12957 @item -mstructure-size-boundary=@var{n}
12958 @opindex mstructure-size-boundary
12959 The sizes of all structures and unions are rounded up to a multiple
12960 of the number of bits set by this option.  Permissible values are 8, 32
12961 and 64.  The default value varies for different toolchains.  For the COFF
12962 targeted toolchain the default value is 8.  A value of 64 is only allowed
12963 if the underlying ABI supports it.
12965 Specifying a larger number can produce faster, more efficient code, but
12966 can also increase the size of the program.  Different values are potentially
12967 incompatible.  Code compiled with one value cannot necessarily expect to
12968 work with code or libraries compiled with another value, if they exchange
12969 information using structures or unions.
12971 @item -mabort-on-noreturn
12972 @opindex mabort-on-noreturn
12973 Generate a call to the function @code{abort} at the end of a
12974 @code{noreturn} function.  It is executed if the function tries to
12975 return.
12977 @item -mlong-calls
12978 @itemx -mno-long-calls
12979 @opindex mlong-calls
12980 @opindex mno-long-calls
12981 Tells the compiler to perform function calls by first loading the
12982 address of the function into a register and then performing a subroutine
12983 call on this register.  This switch is needed if the target function
12984 lies outside of the 64-megabyte addressing range of the offset-based
12985 version of subroutine call instruction.
12987 Even if this switch is enabled, not all function calls are turned
12988 into long calls.  The heuristic is that static functions, functions
12989 that have the @samp{short-call} attribute, functions that are inside
12990 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12991 definitions have already been compiled within the current compilation
12992 unit are not turned into long calls.  The exceptions to this rule are
12993 that weak function definitions, functions with the @samp{long-call}
12994 attribute or the @samp{section} attribute, and functions that are within
12995 the scope of a @samp{#pragma long_calls} directive are always
12996 turned into long calls.
12998 This feature is not enabled by default.  Specifying
12999 @option{-mno-long-calls} restores the default behavior, as does
13000 placing the function calls within the scope of a @samp{#pragma
13001 long_calls_off} directive.  Note these switches have no effect on how
13002 the compiler generates code to handle function calls via function
13003 pointers.
13005 @item -msingle-pic-base
13006 @opindex msingle-pic-base
13007 Treat the register used for PIC addressing as read-only, rather than
13008 loading it in the prologue for each function.  The runtime system is
13009 responsible for initializing this register with an appropriate value
13010 before execution begins.
13012 @item -mpic-register=@var{reg}
13013 @opindex mpic-register
13014 Specify the register to be used for PIC addressing.
13015 For standard PIC base case, the default will be any suitable register
13016 determined by compiler.  For single PIC base case, the default is
13017 @samp{R9} if target is EABI based or stack-checking is enabled,
13018 otherwise the default is @samp{R10}.
13020 @item -mpic-data-is-text-relative
13021 @opindex mpic-data-is-text-relative
13022 Assume that each data segments are relative to text segment at load time.
13023 Therefore, it permits addressing data using PC-relative operations.
13024 This option is on by default for targets other than VxWorks RTP.
13026 @item -mpoke-function-name
13027 @opindex mpoke-function-name
13028 Write the name of each function into the text section, directly
13029 preceding the function prologue.  The generated code is similar to this:
13031 @smallexample
13032      t0
13033          .ascii "arm_poke_function_name", 0
13034          .align
13035      t1
13036          .word 0xff000000 + (t1 - t0)
13037      arm_poke_function_name
13038          mov     ip, sp
13039          stmfd   sp!, @{fp, ip, lr, pc@}
13040          sub     fp, ip, #4
13041 @end smallexample
13043 When performing a stack backtrace, code can inspect the value of
13044 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13045 location @code{pc - 12} and the top 8 bits are set, then we know that
13046 there is a function name embedded immediately preceding this location
13047 and has length @code{((pc[-3]) & 0xff000000)}.
13049 @item -mthumb
13050 @itemx -marm
13051 @opindex marm
13052 @opindex mthumb
13054 Select between generating code that executes in ARM and Thumb
13055 states.  The default for most configurations is to generate code
13056 that executes in ARM state, but the default can be changed by
13057 configuring GCC with the @option{--with-mode=}@var{state}
13058 configure option.
13060 @item -mtpcs-frame
13061 @opindex mtpcs-frame
13062 Generate a stack frame that is compliant with the Thumb Procedure Call
13063 Standard for all non-leaf functions.  (A leaf function is one that does
13064 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13066 @item -mtpcs-leaf-frame
13067 @opindex mtpcs-leaf-frame
13068 Generate a stack frame that is compliant with the Thumb Procedure Call
13069 Standard for all leaf functions.  (A leaf function is one that does
13070 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13072 @item -mcallee-super-interworking
13073 @opindex mcallee-super-interworking
13074 Gives all externally visible functions in the file being compiled an ARM
13075 instruction set header which switches to Thumb mode before executing the
13076 rest of the function.  This allows these functions to be called from
13077 non-interworking code.  This option is not valid in AAPCS configurations
13078 because interworking is enabled by default.
13080 @item -mcaller-super-interworking
13081 @opindex mcaller-super-interworking
13082 Allows calls via function pointers (including virtual functions) to
13083 execute correctly regardless of whether the target code has been
13084 compiled for interworking or not.  There is a small overhead in the cost
13085 of executing a function pointer if this option is enabled.  This option
13086 is not valid in AAPCS configurations because interworking is enabled
13087 by default.
13089 @item -mtp=@var{name}
13090 @opindex mtp
13091 Specify the access model for the thread local storage pointer.  The valid
13092 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
13093 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
13094 (supported in the arm6k architecture), and @option{auto}, which uses the
13095 best available method for the selected processor.  The default setting is
13096 @option{auto}.
13098 @item -mtls-dialect=@var{dialect}
13099 @opindex mtls-dialect
13100 Specify the dialect to use for accessing thread local storage.  Two
13101 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13102 @samp{gnu} dialect selects the original GNU scheme for supporting
13103 local and global dynamic TLS models.  The @samp{gnu2} dialect
13104 selects the GNU descriptor scheme, which provides better performance
13105 for shared libraries.  The GNU descriptor scheme is compatible with
13106 the original scheme, but does require new assembler, linker and
13107 library support.  Initial and local exec TLS models are unaffected by
13108 this option and always use the original scheme.
13110 @item -mword-relocations
13111 @opindex mword-relocations
13112 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13113 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13114 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13115 is specified.
13117 @item -mfix-cortex-m3-ldrd
13118 @opindex mfix-cortex-m3-ldrd
13119 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13120 with overlapping destination and base registers are used.  This option avoids
13121 generating these instructions.  This option is enabled by default when
13122 @option{-mcpu=cortex-m3} is specified.
13124 @item -munaligned-access
13125 @itemx -mno-unaligned-access
13126 @opindex munaligned-access
13127 @opindex mno-unaligned-access
13128 Enables (or disables) reading and writing of 16- and 32- bit values
13129 from addresses that are not 16- or 32- bit aligned.  By default
13130 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13131 architectures, and enabled for all other architectures.  If unaligned
13132 access is not enabled then words in packed data structures will be
13133 accessed a byte at a time.
13135 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
13136 generated object file to either true or false, depending upon the
13137 setting of this option.  If unaligned access is enabled then the
13138 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
13139 defined.
13141 @item -mneon-for-64bits
13142 @opindex mneon-for-64bits
13143 Enables using Neon to handle scalar 64-bits operations. This is
13144 disabled by default since the cost of moving data from core registers
13145 to Neon is high.
13147 @item -mslow-flash-data
13148 @opindex mslow-flash-data
13149 Assume loading data from flash is slower than fetching instruction.
13150 Therefore literal load is minimized for better performance.
13151 This option is only supported when compiling for ARMv7 M-profile and
13152 off by default.
13154 @item -masm-syntax-unified
13155 @opindex masm-syntax-unified
13156 Assume inline assembler is using unified asm syntax.  The default is
13157 currently off which implies divided syntax.  Currently this option is
13158 available only for Thumb1 and has no effect on ARM state and Thumb2.
13159 However, this may change in future releases of GCC.  Divided syntax
13160 should be considered deprecated.
13162 @item -mrestrict-it
13163 @opindex mrestrict-it
13164 Restricts generation of IT blocks to conform to the rules of ARMv8.
13165 IT blocks can only contain a single 16-bit instruction from a select
13166 set of instructions. This option is on by default for ARMv8 Thumb mode.
13167 @end table
13169 @node AVR Options
13170 @subsection AVR Options
13171 @cindex AVR Options
13173 These options are defined for AVR implementations:
13175 @table @gcctabopt
13176 @item -mmcu=@var{mcu}
13177 @opindex mmcu
13178 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13180 The default for this option is@tie{}@code{avr2}.
13182 GCC supports the following AVR devices and ISAs:
13184 @include avr-mmcu.texi
13186 @item -maccumulate-args
13187 @opindex maccumulate-args
13188 Accumulate outgoing function arguments and acquire/release the needed
13189 stack space for outgoing function arguments once in function
13190 prologue/epilogue.  Without this option, outgoing arguments are pushed
13191 before calling a function and popped afterwards.
13193 Popping the arguments after the function call can be expensive on
13194 AVR so that accumulating the stack space might lead to smaller
13195 executables because arguments need not to be removed from the
13196 stack after such a function call.
13198 This option can lead to reduced code size for functions that perform
13199 several calls to functions that get their arguments on the stack like
13200 calls to printf-like functions.
13202 @item -mbranch-cost=@var{cost}
13203 @opindex mbranch-cost
13204 Set the branch costs for conditional branch instructions to
13205 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13206 integers. The default branch cost is 0.
13208 @item -mcall-prologues
13209 @opindex mcall-prologues
13210 Functions prologues/epilogues are expanded as calls to appropriate
13211 subroutines.  Code size is smaller.
13213 @item -mint8
13214 @opindex mint8
13215 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13216 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13217 and @code{long long} is 4 bytes.  Please note that this option does not
13218 conform to the C standards, but it results in smaller code
13219 size.
13221 @item -mno-interrupts
13222 @opindex mno-interrupts
13223 Generated code is not compatible with hardware interrupts.
13224 Code size is smaller.
13226 @item -mrelax
13227 @opindex mrelax
13228 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13229 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13230 Setting @code{-mrelax} just adds the @code{--relax} option to the
13231 linker command line when the linker is called.
13233 Jump relaxing is performed by the linker because jump offsets are not
13234 known before code is located. Therefore, the assembler code generated by the
13235 compiler is the same, but the instructions in the executable may
13236 differ from instructions in the assembler code.
13238 Relaxing must be turned on if linker stubs are needed, see the
13239 section on @code{EIND} and linker stubs below.
13241 @item -msp8
13242 @opindex msp8
13243 Treat the stack pointer register as an 8-bit register,
13244 i.e.@: assume the high byte of the stack pointer is zero.
13245 In general, you don't need to set this option by hand.
13247 This option is used internally by the compiler to select and
13248 build multilibs for architectures @code{avr2} and @code{avr25}.
13249 These architectures mix devices with and without @code{SPH}.
13250 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13251 the compiler driver will add or remove this option from the compiler
13252 proper's command line, because the compiler then knows if the device
13253 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13254 register or not.
13256 @item -mstrict-X
13257 @opindex mstrict-X
13258 Use address register @code{X} in a way proposed by the hardware.  This means
13259 that @code{X} is only used in indirect, post-increment or
13260 pre-decrement addressing.
13262 Without this option, the @code{X} register may be used in the same way
13263 as @code{Y} or @code{Z} which then is emulated by additional
13264 instructions.  
13265 For example, loading a value with @code{X+const} addressing with a
13266 small non-negative @code{const < 64} to a register @var{Rn} is
13267 performed as
13269 @example
13270 adiw r26, const   ; X += const
13271 ld   @var{Rn}, X        ; @var{Rn} = *X
13272 sbiw r26, const   ; X -= const
13273 @end example
13275 @item -mtiny-stack
13276 @opindex mtiny-stack
13277 Only change the lower 8@tie{}bits of the stack pointer.
13279 @item -Waddr-space-convert
13280 @opindex Waddr-space-convert
13281 Warn about conversions between address spaces in the case where the
13282 resulting address space is not contained in the incoming address space.
13283 @end table
13285 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13286 @cindex @code{EIND}
13287 Pointers in the implementation are 16@tie{}bits wide.
13288 The address of a function or label is represented as word address so
13289 that indirect jumps and calls can target any code address in the
13290 range of 64@tie{}Ki words.
13292 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13293 bytes of program memory space, there is a special function register called
13294 @code{EIND} that serves as most significant part of the target address
13295 when @code{EICALL} or @code{EIJMP} instructions are used.
13297 Indirect jumps and calls on these devices are handled as follows by
13298 the compiler and are subject to some limitations:
13300 @itemize @bullet
13302 @item
13303 The compiler never sets @code{EIND}.
13305 @item
13306 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13307 instructions or might read @code{EIND} directly in order to emulate an
13308 indirect call/jump by means of a @code{RET} instruction.
13310 @item
13311 The compiler assumes that @code{EIND} never changes during the startup
13312 code or during the application. In particular, @code{EIND} is not
13313 saved/restored in function or interrupt service routine
13314 prologue/epilogue.
13316 @item
13317 For indirect calls to functions and computed goto, the linker
13318 generates @emph{stubs}. Stubs are jump pads sometimes also called
13319 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13320 The stub contains a direct jump to the desired address.
13322 @item
13323 Linker relaxation must be turned on so that the linker will generate
13324 the stubs correctly an all situaltion. See the compiler option
13325 @code{-mrelax} and the linler option @code{--relax}.
13326 There are corner cases where the linker is supposed to generate stubs
13327 but aborts without relaxation and without a helpful error message.
13329 @item
13330 The default linker script is arranged for code with @code{EIND = 0}.
13331 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13332 linker script has to be used in order to place the sections whose
13333 name start with @code{.trampolines} into the segment where @code{EIND}
13334 points to.
13336 @item
13337 The startup code from libgcc never sets @code{EIND}.
13338 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13339 For the impact of AVR-LibC on @code{EIND}, see the
13340 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13342 @item
13343 It is legitimate for user-specific startup code to set up @code{EIND}
13344 early, for example by means of initialization code located in
13345 section @code{.init3}. Such code runs prior to general startup code
13346 that initializes RAM and calls constructors, but after the bit
13347 of startup code from AVR-LibC that sets @code{EIND} to the segment
13348 where the vector table is located.
13349 @example
13350 #include <avr/io.h>
13352 static void
13353 __attribute__((section(".init3"),naked,used,no_instrument_function))
13354 init3_set_eind (void)
13356   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13357                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13359 @end example
13361 @noindent
13362 The @code{__trampolines_start} symbol is defined in the linker script.
13364 @item
13365 Stubs are generated automatically by the linker if
13366 the following two conditions are met:
13367 @itemize @minus
13369 @item The address of a label is taken by means of the @code{gs} modifier
13370 (short for @emph{generate stubs}) like so:
13371 @example
13372 LDI r24, lo8(gs(@var{func}))
13373 LDI r25, hi8(gs(@var{func}))
13374 @end example
13375 @item The final location of that label is in a code segment
13376 @emph{outside} the segment where the stubs are located.
13377 @end itemize
13379 @item
13380 The compiler emits such @code{gs} modifiers for code labels in the
13381 following situations:
13382 @itemize @minus
13383 @item Taking address of a function or code label.
13384 @item Computed goto.
13385 @item If prologue-save function is used, see @option{-mcall-prologues}
13386 command-line option.
13387 @item Switch/case dispatch tables. If you do not want such dispatch
13388 tables you can specify the @option{-fno-jump-tables} command-line option.
13389 @item C and C++ constructors/destructors called during startup/shutdown.
13390 @item If the tools hit a @code{gs()} modifier explained above.
13391 @end itemize
13393 @item
13394 Jumping to non-symbolic addresses like so is @emph{not} supported:
13396 @example
13397 int main (void)
13399     /* Call function at word address 0x2 */
13400     return ((int(*)(void)) 0x2)();
13402 @end example
13404 Instead, a stub has to be set up, i.e.@: the function has to be called
13405 through a symbol (@code{func_4} in the example):
13407 @example
13408 int main (void)
13410     extern int func_4 (void);
13412     /* Call function at byte address 0x4 */
13413     return func_4();
13415 @end example
13417 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13418 Alternatively, @code{func_4} can be defined in the linker script.
13419 @end itemize
13421 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13422 @cindex @code{RAMPD}
13423 @cindex @code{RAMPX}
13424 @cindex @code{RAMPY}
13425 @cindex @code{RAMPZ}
13426 Some AVR devices support memories larger than the 64@tie{}KiB range
13427 that can be accessed with 16-bit pointers.  To access memory locations
13428 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13429 register is used as high part of the address:
13430 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13431 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13432 register, respectively, to get a wide address. Similarly,
13433 @code{RAMPD} is used together with direct addressing.
13435 @itemize
13436 @item
13437 The startup code initializes the @code{RAMP} special function
13438 registers with zero.
13440 @item
13441 If a @ref{AVR Named Address Spaces,named address space} other than
13442 generic or @code{__flash} is used, then @code{RAMPZ} is set
13443 as needed before the operation.
13445 @item
13446 If the device supports RAM larger than 64@tie{}KiB and the compiler
13447 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13448 is reset to zero after the operation.
13450 @item
13451 If the device comes with a specific @code{RAMP} register, the ISR
13452 prologue/epilogue saves/restores that SFR and initializes it with
13453 zero in case the ISR code might (implicitly) use it.
13455 @item
13456 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13457 If you use inline assembler to read from locations outside the
13458 16-bit address range and change one of the @code{RAMP} registers,
13459 you must reset it to zero after the access.
13461 @end itemize
13463 @subsubsection AVR Built-in Macros
13465 GCC defines several built-in macros so that the user code can test
13466 for the presence or absence of features.  Almost any of the following
13467 built-in macros are deduced from device capabilities and thus
13468 triggered by the @code{-mmcu=} command-line option.
13470 For even more AVR-specific built-in macros see
13471 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13473 @table @code
13475 @item __AVR_ARCH__
13476 Build-in macro that resolves to a decimal number that identifies the
13477 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13478 Possible values are:
13480 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13481 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13482 @code{105}, @code{106}, @code{107}
13484 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13485 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13486 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13487 @code{avrxmega6}, @code{avrxmega7}, respectively.
13488 If @var{mcu} specifies a device, this built-in macro is set
13489 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13490 defined to @code{4}.
13492 @item __AVR_@var{Device}__
13493 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13494 the device's name. For example, @code{-mmcu=atmega8} defines the
13495 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13496 @code{__AVR_ATtiny261A__}, etc.
13498 The built-in macros' names follow
13499 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13500 the device name as from the AVR user manual. The difference between
13501 @var{Device} in the built-in macro and @var{device} in
13502 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13504 If @var{device} is not a device but only a core architecture like
13505 @code{avr51}, this macro will not be defined.
13507 @item   __AVR_DEVICE_NAME__
13508 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13509 the device's name. For example, with @code{-mmcu=atmega8} the macro
13510 will be defined to @code{atmega8}.
13512 If @var{device} is not a device but only a core architecture like
13513 @code{avr51}, this macro will not be defined.
13515 @item __AVR_XMEGA__
13516 The device / architecture belongs to the XMEGA family of devices.
13518 @item __AVR_HAVE_ELPM__
13519 The device has the the @code{ELPM} instruction.
13521 @item __AVR_HAVE_ELPMX__
13522 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13523 R@var{n},Z+} instructions.
13525 @item __AVR_HAVE_MOVW__
13526 The device has the @code{MOVW} instruction to perform 16-bit
13527 register-register moves.
13529 @item __AVR_HAVE_LPMX__
13530 The device has the @code{LPM R@var{n},Z} and
13531 @code{LPM R@var{n},Z+} instructions.
13533 @item __AVR_HAVE_MUL__
13534 The device has a hardware multiplier. 
13536 @item __AVR_HAVE_JMP_CALL__
13537 The device has the @code{JMP} and @code{CALL} instructions.
13538 This is the case for devices with at least 16@tie{}KiB of program
13539 memory.
13541 @item __AVR_HAVE_EIJMP_EICALL__
13542 @itemx __AVR_3_BYTE_PC__
13543 The device has the @code{EIJMP} and @code{EICALL} instructions.
13544 This is the case for devices with more than 128@tie{}KiB of program memory.
13545 This also means that the program counter
13546 (PC) is 3@tie{}bytes wide.
13548 @item __AVR_2_BYTE_PC__
13549 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13550 with up to 128@tie{}KiB of program memory.
13552 @item __AVR_HAVE_8BIT_SP__
13553 @itemx __AVR_HAVE_16BIT_SP__
13554 The stack pointer (SP) register is treated as 8-bit respectively
13555 16-bit register by the compiler.
13556 The definition of these macros is affected by @code{-mtiny-stack}.
13558 @item __AVR_HAVE_SPH__
13559 @itemx __AVR_SP8__
13560 The device has the SPH (high part of stack pointer) special function
13561 register or has an 8-bit stack pointer, respectively.
13562 The definition of these macros is affected by @code{-mmcu=} and
13563 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13564 by @code{-msp8}.
13566 @item __AVR_HAVE_RAMPD__
13567 @itemx __AVR_HAVE_RAMPX__
13568 @itemx __AVR_HAVE_RAMPY__
13569 @itemx __AVR_HAVE_RAMPZ__
13570 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13571 @code{RAMPZ} special function register, respectively.
13573 @item __NO_INTERRUPTS__
13574 This macro reflects the @code{-mno-interrupts} command line option.
13576 @item __AVR_ERRATA_SKIP__
13577 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13578 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13579 instructions because of a hardware erratum.  Skip instructions are
13580 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13581 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13582 set.
13584 @item __AVR_ISA_RMW__
13585 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13587 @item __AVR_SFR_OFFSET__=@var{offset}
13588 Instructions that can address I/O special function registers directly
13589 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13590 address as if addressed by an instruction to access RAM like @code{LD}
13591 or @code{STS}. This offset depends on the device architecture and has
13592 to be subtracted from the RAM address in order to get the
13593 respective I/O@tie{}address.
13595 @item __WITH_AVRLIBC__
13596 The compiler is configured to be used together with AVR-Libc.
13597 See the @code{--with-avrlibc} configure option.
13599 @end table
13601 @node Blackfin Options
13602 @subsection Blackfin Options
13603 @cindex Blackfin Options
13605 @table @gcctabopt
13606 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13607 @opindex mcpu=
13608 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13609 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13610 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13611 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13612 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13613 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13614 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13615 @samp{bf561}, @samp{bf592}.
13617 The optional @var{sirevision} specifies the silicon revision of the target
13618 Blackfin processor.  Any workarounds available for the targeted silicon revision
13619 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13620 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13621 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13622 hexadecimal digits representing the major and minor numbers in the silicon
13623 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13624 is not defined.  If @var{sirevision} is @samp{any}, the
13625 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13626 If this optional @var{sirevision} is not used, GCC assumes the latest known
13627 silicon revision of the targeted Blackfin processor.
13629 GCC defines a preprocessor macro for the specified @var{cpu}.
13630 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13631 provided by libgloss to be linked in if @option{-msim} is not given.
13633 Without this option, @samp{bf532} is used as the processor by default.
13635 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13636 only the preprocessor macro is defined.
13638 @item -msim
13639 @opindex msim
13640 Specifies that the program will be run on the simulator.  This causes
13641 the simulator BSP provided by libgloss to be linked in.  This option
13642 has effect only for @samp{bfin-elf} toolchain.
13643 Certain other options, such as @option{-mid-shared-library} and
13644 @option{-mfdpic}, imply @option{-msim}.
13646 @item -momit-leaf-frame-pointer
13647 @opindex momit-leaf-frame-pointer
13648 Don't keep the frame pointer in a register for leaf functions.  This
13649 avoids the instructions to save, set up and restore frame pointers and
13650 makes an extra register available in leaf functions.  The option
13651 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13652 which might make debugging harder.
13654 @item -mspecld-anomaly
13655 @opindex mspecld-anomaly
13656 When enabled, the compiler ensures that the generated code does not
13657 contain speculative loads after jump instructions. If this option is used,
13658 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13660 @item -mno-specld-anomaly
13661 @opindex mno-specld-anomaly
13662 Don't generate extra code to prevent speculative loads from occurring.
13664 @item -mcsync-anomaly
13665 @opindex mcsync-anomaly
13666 When enabled, the compiler ensures that the generated code does not
13667 contain CSYNC or SSYNC instructions too soon after conditional branches.
13668 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13670 @item -mno-csync-anomaly
13671 @opindex mno-csync-anomaly
13672 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13673 occurring too soon after a conditional branch.
13675 @item -mlow-64k
13676 @opindex mlow-64k
13677 When enabled, the compiler is free to take advantage of the knowledge that
13678 the entire program fits into the low 64k of memory.
13680 @item -mno-low-64k
13681 @opindex mno-low-64k
13682 Assume that the program is arbitrarily large.  This is the default.
13684 @item -mstack-check-l1
13685 @opindex mstack-check-l1
13686 Do stack checking using information placed into L1 scratchpad memory by the
13687 uClinux kernel.
13689 @item -mid-shared-library
13690 @opindex mid-shared-library
13691 Generate code that supports shared libraries via the library ID method.
13692 This allows for execute in place and shared libraries in an environment
13693 without virtual memory management.  This option implies @option{-fPIC}.
13694 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13696 @item -mno-id-shared-library
13697 @opindex mno-id-shared-library
13698 Generate code that doesn't assume ID-based shared libraries are being used.
13699 This is the default.
13701 @item -mleaf-id-shared-library
13702 @opindex mleaf-id-shared-library
13703 Generate code that supports shared libraries via the library ID method,
13704 but assumes that this library or executable won't link against any other
13705 ID shared libraries.  That allows the compiler to use faster code for jumps
13706 and calls.
13708 @item -mno-leaf-id-shared-library
13709 @opindex mno-leaf-id-shared-library
13710 Do not assume that the code being compiled won't link against any ID shared
13711 libraries.  Slower code is generated for jump and call insns.
13713 @item -mshared-library-id=n
13714 @opindex mshared-library-id
13715 Specifies the identification number of the ID-based shared library being
13716 compiled.  Specifying a value of 0 generates more compact code; specifying
13717 other values forces the allocation of that number to the current
13718 library but is no more space- or time-efficient than omitting this option.
13720 @item -msep-data
13721 @opindex msep-data
13722 Generate code that allows the data segment to be located in a different
13723 area of memory from the text segment.  This allows for execute in place in
13724 an environment without virtual memory management by eliminating relocations
13725 against the text section.
13727 @item -mno-sep-data
13728 @opindex mno-sep-data
13729 Generate code that assumes that the data segment follows the text segment.
13730 This is the default.
13732 @item -mlong-calls
13733 @itemx -mno-long-calls
13734 @opindex mlong-calls
13735 @opindex mno-long-calls
13736 Tells the compiler to perform function calls by first loading the
13737 address of the function into a register and then performing a subroutine
13738 call on this register.  This switch is needed if the target function
13739 lies outside of the 24-bit addressing range of the offset-based
13740 version of subroutine call instruction.
13742 This feature is not enabled by default.  Specifying
13743 @option{-mno-long-calls} restores the default behavior.  Note these
13744 switches have no effect on how the compiler generates code to handle
13745 function calls via function pointers.
13747 @item -mfast-fp
13748 @opindex mfast-fp
13749 Link with the fast floating-point library. This library relaxes some of
13750 the IEEE floating-point standard's rules for checking inputs against
13751 Not-a-Number (NAN), in the interest of performance.
13753 @item -minline-plt
13754 @opindex minline-plt
13755 Enable inlining of PLT entries in function calls to functions that are
13756 not known to bind locally.  It has no effect without @option{-mfdpic}.
13758 @item -mmulticore
13759 @opindex mmulticore
13760 Build a standalone application for multicore Blackfin processors. 
13761 This option causes proper start files and link scripts supporting 
13762 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13763 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13765 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13766 selects the one-application-per-core programming model.  Without
13767 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13768 programming model is used. In this model, the main function of Core B
13769 should be named as @code{coreb_main}.
13771 If this option is not used, the single-core application programming
13772 model is used.
13774 @item -mcorea
13775 @opindex mcorea
13776 Build a standalone application for Core A of BF561 when using
13777 the one-application-per-core programming model. Proper start files
13778 and link scripts are used to support Core A, and the macro
13779 @code{__BFIN_COREA} is defined.
13780 This option can only be used in conjunction with @option{-mmulticore}.
13782 @item -mcoreb
13783 @opindex mcoreb
13784 Build a standalone application for Core B of BF561 when using
13785 the one-application-per-core programming model. Proper start files
13786 and link scripts are used to support Core B, and the macro
13787 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13788 should be used instead of @code{main}. 
13789 This option can only be used in conjunction with @option{-mmulticore}.
13791 @item -msdram
13792 @opindex msdram
13793 Build a standalone application for SDRAM. Proper start files and
13794 link scripts are used to put the application into SDRAM, and the macro
13795 @code{__BFIN_SDRAM} is defined.
13796 The loader should initialize SDRAM before loading the application.
13798 @item -micplb
13799 @opindex micplb
13800 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13801 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13802 are enabled; for standalone applications the default is off.
13803 @end table
13805 @node C6X Options
13806 @subsection C6X Options
13807 @cindex C6X Options
13809 @table @gcctabopt
13810 @item -march=@var{name}
13811 @opindex march
13812 This specifies the name of the target architecture.  GCC uses this
13813 name to determine what kind of instructions it can emit when generating
13814 assembly code.  Permissible names are: @samp{c62x},
13815 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13817 @item -mbig-endian
13818 @opindex mbig-endian
13819 Generate code for a big-endian target.
13821 @item -mlittle-endian
13822 @opindex mlittle-endian
13823 Generate code for a little-endian target.  This is the default.
13825 @item -msim
13826 @opindex msim
13827 Choose startup files and linker script suitable for the simulator.
13829 @item -msdata=default
13830 @opindex msdata=default
13831 Put small global and static data in the @samp{.neardata} section,
13832 which is pointed to by register @code{B14}.  Put small uninitialized
13833 global and static data in the @samp{.bss} section, which is adjacent
13834 to the @samp{.neardata} section.  Put small read-only data into the
13835 @samp{.rodata} section.  The corresponding sections used for large
13836 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13838 @item -msdata=all
13839 @opindex msdata=all
13840 Put all data, not just small objects, into the sections reserved for
13841 small data, and use addressing relative to the @code{B14} register to
13842 access them.
13844 @item -msdata=none
13845 @opindex msdata=none
13846 Make no use of the sections reserved for small data, and use absolute
13847 addresses to access all data.  Put all initialized global and static
13848 data in the @samp{.fardata} section, and all uninitialized data in the
13849 @samp{.far} section.  Put all constant data into the @samp{.const}
13850 section.
13851 @end table
13853 @node CRIS Options
13854 @subsection CRIS Options
13855 @cindex CRIS Options
13857 These options are defined specifically for the CRIS ports.
13859 @table @gcctabopt
13860 @item -march=@var{architecture-type}
13861 @itemx -mcpu=@var{architecture-type}
13862 @opindex march
13863 @opindex mcpu
13864 Generate code for the specified architecture.  The choices for
13865 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13866 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13867 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13868 @samp{v10}.
13870 @item -mtune=@var{architecture-type}
13871 @opindex mtune
13872 Tune to @var{architecture-type} everything applicable about the generated
13873 code, except for the ABI and the set of available instructions.  The
13874 choices for @var{architecture-type} are the same as for
13875 @option{-march=@var{architecture-type}}.
13877 @item -mmax-stack-frame=@var{n}
13878 @opindex mmax-stack-frame
13879 Warn when the stack frame of a function exceeds @var{n} bytes.
13881 @item -metrax4
13882 @itemx -metrax100
13883 @opindex metrax4
13884 @opindex metrax100
13885 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13886 @option{-march=v3} and @option{-march=v8} respectively.
13888 @item -mmul-bug-workaround
13889 @itemx -mno-mul-bug-workaround
13890 @opindex mmul-bug-workaround
13891 @opindex mno-mul-bug-workaround
13892 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13893 models where it applies.  This option is active by default.
13895 @item -mpdebug
13896 @opindex mpdebug
13897 Enable CRIS-specific verbose debug-related information in the assembly
13898 code.  This option also has the effect of turning off the @samp{#NO_APP}
13899 formatted-code indicator to the assembler at the beginning of the
13900 assembly file.
13902 @item -mcc-init
13903 @opindex mcc-init
13904 Do not use condition-code results from previous instruction; always emit
13905 compare and test instructions before use of condition codes.
13907 @item -mno-side-effects
13908 @opindex mno-side-effects
13909 Do not emit instructions with side effects in addressing modes other than
13910 post-increment.
13912 @item -mstack-align
13913 @itemx -mno-stack-align
13914 @itemx -mdata-align
13915 @itemx -mno-data-align
13916 @itemx -mconst-align
13917 @itemx -mno-const-align
13918 @opindex mstack-align
13919 @opindex mno-stack-align
13920 @opindex mdata-align
13921 @opindex mno-data-align
13922 @opindex mconst-align
13923 @opindex mno-const-align
13924 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13925 stack frame, individual data and constants to be aligned for the maximum
13926 single data access size for the chosen CPU model.  The default is to
13927 arrange for 32-bit alignment.  ABI details such as structure layout are
13928 not affected by these options.
13930 @item -m32-bit
13931 @itemx -m16-bit
13932 @itemx -m8-bit
13933 @opindex m32-bit
13934 @opindex m16-bit
13935 @opindex m8-bit
13936 Similar to the stack- data- and const-align options above, these options
13937 arrange for stack frame, writable data and constants to all be 32-bit,
13938 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13940 @item -mno-prologue-epilogue
13941 @itemx -mprologue-epilogue
13942 @opindex mno-prologue-epilogue
13943 @opindex mprologue-epilogue
13944 With @option{-mno-prologue-epilogue}, the normal function prologue and
13945 epilogue which set up the stack frame are omitted and no return
13946 instructions or return sequences are generated in the code.  Use this
13947 option only together with visual inspection of the compiled code: no
13948 warnings or errors are generated when call-saved registers must be saved,
13949 or storage for local variables needs to be allocated.
13951 @item -mno-gotplt
13952 @itemx -mgotplt
13953 @opindex mno-gotplt
13954 @opindex mgotplt
13955 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13956 instruction sequences that load addresses for functions from the PLT part
13957 of the GOT rather than (traditional on other architectures) calls to the
13958 PLT@.  The default is @option{-mgotplt}.
13960 @item -melf
13961 @opindex melf
13962 Legacy no-op option only recognized with the cris-axis-elf and
13963 cris-axis-linux-gnu targets.
13965 @item -mlinux
13966 @opindex mlinux
13967 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13969 @item -sim
13970 @opindex sim
13971 This option, recognized for the cris-axis-elf, arranges
13972 to link with input-output functions from a simulator library.  Code,
13973 initialized data and zero-initialized data are allocated consecutively.
13975 @item -sim2
13976 @opindex sim2
13977 Like @option{-sim}, but pass linker options to locate initialized data at
13978 0x40000000 and zero-initialized data at 0x80000000.
13979 @end table
13981 @node CR16 Options
13982 @subsection CR16 Options
13983 @cindex CR16 Options
13985 These options are defined specifically for the CR16 ports.
13987 @table @gcctabopt
13989 @item -mmac
13990 @opindex mmac
13991 Enable the use of multiply-accumulate instructions. Disabled by default.
13993 @item -mcr16cplus
13994 @itemx -mcr16c
13995 @opindex mcr16cplus
13996 @opindex mcr16c
13997 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13998 is default.
14000 @item -msim
14001 @opindex msim
14002 Links the library libsim.a which is in compatible with simulator. Applicable
14003 to ELF compiler only.
14005 @item -mint32
14006 @opindex mint32
14007 Choose integer type as 32-bit wide.
14009 @item -mbit-ops
14010 @opindex mbit-ops
14011 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
14013 @item -mdata-model=@var{model}
14014 @opindex mdata-model
14015 Choose a data model. The choices for @var{model} are @samp{near},
14016 @samp{far} or @samp{medium}. @samp{medium} is default.
14017 However, @samp{far} is not valid with @option{-mcr16c}, as the
14018 CR16C architecture does not support the far data model.
14019 @end table
14021 @node Darwin Options
14022 @subsection Darwin Options
14023 @cindex Darwin options
14025 These options are defined for all architectures running the Darwin operating
14026 system.
14028 FSF GCC on Darwin does not create ``fat'' object files; it creates
14029 an object file for the single architecture that GCC was built to
14030 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14031 @option{-arch} options are used; it does so by running the compiler or
14032 linker multiple times and joining the results together with
14033 @file{lipo}.
14035 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14036 @samp{i686}) is determined by the flags that specify the ISA
14037 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14038 @option{-force_cpusubtype_ALL} option can be used to override this.
14040 The Darwin tools vary in their behavior when presented with an ISA
14041 mismatch.  The assembler, @file{as}, only permits instructions to
14042 be used that are valid for the subtype of the file it is generating,
14043 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14044 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14045 and prints an error if asked to create a shared library with a less
14046 restrictive subtype than its input files (for instance, trying to put
14047 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14048 for executables, @command{ld}, quietly gives the executable the most
14049 restrictive subtype of any of its input files.
14051 @table @gcctabopt
14052 @item -F@var{dir}
14053 @opindex F
14054 Add the framework directory @var{dir} to the head of the list of
14055 directories to be searched for header files.  These directories are
14056 interleaved with those specified by @option{-I} options and are
14057 scanned in a left-to-right order.
14059 A framework directory is a directory with frameworks in it.  A
14060 framework is a directory with a @file{Headers} and/or
14061 @file{PrivateHeaders} directory contained directly in it that ends
14062 in @file{.framework}.  The name of a framework is the name of this
14063 directory excluding the @file{.framework}.  Headers associated with
14064 the framework are found in one of those two directories, with
14065 @file{Headers} being searched first.  A subframework is a framework
14066 directory that is in a framework's @file{Frameworks} directory.
14067 Includes of subframework headers can only appear in a header of a
14068 framework that contains the subframework, or in a sibling subframework
14069 header.  Two subframeworks are siblings if they occur in the same
14070 framework.  A subframework should not have the same name as a
14071 framework; a warning is issued if this is violated.  Currently a
14072 subframework cannot have subframeworks; in the future, the mechanism
14073 may be extended to support this.  The standard frameworks can be found
14074 in @file{/System/Library/Frameworks} and
14075 @file{/Library/Frameworks}.  An example include looks like
14076 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14077 the name of the framework and @file{header.h} is found in the
14078 @file{PrivateHeaders} or @file{Headers} directory.
14080 @item -iframework@var{dir}
14081 @opindex iframework
14082 Like @option{-F} except the directory is a treated as a system
14083 directory.  The main difference between this @option{-iframework} and
14084 @option{-F} is that with @option{-iframework} the compiler does not
14085 warn about constructs contained within header files found via
14086 @var{dir}.  This option is valid only for the C family of languages.
14088 @item -gused
14089 @opindex gused
14090 Emit debugging information for symbols that are used.  For stabs
14091 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14092 This is by default ON@.
14094 @item -gfull
14095 @opindex gfull
14096 Emit debugging information for all symbols and types.
14098 @item -mmacosx-version-min=@var{version}
14099 The earliest version of MacOS X that this executable will run on
14100 is @var{version}.  Typical values of @var{version} include @code{10.1},
14101 @code{10.2}, and @code{10.3.9}.
14103 If the compiler was built to use the system's headers by default,
14104 then the default for this option is the system version on which the
14105 compiler is running, otherwise the default is to make choices that
14106 are compatible with as many systems and code bases as possible.
14108 @item -mkernel
14109 @opindex mkernel
14110 Enable kernel development mode.  The @option{-mkernel} option sets
14111 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14112 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14113 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14114 applicable.  This mode also sets @option{-mno-altivec},
14115 @option{-msoft-float}, @option{-fno-builtin} and
14116 @option{-mlong-branch} for PowerPC targets.
14118 @item -mone-byte-bool
14119 @opindex mone-byte-bool
14120 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
14121 By default @samp{sizeof(bool)} is @samp{4} when compiling for
14122 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
14123 option has no effect on x86.
14125 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14126 to generate code that is not binary compatible with code generated
14127 without that switch.  Using this switch may require recompiling all
14128 other modules in a program, including system libraries.  Use this
14129 switch to conform to a non-default data model.
14131 @item -mfix-and-continue
14132 @itemx -ffix-and-continue
14133 @itemx -findirect-data
14134 @opindex mfix-and-continue
14135 @opindex ffix-and-continue
14136 @opindex findirect-data
14137 Generate code suitable for fast turnaround development, such as to
14138 allow GDB to dynamically load @code{.o} files into already-running
14139 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14140 are provided for backwards compatibility.
14142 @item -all_load
14143 @opindex all_load
14144 Loads all members of static archive libraries.
14145 See man ld(1) for more information.
14147 @item -arch_errors_fatal
14148 @opindex arch_errors_fatal
14149 Cause the errors having to do with files that have the wrong architecture
14150 to be fatal.
14152 @item -bind_at_load
14153 @opindex bind_at_load
14154 Causes the output file to be marked such that the dynamic linker will
14155 bind all undefined references when the file is loaded or launched.
14157 @item -bundle
14158 @opindex bundle
14159 Produce a Mach-o bundle format file.
14160 See man ld(1) for more information.
14162 @item -bundle_loader @var{executable}
14163 @opindex bundle_loader
14164 This option specifies the @var{executable} that will load the build
14165 output file being linked.  See man ld(1) for more information.
14167 @item -dynamiclib
14168 @opindex dynamiclib
14169 When passed this option, GCC produces a dynamic library instead of
14170 an executable when linking, using the Darwin @file{libtool} command.
14172 @item -force_cpusubtype_ALL
14173 @opindex force_cpusubtype_ALL
14174 This causes GCC's output file to have the @var{ALL} subtype, instead of
14175 one controlled by the @option{-mcpu} or @option{-march} option.
14177 @item -allowable_client  @var{client_name}
14178 @itemx -client_name
14179 @itemx -compatibility_version
14180 @itemx -current_version
14181 @itemx -dead_strip
14182 @itemx -dependency-file
14183 @itemx -dylib_file
14184 @itemx -dylinker_install_name
14185 @itemx -dynamic
14186 @itemx -exported_symbols_list
14187 @itemx -filelist
14188 @need 800
14189 @itemx -flat_namespace
14190 @itemx -force_flat_namespace
14191 @itemx -headerpad_max_install_names
14192 @itemx -image_base
14193 @itemx -init
14194 @itemx -install_name
14195 @itemx -keep_private_externs
14196 @itemx -multi_module
14197 @itemx -multiply_defined
14198 @itemx -multiply_defined_unused
14199 @need 800
14200 @itemx -noall_load
14201 @itemx -no_dead_strip_inits_and_terms
14202 @itemx -nofixprebinding
14203 @itemx -nomultidefs
14204 @itemx -noprebind
14205 @itemx -noseglinkedit
14206 @itemx -pagezero_size
14207 @itemx -prebind
14208 @itemx -prebind_all_twolevel_modules
14209 @itemx -private_bundle
14210 @need 800
14211 @itemx -read_only_relocs
14212 @itemx -sectalign
14213 @itemx -sectobjectsymbols
14214 @itemx -whyload
14215 @itemx -seg1addr
14216 @itemx -sectcreate
14217 @itemx -sectobjectsymbols
14218 @itemx -sectorder
14219 @itemx -segaddr
14220 @itemx -segs_read_only_addr
14221 @need 800
14222 @itemx -segs_read_write_addr
14223 @itemx -seg_addr_table
14224 @itemx -seg_addr_table_filename
14225 @itemx -seglinkedit
14226 @itemx -segprot
14227 @itemx -segs_read_only_addr
14228 @itemx -segs_read_write_addr
14229 @itemx -single_module
14230 @itemx -static
14231 @itemx -sub_library
14232 @need 800
14233 @itemx -sub_umbrella
14234 @itemx -twolevel_namespace
14235 @itemx -umbrella
14236 @itemx -undefined
14237 @itemx -unexported_symbols_list
14238 @itemx -weak_reference_mismatches
14239 @itemx -whatsloaded
14240 @opindex allowable_client
14241 @opindex client_name
14242 @opindex compatibility_version
14243 @opindex current_version
14244 @opindex dead_strip
14245 @opindex dependency-file
14246 @opindex dylib_file
14247 @opindex dylinker_install_name
14248 @opindex dynamic
14249 @opindex exported_symbols_list
14250 @opindex filelist
14251 @opindex flat_namespace
14252 @opindex force_flat_namespace
14253 @opindex headerpad_max_install_names
14254 @opindex image_base
14255 @opindex init
14256 @opindex install_name
14257 @opindex keep_private_externs
14258 @opindex multi_module
14259 @opindex multiply_defined
14260 @opindex multiply_defined_unused
14261 @opindex noall_load
14262 @opindex no_dead_strip_inits_and_terms
14263 @opindex nofixprebinding
14264 @opindex nomultidefs
14265 @opindex noprebind
14266 @opindex noseglinkedit
14267 @opindex pagezero_size
14268 @opindex prebind
14269 @opindex prebind_all_twolevel_modules
14270 @opindex private_bundle
14271 @opindex read_only_relocs
14272 @opindex sectalign
14273 @opindex sectobjectsymbols
14274 @opindex whyload
14275 @opindex seg1addr
14276 @opindex sectcreate
14277 @opindex sectobjectsymbols
14278 @opindex sectorder
14279 @opindex segaddr
14280 @opindex segs_read_only_addr
14281 @opindex segs_read_write_addr
14282 @opindex seg_addr_table
14283 @opindex seg_addr_table_filename
14284 @opindex seglinkedit
14285 @opindex segprot
14286 @opindex segs_read_only_addr
14287 @opindex segs_read_write_addr
14288 @opindex single_module
14289 @opindex static
14290 @opindex sub_library
14291 @opindex sub_umbrella
14292 @opindex twolevel_namespace
14293 @opindex umbrella
14294 @opindex undefined
14295 @opindex unexported_symbols_list
14296 @opindex weak_reference_mismatches
14297 @opindex whatsloaded
14298 These options are passed to the Darwin linker.  The Darwin linker man page
14299 describes them in detail.
14300 @end table
14302 @node DEC Alpha Options
14303 @subsection DEC Alpha Options
14305 These @samp{-m} options are defined for the DEC Alpha implementations:
14307 @table @gcctabopt
14308 @item -mno-soft-float
14309 @itemx -msoft-float
14310 @opindex mno-soft-float
14311 @opindex msoft-float
14312 Use (do not use) the hardware floating-point instructions for
14313 floating-point operations.  When @option{-msoft-float} is specified,
14314 functions in @file{libgcc.a} are used to perform floating-point
14315 operations.  Unless they are replaced by routines that emulate the
14316 floating-point operations, or compiled in such a way as to call such
14317 emulations routines, these routines issue floating-point
14318 operations.   If you are compiling for an Alpha without floating-point
14319 operations, you must ensure that the library is built so as not to call
14320 them.
14322 Note that Alpha implementations without floating-point operations are
14323 required to have floating-point registers.
14325 @item -mfp-reg
14326 @itemx -mno-fp-regs
14327 @opindex mfp-reg
14328 @opindex mno-fp-regs
14329 Generate code that uses (does not use) the floating-point register set.
14330 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14331 register set is not used, floating-point operands are passed in integer
14332 registers as if they were integers and floating-point results are passed
14333 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14334 so any function with a floating-point argument or return value called by code
14335 compiled with @option{-mno-fp-regs} must also be compiled with that
14336 option.
14338 A typical use of this option is building a kernel that does not use,
14339 and hence need not save and restore, any floating-point registers.
14341 @item -mieee
14342 @opindex mieee
14343 The Alpha architecture implements floating-point hardware optimized for
14344 maximum performance.  It is mostly compliant with the IEEE floating-point
14345 standard.  However, for full compliance, software assistance is
14346 required.  This option generates code fully IEEE-compliant code
14347 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14348 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14349 defined during compilation.  The resulting code is less efficient but is
14350 able to correctly support denormalized numbers and exceptional IEEE
14351 values such as not-a-number and plus/minus infinity.  Other Alpha
14352 compilers call this option @option{-ieee_with_no_inexact}.
14354 @item -mieee-with-inexact
14355 @opindex mieee-with-inexact
14356 This is like @option{-mieee} except the generated code also maintains
14357 the IEEE @var{inexact-flag}.  Turning on this option causes the
14358 generated code to implement fully-compliant IEEE math.  In addition to
14359 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14360 macro.  On some Alpha implementations the resulting code may execute
14361 significantly slower than the code generated by default.  Since there is
14362 very little code that depends on the @var{inexact-flag}, you should
14363 normally not specify this option.  Other Alpha compilers call this
14364 option @option{-ieee_with_inexact}.
14366 @item -mfp-trap-mode=@var{trap-mode}
14367 @opindex mfp-trap-mode
14368 This option controls what floating-point related traps are enabled.
14369 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14370 The trap mode can be set to one of four values:
14372 @table @samp
14373 @item n
14374 This is the default (normal) setting.  The only traps that are enabled
14375 are the ones that cannot be disabled in software (e.g., division by zero
14376 trap).
14378 @item u
14379 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14380 as well.
14382 @item su
14383 Like @samp{u}, but the instructions are marked to be safe for software
14384 completion (see Alpha architecture manual for details).
14386 @item sui
14387 Like @samp{su}, but inexact traps are enabled as well.
14388 @end table
14390 @item -mfp-rounding-mode=@var{rounding-mode}
14391 @opindex mfp-rounding-mode
14392 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14393 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14396 @table @samp
14397 @item n
14398 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14399 the nearest machine number or towards the even machine number in case
14400 of a tie.
14402 @item m
14403 Round towards minus infinity.
14405 @item c
14406 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14408 @item d
14409 Dynamic rounding mode.  A field in the floating-point control register
14410 (@var{fpcr}, see Alpha architecture reference manual) controls the
14411 rounding mode in effect.  The C library initializes this register for
14412 rounding towards plus infinity.  Thus, unless your program modifies the
14413 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14414 @end table
14416 @item -mtrap-precision=@var{trap-precision}
14417 @opindex mtrap-precision
14418 In the Alpha architecture, floating-point traps are imprecise.  This
14419 means without software assistance it is impossible to recover from a
14420 floating trap and program execution normally needs to be terminated.
14421 GCC can generate code that can assist operating system trap handlers
14422 in determining the exact location that caused a floating-point trap.
14423 Depending on the requirements of an application, different levels of
14424 precisions can be selected:
14426 @table @samp
14427 @item p
14428 Program precision.  This option is the default and means a trap handler
14429 can only identify which program caused a floating-point exception.
14431 @item f
14432 Function precision.  The trap handler can determine the function that
14433 caused a floating-point exception.
14435 @item i
14436 Instruction precision.  The trap handler can determine the exact
14437 instruction that caused a floating-point exception.
14438 @end table
14440 Other Alpha compilers provide the equivalent options called
14441 @option{-scope_safe} and @option{-resumption_safe}.
14443 @item -mieee-conformant
14444 @opindex mieee-conformant
14445 This option marks the generated code as IEEE conformant.  You must not
14446 use this option unless you also specify @option{-mtrap-precision=i} and either
14447 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14448 is to emit the line @samp{.eflag 48} in the function prologue of the
14449 generated assembly file.
14451 @item -mbuild-constants
14452 @opindex mbuild-constants
14453 Normally GCC examines a 32- or 64-bit integer constant to
14454 see if it can construct it from smaller constants in two or three
14455 instructions.  If it cannot, it outputs the constant as a literal and
14456 generates code to load it from the data segment at run time.
14458 Use this option to require GCC to construct @emph{all} integer constants
14459 using code, even if it takes more instructions (the maximum is six).
14461 You typically use this option to build a shared library dynamic
14462 loader.  Itself a shared library, it must relocate itself in memory
14463 before it can find the variables and constants in its own data segment.
14465 @item -mbwx
14466 @itemx -mno-bwx
14467 @itemx -mcix
14468 @itemx -mno-cix
14469 @itemx -mfix
14470 @itemx -mno-fix
14471 @itemx -mmax
14472 @itemx -mno-max
14473 @opindex mbwx
14474 @opindex mno-bwx
14475 @opindex mcix
14476 @opindex mno-cix
14477 @opindex mfix
14478 @opindex mno-fix
14479 @opindex mmax
14480 @opindex mno-max
14481 Indicate whether GCC should generate code to use the optional BWX,
14482 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14483 sets supported by the CPU type specified via @option{-mcpu=} option or that
14484 of the CPU on which GCC was built if none is specified.
14486 @item -mfloat-vax
14487 @itemx -mfloat-ieee
14488 @opindex mfloat-vax
14489 @opindex mfloat-ieee
14490 Generate code that uses (does not use) VAX F and G floating-point
14491 arithmetic instead of IEEE single and double precision.
14493 @item -mexplicit-relocs
14494 @itemx -mno-explicit-relocs
14495 @opindex mexplicit-relocs
14496 @opindex mno-explicit-relocs
14497 Older Alpha assemblers provided no way to generate symbol relocations
14498 except via assembler macros.  Use of these macros does not allow
14499 optimal instruction scheduling.  GNU binutils as of version 2.12
14500 supports a new syntax that allows the compiler to explicitly mark
14501 which relocations should apply to which instructions.  This option
14502 is mostly useful for debugging, as GCC detects the capabilities of
14503 the assembler when it is built and sets the default accordingly.
14505 @item -msmall-data
14506 @itemx -mlarge-data
14507 @opindex msmall-data
14508 @opindex mlarge-data
14509 When @option{-mexplicit-relocs} is in effect, static data is
14510 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14511 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14512 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14513 16-bit relocations off of the @code{$gp} register.  This limits the
14514 size of the small data area to 64KB, but allows the variables to be
14515 directly accessed via a single instruction.
14517 The default is @option{-mlarge-data}.  With this option the data area
14518 is limited to just below 2GB@.  Programs that require more than 2GB of
14519 data must use @code{malloc} or @code{mmap} to allocate the data in the
14520 heap instead of in the program's data segment.
14522 When generating code for shared libraries, @option{-fpic} implies
14523 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14525 @item -msmall-text
14526 @itemx -mlarge-text
14527 @opindex msmall-text
14528 @opindex mlarge-text
14529 When @option{-msmall-text} is used, the compiler assumes that the
14530 code of the entire program (or shared library) fits in 4MB, and is
14531 thus reachable with a branch instruction.  When @option{-msmall-data}
14532 is used, the compiler can assume that all local symbols share the
14533 same @code{$gp} value, and thus reduce the number of instructions
14534 required for a function call from 4 to 1.
14536 The default is @option{-mlarge-text}.
14538 @item -mcpu=@var{cpu_type}
14539 @opindex mcpu
14540 Set the instruction set and instruction scheduling parameters for
14541 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14542 style name or the corresponding chip number.  GCC supports scheduling
14543 parameters for the EV4, EV5 and EV6 family of processors and
14544 chooses the default values for the instruction set from the processor
14545 you specify.  If you do not specify a processor type, GCC defaults
14546 to the processor on which the compiler was built.
14548 Supported values for @var{cpu_type} are
14550 @table @samp
14551 @item ev4
14552 @itemx ev45
14553 @itemx 21064
14554 Schedules as an EV4 and has no instruction set extensions.
14556 @item ev5
14557 @itemx 21164
14558 Schedules as an EV5 and has no instruction set extensions.
14560 @item ev56
14561 @itemx 21164a
14562 Schedules as an EV5 and supports the BWX extension.
14564 @item pca56
14565 @itemx 21164pc
14566 @itemx 21164PC
14567 Schedules as an EV5 and supports the BWX and MAX extensions.
14569 @item ev6
14570 @itemx 21264
14571 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14573 @item ev67
14574 @itemx 21264a
14575 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14576 @end table
14578 Native toolchains also support the value @samp{native},
14579 which selects the best architecture option for the host processor.
14580 @option{-mcpu=native} has no effect if GCC does not recognize
14581 the processor.
14583 @item -mtune=@var{cpu_type}
14584 @opindex mtune
14585 Set only the instruction scheduling parameters for machine type
14586 @var{cpu_type}.  The instruction set is not changed.
14588 Native toolchains also support the value @samp{native},
14589 which selects the best architecture option for the host processor.
14590 @option{-mtune=native} has no effect if GCC does not recognize
14591 the processor.
14593 @item -mmemory-latency=@var{time}
14594 @opindex mmemory-latency
14595 Sets the latency the scheduler should assume for typical memory
14596 references as seen by the application.  This number is highly
14597 dependent on the memory access patterns used by the application
14598 and the size of the external cache on the machine.
14600 Valid options for @var{time} are
14602 @table @samp
14603 @item @var{number}
14604 A decimal number representing clock cycles.
14606 @item L1
14607 @itemx L2
14608 @itemx L3
14609 @itemx main
14610 The compiler contains estimates of the number of clock cycles for
14611 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14612 (also called Dcache, Scache, and Bcache), as well as to main memory.
14613 Note that L3 is only valid for EV5.
14615 @end table
14616 @end table
14618 @node FR30 Options
14619 @subsection FR30 Options
14620 @cindex FR30 Options
14622 These options are defined specifically for the FR30 port.
14624 @table @gcctabopt
14626 @item -msmall-model
14627 @opindex msmall-model
14628 Use the small address space model.  This can produce smaller code, but
14629 it does assume that all symbolic values and addresses fit into a
14630 20-bit range.
14632 @item -mno-lsim
14633 @opindex mno-lsim
14634 Assume that runtime support has been provided and so there is no need
14635 to include the simulator library (@file{libsim.a}) on the linker
14636 command line.
14638 @end table
14640 @node FRV Options
14641 @subsection FRV Options
14642 @cindex FRV Options
14644 @table @gcctabopt
14645 @item -mgpr-32
14646 @opindex mgpr-32
14648 Only use the first 32 general-purpose registers.
14650 @item -mgpr-64
14651 @opindex mgpr-64
14653 Use all 64 general-purpose registers.
14655 @item -mfpr-32
14656 @opindex mfpr-32
14658 Use only the first 32 floating-point registers.
14660 @item -mfpr-64
14661 @opindex mfpr-64
14663 Use all 64 floating-point registers.
14665 @item -mhard-float
14666 @opindex mhard-float
14668 Use hardware instructions for floating-point operations.
14670 @item -msoft-float
14671 @opindex msoft-float
14673 Use library routines for floating-point operations.
14675 @item -malloc-cc
14676 @opindex malloc-cc
14678 Dynamically allocate condition code registers.
14680 @item -mfixed-cc
14681 @opindex mfixed-cc
14683 Do not try to dynamically allocate condition code registers, only
14684 use @code{icc0} and @code{fcc0}.
14686 @item -mdword
14687 @opindex mdword
14689 Change ABI to use double word insns.
14691 @item -mno-dword
14692 @opindex mno-dword
14694 Do not use double word instructions.
14696 @item -mdouble
14697 @opindex mdouble
14699 Use floating-point double instructions.
14701 @item -mno-double
14702 @opindex mno-double
14704 Do not use floating-point double instructions.
14706 @item -mmedia
14707 @opindex mmedia
14709 Use media instructions.
14711 @item -mno-media
14712 @opindex mno-media
14714 Do not use media instructions.
14716 @item -mmuladd
14717 @opindex mmuladd
14719 Use multiply and add/subtract instructions.
14721 @item -mno-muladd
14722 @opindex mno-muladd
14724 Do not use multiply and add/subtract instructions.
14726 @item -mfdpic
14727 @opindex mfdpic
14729 Select the FDPIC ABI, which uses function descriptors to represent
14730 pointers to functions.  Without any PIC/PIE-related options, it
14731 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14732 assumes GOT entries and small data are within a 12-bit range from the
14733 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14734 are computed with 32 bits.
14735 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14737 @item -minline-plt
14738 @opindex minline-plt
14740 Enable inlining of PLT entries in function calls to functions that are
14741 not known to bind locally.  It has no effect without @option{-mfdpic}.
14742 It's enabled by default if optimizing for speed and compiling for
14743 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14744 optimization option such as @option{-O3} or above is present in the
14745 command line.
14747 @item -mTLS
14748 @opindex mTLS
14750 Assume a large TLS segment when generating thread-local code.
14752 @item -mtls
14753 @opindex mtls
14755 Do not assume a large TLS segment when generating thread-local code.
14757 @item -mgprel-ro
14758 @opindex mgprel-ro
14760 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14761 that is known to be in read-only sections.  It's enabled by default,
14762 except for @option{-fpic} or @option{-fpie}: even though it may help
14763 make the global offset table smaller, it trades 1 instruction for 4.
14764 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14765 one of which may be shared by multiple symbols, and it avoids the need
14766 for a GOT entry for the referenced symbol, so it's more likely to be a
14767 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14769 @item -multilib-library-pic
14770 @opindex multilib-library-pic
14772 Link with the (library, not FD) pic libraries.  It's implied by
14773 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14774 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14775 it explicitly.
14777 @item -mlinked-fp
14778 @opindex mlinked-fp
14780 Follow the EABI requirement of always creating a frame pointer whenever
14781 a stack frame is allocated.  This option is enabled by default and can
14782 be disabled with @option{-mno-linked-fp}.
14784 @item -mlong-calls
14785 @opindex mlong-calls
14787 Use indirect addressing to call functions outside the current
14788 compilation unit.  This allows the functions to be placed anywhere
14789 within the 32-bit address space.
14791 @item -malign-labels
14792 @opindex malign-labels
14794 Try to align labels to an 8-byte boundary by inserting NOPs into the
14795 previous packet.  This option only has an effect when VLIW packing
14796 is enabled.  It doesn't create new packets; it merely adds NOPs to
14797 existing ones.
14799 @item -mlibrary-pic
14800 @opindex mlibrary-pic
14802 Generate position-independent EABI code.
14804 @item -macc-4
14805 @opindex macc-4
14807 Use only the first four media accumulator registers.
14809 @item -macc-8
14810 @opindex macc-8
14812 Use all eight media accumulator registers.
14814 @item -mpack
14815 @opindex mpack
14817 Pack VLIW instructions.
14819 @item -mno-pack
14820 @opindex mno-pack
14822 Do not pack VLIW instructions.
14824 @item -mno-eflags
14825 @opindex mno-eflags
14827 Do not mark ABI switches in e_flags.
14829 @item -mcond-move
14830 @opindex mcond-move
14832 Enable the use of conditional-move instructions (default).
14834 This switch is mainly for debugging the compiler and will likely be removed
14835 in a future version.
14837 @item -mno-cond-move
14838 @opindex mno-cond-move
14840 Disable the use of conditional-move instructions.
14842 This switch is mainly for debugging the compiler and will likely be removed
14843 in a future version.
14845 @item -mscc
14846 @opindex mscc
14848 Enable the use of conditional set instructions (default).
14850 This switch is mainly for debugging the compiler and will likely be removed
14851 in a future version.
14853 @item -mno-scc
14854 @opindex mno-scc
14856 Disable the use of conditional set instructions.
14858 This switch is mainly for debugging the compiler and will likely be removed
14859 in a future version.
14861 @item -mcond-exec
14862 @opindex mcond-exec
14864 Enable the use of conditional execution (default).
14866 This switch is mainly for debugging the compiler and will likely be removed
14867 in a future version.
14869 @item -mno-cond-exec
14870 @opindex mno-cond-exec
14872 Disable the use of conditional execution.
14874 This switch is mainly for debugging the compiler and will likely be removed
14875 in a future version.
14877 @item -mvliw-branch
14878 @opindex mvliw-branch
14880 Run a pass to pack branches into VLIW instructions (default).
14882 This switch is mainly for debugging the compiler and will likely be removed
14883 in a future version.
14885 @item -mno-vliw-branch
14886 @opindex mno-vliw-branch
14888 Do not run a pass to pack branches into VLIW instructions.
14890 This switch is mainly for debugging the compiler and will likely be removed
14891 in a future version.
14893 @item -mmulti-cond-exec
14894 @opindex mmulti-cond-exec
14896 Enable optimization of @code{&&} and @code{||} in conditional execution
14897 (default).
14899 This switch is mainly for debugging the compiler and will likely be removed
14900 in a future version.
14902 @item -mno-multi-cond-exec
14903 @opindex mno-multi-cond-exec
14905 Disable optimization of @code{&&} and @code{||} in conditional execution.
14907 This switch is mainly for debugging the compiler and will likely be removed
14908 in a future version.
14910 @item -mnested-cond-exec
14911 @opindex mnested-cond-exec
14913 Enable nested conditional execution optimizations (default).
14915 This switch is mainly for debugging the compiler and will likely be removed
14916 in a future version.
14918 @item -mno-nested-cond-exec
14919 @opindex mno-nested-cond-exec
14921 Disable nested conditional execution optimizations.
14923 This switch is mainly for debugging the compiler and will likely be removed
14924 in a future version.
14926 @item -moptimize-membar
14927 @opindex moptimize-membar
14929 This switch removes redundant @code{membar} instructions from the
14930 compiler-generated code.  It is enabled by default.
14932 @item -mno-optimize-membar
14933 @opindex mno-optimize-membar
14935 This switch disables the automatic removal of redundant @code{membar}
14936 instructions from the generated code.
14938 @item -mtomcat-stats
14939 @opindex mtomcat-stats
14941 Cause gas to print out tomcat statistics.
14943 @item -mcpu=@var{cpu}
14944 @opindex mcpu
14946 Select the processor type for which to generate code.  Possible values are
14947 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14948 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14950 @end table
14952 @node GNU/Linux Options
14953 @subsection GNU/Linux Options
14955 These @samp{-m} options are defined for GNU/Linux targets:
14957 @table @gcctabopt
14958 @item -mglibc
14959 @opindex mglibc
14960 Use the GNU C library.  This is the default except
14961 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14963 @item -muclibc
14964 @opindex muclibc
14965 Use uClibc C library.  This is the default on
14966 @samp{*-*-linux-*uclibc*} targets.
14968 @item -mbionic
14969 @opindex mbionic
14970 Use Bionic C library.  This is the default on
14971 @samp{*-*-linux-*android*} targets.
14973 @item -mandroid
14974 @opindex mandroid
14975 Compile code compatible with Android platform.  This is the default on
14976 @samp{*-*-linux-*android*} targets.
14978 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14979 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14980 this option makes the GCC driver pass Android-specific options to the linker.
14981 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14982 to be defined.
14984 @item -tno-android-cc
14985 @opindex tno-android-cc
14986 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14987 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14988 @option{-fno-rtti} by default.
14990 @item -tno-android-ld
14991 @opindex tno-android-ld
14992 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14993 linking options to the linker.
14995 @end table
14997 @node H8/300 Options
14998 @subsection H8/300 Options
15000 These @samp{-m} options are defined for the H8/300 implementations:
15002 @table @gcctabopt
15003 @item -mrelax
15004 @opindex mrelax
15005 Shorten some address references at link time, when possible; uses the
15006 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
15007 ld, Using ld}, for a fuller description.
15009 @item -mh
15010 @opindex mh
15011 Generate code for the H8/300H@.
15013 @item -ms
15014 @opindex ms
15015 Generate code for the H8S@.
15017 @item -mn
15018 @opindex mn
15019 Generate code for the H8S and H8/300H in the normal mode.  This switch
15020 must be used either with @option{-mh} or @option{-ms}.
15022 @item -ms2600
15023 @opindex ms2600
15024 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15026 @item -mexr
15027 @opindex mexr
15028 Extended registers are stored on stack before execution of function
15029 with monitor attribute. Default option is @option{-mexr}.
15030 This option is valid only for H8S targets.
15032 @item -mno-exr
15033 @opindex mno-exr
15034 Extended registers are not stored on stack before execution of function 
15035 with monitor attribute. Default option is @option{-mno-exr}. 
15036 This option is valid only for H8S targets.
15038 @item -mint32
15039 @opindex mint32
15040 Make @code{int} data 32 bits by default.
15042 @item -malign-300
15043 @opindex malign-300
15044 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15045 The default for the H8/300H and H8S is to align longs and floats on
15046 4-byte boundaries.
15047 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15048 This option has no effect on the H8/300.
15049 @end table
15051 @node HPPA Options
15052 @subsection HPPA Options
15053 @cindex HPPA Options
15055 These @samp{-m} options are defined for the HPPA family of computers:
15057 @table @gcctabopt
15058 @item -march=@var{architecture-type}
15059 @opindex march
15060 Generate code for the specified architecture.  The choices for
15061 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15062 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15063 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15064 architecture option for your machine.  Code compiled for lower numbered
15065 architectures runs on higher numbered architectures, but not the
15066 other way around.
15068 @item -mpa-risc-1-0
15069 @itemx -mpa-risc-1-1
15070 @itemx -mpa-risc-2-0
15071 @opindex mpa-risc-1-0
15072 @opindex mpa-risc-1-1
15073 @opindex mpa-risc-2-0
15074 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15076 @item -mjump-in-delay
15077 @opindex mjump-in-delay
15078 This option is ignored and provided for compatibility purposes only.
15080 @item -mdisable-fpregs
15081 @opindex mdisable-fpregs
15082 Prevent floating-point registers from being used in any manner.  This is
15083 necessary for compiling kernels that perform lazy context switching of
15084 floating-point registers.  If you use this option and attempt to perform
15085 floating-point operations, the compiler aborts.
15087 @item -mdisable-indexing
15088 @opindex mdisable-indexing
15089 Prevent the compiler from using indexing address modes.  This avoids some
15090 rather obscure problems when compiling MIG generated code under MACH@.
15092 @item -mno-space-regs
15093 @opindex mno-space-regs
15094 Generate code that assumes the target has no space registers.  This allows
15095 GCC to generate faster indirect calls and use unscaled index address modes.
15097 Such code is suitable for level 0 PA systems and kernels.
15099 @item -mfast-indirect-calls
15100 @opindex mfast-indirect-calls
15101 Generate code that assumes calls never cross space boundaries.  This
15102 allows GCC to emit code that performs faster indirect calls.
15104 This option does not work in the presence of shared libraries or nested
15105 functions.
15107 @item -mfixed-range=@var{register-range}
15108 @opindex mfixed-range
15109 Generate code treating the given register range as fixed registers.
15110 A fixed register is one that the register allocator cannot use.  This is
15111 useful when compiling kernel code.  A register range is specified as
15112 two registers separated by a dash.  Multiple register ranges can be
15113 specified separated by a comma.
15115 @item -mlong-load-store
15116 @opindex mlong-load-store
15117 Generate 3-instruction load and store sequences as sometimes required by
15118 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15119 the HP compilers.
15121 @item -mportable-runtime
15122 @opindex mportable-runtime
15123 Use the portable calling conventions proposed by HP for ELF systems.
15125 @item -mgas
15126 @opindex mgas
15127 Enable the use of assembler directives only GAS understands.
15129 @item -mschedule=@var{cpu-type}
15130 @opindex mschedule
15131 Schedule code according to the constraints for the machine type
15132 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15133 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15134 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15135 proper scheduling option for your machine.  The default scheduling is
15136 @samp{8000}.
15138 @item -mlinker-opt
15139 @opindex mlinker-opt
15140 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15141 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15142 linkers in which they give bogus error messages when linking some programs.
15144 @item -msoft-float
15145 @opindex msoft-float
15146 Generate output containing library calls for floating point.
15147 @strong{Warning:} the requisite libraries are not available for all HPPA
15148 targets.  Normally the facilities of the machine's usual C compiler are
15149 used, but this cannot be done directly in cross-compilation.  You must make
15150 your own arrangements to provide suitable library functions for
15151 cross-compilation.
15153 @option{-msoft-float} changes the calling convention in the output file;
15154 therefore, it is only useful if you compile @emph{all} of a program with
15155 this option.  In particular, you need to compile @file{libgcc.a}, the
15156 library that comes with GCC, with @option{-msoft-float} in order for
15157 this to work.
15159 @item -msio
15160 @opindex msio
15161 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15162 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15163 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15164 options are available under HP-UX and HI-UX@.
15166 @item -mgnu-ld
15167 @opindex mgnu-ld
15168 Use options specific to GNU @command{ld}.
15169 This passes @option{-shared} to @command{ld} when
15170 building a shared library.  It is the default when GCC is configured,
15171 explicitly or implicitly, with the GNU linker.  This option does not
15172 affect which @command{ld} is called; it only changes what parameters
15173 are passed to that @command{ld}.
15174 The @command{ld} that is called is determined by the
15175 @option{--with-ld} configure option, GCC's program search path, and
15176 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15177 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15178 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15180 @item -mhp-ld
15181 @opindex mhp-ld
15182 Use options specific to HP @command{ld}.
15183 This passes @option{-b} to @command{ld} when building
15184 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15185 links.  It is the default when GCC is configured, explicitly or
15186 implicitly, with the HP linker.  This option does not affect
15187 which @command{ld} is called; it only changes what parameters are passed to that
15188 @command{ld}.
15189 The @command{ld} that is called is determined by the @option{--with-ld}
15190 configure option, GCC's program search path, and finally by the user's
15191 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15192 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15193 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15195 @item -mlong-calls
15196 @opindex mno-long-calls
15197 Generate code that uses long call sequences.  This ensures that a call
15198 is always able to reach linker generated stubs.  The default is to generate
15199 long calls only when the distance from the call site to the beginning
15200 of the function or translation unit, as the case may be, exceeds a
15201 predefined limit set by the branch type being used.  The limits for
15202 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15203 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15204 240,000 bytes.
15206 Distances are measured from the beginning of functions when using the
15207 @option{-ffunction-sections} option, or when using the @option{-mgas}
15208 and @option{-mno-portable-runtime} options together under HP-UX with
15209 the SOM linker.
15211 It is normally not desirable to use this option as it degrades
15212 performance.  However, it may be useful in large applications,
15213 particularly when partial linking is used to build the application.
15215 The types of long calls used depends on the capabilities of the
15216 assembler and linker, and the type of code being generated.  The
15217 impact on systems that support long absolute calls, and long pic
15218 symbol-difference or pc-relative calls should be relatively small.
15219 However, an indirect call is used on 32-bit ELF systems in pic code
15220 and it is quite long.
15222 @item -munix=@var{unix-std}
15223 @opindex march
15224 Generate compiler predefines and select a startfile for the specified
15225 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15226 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15227 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15228 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15229 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15230 and later.
15232 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15233 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15234 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15235 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15236 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15237 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15239 It is @emph{important} to note that this option changes the interfaces
15240 for various library routines.  It also affects the operational behavior
15241 of the C library.  Thus, @emph{extreme} care is needed in using this
15242 option.
15244 Library code that is intended to operate with more than one UNIX
15245 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15246 as appropriate.  Most GNU software doesn't provide this capability.
15248 @item -nolibdld
15249 @opindex nolibdld
15250 Suppress the generation of link options to search libdld.sl when the
15251 @option{-static} option is specified on HP-UX 10 and later.
15253 @item -static
15254 @opindex static
15255 The HP-UX implementation of setlocale in libc has a dependency on
15256 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15257 when the @option{-static} option is specified, special link options
15258 are needed to resolve this dependency.
15260 On HP-UX 10 and later, the GCC driver adds the necessary options to
15261 link with libdld.sl when the @option{-static} option is specified.
15262 This causes the resulting binary to be dynamic.  On the 64-bit port,
15263 the linkers generate dynamic binaries by default in any case.  The
15264 @option{-nolibdld} option can be used to prevent the GCC driver from
15265 adding these link options.
15267 @item -threads
15268 @opindex threads
15269 Add support for multithreading with the @dfn{dce thread} library
15270 under HP-UX@.  This option sets flags for both the preprocessor and
15271 linker.
15272 @end table
15274 @node i386 and x86-64 Options
15275 @subsection Intel 386 and AMD x86-64 Options
15276 @cindex i386 Options
15277 @cindex x86-64 Options
15278 @cindex Intel 386 Options
15279 @cindex AMD x86-64 Options
15281 These @samp{-m} options are defined for the i386 and x86-64 family of
15282 computers:
15284 @table @gcctabopt
15286 @item -march=@var{cpu-type}
15287 @opindex march
15288 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15289 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15290 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15291 to generate code that may not run at all on processors other than the one
15292 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15293 @option{-mtune=@var{cpu-type}}.
15295 The choices for @var{cpu-type} are:
15297 @table @samp
15298 @item native
15299 This selects the CPU to generate code for at compilation time by determining
15300 the processor type of the compiling machine.  Using @option{-march=native}
15301 enables all instruction subsets supported by the local machine (hence
15302 the result might not run on different machines).  Using @option{-mtune=native}
15303 produces code optimized for the local machine under the constraints
15304 of the selected instruction set.  
15306 @item i386
15307 Original Intel i386 CPU@.
15309 @item i486
15310 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15312 @item i586
15313 @itemx pentium
15314 Intel Pentium CPU with no MMX support.
15316 @item pentium-mmx
15317 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15319 @item pentiumpro
15320 Intel Pentium Pro CPU@.
15322 @item i686
15323 When used with @option{-march}, the Pentium Pro
15324 instruction set is used, so the code runs on all i686 family chips.
15325 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15327 @item pentium2
15328 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15329 support.
15331 @item pentium3
15332 @itemx pentium3m
15333 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15334 set support.
15336 @item pentium-m
15337 Intel Pentium M; low-power version of Intel Pentium III CPU
15338 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15340 @item pentium4
15341 @itemx pentium4m
15342 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15344 @item prescott
15345 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15346 set support.
15348 @item nocona
15349 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15350 SSE2 and SSE3 instruction set support.
15352 @item core2
15353 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15354 instruction set support.
15356 @item nehalem
15357 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15358 SSE4.1, SSE4.2 and POPCNT instruction set support.
15360 @item westmere
15361 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15362 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15364 @item sandybridge
15365 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15366 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15368 @item ivybridge
15369 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15370 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15371 instruction set support.
15373 @item haswell
15374 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15375 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15376 BMI, BMI2 and F16C instruction set support.
15378 @item broadwell
15379 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15380 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15381 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15383 @item bonnell
15384 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15385 instruction set support.
15387 @item silvermont
15388 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15389 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15391 @item k6
15392 AMD K6 CPU with MMX instruction set support.
15394 @item k6-2
15395 @itemx k6-3
15396 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15398 @item athlon
15399 @itemx athlon-tbird
15400 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15401 support.
15403 @item athlon-4
15404 @itemx athlon-xp
15405 @itemx athlon-mp
15406 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15407 instruction set support.
15409 @item k8
15410 @itemx opteron
15411 @itemx athlon64
15412 @itemx athlon-fx
15413 Processors based on the AMD K8 core with x86-64 instruction set support,
15414 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15415 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15416 instruction set extensions.)
15418 @item k8-sse3
15419 @itemx opteron-sse3
15420 @itemx athlon64-sse3
15421 Improved versions of AMD K8 cores with SSE3 instruction set support.
15423 @item amdfam10
15424 @itemx barcelona
15425 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15426 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15427 instruction set extensions.)
15429 @item bdver1
15430 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15431 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15432 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15433 @item bdver2
15434 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15435 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15436 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15437 extensions.)
15438 @item bdver3
15439 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15440 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15441 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15442 64-bit instruction set extensions.
15443 @item bdver4
15444 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15445 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15446 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15447 SSE4.2, ABM and 64-bit instruction set extensions.
15449 @item btver1
15450 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15451 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15452 instruction set extensions.)
15454 @item btver2
15455 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15456 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15457 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15459 @item winchip-c6
15460 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15461 set support.
15463 @item winchip2
15464 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15465 instruction set support.
15467 @item c3
15468 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15469 implemented for this chip.)
15471 @item c3-2
15472 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15473 (No scheduling is
15474 implemented for this chip.)
15476 @item geode
15477 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15478 @end table
15480 @item -mtune=@var{cpu-type}
15481 @opindex mtune
15482 Tune to @var{cpu-type} everything applicable about the generated code, except
15483 for the ABI and the set of available instructions.  
15484 While picking a specific @var{cpu-type} schedules things appropriately
15485 for that particular chip, the compiler does not generate any code that
15486 cannot run on the default machine type unless you use a
15487 @option{-march=@var{cpu-type}} option.
15488 For example, if GCC is configured for i686-pc-linux-gnu
15489 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15490 but still runs on i686 machines.
15492 The choices for @var{cpu-type} are the same as for @option{-march}.
15493 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15495 @table @samp
15496 @item generic
15497 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15498 If you know the CPU on which your code will run, then you should use
15499 the corresponding @option{-mtune} or @option{-march} option instead of
15500 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15501 of your application will have, then you should use this option.
15503 As new processors are deployed in the marketplace, the behavior of this
15504 option will change.  Therefore, if you upgrade to a newer version of
15505 GCC, code generation controlled by this option will change to reflect
15506 the processors
15507 that are most common at the time that version of GCC is released.
15509 There is no @option{-march=generic} option because @option{-march}
15510 indicates the instruction set the compiler can use, and there is no
15511 generic instruction set applicable to all processors.  In contrast,
15512 @option{-mtune} indicates the processor (or, in this case, collection of
15513 processors) for which the code is optimized.
15515 @item intel
15516 Produce code optimized for the most current Intel processors, which are
15517 Haswell and Silvermont for this version of GCC.  If you know the CPU
15518 on which your code will run, then you should use the corresponding
15519 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15520 But, if you want your application performs better on both Haswell and
15521 Silvermont, then you should use this option.
15523 As new Intel processors are deployed in the marketplace, the behavior of
15524 this option will change.  Therefore, if you upgrade to a newer version of
15525 GCC, code generation controlled by this option will change to reflect
15526 the most current Intel processors at the time that version of GCC is
15527 released.
15529 There is no @option{-march=intel} option because @option{-march} indicates
15530 the instruction set the compiler can use, and there is no common
15531 instruction set applicable to all processors.  In contrast,
15532 @option{-mtune} indicates the processor (or, in this case, collection of
15533 processors) for which the code is optimized.
15534 @end table
15536 @item -mcpu=@var{cpu-type}
15537 @opindex mcpu
15538 A deprecated synonym for @option{-mtune}.
15540 @item -mfpmath=@var{unit}
15541 @opindex mfpmath
15542 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15543 for @var{unit} are:
15545 @table @samp
15546 @item 387
15547 Use the standard 387 floating-point coprocessor present on the majority of chips and
15548 emulated otherwise.  Code compiled with this option runs almost everywhere.
15549 The temporary results are computed in 80-bit precision instead of the precision
15550 specified by the type, resulting in slightly different results compared to most
15551 of other chips.  See @option{-ffloat-store} for more detailed description.
15553 This is the default choice for i386 compiler.
15555 @item sse
15556 Use scalar floating-point instructions present in the SSE instruction set.
15557 This instruction set is supported by Pentium III and newer chips,
15558 and in the AMD line
15559 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15560 instruction set supports only single-precision arithmetic, thus the double and
15561 extended-precision arithmetic are still done using 387.  A later version, present
15562 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15563 arithmetic too.
15565 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15566 or @option{-msse2} switches to enable SSE extensions and make this option
15567 effective.  For the x86-64 compiler, these extensions are enabled by default.
15569 The resulting code should be considerably faster in the majority of cases and avoid
15570 the numerical instability problems of 387 code, but may break some existing
15571 code that expects temporaries to be 80 bits.
15573 This is the default choice for the x86-64 compiler.
15575 @item sse,387
15576 @itemx sse+387
15577 @itemx both
15578 Attempt to utilize both instruction sets at once.  This effectively doubles the
15579 amount of available registers, and on chips with separate execution units for
15580 387 and SSE the execution resources too.  Use this option with care, as it is
15581 still experimental, because the GCC register allocator does not model separate
15582 functional units well, resulting in unstable performance.
15583 @end table
15585 @item -masm=@var{dialect}
15586 @opindex masm=@var{dialect}
15587 Output assembly instructions using selected @var{dialect}.  Supported
15588 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15589 not support @samp{intel}.
15591 @item -mieee-fp
15592 @itemx -mno-ieee-fp
15593 @opindex mieee-fp
15594 @opindex mno-ieee-fp
15595 Control whether or not the compiler uses IEEE floating-point
15596 comparisons.  These correctly handle the case where the result of a
15597 comparison is unordered.
15599 @item -msoft-float
15600 @opindex msoft-float
15601 Generate output containing library calls for floating point.
15603 @strong{Warning:} the requisite libraries are not part of GCC@.
15604 Normally the facilities of the machine's usual C compiler are used, but
15605 this can't be done directly in cross-compilation.  You must make your
15606 own arrangements to provide suitable library functions for
15607 cross-compilation.
15609 On machines where a function returns floating-point results in the 80387
15610 register stack, some floating-point opcodes may be emitted even if
15611 @option{-msoft-float} is used.
15613 @item -mno-fp-ret-in-387
15614 @opindex mno-fp-ret-in-387
15615 Do not use the FPU registers for return values of functions.
15617 The usual calling convention has functions return values of types
15618 @code{float} and @code{double} in an FPU register, even if there
15619 is no FPU@.  The idea is that the operating system should emulate
15620 an FPU@.
15622 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15623 in ordinary CPU registers instead.
15625 @item -mno-fancy-math-387
15626 @opindex mno-fancy-math-387
15627 Some 387 emulators do not support the @code{sin}, @code{cos} and
15628 @code{sqrt} instructions for the 387.  Specify this option to avoid
15629 generating those instructions.  This option is the default on FreeBSD,
15630 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15631 indicates that the target CPU always has an FPU and so the
15632 instruction does not need emulation.  These
15633 instructions are not generated unless you also use the
15634 @option{-funsafe-math-optimizations} switch.
15636 @item -malign-double
15637 @itemx -mno-align-double
15638 @opindex malign-double
15639 @opindex mno-align-double
15640 Control whether GCC aligns @code{double}, @code{long double}, and
15641 @code{long long} variables on a two-word boundary or a one-word
15642 boundary.  Aligning @code{double} variables on a two-word boundary
15643 produces code that runs somewhat faster on a Pentium at the
15644 expense of more memory.
15646 On x86-64, @option{-malign-double} is enabled by default.
15648 @strong{Warning:} if you use the @option{-malign-double} switch,
15649 structures containing the above types are aligned differently than
15650 the published application binary interface specifications for the 386
15651 and are not binary compatible with structures in code compiled
15652 without that switch.
15654 @item -m96bit-long-double
15655 @itemx -m128bit-long-double
15656 @opindex m96bit-long-double
15657 @opindex m128bit-long-double
15658 These switches control the size of @code{long double} type.  The i386
15659 application binary interface specifies the size to be 96 bits,
15660 so @option{-m96bit-long-double} is the default in 32-bit mode.
15662 Modern architectures (Pentium and newer) prefer @code{long double}
15663 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15664 conforming to the ABI, this is not possible.  So specifying
15665 @option{-m128bit-long-double} aligns @code{long double}
15666 to a 16-byte boundary by padding the @code{long double} with an additional
15667 32-bit zero.
15669 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15670 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15672 Notice that neither of these options enable any extra precision over the x87
15673 standard of 80 bits for a @code{long double}.
15675 @strong{Warning:} if you override the default value for your target ABI, this
15676 changes the size of 
15677 structures and arrays containing @code{long double} variables,
15678 as well as modifying the function calling convention for functions taking
15679 @code{long double}.  Hence they are not binary-compatible
15680 with code compiled without that switch.
15682 @item -mlong-double-64
15683 @itemx -mlong-double-80
15684 @itemx -mlong-double-128
15685 @opindex mlong-double-64
15686 @opindex mlong-double-80
15687 @opindex mlong-double-128
15688 These switches control the size of @code{long double} type. A size
15689 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15690 type. This is the default for 32-bit Bionic C library.  A size
15691 of 128 bits makes the @code{long double} type equivalent to the
15692 @code{__float128} type. This is the default for 64-bit Bionic C library.
15694 @strong{Warning:} if you override the default value for your target ABI, this
15695 changes the size of
15696 structures and arrays containing @code{long double} variables,
15697 as well as modifying the function calling convention for functions taking
15698 @code{long double}.  Hence they are not binary-compatible
15699 with code compiled without that switch.
15701 @item -malign-data=@var{type}
15702 @opindex malign-data
15703 Control how GCC aligns variables.  Supported values for @var{type} are
15704 @samp{compat} uses increased alignment value compatible uses GCC 4.8
15705 and earlier, @samp{abi} uses alignment value as specified by the
15706 psABI, and @samp{cacheline} uses increased alignment value to match
15707 the cache line size.  @samp{compat} is the default.
15709 @item -mlarge-data-threshold=@var{threshold}
15710 @opindex mlarge-data-threshold
15711 When @option{-mcmodel=medium} is specified, data objects larger than
15712 @var{threshold} are placed in the large data section.  This value must be the
15713 same across all objects linked into the binary, and defaults to 65535.
15715 @item -mrtd
15716 @opindex mrtd
15717 Use a different function-calling convention, in which functions that
15718 take a fixed number of arguments return with the @code{ret @var{num}}
15719 instruction, which pops their arguments while returning.  This saves one
15720 instruction in the caller since there is no need to pop the arguments
15721 there.
15723 You can specify that an individual function is called with this calling
15724 sequence with the function attribute @samp{stdcall}.  You can also
15725 override the @option{-mrtd} option by using the function attribute
15726 @samp{cdecl}.  @xref{Function Attributes}.
15728 @strong{Warning:} this calling convention is incompatible with the one
15729 normally used on Unix, so you cannot use it if you need to call
15730 libraries compiled with the Unix compiler.
15732 Also, you must provide function prototypes for all functions that
15733 take variable numbers of arguments (including @code{printf});
15734 otherwise incorrect code is generated for calls to those
15735 functions.
15737 In addition, seriously incorrect code results if you call a
15738 function with too many arguments.  (Normally, extra arguments are
15739 harmlessly ignored.)
15741 @item -mregparm=@var{num}
15742 @opindex mregparm
15743 Control how many registers are used to pass integer arguments.  By
15744 default, no registers are used to pass arguments, and at most 3
15745 registers can be used.  You can control this behavior for a specific
15746 function by using the function attribute @samp{regparm}.
15747 @xref{Function Attributes}.
15749 @strong{Warning:} if you use this switch, and
15750 @var{num} is nonzero, then you must build all modules with the same
15751 value, including any libraries.  This includes the system libraries and
15752 startup modules.
15754 @item -msseregparm
15755 @opindex msseregparm
15756 Use SSE register passing conventions for float and double arguments
15757 and return values.  You can control this behavior for a specific
15758 function by using the function attribute @samp{sseregparm}.
15759 @xref{Function Attributes}.
15761 @strong{Warning:} if you use this switch then you must build all
15762 modules with the same value, including any libraries.  This includes
15763 the system libraries and startup modules.
15765 @item -mvect8-ret-in-mem
15766 @opindex mvect8-ret-in-mem
15767 Return 8-byte vectors in memory instead of MMX registers.  This is the
15768 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15769 Studio compilers until version 12.  Later compiler versions (starting
15770 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15771 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15772 you need to remain compatible with existing code produced by those
15773 previous compiler versions or older versions of GCC@.
15775 @item -mpc32
15776 @itemx -mpc64
15777 @itemx -mpc80
15778 @opindex mpc32
15779 @opindex mpc64
15780 @opindex mpc80
15782 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15783 is specified, the significands of results of floating-point operations are
15784 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15785 significands of results of floating-point operations to 53 bits (double
15786 precision) and @option{-mpc80} rounds the significands of results of
15787 floating-point operations to 64 bits (extended double precision), which is
15788 the default.  When this option is used, floating-point operations in higher
15789 precisions are not available to the programmer without setting the FPU
15790 control word explicitly.
15792 Setting the rounding of floating-point operations to less than the default
15793 80 bits can speed some programs by 2% or more.  Note that some mathematical
15794 libraries assume that extended-precision (80-bit) floating-point operations
15795 are enabled by default; routines in such libraries could suffer significant
15796 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15797 when this option is used to set the precision to less than extended precision.
15799 @item -mstackrealign
15800 @opindex mstackrealign
15801 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15802 option generates an alternate prologue and epilogue that realigns the
15803 run-time stack if necessary.  This supports mixing legacy codes that keep
15804 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15805 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15806 applicable to individual functions.
15808 @item -mpreferred-stack-boundary=@var{num}
15809 @opindex mpreferred-stack-boundary
15810 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15811 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15812 the default is 4 (16 bytes or 128 bits).
15814 @strong{Warning:} When generating code for the x86-64 architecture with
15815 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15816 used to keep the stack boundary aligned to 8 byte boundary.  Since
15817 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15818 intended to be used in controlled environment where stack space is
15819 important limitation.  This option will lead to wrong code when functions
15820 compiled with 16 byte stack alignment (such as functions from a standard
15821 library) are called with misaligned stack.  In this case, SSE
15822 instructions may lead to misaligned memory access traps.  In addition,
15823 variable arguments will be handled incorrectly for 16 byte aligned
15824 objects (including x87 long double and __int128), leading to wrong
15825 results.  You must build all modules with
15826 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15827 includes the system libraries and startup modules.
15829 @item -mincoming-stack-boundary=@var{num}
15830 @opindex mincoming-stack-boundary
15831 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15832 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15833 the one specified by @option{-mpreferred-stack-boundary} is used.
15835 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15836 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15837 suffer significant run time performance penalties.  On Pentium III, the
15838 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15839 properly if it is not 16-byte aligned.
15841 To ensure proper alignment of this values on the stack, the stack boundary
15842 must be as aligned as that required by any value stored on the stack.
15843 Further, every function must be generated such that it keeps the stack
15844 aligned.  Thus calling a function compiled with a higher preferred
15845 stack boundary from a function compiled with a lower preferred stack
15846 boundary most likely misaligns the stack.  It is recommended that
15847 libraries that use callbacks always use the default setting.
15849 This extra alignment does consume extra stack space, and generally
15850 increases code size.  Code that is sensitive to stack space usage, such
15851 as embedded systems and operating system kernels, may want to reduce the
15852 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15854 @item -mmmx
15855 @itemx -mno-mmx
15856 @itemx -msse
15857 @itemx -mno-sse
15858 @itemx -msse2
15859 @itemx -mno-sse2
15860 @itemx -msse3
15861 @itemx -mno-sse3
15862 @itemx -mssse3
15863 @itemx -mno-ssse3
15864 @itemx -msse4.1
15865 @need 800
15866 @itemx -mno-sse4.1
15867 @itemx -msse4.2
15868 @itemx -mno-sse4.2
15869 @itemx -msse4
15870 @itemx -mno-sse4
15871 @itemx -mavx
15872 @itemx -mno-avx
15873 @itemx -mavx2
15874 @itemx -mno-avx2
15875 @itemx -mavx512f
15876 @itemx -mno-avx512f
15877 @need 800
15878 @itemx -mavx512pf
15879 @itemx -mno-avx512pf
15880 @itemx -mavx512er
15881 @itemx -mno-avx512er
15882 @itemx -mavx512cd
15883 @itemx -mno-avx512cd
15884 @itemx -msha
15885 @itemx -mno-sha
15886 @itemx -maes
15887 @itemx -mno-aes
15888 @itemx -mpclmul
15889 @itemx -mno-pclmul
15890 @itemx -mclfushopt
15891 @itemx -mno-clflsuhopt
15892 @need 800
15893 @itemx -mfsgsbase
15894 @itemx -mno-fsgsbase
15895 @itemx -mrdrnd
15896 @itemx -mno-rdrnd
15897 @itemx -mf16c
15898 @itemx -mno-f16c
15899 @itemx -mfma
15900 @itemx -mno-fma
15901 @itemx -mprefetchwt1
15902 @itemx -mno-prefetchwt1
15903 @itemx -msse4a
15904 @itemx -mno-sse4a
15905 @itemx -mfma4
15906 @itemx -mno-fma4
15907 @need 800
15908 @itemx -mxop
15909 @itemx -mno-xop
15910 @itemx -mlwp
15911 @itemx -mno-lwp
15912 @itemx -m3dnow
15913 @itemx -mno-3dnow
15914 @itemx -mpopcnt
15915 @itemx -mno-popcnt
15916 @itemx -mabm
15917 @itemx -mno-abm
15918 @itemx -mbmi
15919 @itemx -mbmi2
15920 @itemx -mno-bmi
15921 @itemx -mno-bmi2
15922 @itemx -mlzcnt
15923 @itemx -mno-lzcnt
15924 @itemx -mfxsr
15925 @itemx -mxsave
15926 @itemx -mxsaveopt
15927 @itemx -mrtm
15928 @itemx -mtbm
15929 @itemx -mno-tbm
15930 @itemx -mxsavec
15931 @itemx -mno-xsavec
15932 @itemx -mxsaves
15933 @itemx -mno-xsaves
15934 @itemx -mmpx
15935 @itemx -mno-mpx
15936 @opindex mmmx
15937 @opindex mno-mmx
15938 @opindex msse
15939 @opindex mno-sse
15940 @opindex m3dnow
15941 @opindex mno-3dnow
15942 These switches enable or disable the use of instructions in the MMX, SSE,
15943 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15944 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15945 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15946 extended instruction sets.
15947 These extensions are also available as built-in functions: see
15948 @ref{X86 Built-in Functions}, for details of the functions enabled and
15949 disabled by these switches.
15951 To generate SSE/SSE2 instructions automatically from floating-point
15952 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15954 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15955 generates new AVX instructions or AVX equivalence for all SSEx instructions
15956 when needed.
15958 These options enable GCC to use these extended instructions in
15959 generated code, even without @option{-mfpmath=sse}.  Applications that
15960 perform run-time CPU detection must compile separate files for each
15961 supported architecture, using the appropriate flags.  In particular,
15962 the file containing the CPU detection code should be compiled without
15963 these options.
15965 @item -mdump-tune-features
15966 @opindex mdump-tune-features
15967 This option instructs GCC to dump the names of the x86 performance 
15968 tuning features and default settings. The names can be used in 
15969 @option{-mtune-ctrl=@var{feature-list}}.
15971 @item -mtune-ctrl=@var{feature-list}
15972 @opindex mtune-ctrl=@var{feature-list}
15973 This option is used to do fine grain control of x86 code generation features.
15974 @var{feature-list} is a comma separated list of @var{feature} names. See also
15975 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15976 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15977 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15978 developers. Using it may lead to code paths not covered by testing and can
15979 potentially result in compiler ICEs or runtime errors.
15981 @item -mno-default
15982 @opindex mno-default
15983 This option instructs GCC to turn off all tunable features. See also 
15984 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15986 @item -mcld
15987 @opindex mcld
15988 This option instructs GCC to emit a @code{cld} instruction in the prologue
15989 of functions that use string instructions.  String instructions depend on
15990 the DF flag to select between autoincrement or autodecrement mode.  While the
15991 ABI specifies the DF flag to be cleared on function entry, some operating
15992 systems violate this specification by not clearing the DF flag in their
15993 exception dispatchers.  The exception handler can be invoked with the DF flag
15994 set, which leads to wrong direction mode when string instructions are used.
15995 This option can be enabled by default on 32-bit x86 targets by configuring
15996 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15997 instructions can be suppressed with the @option{-mno-cld} compiler option
15998 in this case.
16000 @item -mvzeroupper
16001 @opindex mvzeroupper
16002 This option instructs GCC to emit a @code{vzeroupper} instruction
16003 before a transfer of control flow out of the function to minimize
16004 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
16005 intrinsics.
16007 @item -mprefer-avx128
16008 @opindex mprefer-avx128
16009 This option instructs GCC to use 128-bit AVX instructions instead of
16010 256-bit AVX instructions in the auto-vectorizer.
16012 @item -mcx16
16013 @opindex mcx16
16014 This option enables GCC to generate @code{CMPXCHG16B} instructions.
16015 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
16016 (or oword) data types.  
16017 This is useful for high-resolution counters that can be updated
16018 by multiple processors (or cores).  This instruction is generated as part of
16019 atomic built-in functions: see @ref{__sync Builtins} or
16020 @ref{__atomic Builtins} for details.
16022 @item -msahf
16023 @opindex msahf
16024 This option enables generation of @code{SAHF} instructions in 64-bit code.
16025 Early Intel Pentium 4 CPUs with Intel 64 support,
16026 prior to the introduction of Pentium 4 G1 step in December 2005,
16027 lacked the @code{LAHF} and @code{SAHF} instructions
16028 which were supported by AMD64.
16029 These are load and store instructions, respectively, for certain status flags.
16030 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
16031 @code{drem}, and @code{remainder} built-in functions;
16032 see @ref{Other Builtins} for details.
16034 @item -mmovbe
16035 @opindex mmovbe
16036 This option enables use of the @code{movbe} instruction to implement
16037 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
16039 @item -mcrc32
16040 @opindex mcrc32
16041 This option enables built-in functions @code{__builtin_ia32_crc32qi},
16042 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
16043 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
16045 @item -mrecip
16046 @opindex mrecip
16047 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
16048 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
16049 with an additional Newton-Raphson step
16050 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
16051 (and their vectorized
16052 variants) for single-precision floating-point arguments.  These instructions
16053 are generated only when @option{-funsafe-math-optimizations} is enabled
16054 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
16055 Note that while the throughput of the sequence is higher than the throughput
16056 of the non-reciprocal instruction, the precision of the sequence can be
16057 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
16059 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
16060 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
16061 combination), and doesn't need @option{-mrecip}.
16063 Also note that GCC emits the above sequence with additional Newton-Raphson step
16064 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
16065 already with @option{-ffast-math} (or the above option combination), and
16066 doesn't need @option{-mrecip}.
16068 @item -mrecip=@var{opt}
16069 @opindex mrecip=opt
16070 This option controls which reciprocal estimate instructions
16071 may be used.  @var{opt} is a comma-separated list of options, which may
16072 be preceded by a @samp{!} to invert the option:
16074 @table @samp
16075 @item all
16076 Enable all estimate instructions.
16078 @item default
16079 Enable the default instructions, equivalent to @option{-mrecip}.
16081 @item none
16082 Disable all estimate instructions, equivalent to @option{-mno-recip}.
16084 @item div
16085 Enable the approximation for scalar division.
16087 @item vec-div
16088 Enable the approximation for vectorized division.
16090 @item sqrt
16091 Enable the approximation for scalar square root.
16093 @item vec-sqrt
16094 Enable the approximation for vectorized square root.
16095 @end table
16097 So, for example, @option{-mrecip=all,!sqrt} enables
16098 all of the reciprocal approximations, except for square root.
16100 @item -mveclibabi=@var{type}
16101 @opindex mveclibabi
16102 Specifies the ABI type to use for vectorizing intrinsics using an
16103 external library.  Supported values for @var{type} are @samp{svml} 
16104 for the Intel short
16105 vector math library and @samp{acml} for the AMD math core library.
16106 To use this option, both @option{-ftree-vectorize} and
16107 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
16108 ABI-compatible library must be specified at link time.
16110 GCC currently emits calls to @code{vmldExp2},
16111 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
16112 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
16113 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
16114 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
16115 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
16116 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
16117 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
16118 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
16119 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
16120 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
16121 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
16122 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
16123 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
16124 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
16125 when @option{-mveclibabi=acml} is used.  
16127 @item -mabi=@var{name}
16128 @opindex mabi
16129 Generate code for the specified calling convention.  Permissible values
16130 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
16131 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
16132 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
16133 You can control this behavior for a specific function by
16134 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
16135 @xref{Function Attributes}.
16137 @item -mtls-dialect=@var{type}
16138 @opindex mtls-dialect
16139 Generate code to access thread-local storage using the @samp{gnu} or
16140 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
16141 @samp{gnu2} is more efficient, but it may add compile- and run-time
16142 requirements that cannot be satisfied on all systems.
16144 @item -mpush-args
16145 @itemx -mno-push-args
16146 @opindex mpush-args
16147 @opindex mno-push-args
16148 Use PUSH operations to store outgoing parameters.  This method is shorter
16149 and usually equally fast as method using SUB/MOV operations and is enabled
16150 by default.  In some cases disabling it may improve performance because of
16151 improved scheduling and reduced dependencies.
16153 @item -maccumulate-outgoing-args
16154 @opindex maccumulate-outgoing-args
16155 If enabled, the maximum amount of space required for outgoing arguments is
16156 computed in the function prologue.  This is faster on most modern CPUs
16157 because of reduced dependencies, improved scheduling and reduced stack usage
16158 when the preferred stack boundary is not equal to 2.  The drawback is a notable
16159 increase in code size.  This switch implies @option{-mno-push-args}.
16161 @item -mthreads
16162 @opindex mthreads
16163 Support thread-safe exception handling on MinGW.  Programs that rely
16164 on thread-safe exception handling must compile and link all code with the
16165 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
16166 @code{-D_MT}; when linking, it links in a special thread helper library
16167 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
16169 @item -mno-align-stringops
16170 @opindex mno-align-stringops
16171 Do not align the destination of inlined string operations.  This switch reduces
16172 code size and improves performance in case the destination is already aligned,
16173 but GCC doesn't know about it.
16175 @item -minline-all-stringops
16176 @opindex minline-all-stringops
16177 By default GCC inlines string operations only when the destination is 
16178 known to be aligned to least a 4-byte boundary.  
16179 This enables more inlining and increases code
16180 size, but may improve performance of code that depends on fast
16181 @code{memcpy}, @code{strlen},
16182 and @code{memset} for short lengths.
16184 @item -minline-stringops-dynamically
16185 @opindex minline-stringops-dynamically
16186 For string operations of unknown size, use run-time checks with
16187 inline code for small blocks and a library call for large blocks.
16189 @item -mstringop-strategy=@var{alg}
16190 @opindex mstringop-strategy=@var{alg}
16191 Override the internal decision heuristic for the particular algorithm to use
16192 for inlining string operations.  The allowed values for @var{alg} are:
16194 @table @samp
16195 @item rep_byte
16196 @itemx rep_4byte
16197 @itemx rep_8byte
16198 Expand using i386 @code{rep} prefix of the specified size.
16200 @item byte_loop
16201 @itemx loop
16202 @itemx unrolled_loop
16203 Expand into an inline loop.
16205 @item libcall
16206 Always use a library call.
16207 @end table
16209 @item -mmemcpy-strategy=@var{strategy}
16210 @opindex mmemcpy-strategy=@var{strategy}
16211 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
16212 should be inlined and what inline algorithm to use when the expected size
16213 of the copy operation is known. @var{strategy} 
16214 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
16215 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
16216 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
16217 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
16218 in the list must be specified in increasing order.  The minimal byte size for 
16219 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
16220 preceding range.
16222 @item -mmemset-strategy=@var{strategy}
16223 @opindex mmemset-strategy=@var{strategy}
16224 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
16225 @code{__builtin_memset} expansion.
16227 @item -momit-leaf-frame-pointer
16228 @opindex momit-leaf-frame-pointer
16229 Don't keep the frame pointer in a register for leaf functions.  This
16230 avoids the instructions to save, set up, and restore frame pointers and
16231 makes an extra register available in leaf functions.  The option
16232 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
16233 which might make debugging harder.
16235 @item -mtls-direct-seg-refs
16236 @itemx -mno-tls-direct-seg-refs
16237 @opindex mtls-direct-seg-refs
16238 Controls whether TLS variables may be accessed with offsets from the
16239 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16240 or whether the thread base pointer must be added.  Whether or not this
16241 is valid depends on the operating system, and whether it maps the
16242 segment to cover the entire TLS area.
16244 For systems that use the GNU C Library, the default is on.
16246 @item -msse2avx
16247 @itemx -mno-sse2avx
16248 @opindex msse2avx
16249 Specify that the assembler should encode SSE instructions with VEX
16250 prefix.  The option @option{-mavx} turns this on by default.
16252 @item -mfentry
16253 @itemx -mno-fentry
16254 @opindex mfentry
16255 If profiling is active (@option{-pg}), put the profiling
16256 counter call before the prologue.
16257 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16258 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16260 @item -mrecord-mcount
16261 @itemx -mno-record-mcount
16262 @opindex mrecord-mcount
16263 If profiling is active (@option{-pg}), generate a __mcount_loc section
16264 that contains pointers to each profiling call. This is useful for
16265 automatically patching and out calls.
16267 @item -mnop-mcount
16268 @itemx -mno-nop-mcount
16269 @opindex mnop-mcount
16270 If profiling is active (@option{-pg}), generate the calls to
16271 the profiling functions as nops. This is useful when they
16272 should be patched in later dynamically. This is likely only
16273 useful together with @option{-mrecord-mcount}.
16275 @item -mskip-rax-setup
16276 @itemx -mno-skip-rax-setup
16277 @opindex mskip-rax-setup
16278 When generating code for the x86-64 architecture with SSE extensions
16279 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
16280 register when there are no variable arguments passed in vector registers.
16282 @strong{Warning:} Since RAX register is used to avoid unnecessarily
16283 saving vector registers on stack when passing variable arguments, the
16284 impacts of this option are callees may waste some stack space,
16285 misbehave or jump to a random location.  GCC 4.4 or newer don't have
16286 those issues, regardless the RAX register value.
16288 @item -m8bit-idiv
16289 @itemx -mno-8bit-idiv
16290 @opindex 8bit-idiv
16291 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16292 much faster than 32-bit/64-bit integer divide.  This option generates a
16293 run-time check.  If both dividend and divisor are within range of 0
16294 to 255, 8-bit unsigned integer divide is used instead of
16295 32-bit/64-bit integer divide.
16297 @item -mavx256-split-unaligned-load
16298 @itemx -mavx256-split-unaligned-store
16299 @opindex avx256-split-unaligned-load
16300 @opindex avx256-split-unaligned-store
16301 Split 32-byte AVX unaligned load and store.
16303 @item -mstack-protector-guard=@var{guard}
16304 @opindex mstack-protector-guard=@var{guard}
16305 Generate stack protection code using canary at @var{guard}.  Supported
16306 locations are @samp{global} for global canary or @samp{tls} for per-thread
16307 canary in the TLS block (the default).  This option has effect only when
16308 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16310 @end table
16312 These @samp{-m} switches are supported in addition to the above
16313 on x86-64 processors in 64-bit environments.
16315 @table @gcctabopt
16316 @item -m32
16317 @itemx -m64
16318 @itemx -mx32
16319 @itemx -m16
16320 @opindex m32
16321 @opindex m64
16322 @opindex mx32
16323 @opindex m16
16324 Generate code for a 16-bit, 32-bit or 64-bit environment.
16325 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16326 to 32 bits, and
16327 generates code that runs on any i386 system.
16329 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16330 types to 64 bits, and generates code for the x86-64 architecture.
16331 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16332 and @option{-mdynamic-no-pic} options.
16334 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16335 to 32 bits, and
16336 generates code for the x86-64 architecture.
16338 The @option{-m16} option is the same as @option{-m32}, except for that
16339 it outputs the @code{.code16gcc} assembly directive at the beginning of
16340 the assembly output so that the binary can run in 16-bit mode.
16342 @item -mno-red-zone
16343 @opindex mno-red-zone
16344 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16345 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16346 stack pointer that is not modified by signal or interrupt handlers
16347 and therefore can be used for temporary data without adjusting the stack
16348 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16350 @item -mcmodel=small
16351 @opindex mcmodel=small
16352 Generate code for the small code model: the program and its symbols must
16353 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16354 Programs can be statically or dynamically linked.  This is the default
16355 code model.
16357 @item -mcmodel=kernel
16358 @opindex mcmodel=kernel
16359 Generate code for the kernel code model.  The kernel runs in the
16360 negative 2 GB of the address space.
16361 This model has to be used for Linux kernel code.
16363 @item -mcmodel=medium
16364 @opindex mcmodel=medium
16365 Generate code for the medium model: the program is linked in the lower 2
16366 GB of the address space.  Small symbols are also placed there.  Symbols
16367 with sizes larger than @option{-mlarge-data-threshold} are put into
16368 large data or BSS sections and can be located above 2GB.  Programs can
16369 be statically or dynamically linked.
16371 @item -mcmodel=large
16372 @opindex mcmodel=large
16373 Generate code for the large model.  This model makes no assumptions
16374 about addresses and sizes of sections.
16376 @item -maddress-mode=long
16377 @opindex maddress-mode=long
16378 Generate code for long address mode.  This is only supported for 64-bit
16379 and x32 environments.  It is the default address mode for 64-bit
16380 environments.
16382 @item -maddress-mode=short
16383 @opindex maddress-mode=short
16384 Generate code for short address mode.  This is only supported for 32-bit
16385 and x32 environments.  It is the default address mode for 32-bit and
16386 x32 environments.
16387 @end table
16389 @node i386 and x86-64 Windows Options
16390 @subsection i386 and x86-64 Windows Options
16391 @cindex i386 and x86-64 Windows Options
16393 These additional options are available for Microsoft Windows targets:
16395 @table @gcctabopt
16396 @item -mconsole
16397 @opindex mconsole
16398 This option
16399 specifies that a console application is to be generated, by
16400 instructing the linker to set the PE header subsystem type
16401 required for console applications.
16402 This option is available for Cygwin and MinGW targets and is
16403 enabled by default on those targets.
16405 @item -mdll
16406 @opindex mdll
16407 This option is available for Cygwin and MinGW targets.  It
16408 specifies that a DLL---a dynamic link library---is to be
16409 generated, enabling the selection of the required runtime
16410 startup object and entry point.
16412 @item -mnop-fun-dllimport
16413 @opindex mnop-fun-dllimport
16414 This option is available for Cygwin and MinGW targets.  It
16415 specifies that the @code{dllimport} attribute should be ignored.
16417 @item -mthread
16418 @opindex mthread
16419 This option is available for MinGW targets. It specifies
16420 that MinGW-specific thread support is to be used.
16422 @item -municode
16423 @opindex municode
16424 This option is available for MinGW-w64 targets.  It causes
16425 the @code{UNICODE} preprocessor macro to be predefined, and
16426 chooses Unicode-capable runtime startup code.
16428 @item -mwin32
16429 @opindex mwin32
16430 This option is available for Cygwin and MinGW targets.  It
16431 specifies that the typical Microsoft Windows predefined macros are to
16432 be set in the pre-processor, but does not influence the choice
16433 of runtime library/startup code.
16435 @item -mwindows
16436 @opindex mwindows
16437 This option is available for Cygwin and MinGW targets.  It
16438 specifies that a GUI application is to be generated by
16439 instructing the linker to set the PE header subsystem type
16440 appropriately.
16442 @item -fno-set-stack-executable
16443 @opindex fno-set-stack-executable
16444 This option is available for MinGW targets. It specifies that
16445 the executable flag for the stack used by nested functions isn't
16446 set. This is necessary for binaries running in kernel mode of
16447 Microsoft Windows, as there the User32 API, which is used to set executable
16448 privileges, isn't available.
16450 @item -fwritable-relocated-rdata
16451 @opindex fno-writable-relocated-rdata
16452 This option is available for MinGW and Cygwin targets.  It specifies
16453 that relocated-data in read-only section is put into .data
16454 section.  This is a necessary for older runtimes not supporting
16455 modification of .rdata sections for pseudo-relocation.
16457 @item -mpe-aligned-commons
16458 @opindex mpe-aligned-commons
16459 This option is available for Cygwin and MinGW targets.  It
16460 specifies that the GNU extension to the PE file format that
16461 permits the correct alignment of COMMON variables should be
16462 used when generating code.  It is enabled by default if
16463 GCC detects that the target assembler found during configuration
16464 supports the feature.
16465 @end table
16467 See also under @ref{i386 and x86-64 Options} for standard options.
16469 @node IA-64 Options
16470 @subsection IA-64 Options
16471 @cindex IA-64 Options
16473 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16475 @table @gcctabopt
16476 @item -mbig-endian
16477 @opindex mbig-endian
16478 Generate code for a big-endian target.  This is the default for HP-UX@.
16480 @item -mlittle-endian
16481 @opindex mlittle-endian
16482 Generate code for a little-endian target.  This is the default for AIX5
16483 and GNU/Linux.
16485 @item -mgnu-as
16486 @itemx -mno-gnu-as
16487 @opindex mgnu-as
16488 @opindex mno-gnu-as
16489 Generate (or don't) code for the GNU assembler.  This is the default.
16490 @c Also, this is the default if the configure option @option{--with-gnu-as}
16491 @c is used.
16493 @item -mgnu-ld
16494 @itemx -mno-gnu-ld
16495 @opindex mgnu-ld
16496 @opindex mno-gnu-ld
16497 Generate (or don't) code for the GNU linker.  This is the default.
16498 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16499 @c is used.
16501 @item -mno-pic
16502 @opindex mno-pic
16503 Generate code that does not use a global pointer register.  The result
16504 is not position independent code, and violates the IA-64 ABI@.
16506 @item -mvolatile-asm-stop
16507 @itemx -mno-volatile-asm-stop
16508 @opindex mvolatile-asm-stop
16509 @opindex mno-volatile-asm-stop
16510 Generate (or don't) a stop bit immediately before and after volatile asm
16511 statements.
16513 @item -mregister-names
16514 @itemx -mno-register-names
16515 @opindex mregister-names
16516 @opindex mno-register-names
16517 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16518 the stacked registers.  This may make assembler output more readable.
16520 @item -mno-sdata
16521 @itemx -msdata
16522 @opindex mno-sdata
16523 @opindex msdata
16524 Disable (or enable) optimizations that use the small data section.  This may
16525 be useful for working around optimizer bugs.
16527 @item -mconstant-gp
16528 @opindex mconstant-gp
16529 Generate code that uses a single constant global pointer value.  This is
16530 useful when compiling kernel code.
16532 @item -mauto-pic
16533 @opindex mauto-pic
16534 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16535 This is useful when compiling firmware code.
16537 @item -minline-float-divide-min-latency
16538 @opindex minline-float-divide-min-latency
16539 Generate code for inline divides of floating-point values
16540 using the minimum latency algorithm.
16542 @item -minline-float-divide-max-throughput
16543 @opindex minline-float-divide-max-throughput
16544 Generate code for inline divides of floating-point values
16545 using the maximum throughput algorithm.
16547 @item -mno-inline-float-divide
16548 @opindex mno-inline-float-divide
16549 Do not generate inline code for divides of floating-point values.
16551 @item -minline-int-divide-min-latency
16552 @opindex minline-int-divide-min-latency
16553 Generate code for inline divides of integer values
16554 using the minimum latency algorithm.
16556 @item -minline-int-divide-max-throughput
16557 @opindex minline-int-divide-max-throughput
16558 Generate code for inline divides of integer values
16559 using the maximum throughput algorithm.
16561 @item -mno-inline-int-divide
16562 @opindex mno-inline-int-divide
16563 Do not generate inline code for divides of integer values.
16565 @item -minline-sqrt-min-latency
16566 @opindex minline-sqrt-min-latency
16567 Generate code for inline square roots
16568 using the minimum latency algorithm.
16570 @item -minline-sqrt-max-throughput
16571 @opindex minline-sqrt-max-throughput
16572 Generate code for inline square roots
16573 using the maximum throughput algorithm.
16575 @item -mno-inline-sqrt
16576 @opindex mno-inline-sqrt
16577 Do not generate inline code for @code{sqrt}.
16579 @item -mfused-madd
16580 @itemx -mno-fused-madd
16581 @opindex mfused-madd
16582 @opindex mno-fused-madd
16583 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16584 instructions.  The default is to use these instructions.
16586 @item -mno-dwarf2-asm
16587 @itemx -mdwarf2-asm
16588 @opindex mno-dwarf2-asm
16589 @opindex mdwarf2-asm
16590 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16591 info.  This may be useful when not using the GNU assembler.
16593 @item -mearly-stop-bits
16594 @itemx -mno-early-stop-bits
16595 @opindex mearly-stop-bits
16596 @opindex mno-early-stop-bits
16597 Allow stop bits to be placed earlier than immediately preceding the
16598 instruction that triggered the stop bit.  This can improve instruction
16599 scheduling, but does not always do so.
16601 @item -mfixed-range=@var{register-range}
16602 @opindex mfixed-range
16603 Generate code treating the given register range as fixed registers.
16604 A fixed register is one that the register allocator cannot use.  This is
16605 useful when compiling kernel code.  A register range is specified as
16606 two registers separated by a dash.  Multiple register ranges can be
16607 specified separated by a comma.
16609 @item -mtls-size=@var{tls-size}
16610 @opindex mtls-size
16611 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16614 @item -mtune=@var{cpu-type}
16615 @opindex mtune
16616 Tune the instruction scheduling for a particular CPU, Valid values are
16617 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16618 and @samp{mckinley}.
16620 @item -milp32
16621 @itemx -mlp64
16622 @opindex milp32
16623 @opindex mlp64
16624 Generate code for a 32-bit or 64-bit environment.
16625 The 32-bit environment sets int, long and pointer to 32 bits.
16626 The 64-bit environment sets int to 32 bits and long and pointer
16627 to 64 bits.  These are HP-UX specific flags.
16629 @item -mno-sched-br-data-spec
16630 @itemx -msched-br-data-spec
16631 @opindex mno-sched-br-data-spec
16632 @opindex msched-br-data-spec
16633 (Dis/En)able data speculative scheduling before reload.
16634 This results in generation of @code{ld.a} instructions and
16635 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16636 The default is 'disable'.
16638 @item -msched-ar-data-spec
16639 @itemx -mno-sched-ar-data-spec
16640 @opindex msched-ar-data-spec
16641 @opindex mno-sched-ar-data-spec
16642 (En/Dis)able data speculative scheduling after reload.
16643 This results in generation of @code{ld.a} instructions and
16644 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16645 The default is 'enable'.
16647 @item -mno-sched-control-spec
16648 @itemx -msched-control-spec
16649 @opindex mno-sched-control-spec
16650 @opindex msched-control-spec
16651 (Dis/En)able control speculative scheduling.  This feature is
16652 available only during region scheduling (i.e.@: before reload).
16653 This results in generation of the @code{ld.s} instructions and
16654 the corresponding check instructions @code{chk.s}.
16655 The default is 'disable'.
16657 @item -msched-br-in-data-spec
16658 @itemx -mno-sched-br-in-data-spec
16659 @opindex msched-br-in-data-spec
16660 @opindex mno-sched-br-in-data-spec
16661 (En/Dis)able speculative scheduling of the instructions that
16662 are dependent on the data speculative loads before reload.
16663 This is effective only with @option{-msched-br-data-spec} enabled.
16664 The default is 'enable'.
16666 @item -msched-ar-in-data-spec
16667 @itemx -mno-sched-ar-in-data-spec
16668 @opindex msched-ar-in-data-spec
16669 @opindex mno-sched-ar-in-data-spec
16670 (En/Dis)able speculative scheduling of the instructions that
16671 are dependent on the data speculative loads after reload.
16672 This is effective only with @option{-msched-ar-data-spec} enabled.
16673 The default is 'enable'.
16675 @item -msched-in-control-spec
16676 @itemx -mno-sched-in-control-spec
16677 @opindex msched-in-control-spec
16678 @opindex mno-sched-in-control-spec
16679 (En/Dis)able speculative scheduling of the instructions that
16680 are dependent on the control speculative loads.
16681 This is effective only with @option{-msched-control-spec} enabled.
16682 The default is 'enable'.
16684 @item -mno-sched-prefer-non-data-spec-insns
16685 @itemx -msched-prefer-non-data-spec-insns
16686 @opindex mno-sched-prefer-non-data-spec-insns
16687 @opindex msched-prefer-non-data-spec-insns
16688 If enabled, data-speculative instructions are chosen for schedule
16689 only if there are no other choices at the moment.  This makes
16690 the use of the data speculation much more conservative.
16691 The default is 'disable'.
16693 @item -mno-sched-prefer-non-control-spec-insns
16694 @itemx -msched-prefer-non-control-spec-insns
16695 @opindex mno-sched-prefer-non-control-spec-insns
16696 @opindex msched-prefer-non-control-spec-insns
16697 If enabled, control-speculative instructions are chosen for schedule
16698 only if there are no other choices at the moment.  This makes
16699 the use of the control speculation much more conservative.
16700 The default is 'disable'.
16702 @item -mno-sched-count-spec-in-critical-path
16703 @itemx -msched-count-spec-in-critical-path
16704 @opindex mno-sched-count-spec-in-critical-path
16705 @opindex msched-count-spec-in-critical-path
16706 If enabled, speculative dependencies are considered during
16707 computation of the instructions priorities.  This makes the use of the
16708 speculation a bit more conservative.
16709 The default is 'disable'.
16711 @item -msched-spec-ldc
16712 @opindex msched-spec-ldc
16713 Use a simple data speculation check.  This option is on by default.
16715 @item -msched-control-spec-ldc
16716 @opindex msched-spec-ldc
16717 Use a simple check for control speculation.  This option is on by default.
16719 @item -msched-stop-bits-after-every-cycle
16720 @opindex msched-stop-bits-after-every-cycle
16721 Place a stop bit after every cycle when scheduling.  This option is on
16722 by default.
16724 @item -msched-fp-mem-deps-zero-cost
16725 @opindex msched-fp-mem-deps-zero-cost
16726 Assume that floating-point stores and loads are not likely to cause a conflict
16727 when placed into the same instruction group.  This option is disabled by
16728 default.
16730 @item -msel-sched-dont-check-control-spec
16731 @opindex msel-sched-dont-check-control-spec
16732 Generate checks for control speculation in selective scheduling.
16733 This flag is disabled by default.
16735 @item -msched-max-memory-insns=@var{max-insns}
16736 @opindex msched-max-memory-insns
16737 Limit on the number of memory insns per instruction group, giving lower
16738 priority to subsequent memory insns attempting to schedule in the same
16739 instruction group. Frequently useful to prevent cache bank conflicts.
16740 The default value is 1.
16742 @item -msched-max-memory-insns-hard-limit
16743 @opindex msched-max-memory-insns-hard-limit
16744 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16745 disallowing more than that number in an instruction group.
16746 Otherwise, the limit is ``soft'', meaning that non-memory operations
16747 are preferred when the limit is reached, but memory operations may still
16748 be scheduled.
16750 @end table
16752 @node LM32 Options
16753 @subsection LM32 Options
16754 @cindex LM32 options
16756 These @option{-m} options are defined for the LatticeMico32 architecture:
16758 @table @gcctabopt
16759 @item -mbarrel-shift-enabled
16760 @opindex mbarrel-shift-enabled
16761 Enable barrel-shift instructions.
16763 @item -mdivide-enabled
16764 @opindex mdivide-enabled
16765 Enable divide and modulus instructions.
16767 @item -mmultiply-enabled
16768 @opindex multiply-enabled
16769 Enable multiply instructions.
16771 @item -msign-extend-enabled
16772 @opindex msign-extend-enabled
16773 Enable sign extend instructions.
16775 @item -muser-enabled
16776 @opindex muser-enabled
16777 Enable user-defined instructions.
16779 @end table
16781 @node M32C Options
16782 @subsection M32C Options
16783 @cindex M32C options
16785 @table @gcctabopt
16786 @item -mcpu=@var{name}
16787 @opindex mcpu=
16788 Select the CPU for which code is generated.  @var{name} may be one of
16789 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16790 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16791 the M32C/80 series.
16793 @item -msim
16794 @opindex msim
16795 Specifies that the program will be run on the simulator.  This causes
16796 an alternate runtime library to be linked in which supports, for
16797 example, file I/O@.  You must not use this option when generating
16798 programs that will run on real hardware; you must provide your own
16799 runtime library for whatever I/O functions are needed.
16801 @item -memregs=@var{number}
16802 @opindex memregs=
16803 Specifies the number of memory-based pseudo-registers GCC uses
16804 during code generation.  These pseudo-registers are used like real
16805 registers, so there is a tradeoff between GCC's ability to fit the
16806 code into available registers, and the performance penalty of using
16807 memory instead of registers.  Note that all modules in a program must
16808 be compiled with the same value for this option.  Because of that, you
16809 must not use this option with GCC's default runtime libraries.
16811 @end table
16813 @node M32R/D Options
16814 @subsection M32R/D Options
16815 @cindex M32R/D options
16817 These @option{-m} options are defined for Renesas M32R/D architectures:
16819 @table @gcctabopt
16820 @item -m32r2
16821 @opindex m32r2
16822 Generate code for the M32R/2@.
16824 @item -m32rx
16825 @opindex m32rx
16826 Generate code for the M32R/X@.
16828 @item -m32r
16829 @opindex m32r
16830 Generate code for the M32R@.  This is the default.
16832 @item -mmodel=small
16833 @opindex mmodel=small
16834 Assume all objects live in the lower 16MB of memory (so that their addresses
16835 can be loaded with the @code{ld24} instruction), and assume all subroutines
16836 are reachable with the @code{bl} instruction.
16837 This is the default.
16839 The addressability of a particular object can be set with the
16840 @code{model} attribute.
16842 @item -mmodel=medium
16843 @opindex mmodel=medium
16844 Assume objects may be anywhere in the 32-bit address space (the compiler
16845 generates @code{seth/add3} instructions to load their addresses), and
16846 assume all subroutines are reachable with the @code{bl} instruction.
16848 @item -mmodel=large
16849 @opindex mmodel=large
16850 Assume objects may be anywhere in the 32-bit address space (the compiler
16851 generates @code{seth/add3} instructions to load their addresses), and
16852 assume subroutines may not be reachable with the @code{bl} instruction
16853 (the compiler generates the much slower @code{seth/add3/jl}
16854 instruction sequence).
16856 @item -msdata=none
16857 @opindex msdata=none
16858 Disable use of the small data area.  Variables are put into
16859 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16860 @code{section} attribute has been specified).
16861 This is the default.
16863 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16864 Objects may be explicitly put in the small data area with the
16865 @code{section} attribute using one of these sections.
16867 @item -msdata=sdata
16868 @opindex msdata=sdata
16869 Put small global and static data in the small data area, but do not
16870 generate special code to reference them.
16872 @item -msdata=use
16873 @opindex msdata=use
16874 Put small global and static data in the small data area, and generate
16875 special instructions to reference them.
16877 @item -G @var{num}
16878 @opindex G
16879 @cindex smaller data references
16880 Put global and static objects less than or equal to @var{num} bytes
16881 into the small data or BSS sections instead of the normal data or BSS
16882 sections.  The default value of @var{num} is 8.
16883 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16884 for this option to have any effect.
16886 All modules should be compiled with the same @option{-G @var{num}} value.
16887 Compiling with different values of @var{num} may or may not work; if it
16888 doesn't the linker gives an error message---incorrect code is not
16889 generated.
16891 @item -mdebug
16892 @opindex mdebug
16893 Makes the M32R-specific code in the compiler display some statistics
16894 that might help in debugging programs.
16896 @item -malign-loops
16897 @opindex malign-loops
16898 Align all loops to a 32-byte boundary.
16900 @item -mno-align-loops
16901 @opindex mno-align-loops
16902 Do not enforce a 32-byte alignment for loops.  This is the default.
16904 @item -missue-rate=@var{number}
16905 @opindex missue-rate=@var{number}
16906 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16907 or 2.
16909 @item -mbranch-cost=@var{number}
16910 @opindex mbranch-cost=@var{number}
16911 @var{number} can only be 1 or 2.  If it is 1 then branches are
16912 preferred over conditional code, if it is 2, then the opposite applies.
16914 @item -mflush-trap=@var{number}
16915 @opindex mflush-trap=@var{number}
16916 Specifies the trap number to use to flush the cache.  The default is
16917 12.  Valid numbers are between 0 and 15 inclusive.
16919 @item -mno-flush-trap
16920 @opindex mno-flush-trap
16921 Specifies that the cache cannot be flushed by using a trap.
16923 @item -mflush-func=@var{name}
16924 @opindex mflush-func=@var{name}
16925 Specifies the name of the operating system function to call to flush
16926 the cache.  The default is @emph{_flush_cache}, but a function call
16927 is only used if a trap is not available.
16929 @item -mno-flush-func
16930 @opindex mno-flush-func
16931 Indicates that there is no OS function for flushing the cache.
16933 @end table
16935 @node M680x0 Options
16936 @subsection M680x0 Options
16937 @cindex M680x0 options
16939 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16940 The default settings depend on which architecture was selected when
16941 the compiler was configured; the defaults for the most common choices
16942 are given below.
16944 @table @gcctabopt
16945 @item -march=@var{arch}
16946 @opindex march
16947 Generate code for a specific M680x0 or ColdFire instruction set
16948 architecture.  Permissible values of @var{arch} for M680x0
16949 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16950 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16951 architectures are selected according to Freescale's ISA classification
16952 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16953 @samp{isab} and @samp{isac}.
16955 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16956 code for a ColdFire target.  The @var{arch} in this macro is one of the
16957 @option{-march} arguments given above.
16959 When used together, @option{-march} and @option{-mtune} select code
16960 that runs on a family of similar processors but that is optimized
16961 for a particular microarchitecture.
16963 @item -mcpu=@var{cpu}
16964 @opindex mcpu
16965 Generate code for a specific M680x0 or ColdFire processor.
16966 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16967 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16968 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16969 below, which also classifies the CPUs into families:
16971 @multitable @columnfractions 0.20 0.80
16972 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16973 @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}
16974 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16975 @item @samp{5206e} @tab @samp{5206e}
16976 @item @samp{5208} @tab @samp{5207} @samp{5208}
16977 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16978 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16979 @item @samp{5216} @tab @samp{5214} @samp{5216}
16980 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16981 @item @samp{5225} @tab @samp{5224} @samp{5225}
16982 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16983 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16984 @item @samp{5249} @tab @samp{5249}
16985 @item @samp{5250} @tab @samp{5250}
16986 @item @samp{5271} @tab @samp{5270} @samp{5271}
16987 @item @samp{5272} @tab @samp{5272}
16988 @item @samp{5275} @tab @samp{5274} @samp{5275}
16989 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16990 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16991 @item @samp{5307} @tab @samp{5307}
16992 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16993 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16994 @item @samp{5407} @tab @samp{5407}
16995 @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}
16996 @end multitable
16998 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16999 @var{arch} is compatible with @var{cpu}.  Other combinations of
17000 @option{-mcpu} and @option{-march} are rejected.
17002 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
17003 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
17004 where the value of @var{family} is given by the table above.
17006 @item -mtune=@var{tune}
17007 @opindex mtune
17008 Tune the code for a particular microarchitecture within the
17009 constraints set by @option{-march} and @option{-mcpu}.
17010 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
17011 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
17012 and @samp{cpu32}.  The ColdFire microarchitectures
17013 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
17015 You can also use @option{-mtune=68020-40} for code that needs
17016 to run relatively well on 68020, 68030 and 68040 targets.
17017 @option{-mtune=68020-60} is similar but includes 68060 targets
17018 as well.  These two options select the same tuning decisions as
17019 @option{-m68020-40} and @option{-m68020-60} respectively.
17021 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
17022 when tuning for 680x0 architecture @var{arch}.  It also defines
17023 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
17024 option is used.  If GCC is tuning for a range of architectures,
17025 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
17026 it defines the macros for every architecture in the range.
17028 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
17029 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
17030 of the arguments given above.
17032 @item -m68000
17033 @itemx -mc68000
17034 @opindex m68000
17035 @opindex mc68000
17036 Generate output for a 68000.  This is the default
17037 when the compiler is configured for 68000-based systems.
17038 It is equivalent to @option{-march=68000}.
17040 Use this option for microcontrollers with a 68000 or EC000 core,
17041 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
17043 @item -m68010
17044 @opindex m68010
17045 Generate output for a 68010.  This is the default
17046 when the compiler is configured for 68010-based systems.
17047 It is equivalent to @option{-march=68010}.
17049 @item -m68020
17050 @itemx -mc68020
17051 @opindex m68020
17052 @opindex mc68020
17053 Generate output for a 68020.  This is the default
17054 when the compiler is configured for 68020-based systems.
17055 It is equivalent to @option{-march=68020}.
17057 @item -m68030
17058 @opindex m68030
17059 Generate output for a 68030.  This is the default when the compiler is
17060 configured for 68030-based systems.  It is equivalent to
17061 @option{-march=68030}.
17063 @item -m68040
17064 @opindex m68040
17065 Generate output for a 68040.  This is the default when the compiler is
17066 configured for 68040-based systems.  It is equivalent to
17067 @option{-march=68040}.
17069 This option inhibits the use of 68881/68882 instructions that have to be
17070 emulated by software on the 68040.  Use this option if your 68040 does not
17071 have code to emulate those instructions.
17073 @item -m68060
17074 @opindex m68060
17075 Generate output for a 68060.  This is the default when the compiler is
17076 configured for 68060-based systems.  It is equivalent to
17077 @option{-march=68060}.
17079 This option inhibits the use of 68020 and 68881/68882 instructions that
17080 have to be emulated by software on the 68060.  Use this option if your 68060
17081 does not have code to emulate those instructions.
17083 @item -mcpu32
17084 @opindex mcpu32
17085 Generate output for a CPU32.  This is the default
17086 when the compiler is configured for CPU32-based systems.
17087 It is equivalent to @option{-march=cpu32}.
17089 Use this option for microcontrollers with a
17090 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17091 68336, 68340, 68341, 68349 and 68360.
17093 @item -m5200
17094 @opindex m5200
17095 Generate output for a 520X ColdFire CPU@.  This is the default
17096 when the compiler is configured for 520X-based systems.
17097 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17098 in favor of that option.
17100 Use this option for microcontroller with a 5200 core, including
17101 the MCF5202, MCF5203, MCF5204 and MCF5206.
17103 @item -m5206e
17104 @opindex m5206e
17105 Generate output for a 5206e ColdFire CPU@.  The option is now
17106 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17108 @item -m528x
17109 @opindex m528x
17110 Generate output for a member of the ColdFire 528X family.
17111 The option is now deprecated in favor of the equivalent
17112 @option{-mcpu=528x}.
17114 @item -m5307
17115 @opindex m5307
17116 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17117 in favor of the equivalent @option{-mcpu=5307}.
17119 @item -m5407
17120 @opindex m5407
17121 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17122 in favor of the equivalent @option{-mcpu=5407}.
17124 @item -mcfv4e
17125 @opindex mcfv4e
17126 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17127 This includes use of hardware floating-point instructions.
17128 The option is equivalent to @option{-mcpu=547x}, and is now
17129 deprecated in favor of that option.
17131 @item -m68020-40
17132 @opindex m68020-40
17133 Generate output for a 68040, without using any of the new instructions.
17134 This results in code that can run relatively efficiently on either a
17135 68020/68881 or a 68030 or a 68040.  The generated code does use the
17136 68881 instructions that are emulated on the 68040.
17138 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17140 @item -m68020-60
17141 @opindex m68020-60
17142 Generate output for a 68060, without using any of the new instructions.
17143 This results in code that can run relatively efficiently on either a
17144 68020/68881 or a 68030 or a 68040.  The generated code does use the
17145 68881 instructions that are emulated on the 68060.
17147 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17149 @item -mhard-float
17150 @itemx -m68881
17151 @opindex mhard-float
17152 @opindex m68881
17153 Generate floating-point instructions.  This is the default for 68020
17154 and above, and for ColdFire devices that have an FPU@.  It defines the
17155 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
17156 on ColdFire targets.
17158 @item -msoft-float
17159 @opindex msoft-float
17160 Do not generate floating-point instructions; use library calls instead.
17161 This is the default for 68000, 68010, and 68832 targets.  It is also
17162 the default for ColdFire devices that have no FPU.
17164 @item -mdiv
17165 @itemx -mno-div
17166 @opindex mdiv
17167 @opindex mno-div
17168 Generate (do not generate) ColdFire hardware divide and remainder
17169 instructions.  If @option{-march} is used without @option{-mcpu},
17170 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17171 architectures.  Otherwise, the default is taken from the target CPU
17172 (either the default CPU, or the one specified by @option{-mcpu}).  For
17173 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17174 @option{-mcpu=5206e}.
17176 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
17178 @item -mshort
17179 @opindex mshort
17180 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17181 Additionally, parameters passed on the stack are also aligned to a
17182 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17184 @item -mno-short
17185 @opindex mno-short
17186 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17188 @item -mnobitfield
17189 @itemx -mno-bitfield
17190 @opindex mnobitfield
17191 @opindex mno-bitfield
17192 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17193 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17195 @item -mbitfield
17196 @opindex mbitfield
17197 Do use the bit-field instructions.  The @option{-m68020} option implies
17198 @option{-mbitfield}.  This is the default if you use a configuration
17199 designed for a 68020.
17201 @item -mrtd
17202 @opindex mrtd
17203 Use a different function-calling convention, in which functions
17204 that take a fixed number of arguments return with the @code{rtd}
17205 instruction, which pops their arguments while returning.  This
17206 saves one instruction in the caller since there is no need to pop
17207 the arguments there.
17209 This calling convention is incompatible with the one normally
17210 used on Unix, so you cannot use it if you need to call libraries
17211 compiled with the Unix compiler.
17213 Also, you must provide function prototypes for all functions that
17214 take variable numbers of arguments (including @code{printf});
17215 otherwise incorrect code is generated for calls to those
17216 functions.
17218 In addition, seriously incorrect code results if you call a
17219 function with too many arguments.  (Normally, extra arguments are
17220 harmlessly ignored.)
17222 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17223 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17225 @item -mno-rtd
17226 @opindex mno-rtd
17227 Do not use the calling conventions selected by @option{-mrtd}.
17228 This is the default.
17230 @item -malign-int
17231 @itemx -mno-align-int
17232 @opindex malign-int
17233 @opindex mno-align-int
17234 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17235 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17236 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17237 Aligning variables on 32-bit boundaries produces code that runs somewhat
17238 faster on processors with 32-bit busses at the expense of more memory.
17240 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17241 aligns structures containing the above types differently than
17242 most published application binary interface specifications for the m68k.
17244 @item -mpcrel
17245 @opindex mpcrel
17246 Use the pc-relative addressing mode of the 68000 directly, instead of
17247 using a global offset table.  At present, this option implies @option{-fpic},
17248 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17249 not presently supported with @option{-mpcrel}, though this could be supported for
17250 68020 and higher processors.
17252 @item -mno-strict-align
17253 @itemx -mstrict-align
17254 @opindex mno-strict-align
17255 @opindex mstrict-align
17256 Do not (do) assume that unaligned memory references are handled by
17257 the system.
17259 @item -msep-data
17260 Generate code that allows the data segment to be located in a different
17261 area of memory from the text segment.  This allows for execute-in-place in
17262 an environment without virtual memory management.  This option implies
17263 @option{-fPIC}.
17265 @item -mno-sep-data
17266 Generate code that assumes that the data segment follows the text segment.
17267 This is the default.
17269 @item -mid-shared-library
17270 Generate code that supports shared libraries via the library ID method.
17271 This allows for execute-in-place and shared libraries in an environment
17272 without virtual memory management.  This option implies @option{-fPIC}.
17274 @item -mno-id-shared-library
17275 Generate code that doesn't assume ID-based shared libraries are being used.
17276 This is the default.
17278 @item -mshared-library-id=n
17279 Specifies the identification number of the ID-based shared library being
17280 compiled.  Specifying a value of 0 generates more compact code; specifying
17281 other values forces the allocation of that number to the current
17282 library, but is no more space- or time-efficient than omitting this option.
17284 @item -mxgot
17285 @itemx -mno-xgot
17286 @opindex mxgot
17287 @opindex mno-xgot
17288 When generating position-independent code for ColdFire, generate code
17289 that works if the GOT has more than 8192 entries.  This code is
17290 larger and slower than code generated without this option.  On M680x0
17291 processors, this option is not needed; @option{-fPIC} suffices.
17293 GCC normally uses a single instruction to load values from the GOT@.
17294 While this is relatively efficient, it only works if the GOT
17295 is smaller than about 64k.  Anything larger causes the linker
17296 to report an error such as:
17298 @cindex relocation truncated to fit (ColdFire)
17299 @smallexample
17300 relocation truncated to fit: R_68K_GOT16O foobar
17301 @end smallexample
17303 If this happens, you should recompile your code with @option{-mxgot}.
17304 It should then work with very large GOTs.  However, code generated with
17305 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17306 the value of a global symbol.
17308 Note that some linkers, including newer versions of the GNU linker,
17309 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17310 you should only need to use @option{-mxgot} when compiling a single
17311 object file that accesses more than 8192 GOT entries.  Very few do.
17313 These options have no effect unless GCC is generating
17314 position-independent code.
17316 @end table
17318 @node MCore Options
17319 @subsection MCore Options
17320 @cindex MCore options
17322 These are the @samp{-m} options defined for the Motorola M*Core
17323 processors.
17325 @table @gcctabopt
17327 @item -mhardlit
17328 @itemx -mno-hardlit
17329 @opindex mhardlit
17330 @opindex mno-hardlit
17331 Inline constants into the code stream if it can be done in two
17332 instructions or less.
17334 @item -mdiv
17335 @itemx -mno-div
17336 @opindex mdiv
17337 @opindex mno-div
17338 Use the divide instruction.  (Enabled by default).
17340 @item -mrelax-immediate
17341 @itemx -mno-relax-immediate
17342 @opindex mrelax-immediate
17343 @opindex mno-relax-immediate
17344 Allow arbitrary-sized immediates in bit operations.
17346 @item -mwide-bitfields
17347 @itemx -mno-wide-bitfields
17348 @opindex mwide-bitfields
17349 @opindex mno-wide-bitfields
17350 Always treat bit-fields as @code{int}-sized.
17352 @item -m4byte-functions
17353 @itemx -mno-4byte-functions
17354 @opindex m4byte-functions
17355 @opindex mno-4byte-functions
17356 Force all functions to be aligned to a 4-byte boundary.
17358 @item -mcallgraph-data
17359 @itemx -mno-callgraph-data
17360 @opindex mcallgraph-data
17361 @opindex mno-callgraph-data
17362 Emit callgraph information.
17364 @item -mslow-bytes
17365 @itemx -mno-slow-bytes
17366 @opindex mslow-bytes
17367 @opindex mno-slow-bytes
17368 Prefer word access when reading byte quantities.
17370 @item -mlittle-endian
17371 @itemx -mbig-endian
17372 @opindex mlittle-endian
17373 @opindex mbig-endian
17374 Generate code for a little-endian target.
17376 @item -m210
17377 @itemx -m340
17378 @opindex m210
17379 @opindex m340
17380 Generate code for the 210 processor.
17382 @item -mno-lsim
17383 @opindex mno-lsim
17384 Assume that runtime support has been provided and so omit the
17385 simulator library (@file{libsim.a)} from the linker command line.
17387 @item -mstack-increment=@var{size}
17388 @opindex mstack-increment
17389 Set the maximum amount for a single stack increment operation.  Large
17390 values can increase the speed of programs that contain functions
17391 that need a large amount of stack space, but they can also trigger a
17392 segmentation fault if the stack is extended too much.  The default
17393 value is 0x1000.
17395 @end table
17397 @node MeP Options
17398 @subsection MeP Options
17399 @cindex MeP options
17401 @table @gcctabopt
17403 @item -mabsdiff
17404 @opindex mabsdiff
17405 Enables the @code{abs} instruction, which is the absolute difference
17406 between two registers.
17408 @item -mall-opts
17409 @opindex mall-opts
17410 Enables all the optional instructions---average, multiply, divide, bit
17411 operations, leading zero, absolute difference, min/max, clip, and
17412 saturation.
17415 @item -maverage
17416 @opindex maverage
17417 Enables the @code{ave} instruction, which computes the average of two
17418 registers.
17420 @item -mbased=@var{n}
17421 @opindex mbased=
17422 Variables of size @var{n} bytes or smaller are placed in the
17423 @code{.based} section by default.  Based variables use the @code{$tp}
17424 register as a base register, and there is a 128-byte limit to the
17425 @code{.based} section.
17427 @item -mbitops
17428 @opindex mbitops
17429 Enables the bit operation instructions---bit test (@code{btstm}), set
17430 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17431 test-and-set (@code{tas}).
17433 @item -mc=@var{name}
17434 @opindex mc=
17435 Selects which section constant data is placed in.  @var{name} may
17436 be @code{tiny}, @code{near}, or @code{far}.
17438 @item -mclip
17439 @opindex mclip
17440 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17441 useful unless you also provide @code{-mminmax}.
17443 @item -mconfig=@var{name}
17444 @opindex mconfig=
17445 Selects one of the built-in core configurations.  Each MeP chip has
17446 one or more modules in it; each module has a core CPU and a variety of
17447 coprocessors, optional instructions, and peripherals.  The
17448 @code{MeP-Integrator} tool, not part of GCC, provides these
17449 configurations through this option; using this option is the same as
17450 using all the corresponding command-line options.  The default
17451 configuration is @code{default}.
17453 @item -mcop
17454 @opindex mcop
17455 Enables the coprocessor instructions.  By default, this is a 32-bit
17456 coprocessor.  Note that the coprocessor is normally enabled via the
17457 @code{-mconfig=} option.
17459 @item -mcop32
17460 @opindex mcop32
17461 Enables the 32-bit coprocessor's instructions.
17463 @item -mcop64
17464 @opindex mcop64
17465 Enables the 64-bit coprocessor's instructions.
17467 @item -mivc2
17468 @opindex mivc2
17469 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17471 @item -mdc
17472 @opindex mdc
17473 Causes constant variables to be placed in the @code{.near} section.
17475 @item -mdiv
17476 @opindex mdiv
17477 Enables the @code{div} and @code{divu} instructions.
17479 @item -meb
17480 @opindex meb
17481 Generate big-endian code.
17483 @item -mel
17484 @opindex mel
17485 Generate little-endian code.
17487 @item -mio-volatile
17488 @opindex mio-volatile
17489 Tells the compiler that any variable marked with the @code{io}
17490 attribute is to be considered volatile.
17492 @item -ml
17493 @opindex ml
17494 Causes variables to be assigned to the @code{.far} section by default.
17496 @item -mleadz
17497 @opindex mleadz
17498 Enables the @code{leadz} (leading zero) instruction.
17500 @item -mm
17501 @opindex mm
17502 Causes variables to be assigned to the @code{.near} section by default.
17504 @item -mminmax
17505 @opindex mminmax
17506 Enables the @code{min} and @code{max} instructions.
17508 @item -mmult
17509 @opindex mmult
17510 Enables the multiplication and multiply-accumulate instructions.
17512 @item -mno-opts
17513 @opindex mno-opts
17514 Disables all the optional instructions enabled by @code{-mall-opts}.
17516 @item -mrepeat
17517 @opindex mrepeat
17518 Enables the @code{repeat} and @code{erepeat} instructions, used for
17519 low-overhead looping.
17521 @item -ms
17522 @opindex ms
17523 Causes all variables to default to the @code{.tiny} section.  Note
17524 that there is a 65536-byte limit to this section.  Accesses to these
17525 variables use the @code{%gp} base register.
17527 @item -msatur
17528 @opindex msatur
17529 Enables the saturation instructions.  Note that the compiler does not
17530 currently generate these itself, but this option is included for
17531 compatibility with other tools, like @code{as}.
17533 @item -msdram
17534 @opindex msdram
17535 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17537 @item -msim
17538 @opindex msim
17539 Link the simulator run-time libraries.
17541 @item -msimnovec
17542 @opindex msimnovec
17543 Link the simulator runtime libraries, excluding built-in support
17544 for reset and exception vectors and tables.
17546 @item -mtf
17547 @opindex mtf
17548 Causes all functions to default to the @code{.far} section.  Without
17549 this option, functions default to the @code{.near} section.
17551 @item -mtiny=@var{n}
17552 @opindex mtiny=
17553 Variables that are @var{n} bytes or smaller are allocated to the
17554 @code{.tiny} section.  These variables use the @code{$gp} base
17555 register.  The default for this option is 4, but note that there's a
17556 65536-byte limit to the @code{.tiny} section.
17558 @end table
17560 @node MicroBlaze Options
17561 @subsection MicroBlaze Options
17562 @cindex MicroBlaze Options
17564 @table @gcctabopt
17566 @item -msoft-float
17567 @opindex msoft-float
17568 Use software emulation for floating point (default).
17570 @item -mhard-float
17571 @opindex mhard-float
17572 Use hardware floating-point instructions.
17574 @item -mmemcpy
17575 @opindex mmemcpy
17576 Do not optimize block moves, use @code{memcpy}.
17578 @item -mno-clearbss
17579 @opindex mno-clearbss
17580 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17582 @item -mcpu=@var{cpu-type}
17583 @opindex mcpu=
17584 Use features of, and schedule code for, the given CPU.
17585 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17586 where @var{X} is a major version, @var{YY} is the minor version, and
17587 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17588 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17590 @item -mxl-soft-mul
17591 @opindex mxl-soft-mul
17592 Use software multiply emulation (default).
17594 @item -mxl-soft-div
17595 @opindex mxl-soft-div
17596 Use software emulation for divides (default).
17598 @item -mxl-barrel-shift
17599 @opindex mxl-barrel-shift
17600 Use the hardware barrel shifter.
17602 @item -mxl-pattern-compare
17603 @opindex mxl-pattern-compare
17604 Use pattern compare instructions.
17606 @item -msmall-divides
17607 @opindex msmall-divides
17608 Use table lookup optimization for small signed integer divisions.
17610 @item -mxl-stack-check
17611 @opindex mxl-stack-check
17612 This option is deprecated.  Use @option{-fstack-check} instead.
17614 @item -mxl-gp-opt
17615 @opindex mxl-gp-opt
17616 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17618 @item -mxl-multiply-high
17619 @opindex mxl-multiply-high
17620 Use multiply high instructions for high part of 32x32 multiply.
17622 @item -mxl-float-convert
17623 @opindex mxl-float-convert
17624 Use hardware floating-point conversion instructions.
17626 @item -mxl-float-sqrt
17627 @opindex mxl-float-sqrt
17628 Use hardware floating-point square root instruction.
17630 @item -mbig-endian
17631 @opindex mbig-endian
17632 Generate code for a big-endian target.
17634 @item -mlittle-endian
17635 @opindex mlittle-endian
17636 Generate code for a little-endian target.
17638 @item -mxl-reorder
17639 @opindex mxl-reorder
17640 Use reorder instructions (swap and byte reversed load/store).
17642 @item -mxl-mode-@var{app-model}
17643 Select application model @var{app-model}.  Valid models are
17644 @table @samp
17645 @item executable
17646 normal executable (default), uses startup code @file{crt0.o}.
17648 @item xmdstub
17649 for use with Xilinx Microprocessor Debugger (XMD) based
17650 software intrusive debug agent called xmdstub. This uses startup file
17651 @file{crt1.o} and sets the start address of the program to 0x800.
17653 @item bootstrap
17654 for applications that are loaded using a bootloader.
17655 This model uses startup file @file{crt2.o} which does not contain a processor
17656 reset vector handler. This is suitable for transferring control on a
17657 processor reset to the bootloader rather than the application.
17659 @item novectors
17660 for applications that do not require any of the
17661 MicroBlaze vectors. This option may be useful for applications running
17662 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17663 @end table
17665 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17666 @option{-mxl-mode-@var{app-model}}.
17668 @end table
17670 @node MIPS Options
17671 @subsection MIPS Options
17672 @cindex MIPS options
17674 @table @gcctabopt
17676 @item -EB
17677 @opindex EB
17678 Generate big-endian code.
17680 @item -EL
17681 @opindex EL
17682 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17683 configurations.
17685 @item -march=@var{arch}
17686 @opindex march
17687 Generate code that runs on @var{arch}, which can be the name of a
17688 generic MIPS ISA, or the name of a particular processor.
17689 The ISA names are:
17690 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17691 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17692 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17693 @samp{mips64r5} and @samp{mips64r6}.
17694 The processor names are:
17695 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17696 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17697 @samp{5kc}, @samp{5kf},
17698 @samp{20kc},
17699 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17700 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17701 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17702 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17703 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17704 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17705 @samp{m4k},
17706 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17707 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17708 @samp{orion},
17709 @samp{p5600},
17710 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17711 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17712 @samp{rm7000}, @samp{rm9000},
17713 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17714 @samp{sb1},
17715 @samp{sr71000},
17716 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17717 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17718 @samp{xlr} and @samp{xlp}.
17719 The special value @samp{from-abi} selects the
17720 most compatible architecture for the selected ABI (that is,
17721 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17723 The native Linux/GNU toolchain also supports the value @samp{native},
17724 which selects the best architecture option for the host processor.
17725 @option{-march=native} has no effect if GCC does not recognize
17726 the processor.
17728 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17729 (for example, @option{-march=r2k}).  Prefixes are optional, and
17730 @samp{vr} may be written @samp{r}.
17732 Names of the form @samp{@var{n}f2_1} refer to processors with
17733 FPUs clocked at half the rate of the core, names of the form
17734 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17735 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17736 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17737 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17738 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17739 accepted as synonyms for @samp{@var{n}f1_1}.
17741 GCC defines two macros based on the value of this option.  The first
17742 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17743 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17744 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17745 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17746 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17748 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17749 above.  In other words, it has the full prefix and does not
17750 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17751 the macro names the resolved architecture (either @samp{"mips1"} or
17752 @samp{"mips3"}).  It names the default architecture when no
17753 @option{-march} option is given.
17755 @item -mtune=@var{arch}
17756 @opindex mtune
17757 Optimize for @var{arch}.  Among other things, this option controls
17758 the way instructions are scheduled, and the perceived cost of arithmetic
17759 operations.  The list of @var{arch} values is the same as for
17760 @option{-march}.
17762 When this option is not used, GCC optimizes for the processor
17763 specified by @option{-march}.  By using @option{-march} and
17764 @option{-mtune} together, it is possible to generate code that
17765 runs on a family of processors, but optimize the code for one
17766 particular member of that family.
17768 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17769 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17770 @option{-march} ones described above.
17772 @item -mips1
17773 @opindex mips1
17774 Equivalent to @option{-march=mips1}.
17776 @item -mips2
17777 @opindex mips2
17778 Equivalent to @option{-march=mips2}.
17780 @item -mips3
17781 @opindex mips3
17782 Equivalent to @option{-march=mips3}.
17784 @item -mips4
17785 @opindex mips4
17786 Equivalent to @option{-march=mips4}.
17788 @item -mips32
17789 @opindex mips32
17790 Equivalent to @option{-march=mips32}.
17792 @item -mips32r3
17793 @opindex mips32r3
17794 Equivalent to @option{-march=mips32r3}.
17796 @item -mips32r5
17797 @opindex mips32r5
17798 Equivalent to @option{-march=mips32r5}.
17800 @item -mips32r6
17801 @opindex mips32r6
17802 Equivalent to @option{-march=mips32r6}.
17804 @item -mips64
17805 @opindex mips64
17806 Equivalent to @option{-march=mips64}.
17808 @item -mips64r2
17809 @opindex mips64r2
17810 Equivalent to @option{-march=mips64r2}.
17812 @item -mips64r3
17813 @opindex mips64r3
17814 Equivalent to @option{-march=mips64r3}.
17816 @item -mips64r5
17817 @opindex mips64r5
17818 Equivalent to @option{-march=mips64r5}.
17820 @item -mips64r6
17821 @opindex mips64r6
17822 Equivalent to @option{-march=mips64r6}.
17824 @item -mips16
17825 @itemx -mno-mips16
17826 @opindex mips16
17827 @opindex mno-mips16
17828 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17829 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17831 MIPS16 code generation can also be controlled on a per-function basis
17832 by means of @code{mips16} and @code{nomips16} attributes.
17833 @xref{Function Attributes}, for more information.
17835 @item -mflip-mips16
17836 @opindex mflip-mips16
17837 Generate MIPS16 code on alternating functions.  This option is provided
17838 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17839 not intended for ordinary use in compiling user code.
17841 @item -minterlink-compressed
17842 @item -mno-interlink-compressed
17843 @opindex minterlink-compressed
17844 @opindex mno-interlink-compressed
17845 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17846 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17848 For example, code using the standard ISA encoding cannot jump directly
17849 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17850 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17851 knows that the target of the jump is not compressed.
17853 @item -minterlink-mips16
17854 @itemx -mno-interlink-mips16
17855 @opindex minterlink-mips16
17856 @opindex mno-interlink-mips16
17857 Aliases of @option{-minterlink-compressed} and
17858 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17859 and are retained for backwards compatibility.
17861 @item -mabi=32
17862 @itemx -mabi=o64
17863 @itemx -mabi=n32
17864 @itemx -mabi=64
17865 @itemx -mabi=eabi
17866 @opindex mabi=32
17867 @opindex mabi=o64
17868 @opindex mabi=n32
17869 @opindex mabi=64
17870 @opindex mabi=eabi
17871 Generate code for the given ABI@.
17873 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17874 generates 64-bit code when you select a 64-bit architecture, but you
17875 can use @option{-mgp32} to get 32-bit code instead.
17877 For information about the O64 ABI, see
17878 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17880 GCC supports a variant of the o32 ABI in which floating-point registers
17881 are 64 rather than 32 bits wide.  You can select this combination with
17882 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17883 and @code{mfhc1} instructions and is therefore only supported for
17884 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17886 The register assignments for arguments and return values remain the
17887 same, but each scalar value is passed in a single 64-bit register
17888 rather than a pair of 32-bit registers.  For example, scalar
17889 floating-point values are returned in @samp{$f0} only, not a
17890 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17891 remains the same in that the even-numbered double-precision registers
17892 are saved.
17894 Two additional variants of the o32 ABI are supported to enable
17895 a transition from 32-bit to 64-bit registers.  These are FPXX
17896 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17897 The FPXX extension mandates that all code must execute correctly
17898 when run using 32-bit or 64-bit registers.  The code can be interlinked
17899 with either FP32 or FP64, but not both.
17900 The FP64A extension is similar to the FP64 extension but forbids the
17901 use of odd-numbered single-precision registers.  This can be used
17902 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17903 processors and allows both FP32 and FP64A code to interlink and
17904 run in the same process without changing FPU modes.
17906 @item -mabicalls
17907 @itemx -mno-abicalls
17908 @opindex mabicalls
17909 @opindex mno-abicalls
17910 Generate (do not generate) code that is suitable for SVR4-style
17911 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17912 systems.
17914 @item -mshared
17915 @itemx -mno-shared
17916 Generate (do not generate) code that is fully position-independent,
17917 and that can therefore be linked into shared libraries.  This option
17918 only affects @option{-mabicalls}.
17920 All @option{-mabicalls} code has traditionally been position-independent,
17921 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17922 as an extension, the GNU toolchain allows executables to use absolute
17923 accesses for locally-binding symbols.  It can also use shorter GP
17924 initialization sequences and generate direct calls to locally-defined
17925 functions.  This mode is selected by @option{-mno-shared}.
17927 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17928 objects that can only be linked by the GNU linker.  However, the option
17929 does not affect the ABI of the final executable; it only affects the ABI
17930 of relocatable objects.  Using @option{-mno-shared} generally makes
17931 executables both smaller and quicker.
17933 @option{-mshared} is the default.
17935 @item -mplt
17936 @itemx -mno-plt
17937 @opindex mplt
17938 @opindex mno-plt
17939 Assume (do not assume) that the static and dynamic linkers
17940 support PLTs and copy relocations.  This option only affects
17941 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17942 has no effect without @option{-msym32}.
17944 You can make @option{-mplt} the default by configuring
17945 GCC with @option{--with-mips-plt}.  The default is
17946 @option{-mno-plt} otherwise.
17948 @item -mxgot
17949 @itemx -mno-xgot
17950 @opindex mxgot
17951 @opindex mno-xgot
17952 Lift (do not lift) the usual restrictions on the size of the global
17953 offset table.
17955 GCC normally uses a single instruction to load values from the GOT@.
17956 While this is relatively efficient, it only works if the GOT
17957 is smaller than about 64k.  Anything larger causes the linker
17958 to report an error such as:
17960 @cindex relocation truncated to fit (MIPS)
17961 @smallexample
17962 relocation truncated to fit: R_MIPS_GOT16 foobar
17963 @end smallexample
17965 If this happens, you should recompile your code with @option{-mxgot}.
17966 This works with very large GOTs, although the code is also
17967 less efficient, since it takes three instructions to fetch the
17968 value of a global symbol.
17970 Note that some linkers can create multiple GOTs.  If you have such a
17971 linker, you should only need to use @option{-mxgot} when a single object
17972 file accesses more than 64k's worth of GOT entries.  Very few do.
17974 These options have no effect unless GCC is generating position
17975 independent code.
17977 @item -mgp32
17978 @opindex mgp32
17979 Assume that general-purpose registers are 32 bits wide.
17981 @item -mgp64
17982 @opindex mgp64
17983 Assume that general-purpose registers are 64 bits wide.
17985 @item -mfp32
17986 @opindex mfp32
17987 Assume that floating-point registers are 32 bits wide.
17989 @item -mfp64
17990 @opindex mfp64
17991 Assume that floating-point registers are 64 bits wide.
17993 @item -mfpxx
17994 @opindex mfpxx
17995 Do not assume the width of floating-point registers.
17997 @item -mhard-float
17998 @opindex mhard-float
17999 Use floating-point coprocessor instructions.
18001 @item -msoft-float
18002 @opindex msoft-float
18003 Do not use floating-point coprocessor instructions.  Implement
18004 floating-point calculations using library calls instead.
18006 @item -mno-float
18007 @opindex mno-float
18008 Equivalent to @option{-msoft-float}, but additionally asserts that the
18009 program being compiled does not perform any floating-point operations.
18010 This option is presently supported only by some bare-metal MIPS
18011 configurations, where it may select a special set of libraries
18012 that lack all floating-point support (including, for example, the
18013 floating-point @code{printf} formats).  
18014 If code compiled with @code{-mno-float} accidentally contains
18015 floating-point operations, it is likely to suffer a link-time
18016 or run-time failure.
18018 @item -msingle-float
18019 @opindex msingle-float
18020 Assume that the floating-point coprocessor only supports single-precision
18021 operations.
18023 @item -mdouble-float
18024 @opindex mdouble-float
18025 Assume that the floating-point coprocessor supports double-precision
18026 operations.  This is the default.
18028 @item -modd-spreg
18029 @itemx -mno-odd-spreg
18030 @opindex modd-spreg
18031 @opindex mno-odd-spreg
18032 Enable the use of odd-numbered single-precision floating-point registers
18033 for the o32 ABI.  This is the default for processors that are known to
18034 support these registers.  When using the o32 FPXX ABI, @code{-mno-odd-spreg}
18035 is set by default.
18037 @item -mabs=2008
18038 @itemx -mabs=legacy
18039 @opindex mabs=2008
18040 @opindex mabs=legacy
18041 These options control the treatment of the special not-a-number (NaN)
18042 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
18043 @code{neg.@i{fmt}} machine instructions.
18045 By default or when the @option{-mabs=legacy} is used the legacy
18046 treatment is selected.  In this case these instructions are considered
18047 arithmetic and avoided where correct operation is required and the
18048 input operand might be a NaN.  A longer sequence of instructions that
18049 manipulate the sign bit of floating-point datum manually is used
18050 instead unless the @option{-ffinite-math-only} option has also been
18051 specified.
18053 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
18054 this case these instructions are considered non-arithmetic and therefore
18055 operating correctly in all cases, including in particular where the
18056 input operand is a NaN.  These instructions are therefore always used
18057 for the respective operations.
18059 @item -mnan=2008
18060 @itemx -mnan=legacy
18061 @opindex mnan=2008
18062 @opindex mnan=legacy
18063 These options control the encoding of the special not-a-number (NaN)
18064 IEEE 754 floating-point data.
18066 The @option{-mnan=legacy} option selects the legacy encoding.  In this
18067 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
18068 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
18069 by the first bit of their trailing significand field being 1.
18071 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18072 this case qNaNs are denoted by the first bit of their trailing
18073 significand field being 1, whereas sNaNs are denoted by the first bit of
18074 their trailing significand field being 0.
18076 The default is @option{-mnan=legacy} unless GCC has been configured with
18077 @option{--with-nan=2008}.
18079 @item -mllsc
18080 @itemx -mno-llsc
18081 @opindex mllsc
18082 @opindex mno-llsc
18083 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18084 implement atomic memory built-in functions.  When neither option is
18085 specified, GCC uses the instructions if the target architecture
18086 supports them.
18088 @option{-mllsc} is useful if the runtime environment can emulate the
18089 instructions and @option{-mno-llsc} can be useful when compiling for
18090 nonstandard ISAs.  You can make either option the default by
18091 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18092 respectively.  @option{--with-llsc} is the default for some
18093 configurations; see the installation documentation for details.
18095 @item -mdsp
18096 @itemx -mno-dsp
18097 @opindex mdsp
18098 @opindex mno-dsp
18099 Use (do not use) revision 1 of the MIPS DSP ASE@.
18100 @xref{MIPS DSP Built-in Functions}.  This option defines the
18101 preprocessor macro @samp{__mips_dsp}.  It also defines
18102 @samp{__mips_dsp_rev} to 1.
18104 @item -mdspr2
18105 @itemx -mno-dspr2
18106 @opindex mdspr2
18107 @opindex mno-dspr2
18108 Use (do not use) revision 2 of the MIPS DSP ASE@.
18109 @xref{MIPS DSP Built-in Functions}.  This option defines the
18110 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
18111 It also defines @samp{__mips_dsp_rev} to 2.
18113 @item -msmartmips
18114 @itemx -mno-smartmips
18115 @opindex msmartmips
18116 @opindex mno-smartmips
18117 Use (do not use) the MIPS SmartMIPS ASE.
18119 @item -mpaired-single
18120 @itemx -mno-paired-single
18121 @opindex mpaired-single
18122 @opindex mno-paired-single
18123 Use (do not use) paired-single floating-point instructions.
18124 @xref{MIPS Paired-Single Support}.  This option requires
18125 hardware floating-point support to be enabled.
18127 @item -mdmx
18128 @itemx -mno-mdmx
18129 @opindex mdmx
18130 @opindex mno-mdmx
18131 Use (do not use) MIPS Digital Media Extension instructions.
18132 This option can only be used when generating 64-bit code and requires
18133 hardware floating-point support to be enabled.
18135 @item -mips3d
18136 @itemx -mno-mips3d
18137 @opindex mips3d
18138 @opindex mno-mips3d
18139 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18140 The option @option{-mips3d} implies @option{-mpaired-single}.
18142 @item -mmicromips
18143 @itemx -mno-micromips
18144 @opindex mmicromips
18145 @opindex mno-mmicromips
18146 Generate (do not generate) microMIPS code.
18148 MicroMIPS code generation can also be controlled on a per-function basis
18149 by means of @code{micromips} and @code{nomicromips} attributes.
18150 @xref{Function Attributes}, for more information.
18152 @item -mmt
18153 @itemx -mno-mt
18154 @opindex mmt
18155 @opindex mno-mt
18156 Use (do not use) MT Multithreading instructions.
18158 @item -mmcu
18159 @itemx -mno-mcu
18160 @opindex mmcu
18161 @opindex mno-mcu
18162 Use (do not use) the MIPS MCU ASE instructions.
18164 @item -meva
18165 @itemx -mno-eva
18166 @opindex meva
18167 @opindex mno-eva
18168 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18170 @item -mvirt
18171 @itemx -mno-virt
18172 @opindex mvirt
18173 @opindex mno-virt
18174 Use (do not use) the MIPS Virtualization Application Specific instructions.
18176 @item -mxpa
18177 @itemx -mno-xpa
18178 @opindex mxpa
18179 @opindex mno-xpa
18180 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18182 @item -mlong64
18183 @opindex mlong64
18184 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18185 an explanation of the default and the way that the pointer size is
18186 determined.
18188 @item -mlong32
18189 @opindex mlong32
18190 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18192 The default size of @code{int}s, @code{long}s and pointers depends on
18193 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18194 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18195 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18196 or the same size as integer registers, whichever is smaller.
18198 @item -msym32
18199 @itemx -mno-sym32
18200 @opindex msym32
18201 @opindex mno-sym32
18202 Assume (do not assume) that all symbols have 32-bit values, regardless
18203 of the selected ABI@.  This option is useful in combination with
18204 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18205 to generate shorter and faster references to symbolic addresses.
18207 @item -G @var{num}
18208 @opindex G
18209 Put definitions of externally-visible data in a small data section
18210 if that data is no bigger than @var{num} bytes.  GCC can then generate
18211 more efficient accesses to the data; see @option{-mgpopt} for details.
18213 The default @option{-G} option depends on the configuration.
18215 @item -mlocal-sdata
18216 @itemx -mno-local-sdata
18217 @opindex mlocal-sdata
18218 @opindex mno-local-sdata
18219 Extend (do not extend) the @option{-G} behavior to local data too,
18220 such as to static variables in C@.  @option{-mlocal-sdata} is the
18221 default for all configurations.
18223 If the linker complains that an application is using too much small data,
18224 you might want to try rebuilding the less performance-critical parts with
18225 @option{-mno-local-sdata}.  You might also want to build large
18226 libraries with @option{-mno-local-sdata}, so that the libraries leave
18227 more room for the main program.
18229 @item -mextern-sdata
18230 @itemx -mno-extern-sdata
18231 @opindex mextern-sdata
18232 @opindex mno-extern-sdata
18233 Assume (do not assume) that externally-defined data is in
18234 a small data section if the size of that data is within the @option{-G} limit.
18235 @option{-mextern-sdata} is the default for all configurations.
18237 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18238 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18239 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18240 is placed in a small data section.  If @var{Var} is defined by another
18241 module, you must either compile that module with a high-enough
18242 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18243 definition.  If @var{Var} is common, you must link the application
18244 with a high-enough @option{-G} setting.
18246 The easiest way of satisfying these restrictions is to compile
18247 and link every module with the same @option{-G} option.  However,
18248 you may wish to build a library that supports several different
18249 small data limits.  You can do this by compiling the library with
18250 the highest supported @option{-G} setting and additionally using
18251 @option{-mno-extern-sdata} to stop the library from making assumptions
18252 about externally-defined data.
18254 @item -mgpopt
18255 @itemx -mno-gpopt
18256 @opindex mgpopt
18257 @opindex mno-gpopt
18258 Use (do not use) GP-relative accesses for symbols that are known to be
18259 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18260 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18261 configurations.
18263 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18264 might not hold the value of @code{_gp}.  For example, if the code is
18265 part of a library that might be used in a boot monitor, programs that
18266 call boot monitor routines pass an unknown value in @code{$gp}.
18267 (In such situations, the boot monitor itself is usually compiled
18268 with @option{-G0}.)
18270 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18271 @option{-mno-extern-sdata}.
18273 @item -membedded-data
18274 @itemx -mno-embedded-data
18275 @opindex membedded-data
18276 @opindex mno-embedded-data
18277 Allocate variables to the read-only data section first if possible, then
18278 next in the small data section if possible, otherwise in data.  This gives
18279 slightly slower code than the default, but reduces the amount of RAM required
18280 when executing, and thus may be preferred for some embedded systems.
18282 @item -muninit-const-in-rodata
18283 @itemx -mno-uninit-const-in-rodata
18284 @opindex muninit-const-in-rodata
18285 @opindex mno-uninit-const-in-rodata
18286 Put uninitialized @code{const} variables in the read-only data section.
18287 This option is only meaningful in conjunction with @option{-membedded-data}.
18289 @item -mcode-readable=@var{setting}
18290 @opindex mcode-readable
18291 Specify whether GCC may generate code that reads from executable sections.
18292 There are three possible settings:
18294 @table @gcctabopt
18295 @item -mcode-readable=yes
18296 Instructions may freely access executable sections.  This is the
18297 default setting.
18299 @item -mcode-readable=pcrel
18300 MIPS16 PC-relative load instructions can access executable sections,
18301 but other instructions must not do so.  This option is useful on 4KSc
18302 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18303 It is also useful on processors that can be configured to have a dual
18304 instruction/data SRAM interface and that, like the M4K, automatically
18305 redirect PC-relative loads to the instruction RAM.
18307 @item -mcode-readable=no
18308 Instructions must not access executable sections.  This option can be
18309 useful on targets that are configured to have a dual instruction/data
18310 SRAM interface but that (unlike the M4K) do not automatically redirect
18311 PC-relative loads to the instruction RAM.
18312 @end table
18314 @item -msplit-addresses
18315 @itemx -mno-split-addresses
18316 @opindex msplit-addresses
18317 @opindex mno-split-addresses
18318 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18319 relocation operators.  This option has been superseded by
18320 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18322 @item -mexplicit-relocs
18323 @itemx -mno-explicit-relocs
18324 @opindex mexplicit-relocs
18325 @opindex mno-explicit-relocs
18326 Use (do not use) assembler relocation operators when dealing with symbolic
18327 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18328 is to use assembler macros instead.
18330 @option{-mexplicit-relocs} is the default if GCC was configured
18331 to use an assembler that supports relocation operators.
18333 @item -mcheck-zero-division
18334 @itemx -mno-check-zero-division
18335 @opindex mcheck-zero-division
18336 @opindex mno-check-zero-division
18337 Trap (do not trap) on integer division by zero.
18339 The default is @option{-mcheck-zero-division}.
18341 @item -mdivide-traps
18342 @itemx -mdivide-breaks
18343 @opindex mdivide-traps
18344 @opindex mdivide-breaks
18345 MIPS systems check for division by zero by generating either a
18346 conditional trap or a break instruction.  Using traps results in
18347 smaller code, but is only supported on MIPS II and later.  Also, some
18348 versions of the Linux kernel have a bug that prevents trap from
18349 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18350 allow conditional traps on architectures that support them and
18351 @option{-mdivide-breaks} to force the use of breaks.
18353 The default is usually @option{-mdivide-traps}, but this can be
18354 overridden at configure time using @option{--with-divide=breaks}.
18355 Divide-by-zero checks can be completely disabled using
18356 @option{-mno-check-zero-division}.
18358 @item -mmemcpy
18359 @itemx -mno-memcpy
18360 @opindex mmemcpy
18361 @opindex mno-memcpy
18362 Force (do not force) the use of @code{memcpy()} for non-trivial block
18363 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18364 most constant-sized copies.
18366 @item -mlong-calls
18367 @itemx -mno-long-calls
18368 @opindex mlong-calls
18369 @opindex mno-long-calls
18370 Disable (do not disable) use of the @code{jal} instruction.  Calling
18371 functions using @code{jal} is more efficient but requires the caller
18372 and callee to be in the same 256 megabyte segment.
18374 This option has no effect on abicalls code.  The default is
18375 @option{-mno-long-calls}.
18377 @item -mmad
18378 @itemx -mno-mad
18379 @opindex mmad
18380 @opindex mno-mad
18381 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18382 instructions, as provided by the R4650 ISA@.
18384 @item -mimadd
18385 @itemx -mno-imadd
18386 @opindex mimadd
18387 @opindex mno-imadd
18388 Enable (disable) use of the @code{madd} and @code{msub} integer
18389 instructions.  The default is @option{-mimadd} on architectures
18390 that support @code{madd} and @code{msub} except for the 74k 
18391 architecture where it was found to generate slower code.
18393 @item -mfused-madd
18394 @itemx -mno-fused-madd
18395 @opindex mfused-madd
18396 @opindex mno-fused-madd
18397 Enable (disable) use of the floating-point multiply-accumulate
18398 instructions, when they are available.  The default is
18399 @option{-mfused-madd}.
18401 On the R8000 CPU when multiply-accumulate instructions are used,
18402 the intermediate product is calculated to infinite precision
18403 and is not subject to the FCSR Flush to Zero bit.  This may be
18404 undesirable in some circumstances.  On other processors the result
18405 is numerically identical to the equivalent computation using
18406 separate multiply, add, subtract and negate instructions.
18408 @item -nocpp
18409 @opindex nocpp
18410 Tell the MIPS assembler to not run its preprocessor over user
18411 assembler files (with a @samp{.s} suffix) when assembling them.
18413 @item -mfix-24k
18414 @item -mno-fix-24k
18415 @opindex mfix-24k
18416 @opindex mno-fix-24k
18417 Work around the 24K E48 (lost data on stores during refill) errata.
18418 The workarounds are implemented by the assembler rather than by GCC@.
18420 @item -mfix-r4000
18421 @itemx -mno-fix-r4000
18422 @opindex mfix-r4000
18423 @opindex mno-fix-r4000
18424 Work around certain R4000 CPU errata:
18425 @itemize @minus
18426 @item
18427 A double-word or a variable shift may give an incorrect result if executed
18428 immediately after starting an integer division.
18429 @item
18430 A double-word or a variable shift may give an incorrect result if executed
18431 while an integer multiplication is in progress.
18432 @item
18433 An integer division may give an incorrect result if started in a delay slot
18434 of a taken branch or a jump.
18435 @end itemize
18437 @item -mfix-r4400
18438 @itemx -mno-fix-r4400
18439 @opindex mfix-r4400
18440 @opindex mno-fix-r4400
18441 Work around certain R4400 CPU errata:
18442 @itemize @minus
18443 @item
18444 A double-word or a variable shift may give an incorrect result if executed
18445 immediately after starting an integer division.
18446 @end itemize
18448 @item -mfix-r10000
18449 @itemx -mno-fix-r10000
18450 @opindex mfix-r10000
18451 @opindex mno-fix-r10000
18452 Work around certain R10000 errata:
18453 @itemize @minus
18454 @item
18455 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18456 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18457 @end itemize
18459 This option can only be used if the target architecture supports
18460 branch-likely instructions.  @option{-mfix-r10000} is the default when
18461 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18462 otherwise.
18464 @item -mfix-rm7000
18465 @itemx -mno-fix-rm7000
18466 @opindex mfix-rm7000
18467 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18468 workarounds are implemented by the assembler rather than by GCC@.
18470 @item -mfix-vr4120
18471 @itemx -mno-fix-vr4120
18472 @opindex mfix-vr4120
18473 Work around certain VR4120 errata:
18474 @itemize @minus
18475 @item
18476 @code{dmultu} does not always produce the correct result.
18477 @item
18478 @code{div} and @code{ddiv} do not always produce the correct result if one
18479 of the operands is negative.
18480 @end itemize
18481 The workarounds for the division errata rely on special functions in
18482 @file{libgcc.a}.  At present, these functions are only provided by
18483 the @code{mips64vr*-elf} configurations.
18485 Other VR4120 errata require a NOP to be inserted between certain pairs of
18486 instructions.  These errata are handled by the assembler, not by GCC itself.
18488 @item -mfix-vr4130
18489 @opindex mfix-vr4130
18490 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18491 workarounds are implemented by the assembler rather than by GCC,
18492 although GCC avoids using @code{mflo} and @code{mfhi} if the
18493 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18494 instructions are available instead.
18496 @item -mfix-sb1
18497 @itemx -mno-fix-sb1
18498 @opindex mfix-sb1
18499 Work around certain SB-1 CPU core errata.
18500 (This flag currently works around the SB-1 revision 2
18501 ``F1'' and ``F2'' floating-point errata.)
18503 @item -mr10k-cache-barrier=@var{setting}
18504 @opindex mr10k-cache-barrier
18505 Specify whether GCC should insert cache barriers to avoid the
18506 side-effects of speculation on R10K processors.
18508 In common with many processors, the R10K tries to predict the outcome
18509 of a conditional branch and speculatively executes instructions from
18510 the ``taken'' branch.  It later aborts these instructions if the
18511 predicted outcome is wrong.  However, on the R10K, even aborted
18512 instructions can have side effects.
18514 This problem only affects kernel stores and, depending on the system,
18515 kernel loads.  As an example, a speculatively-executed store may load
18516 the target memory into cache and mark the cache line as dirty, even if
18517 the store itself is later aborted.  If a DMA operation writes to the
18518 same area of memory before the ``dirty'' line is flushed, the cached
18519 data overwrites the DMA-ed data.  See the R10K processor manual
18520 for a full description, including other potential problems.
18522 One workaround is to insert cache barrier instructions before every memory
18523 access that might be speculatively executed and that might have side
18524 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18525 controls GCC's implementation of this workaround.  It assumes that
18526 aborted accesses to any byte in the following regions does not have
18527 side effects:
18529 @enumerate
18530 @item
18531 the memory occupied by the current function's stack frame;
18533 @item
18534 the memory occupied by an incoming stack argument;
18536 @item
18537 the memory occupied by an object with a link-time-constant address.
18538 @end enumerate
18540 It is the kernel's responsibility to ensure that speculative
18541 accesses to these regions are indeed safe.
18543 If the input program contains a function declaration such as:
18545 @smallexample
18546 void foo (void);
18547 @end smallexample
18549 then the implementation of @code{foo} must allow @code{j foo} and
18550 @code{jal foo} to be executed speculatively.  GCC honors this
18551 restriction for functions it compiles itself.  It expects non-GCC
18552 functions (such as hand-written assembly code) to do the same.
18554 The option has three forms:
18556 @table @gcctabopt
18557 @item -mr10k-cache-barrier=load-store
18558 Insert a cache barrier before a load or store that might be
18559 speculatively executed and that might have side effects even
18560 if aborted.
18562 @item -mr10k-cache-barrier=store
18563 Insert a cache barrier before a store that might be speculatively
18564 executed and that might have side effects even if aborted.
18566 @item -mr10k-cache-barrier=none
18567 Disable the insertion of cache barriers.  This is the default setting.
18568 @end table
18570 @item -mflush-func=@var{func}
18571 @itemx -mno-flush-func
18572 @opindex mflush-func
18573 Specifies the function to call to flush the I and D caches, or to not
18574 call any such function.  If called, the function must take the same
18575 arguments as the common @code{_flush_func()}, that is, the address of the
18576 memory range for which the cache is being flushed, the size of the
18577 memory range, and the number 3 (to flush both caches).  The default
18578 depends on the target GCC was configured for, but commonly is either
18579 @samp{_flush_func} or @samp{__cpu_flush}.
18581 @item mbranch-cost=@var{num}
18582 @opindex mbranch-cost
18583 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18584 This cost is only a heuristic and is not guaranteed to produce
18585 consistent results across releases.  A zero cost redundantly selects
18586 the default, which is based on the @option{-mtune} setting.
18588 @item -mbranch-likely
18589 @itemx -mno-branch-likely
18590 @opindex mbranch-likely
18591 @opindex mno-branch-likely
18592 Enable or disable use of Branch Likely instructions, regardless of the
18593 default for the selected architecture.  By default, Branch Likely
18594 instructions may be generated if they are supported by the selected
18595 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18596 and processors that implement those architectures; for those, Branch
18597 Likely instructions are not be generated by default because the MIPS32
18598 and MIPS64 architectures specifically deprecate their use.
18600 @item -mfp-exceptions
18601 @itemx -mno-fp-exceptions
18602 @opindex mfp-exceptions
18603 Specifies whether FP exceptions are enabled.  This affects how
18604 FP instructions are scheduled for some processors.
18605 The default is that FP exceptions are
18606 enabled.
18608 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18609 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18610 FP pipe.
18612 @item -mvr4130-align
18613 @itemx -mno-vr4130-align
18614 @opindex mvr4130-align
18615 The VR4130 pipeline is two-way superscalar, but can only issue two
18616 instructions together if the first one is 8-byte aligned.  When this
18617 option is enabled, GCC aligns pairs of instructions that it
18618 thinks should execute in parallel.
18620 This option only has an effect when optimizing for the VR4130.
18621 It normally makes code faster, but at the expense of making it bigger.
18622 It is enabled by default at optimization level @option{-O3}.
18624 @item -msynci
18625 @itemx -mno-synci
18626 @opindex msynci
18627 Enable (disable) generation of @code{synci} instructions on
18628 architectures that support it.  The @code{synci} instructions (if
18629 enabled) are generated when @code{__builtin___clear_cache()} is
18630 compiled.
18632 This option defaults to @code{-mno-synci}, but the default can be
18633 overridden by configuring with @code{--with-synci}.
18635 When compiling code for single processor systems, it is generally safe
18636 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18637 does not invalidate the instruction caches on all cores and may lead
18638 to undefined behavior.
18640 @item -mrelax-pic-calls
18641 @itemx -mno-relax-pic-calls
18642 @opindex mrelax-pic-calls
18643 Try to turn PIC calls that are normally dispatched via register
18644 @code{$25} into direct calls.  This is only possible if the linker can
18645 resolve the destination at link-time and if the destination is within
18646 range for a direct call.
18648 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18649 an assembler and a linker that support the @code{.reloc} assembly
18650 directive and @code{-mexplicit-relocs} is in effect.  With
18651 @code{-mno-explicit-relocs}, this optimization can be performed by the
18652 assembler and the linker alone without help from the compiler.
18654 @item -mmcount-ra-address
18655 @itemx -mno-mcount-ra-address
18656 @opindex mmcount-ra-address
18657 @opindex mno-mcount-ra-address
18658 Emit (do not emit) code that allows @code{_mcount} to modify the
18659 calling function's return address.  When enabled, this option extends
18660 the usual @code{_mcount} interface with a new @var{ra-address}
18661 parameter, which has type @code{intptr_t *} and is passed in register
18662 @code{$12}.  @code{_mcount} can then modify the return address by
18663 doing both of the following:
18664 @itemize
18665 @item
18666 Returning the new address in register @code{$31}.
18667 @item
18668 Storing the new address in @code{*@var{ra-address}},
18669 if @var{ra-address} is nonnull.
18670 @end itemize
18672 The default is @option{-mno-mcount-ra-address}.
18674 @end table
18676 @node MMIX Options
18677 @subsection MMIX Options
18678 @cindex MMIX Options
18680 These options are defined for the MMIX:
18682 @table @gcctabopt
18683 @item -mlibfuncs
18684 @itemx -mno-libfuncs
18685 @opindex mlibfuncs
18686 @opindex mno-libfuncs
18687 Specify that intrinsic library functions are being compiled, passing all
18688 values in registers, no matter the size.
18690 @item -mepsilon
18691 @itemx -mno-epsilon
18692 @opindex mepsilon
18693 @opindex mno-epsilon
18694 Generate floating-point comparison instructions that compare with respect
18695 to the @code{rE} epsilon register.
18697 @item -mabi=mmixware
18698 @itemx -mabi=gnu
18699 @opindex mabi=mmixware
18700 @opindex mabi=gnu
18701 Generate code that passes function parameters and return values that (in
18702 the called function) are seen as registers @code{$0} and up, as opposed to
18703 the GNU ABI which uses global registers @code{$231} and up.
18705 @item -mzero-extend
18706 @itemx -mno-zero-extend
18707 @opindex mzero-extend
18708 @opindex mno-zero-extend
18709 When reading data from memory in sizes shorter than 64 bits, use (do not
18710 use) zero-extending load instructions by default, rather than
18711 sign-extending ones.
18713 @item -mknuthdiv
18714 @itemx -mno-knuthdiv
18715 @opindex mknuthdiv
18716 @opindex mno-knuthdiv
18717 Make the result of a division yielding a remainder have the same sign as
18718 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18719 remainder follows the sign of the dividend.  Both methods are
18720 arithmetically valid, the latter being almost exclusively used.
18722 @item -mtoplevel-symbols
18723 @itemx -mno-toplevel-symbols
18724 @opindex mtoplevel-symbols
18725 @opindex mno-toplevel-symbols
18726 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18727 code can be used with the @code{PREFIX} assembly directive.
18729 @item -melf
18730 @opindex melf
18731 Generate an executable in the ELF format, rather than the default
18732 @samp{mmo} format used by the @command{mmix} simulator.
18734 @item -mbranch-predict
18735 @itemx -mno-branch-predict
18736 @opindex mbranch-predict
18737 @opindex mno-branch-predict
18738 Use (do not use) the probable-branch instructions, when static branch
18739 prediction indicates a probable branch.
18741 @item -mbase-addresses
18742 @itemx -mno-base-addresses
18743 @opindex mbase-addresses
18744 @opindex mno-base-addresses
18745 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18746 base address automatically generates a request (handled by the assembler
18747 and the linker) for a constant to be set up in a global register.  The
18748 register is used for one or more base address requests within the range 0
18749 to 255 from the value held in the register.  The generally leads to short
18750 and fast code, but the number of different data items that can be
18751 addressed is limited.  This means that a program that uses lots of static
18752 data may require @option{-mno-base-addresses}.
18754 @item -msingle-exit
18755 @itemx -mno-single-exit
18756 @opindex msingle-exit
18757 @opindex mno-single-exit
18758 Force (do not force) generated code to have a single exit point in each
18759 function.
18760 @end table
18762 @node MN10300 Options
18763 @subsection MN10300 Options
18764 @cindex MN10300 options
18766 These @option{-m} options are defined for Matsushita MN10300 architectures:
18768 @table @gcctabopt
18769 @item -mmult-bug
18770 @opindex mmult-bug
18771 Generate code to avoid bugs in the multiply instructions for the MN10300
18772 processors.  This is the default.
18774 @item -mno-mult-bug
18775 @opindex mno-mult-bug
18776 Do not generate code to avoid bugs in the multiply instructions for the
18777 MN10300 processors.
18779 @item -mam33
18780 @opindex mam33
18781 Generate code using features specific to the AM33 processor.
18783 @item -mno-am33
18784 @opindex mno-am33
18785 Do not generate code using features specific to the AM33 processor.  This
18786 is the default.
18788 @item -mam33-2
18789 @opindex mam33-2
18790 Generate code using features specific to the AM33/2.0 processor.
18792 @item -mam34
18793 @opindex mam34
18794 Generate code using features specific to the AM34 processor.
18796 @item -mtune=@var{cpu-type}
18797 @opindex mtune
18798 Use the timing characteristics of the indicated CPU type when
18799 scheduling instructions.  This does not change the targeted processor
18800 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18801 @samp{am33-2} or @samp{am34}.
18803 @item -mreturn-pointer-on-d0
18804 @opindex mreturn-pointer-on-d0
18805 When generating a function that returns a pointer, return the pointer
18806 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18807 only in @code{a0}, and attempts to call such functions without a prototype
18808 result in errors.  Note that this option is on by default; use
18809 @option{-mno-return-pointer-on-d0} to disable it.
18811 @item -mno-crt0
18812 @opindex mno-crt0
18813 Do not link in the C run-time initialization object file.
18815 @item -mrelax
18816 @opindex mrelax
18817 Indicate to the linker that it should perform a relaxation optimization pass
18818 to shorten branches, calls and absolute memory addresses.  This option only
18819 has an effect when used on the command line for the final link step.
18821 This option makes symbolic debugging impossible.
18823 @item -mliw
18824 @opindex mliw
18825 Allow the compiler to generate @emph{Long Instruction Word}
18826 instructions if the target is the @samp{AM33} or later.  This is the
18827 default.  This option defines the preprocessor macro @samp{__LIW__}.
18829 @item -mnoliw
18830 @opindex mnoliw
18831 Do not allow the compiler to generate @emph{Long Instruction Word}
18832 instructions.  This option defines the preprocessor macro
18833 @samp{__NO_LIW__}.
18835 @item -msetlb
18836 @opindex msetlb
18837 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18838 instructions if the target is the @samp{AM33} or later.  This is the
18839 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18841 @item -mnosetlb
18842 @opindex mnosetlb
18843 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18844 instructions.  This option defines the preprocessor macro
18845 @samp{__NO_SETLB__}.
18847 @end table
18849 @node Moxie Options
18850 @subsection Moxie Options
18851 @cindex Moxie Options
18853 @table @gcctabopt
18855 @item -meb
18856 @opindex meb
18857 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18858 configurations.
18860 @item -mel
18861 @opindex mel
18862 Generate little-endian code.
18864 @item -mmul.x
18865 @opindex mmul.x
18866 Generate mul.x and umul.x instructions.  This is the default for
18867 @samp{moxiebox-*-*} configurations.
18869 @item -mno-crt0
18870 @opindex mno-crt0
18871 Do not link in the C run-time initialization object file.
18873 @end table
18875 @node MSP430 Options
18876 @subsection MSP430 Options
18877 @cindex MSP430 Options
18879 These options are defined for the MSP430:
18881 @table @gcctabopt
18883 @item -masm-hex
18884 @opindex masm-hex
18885 Force assembly output to always use hex constants.  Normally such
18886 constants are signed decimals, but this option is available for
18887 testsuite and/or aesthetic purposes.
18889 @item -mmcu=
18890 @opindex mmcu=
18891 Select the MCU to target.  This is used to create a C preprocessor
18892 symbol based upon the MCU name, converted to upper case and pre- and
18893 post- fixed with @code{__}.  This in turn will be used by the
18894 @code{msp430.h} header file to select an MCU specific supplimentary
18895 header file.
18897 The option also sets the ISA to use.  If the MCU name is one that is
18898 known to only support the 430 ISA then that is selected, otherwise the
18899 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18900 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18901 name will select the 430X ISA.
18903 In addition an MCU specific linker script will be added to the linker
18904 command line.  The script's name is the name of the MCU with
18905 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18906 command line will define the C preprocessor symbol @code{__XXX__} and
18907 cause the linker to search for a script called @file{xxx.ld}.
18909 This option is also passed on to the assembler.
18911 @item -mcpu=
18912 @opindex -mcpu=
18913 Specifies the ISA to use.  Accepted values are @code{msp430},
18914 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18915 @option{-mmcu=} option should be used to select the ISA.
18917 @item -msim
18918 @opindex msim
18919 Link to the simulator runtime libraries and linker script.  Overrides
18920 any scripts that would be selected by the @option{-mmcu=} option.
18922 @item -mlarge
18923 @opindex mlarge
18924 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18926 @item -msmall
18927 @opindex msmall
18928 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18930 @item -mrelax
18931 @opindex mrelax
18932 This option is passed to the assembler and linker, and allows the
18933 linker to perform certain optimizations that cannot be done until
18934 the final link.
18936 @item mhwmult=
18937 @opindex mhwmult=
18938 Describes the type of hardware multiply supported by the target.
18939 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18940 for the original 16-bit-only multiply supported by early MCUs.
18941 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18942 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18943 A value of @code{auto} can also be given.  This tells GCC to deduce
18944 the hardware multiply support based upon the MCU name provided by the
18945 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18946 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18947 default setting.
18949 Hardware multiplies are normally performed by calling a library
18950 routine.  This saves space in the generated code.  When compiling at
18951 @code{-O3} or higher however the hardware multiplier is invoked
18952 inline.  This makes for bigger, but faster code.
18954 The hardware multiply routines disable interrupts whilst running and
18955 restore the previous interrupt state when they finish.  This makes
18956 them safe to use inside interrupt handlers as well as in normal code.
18958 @item -minrt
18959 @opindex minrt
18960 Enable the use of a minimum runtime environment - no static
18961 initializers or constructors.  This is intended for memory-constrained
18962 devices.  The compiler will include special symbols in some objects
18963 that tell the linker and runtime which code fragments are required.
18965 @end table
18967 @node NDS32 Options
18968 @subsection NDS32 Options
18969 @cindex NDS32 Options
18971 These options are defined for NDS32 implementations:
18973 @table @gcctabopt
18975 @item -mbig-endian
18976 @opindex mbig-endian
18977 Generate code in big-endian mode.
18979 @item -mlittle-endian
18980 @opindex mlittle-endian
18981 Generate code in little-endian mode.
18983 @item -mreduced-regs
18984 @opindex mreduced-regs
18985 Use reduced-set registers for register allocation.
18987 @item -mfull-regs
18988 @opindex mfull-regs
18989 Use full-set registers for register allocation.
18991 @item -mcmov
18992 @opindex mcmov
18993 Generate conditional move instructions.
18995 @item -mno-cmov
18996 @opindex mno-cmov
18997 Do not generate conditional move instructions.
18999 @item -mperf-ext
19000 @opindex mperf-ext
19001 Generate performance extension instructions.
19003 @item -mno-perf-ext
19004 @opindex mno-perf-ext
19005 Do not generate performance extension instructions.
19007 @item -mv3push
19008 @opindex mv3push
19009 Generate v3 push25/pop25 instructions.
19011 @item -mno-v3push
19012 @opindex mno-v3push
19013 Do not generate v3 push25/pop25 instructions.
19015 @item -m16-bit
19016 @opindex m16-bit
19017 Generate 16-bit instructions.
19019 @item -mno-16-bit
19020 @opindex mno-16-bit
19021 Do not generate 16-bit instructions.
19023 @item -mgp-direct
19024 @opindex mgp-direct
19025 Generate GP base instructions directly.
19027 @item -mno-gp-direct
19028 @opindex mno-gp-direct
19029 Do no generate GP base instructions directly.
19031 @item -misr-vector-size=@var{num}
19032 @opindex misr-vector-size
19033 Specify the size of each interrupt vector, which must be 4 or 16.
19035 @item -mcache-block-size=@var{num}
19036 @opindex mcache-block-size
19037 Specify the size of each cache block,
19038 which must be a power of 2 between 4 and 512.
19040 @item -march=@var{arch}
19041 @opindex march
19042 Specify the name of the target architecture.
19044 @item -mforce-fp-as-gp
19045 @opindex mforce-fp-as-gp
19046 Prevent $fp being allocated during register allocation so that compiler
19047 is able to force performing fp-as-gp optimization.
19049 @item -mforbid-fp-as-gp
19050 @opindex mforbid-fp-as-gp
19051 Forbid using $fp to access static and global variables.
19052 This option strictly forbids fp-as-gp optimization
19053 regardless of @option{-mforce-fp-as-gp}.
19055 @item -mex9
19056 @opindex mex9
19057 Use special directives to guide linker doing ex9 optimization.
19059 @item -mctor-dtor
19060 @opindex mctor-dtor
19061 Enable constructor/destructor feature.
19063 @item -mrelax
19064 @opindex mrelax
19065 Guide linker to relax instructions.
19067 @end table
19069 @node Nios II Options
19070 @subsection Nios II Options
19071 @cindex Nios II options
19072 @cindex Altera Nios II options
19074 These are the options defined for the Altera Nios II processor.
19076 @table @gcctabopt
19078 @item -G @var{num}
19079 @opindex G
19080 @cindex smaller data references
19081 Put global and static objects less than or equal to @var{num} bytes
19082 into the small data or BSS sections instead of the normal data or BSS
19083 sections.  The default value of @var{num} is 8.
19085 @item -mgpopt
19086 @itemx -mno-gpopt
19087 @opindex mgpopt
19088 @opindex mno-gpopt
19089 Generate (do not generate) GP-relative accesses for objects in the
19090 small data or BSS sections.  The default is @option{-mgpopt} except
19091 when @option{-fpic} or @option{-fPIC} is specified to generate
19092 position-independent code.  Note that the Nios II ABI does not permit
19093 GP-relative accesses from shared libraries.
19095 You may need to specify @option{-mno-gpopt} explicitly when building
19096 programs that include large amounts of small data, including large
19097 GOT data sections.  In this case, the 16-bit offset for GP-relative
19098 addressing may not be large enough to allow access to the entire 
19099 small data section.
19101 @item -mel
19102 @itemx -meb
19103 @opindex mel
19104 @opindex meb
19105 Generate little-endian (default) or big-endian (experimental) code,
19106 respectively.
19108 @item -mbypass-cache
19109 @itemx -mno-bypass-cache
19110 @opindex mno-bypass-cache
19111 @opindex mbypass-cache
19112 Force all load and store instructions to always bypass cache by 
19113 using I/O variants of the instructions. The default is not to
19114 bypass the cache.
19116 @item -mno-cache-volatile 
19117 @itemx -mcache-volatile       
19118 @opindex mcache-volatile 
19119 @opindex mno-cache-volatile
19120 Volatile memory access bypass the cache using the I/O variants of 
19121 the load and store instructions. The default is not to bypass the cache.
19123 @item -mno-fast-sw-div
19124 @itemx -mfast-sw-div
19125 @opindex mno-fast-sw-div
19126 @opindex mfast-sw-div
19127 Do not use table-based fast divide for small numbers. The default 
19128 is to use the fast divide at @option{-O3} and above.
19130 @item -mno-hw-mul
19131 @itemx -mhw-mul
19132 @itemx -mno-hw-mulx
19133 @itemx -mhw-mulx
19134 @itemx -mno-hw-div
19135 @itemx -mhw-div
19136 @opindex mno-hw-mul
19137 @opindex mhw-mul
19138 @opindex mno-hw-mulx
19139 @opindex mhw-mulx
19140 @opindex mno-hw-div
19141 @opindex mhw-div
19142 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19143 instructions by the compiler. The default is to emit @code{mul}
19144 and not emit @code{div} and @code{mulx}.
19146 @item -mcustom-@var{insn}=@var{N}
19147 @itemx -mno-custom-@var{insn}
19148 @opindex mcustom-@var{insn}
19149 @opindex mno-custom-@var{insn}
19150 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19151 custom instruction with encoding @var{N} when generating code that uses 
19152 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
19153 instruction 253 for single-precision floating-point add operations instead
19154 of the default behavior of using a library call.
19156 The following values of @var{insn} are supported.  Except as otherwise
19157 noted, floating-point operations are expected to be implemented with
19158 normal IEEE 754 semantics and correspond directly to the C operators or the
19159 equivalent GCC built-in functions (@pxref{Other Builtins}).
19161 Single-precision floating point:
19162 @table @asis
19164 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19165 Binary arithmetic operations.
19167 @item @samp{fnegs}
19168 Unary negation.
19170 @item @samp{fabss}
19171 Unary absolute value.
19173 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19174 Comparison operations.
19176 @item @samp{fmins}, @samp{fmaxs}
19177 Floating-point minimum and maximum.  These instructions are only
19178 generated if @option{-ffinite-math-only} is specified.
19180 @item @samp{fsqrts}
19181 Unary square root operation.
19183 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19184 Floating-point trigonometric and exponential functions.  These instructions
19185 are only generated if @option{-funsafe-math-optimizations} is also specified.
19187 @end table
19189 Double-precision floating point:
19190 @table @asis
19192 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19193 Binary arithmetic operations.
19195 @item @samp{fnegd}
19196 Unary negation.
19198 @item @samp{fabsd}
19199 Unary absolute value.
19201 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19202 Comparison operations.
19204 @item @samp{fmind}, @samp{fmaxd}
19205 Double-precision minimum and maximum.  These instructions are only
19206 generated if @option{-ffinite-math-only} is specified.
19208 @item @samp{fsqrtd}
19209 Unary square root operation.
19211 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19212 Double-precision trigonometric and exponential functions.  These instructions
19213 are only generated if @option{-funsafe-math-optimizations} is also specified.
19215 @end table
19217 Conversions:
19218 @table @asis
19219 @item @samp{fextsd}
19220 Conversion from single precision to double precision.
19222 @item @samp{ftruncds}
19223 Conversion from double precision to single precision.
19225 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19226 Conversion from floating point to signed or unsigned integer types, with
19227 truncation towards zero.
19229 @item @samp{round}
19230 Conversion from single-precision floating point to signed integer,
19231 rounding to the nearest integer and ties away from zero.
19232 This corresponds to the @code{__builtin_lroundf} function when
19233 @option{-fno-math-errno} is used.
19235 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19236 Conversion from signed or unsigned integer types to floating-point types.
19238 @end table
19240 In addition, all of the following transfer instructions for internal
19241 registers X and Y must be provided to use any of the double-precision
19242 floating-point instructions.  Custom instructions taking two
19243 double-precision source operands expect the first operand in the
19244 64-bit register X.  The other operand (or only operand of a unary
19245 operation) is given to the custom arithmetic instruction with the
19246 least significant half in source register @var{src1} and the most
19247 significant half in @var{src2}.  A custom instruction that returns a
19248 double-precision result returns the most significant 32 bits in the
19249 destination register and the other half in 32-bit register Y.  
19250 GCC automatically generates the necessary code sequences to write
19251 register X and/or read register Y when double-precision floating-point
19252 instructions are used.
19254 @table @asis
19256 @item @samp{fwrx}
19257 Write @var{src1} into the least significant half of X and @var{src2} into
19258 the most significant half of X.
19260 @item @samp{fwry}
19261 Write @var{src1} into Y.
19263 @item @samp{frdxhi}, @samp{frdxlo}
19264 Read the most or least (respectively) significant half of X and store it in
19265 @var{dest}.
19267 @item @samp{frdy}
19268 Read the value of Y and store it into @var{dest}.
19269 @end table
19271 Note that you can gain more local control over generation of Nios II custom
19272 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19273 and @code{target("no-custom-@var{insn}")} function attributes
19274 (@pxref{Function Attributes})
19275 or pragmas (@pxref{Function Specific Option Pragmas}).
19277 @item -mcustom-fpu-cfg=@var{name}
19278 @opindex mcustom-fpu-cfg
19280 This option enables a predefined, named set of custom instruction encodings
19281 (see @option{-mcustom-@var{insn}} above).  
19282 Currently, the following sets are defined:
19284 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19285 @gccoptlist{-mcustom-fmuls=252 @gol
19286 -mcustom-fadds=253 @gol
19287 -mcustom-fsubs=254 @gol
19288 -fsingle-precision-constant}
19290 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19291 @gccoptlist{-mcustom-fmuls=252 @gol
19292 -mcustom-fadds=253 @gol
19293 -mcustom-fsubs=254 @gol
19294 -mcustom-fdivs=255 @gol
19295 -fsingle-precision-constant}
19297 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19298 @gccoptlist{-mcustom-floatus=243 @gol
19299 -mcustom-fixsi=244 @gol
19300 -mcustom-floatis=245 @gol
19301 -mcustom-fcmpgts=246 @gol
19302 -mcustom-fcmples=249 @gol
19303 -mcustom-fcmpeqs=250 @gol
19304 -mcustom-fcmpnes=251 @gol
19305 -mcustom-fmuls=252 @gol
19306 -mcustom-fadds=253 @gol
19307 -mcustom-fsubs=254 @gol
19308 -mcustom-fdivs=255 @gol
19309 -fsingle-precision-constant}
19311 Custom instruction assignments given by individual
19312 @option{-mcustom-@var{insn}=} options override those given by
19313 @option{-mcustom-fpu-cfg=}, regardless of the
19314 order of the options on the command line.
19316 Note that you can gain more local control over selection of a FPU
19317 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19318 function attribute (@pxref{Function Attributes})
19319 or pragma (@pxref{Function Specific Option Pragmas}).
19321 @end table
19323 These additional @samp{-m} options are available for the Altera Nios II
19324 ELF (bare-metal) target:
19326 @table @gcctabopt
19328 @item -mhal
19329 @opindex mhal
19330 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19331 startup and termination code, and is typically used in conjunction with
19332 @option{-msys-crt0=} to specify the location of the alternate startup code
19333 provided by the HAL BSP.
19335 @item -msmallc
19336 @opindex msmallc
19337 Link with a limited version of the C library, @option{-lsmallc}, rather than
19338 Newlib.
19340 @item -msys-crt0=@var{startfile}
19341 @opindex msys-crt0
19342 @var{startfile} is the file name of the startfile (crt0) to use 
19343 when linking.  This option is only useful in conjunction with @option{-mhal}.
19345 @item -msys-lib=@var{systemlib}
19346 @opindex msys-lib
19347 @var{systemlib} is the library name of the library that provides
19348 low-level system calls required by the C library,
19349 e.g. @code{read} and @code{write}.
19350 This option is typically used to link with a library provided by a HAL BSP.
19352 @end table
19354 @node PDP-11 Options
19355 @subsection PDP-11 Options
19356 @cindex PDP-11 Options
19358 These options are defined for the PDP-11:
19360 @table @gcctabopt
19361 @item -mfpu
19362 @opindex mfpu
19363 Use hardware FPP floating point.  This is the default.  (FIS floating
19364 point on the PDP-11/40 is not supported.)
19366 @item -msoft-float
19367 @opindex msoft-float
19368 Do not use hardware floating point.
19370 @item -mac0
19371 @opindex mac0
19372 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19374 @item -mno-ac0
19375 @opindex mno-ac0
19376 Return floating-point results in memory.  This is the default.
19378 @item -m40
19379 @opindex m40
19380 Generate code for a PDP-11/40.
19382 @item -m45
19383 @opindex m45
19384 Generate code for a PDP-11/45.  This is the default.
19386 @item -m10
19387 @opindex m10
19388 Generate code for a PDP-11/10.
19390 @item -mbcopy-builtin
19391 @opindex mbcopy-builtin
19392 Use inline @code{movmemhi} patterns for copying memory.  This is the
19393 default.
19395 @item -mbcopy
19396 @opindex mbcopy
19397 Do not use inline @code{movmemhi} patterns for copying memory.
19399 @item -mint16
19400 @itemx -mno-int32
19401 @opindex mint16
19402 @opindex mno-int32
19403 Use 16-bit @code{int}.  This is the default.
19405 @item -mint32
19406 @itemx -mno-int16
19407 @opindex mint32
19408 @opindex mno-int16
19409 Use 32-bit @code{int}.
19411 @item -mfloat64
19412 @itemx -mno-float32
19413 @opindex mfloat64
19414 @opindex mno-float32
19415 Use 64-bit @code{float}.  This is the default.
19417 @item -mfloat32
19418 @itemx -mno-float64
19419 @opindex mfloat32
19420 @opindex mno-float64
19421 Use 32-bit @code{float}.
19423 @item -mabshi
19424 @opindex mabshi
19425 Use @code{abshi2} pattern.  This is the default.
19427 @item -mno-abshi
19428 @opindex mno-abshi
19429 Do not use @code{abshi2} pattern.
19431 @item -mbranch-expensive
19432 @opindex mbranch-expensive
19433 Pretend that branches are expensive.  This is for experimenting with
19434 code generation only.
19436 @item -mbranch-cheap
19437 @opindex mbranch-cheap
19438 Do not pretend that branches are expensive.  This is the default.
19440 @item -munix-asm
19441 @opindex munix-asm
19442 Use Unix assembler syntax.  This is the default when configured for
19443 @samp{pdp11-*-bsd}.
19445 @item -mdec-asm
19446 @opindex mdec-asm
19447 Use DEC assembler syntax.  This is the default when configured for any
19448 PDP-11 target other than @samp{pdp11-*-bsd}.
19449 @end table
19451 @node picoChip Options
19452 @subsection picoChip Options
19453 @cindex picoChip options
19455 These @samp{-m} options are defined for picoChip implementations:
19457 @table @gcctabopt
19459 @item -mae=@var{ae_type}
19460 @opindex mcpu
19461 Set the instruction set, register set, and instruction scheduling
19462 parameters for array element type @var{ae_type}.  Supported values
19463 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19465 @option{-mae=ANY} selects a completely generic AE type.  Code
19466 generated with this option runs on any of the other AE types.  The
19467 code is not as efficient as it would be if compiled for a specific
19468 AE type, and some types of operation (e.g., multiplication) do not
19469 work properly on all types of AE.
19471 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19472 for compiled code, and is the default.
19474 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19475 option may suffer from poor performance of byte (char) manipulation,
19476 since the DSP AE does not provide hardware support for byte load/stores.
19478 @item -msymbol-as-address
19479 Enable the compiler to directly use a symbol name as an address in a
19480 load/store instruction, without first loading it into a
19481 register.  Typically, the use of this option generates larger
19482 programs, which run faster than when the option isn't used.  However, the
19483 results vary from program to program, so it is left as a user option,
19484 rather than being permanently enabled.
19486 @item -mno-inefficient-warnings
19487 Disables warnings about the generation of inefficient code.  These
19488 warnings can be generated, for example, when compiling code that
19489 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19490 no hardware support for byte-level memory operations, so all byte
19491 load/stores must be synthesized from word load/store operations.  This is
19492 inefficient and a warning is generated to indicate
19493 that you should rewrite the code to avoid byte operations, or to target
19494 an AE type that has the necessary hardware support.  This option disables
19495 these warnings.
19497 @end table
19499 @node PowerPC Options
19500 @subsection PowerPC Options
19501 @cindex PowerPC options
19503 These are listed under @xref{RS/6000 and PowerPC Options}.
19505 @node RL78 Options
19506 @subsection RL78 Options
19507 @cindex RL78 Options
19509 @table @gcctabopt
19511 @item -msim
19512 @opindex msim
19513 Links in additional target libraries to support operation within a
19514 simulator.
19516 @item -mmul=none
19517 @itemx -mmul=g13
19518 @itemx -mmul=rl78
19519 @opindex mmul
19520 Specifies the type of hardware multiplication support to be used.  The
19521 default is @code{none}, which uses software multiplication functions.
19522 The @code{g13} option is for the hardware multiply/divide peripheral
19523 only on the RL78/G13 targets.  The @code{rl78} option is for the
19524 standard hardware multiplication defined in the RL78 software manual.
19526 @item -m64bit-doubles
19527 @itemx -m32bit-doubles
19528 @opindex m64bit-doubles
19529 @opindex m32bit-doubles
19530 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19531 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19532 @option{-m32bit-doubles}.
19534 @end table
19536 @node RS/6000 and PowerPC Options
19537 @subsection IBM RS/6000 and PowerPC Options
19538 @cindex RS/6000 and PowerPC Options
19539 @cindex IBM RS/6000 and PowerPC Options
19541 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19542 @table @gcctabopt
19543 @item -mpowerpc-gpopt
19544 @itemx -mno-powerpc-gpopt
19545 @itemx -mpowerpc-gfxopt
19546 @itemx -mno-powerpc-gfxopt
19547 @need 800
19548 @itemx -mpowerpc64
19549 @itemx -mno-powerpc64
19550 @itemx -mmfcrf
19551 @itemx -mno-mfcrf
19552 @itemx -mpopcntb
19553 @itemx -mno-popcntb
19554 @itemx -mpopcntd
19555 @itemx -mno-popcntd
19556 @itemx -mfprnd
19557 @itemx -mno-fprnd
19558 @need 800
19559 @itemx -mcmpb
19560 @itemx -mno-cmpb
19561 @itemx -mmfpgpr
19562 @itemx -mno-mfpgpr
19563 @itemx -mhard-dfp
19564 @itemx -mno-hard-dfp
19565 @opindex mpowerpc-gpopt
19566 @opindex mno-powerpc-gpopt
19567 @opindex mpowerpc-gfxopt
19568 @opindex mno-powerpc-gfxopt
19569 @opindex mpowerpc64
19570 @opindex mno-powerpc64
19571 @opindex mmfcrf
19572 @opindex mno-mfcrf
19573 @opindex mpopcntb
19574 @opindex mno-popcntb
19575 @opindex mpopcntd
19576 @opindex mno-popcntd
19577 @opindex mfprnd
19578 @opindex mno-fprnd
19579 @opindex mcmpb
19580 @opindex mno-cmpb
19581 @opindex mmfpgpr
19582 @opindex mno-mfpgpr
19583 @opindex mhard-dfp
19584 @opindex mno-hard-dfp
19585 You use these options to specify which instructions are available on the
19586 processor you are using.  The default value of these options is
19587 determined when configuring GCC@.  Specifying the
19588 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19589 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19590 rather than the options listed above.
19592 Specifying @option{-mpowerpc-gpopt} allows
19593 GCC to use the optional PowerPC architecture instructions in the
19594 General Purpose group, including floating-point square root.  Specifying
19595 @option{-mpowerpc-gfxopt} allows GCC to
19596 use the optional PowerPC architecture instructions in the Graphics
19597 group, including floating-point select.
19599 The @option{-mmfcrf} option allows GCC to generate the move from
19600 condition register field instruction implemented on the POWER4
19601 processor and other processors that support the PowerPC V2.01
19602 architecture.
19603 The @option{-mpopcntb} option allows GCC to generate the popcount and
19604 double-precision FP reciprocal estimate instruction implemented on the
19605 POWER5 processor and other processors that support the PowerPC V2.02
19606 architecture.
19607 The @option{-mpopcntd} option allows GCC to generate the popcount
19608 instruction implemented on the POWER7 processor and other processors
19609 that support the PowerPC V2.06 architecture.
19610 The @option{-mfprnd} option allows GCC to generate the FP round to
19611 integer instructions implemented on the POWER5+ processor and other
19612 processors that support the PowerPC V2.03 architecture.
19613 The @option{-mcmpb} option allows GCC to generate the compare bytes
19614 instruction implemented on the POWER6 processor and other processors
19615 that support the PowerPC V2.05 architecture.
19616 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19617 general-purpose register instructions implemented on the POWER6X
19618 processor and other processors that support the extended PowerPC V2.05
19619 architecture.
19620 The @option{-mhard-dfp} option allows GCC to generate the decimal
19621 floating-point instructions implemented on some POWER processors.
19623 The @option{-mpowerpc64} option allows GCC to generate the additional
19624 64-bit instructions that are found in the full PowerPC64 architecture
19625 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19626 @option{-mno-powerpc64}.
19628 @item -mcpu=@var{cpu_type}
19629 @opindex mcpu
19630 Set architecture type, register usage, and
19631 instruction scheduling parameters for machine type @var{cpu_type}.
19632 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19633 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19634 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19635 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19636 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19637 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19638 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19639 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19640 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19641 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19642 @samp{powerpc64}, and @samp{rs64}.
19644 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19645 PowerPC and 64-bit PowerPC architecture machine
19646 types, with an appropriate, generic processor model assumed for
19647 scheduling purposes.
19649 The other options specify a specific processor.  Code generated under
19650 those options runs best on that processor, and may not run at all on
19651 others.
19653 The @option{-mcpu} options automatically enable or disable the
19654 following options:
19656 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19657 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19658 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19659 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19660 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19661 -mquad-memory -mquad-memory-atomic}
19663 The particular options set for any particular CPU varies between
19664 compiler versions, depending on what setting seems to produce optimal
19665 code for that CPU; it doesn't necessarily reflect the actual hardware's
19666 capabilities.  If you wish to set an individual option to a particular
19667 value, you may specify it after the @option{-mcpu} option, like
19668 @option{-mcpu=970 -mno-altivec}.
19670 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19671 not enabled or disabled by the @option{-mcpu} option at present because
19672 AIX does not have full support for these options.  You may still
19673 enable or disable them individually if you're sure it'll work in your
19674 environment.
19676 @item -mtune=@var{cpu_type}
19677 @opindex mtune
19678 Set the instruction scheduling parameters for machine type
19679 @var{cpu_type}, but do not set the architecture type or register usage,
19680 as @option{-mcpu=@var{cpu_type}} does.  The same
19681 values for @var{cpu_type} are used for @option{-mtune} as for
19682 @option{-mcpu}.  If both are specified, the code generated uses the
19683 architecture and registers set by @option{-mcpu}, but the
19684 scheduling parameters set by @option{-mtune}.
19686 @item -mcmodel=small
19687 @opindex mcmodel=small
19688 Generate PowerPC64 code for the small model: The TOC is limited to
19689 64k.
19691 @item -mcmodel=medium
19692 @opindex mcmodel=medium
19693 Generate PowerPC64 code for the medium model: The TOC and other static
19694 data may be up to a total of 4G in size.
19696 @item -mcmodel=large
19697 @opindex mcmodel=large
19698 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19699 in size.  Other data and code is only limited by the 64-bit address
19700 space.
19702 @item -maltivec
19703 @itemx -mno-altivec
19704 @opindex maltivec
19705 @opindex mno-altivec
19706 Generate code that uses (does not use) AltiVec instructions, and also
19707 enable the use of built-in functions that allow more direct access to
19708 the AltiVec instruction set.  You may also need to set
19709 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19710 enhancements.
19712 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19713 @option{-maltivec=be}, the element order for Altivec intrinsics such
19714 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19715 match array element order corresponding to the endianness of the
19716 target.  That is, element zero identifies the leftmost element in a
19717 vector register when targeting a big-endian platform, and identifies
19718 the rightmost element in a vector register when targeting a
19719 little-endian platform.
19721 @item -maltivec=be
19722 @opindex maltivec=be
19723 Generate Altivec instructions using big-endian element order,
19724 regardless of whether the target is big- or little-endian.  This is
19725 the default when targeting a big-endian platform.
19727 The element order is used to interpret element numbers in Altivec
19728 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19729 @code{vec_insert}.  By default, these will match array element order
19730 corresponding to the endianness for the target.
19732 @item -maltivec=le
19733 @opindex maltivec=le
19734 Generate Altivec instructions using little-endian element order,
19735 regardless of whether the target is big- or little-endian.  This is
19736 the default when targeting a little-endian platform.  This option is
19737 currently ignored when targeting a big-endian platform.
19739 The element order is used to interpret element numbers in Altivec
19740 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19741 @code{vec_insert}.  By default, these will match array element order
19742 corresponding to the endianness for the target.
19744 @item -mvrsave
19745 @itemx -mno-vrsave
19746 @opindex mvrsave
19747 @opindex mno-vrsave
19748 Generate VRSAVE instructions when generating AltiVec code.
19750 @item -mgen-cell-microcode
19751 @opindex mgen-cell-microcode
19752 Generate Cell microcode instructions.
19754 @item -mwarn-cell-microcode
19755 @opindex mwarn-cell-microcode
19756 Warn when a Cell microcode instruction is emitted.  An example
19757 of a Cell microcode instruction is a variable shift.
19759 @item -msecure-plt
19760 @opindex msecure-plt
19761 Generate code that allows @command{ld} and @command{ld.so}
19762 to build executables and shared
19763 libraries with non-executable @code{.plt} and @code{.got} sections.
19764 This is a PowerPC
19765 32-bit SYSV ABI option.
19767 @item -mbss-plt
19768 @opindex mbss-plt
19769 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19770 fills in, and
19771 requires @code{.plt} and @code{.got}
19772 sections that are both writable and executable.
19773 This is a PowerPC 32-bit SYSV ABI option.
19775 @item -misel
19776 @itemx -mno-isel
19777 @opindex misel
19778 @opindex mno-isel
19779 This switch enables or disables the generation of ISEL instructions.
19781 @item -misel=@var{yes/no}
19782 This switch has been deprecated.  Use @option{-misel} and
19783 @option{-mno-isel} instead.
19785 @item -mspe
19786 @itemx -mno-spe
19787 @opindex mspe
19788 @opindex mno-spe
19789 This switch enables or disables the generation of SPE simd
19790 instructions.
19792 @item -mpaired
19793 @itemx -mno-paired
19794 @opindex mpaired
19795 @opindex mno-paired
19796 This switch enables or disables the generation of PAIRED simd
19797 instructions.
19799 @item -mspe=@var{yes/no}
19800 This option has been deprecated.  Use @option{-mspe} and
19801 @option{-mno-spe} instead.
19803 @item -mvsx
19804 @itemx -mno-vsx
19805 @opindex mvsx
19806 @opindex mno-vsx
19807 Generate code that uses (does not use) vector/scalar (VSX)
19808 instructions, and also enable the use of built-in functions that allow
19809 more direct access to the VSX instruction set.
19811 @item -mcrypto
19812 @itemx -mno-crypto
19813 @opindex mcrypto
19814 @opindex mno-crypto
19815 Enable the use (disable) of the built-in functions that allow direct
19816 access to the cryptographic instructions that were added in version
19817 2.07 of the PowerPC ISA.
19819 @item -mdirect-move
19820 @itemx -mno-direct-move
19821 @opindex mdirect-move
19822 @opindex mno-direct-move
19823 Generate code that uses (does not use) the instructions to move data
19824 between the general purpose registers and the vector/scalar (VSX)
19825 registers that were added in version 2.07 of the PowerPC ISA.
19827 @item -mpower8-fusion
19828 @itemx -mno-power8-fusion
19829 @opindex mpower8-fusion
19830 @opindex mno-power8-fusion
19831 Generate code that keeps (does not keeps) some integer operations
19832 adjacent so that the instructions can be fused together on power8 and
19833 later processors.
19835 @item -mpower8-vector
19836 @itemx -mno-power8-vector
19837 @opindex mpower8-vector
19838 @opindex mno-power8-vector
19839 Generate code that uses (does not use) the vector and scalar
19840 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19841 enable the use of built-in functions that allow more direct access to
19842 the vector instructions.
19844 @item -mquad-memory
19845 @itemx -mno-quad-memory
19846 @opindex mquad-memory
19847 @opindex mno-quad-memory
19848 Generate code that uses (does not use) the non-atomic quad word memory
19849 instructions.  The @option{-mquad-memory} option requires use of
19850 64-bit mode.
19852 @item -mquad-memory-atomic
19853 @itemx -mno-quad-memory-atomic
19854 @opindex mquad-memory-atomic
19855 @opindex mno-quad-memory-atomic
19856 Generate code that uses (does not use) the atomic quad word memory
19857 instructions.  The @option{-mquad-memory-atomic} option requires use of
19858 64-bit mode.
19860 @item -mupper-regs-df
19861 @itemx -mno-upper-regs-df
19862 @opindex mupper-regs-df
19863 @opindex mno-upper-regs-df
19864 Generate code that uses (does not use) the scalar double precision
19865 instructions that target all 64 registers in the vector/scalar
19866 floating point register set that were added in version 2.06 of the
19867 PowerPC ISA.  The @option{-mupper-regs-df} turned on by default if you
19868 use either of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19869 @option{-mvsx} options.
19871 @item -mupper-regs-sf
19872 @itemx -mno-upper-regs-sf
19873 @opindex mupper-regs-sf
19874 @opindex mno-upper-regs-sf
19875 Generate code that uses (does not use) the scalar single precision
19876 instructions that target all 64 registers in the vector/scalar
19877 floating point register set that were added in version 2.07 of the
19878 PowerPC ISA.  The @option{-mupper-regs-sf} turned on by default if you
19879 use either of the @option{-mcpu=power8}, or @option{-mpower8-vector}
19880 options.
19882 @item -mupper-regs
19883 @itemx -mno-upper-regs
19884 @opindex mupper-regs
19885 @opindex mno-upper-regs
19886 Generate code that uses (does not use) the scalar
19887 instructions that target all 64 registers in the vector/scalar
19888 floating point register set, depending on the model of the machine.
19890 If the @option{-mno-upper-regs} option was used, it will turn off both
19891 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19893 @item -mfloat-gprs=@var{yes/single/double/no}
19894 @itemx -mfloat-gprs
19895 @opindex mfloat-gprs
19896 This switch enables or disables the generation of floating-point
19897 operations on the general-purpose registers for architectures that
19898 support it.
19900 The argument @var{yes} or @var{single} enables the use of
19901 single-precision floating-point operations.
19903 The argument @var{double} enables the use of single and
19904 double-precision floating-point operations.
19906 The argument @var{no} disables floating-point operations on the
19907 general-purpose registers.
19909 This option is currently only available on the MPC854x.
19911 @item -m32
19912 @itemx -m64
19913 @opindex m32
19914 @opindex m64
19915 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19916 targets (including GNU/Linux).  The 32-bit environment sets int, long
19917 and pointer to 32 bits and generates code that runs on any PowerPC
19918 variant.  The 64-bit environment sets int to 32 bits and long and
19919 pointer to 64 bits, and generates code for PowerPC64, as for
19920 @option{-mpowerpc64}.
19922 @item -mfull-toc
19923 @itemx -mno-fp-in-toc
19924 @itemx -mno-sum-in-toc
19925 @itemx -mminimal-toc
19926 @opindex mfull-toc
19927 @opindex mno-fp-in-toc
19928 @opindex mno-sum-in-toc
19929 @opindex mminimal-toc
19930 Modify generation of the TOC (Table Of Contents), which is created for
19931 every executable file.  The @option{-mfull-toc} option is selected by
19932 default.  In that case, GCC allocates at least one TOC entry for
19933 each unique non-automatic variable reference in your program.  GCC
19934 also places floating-point constants in the TOC@.  However, only
19935 16,384 entries are available in the TOC@.
19937 If you receive a linker error message that saying you have overflowed
19938 the available TOC space, you can reduce the amount of TOC space used
19939 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19940 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19941 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19942 generate code to calculate the sum of an address and a constant at
19943 run time instead of putting that sum into the TOC@.  You may specify one
19944 or both of these options.  Each causes GCC to produce very slightly
19945 slower and larger code at the expense of conserving TOC space.
19947 If you still run out of space in the TOC even when you specify both of
19948 these options, specify @option{-mminimal-toc} instead.  This option causes
19949 GCC to make only one TOC entry for every file.  When you specify this
19950 option, GCC produces code that is slower and larger but which
19951 uses extremely little TOC space.  You may wish to use this option
19952 only on files that contain less frequently-executed code.
19954 @item -maix64
19955 @itemx -maix32
19956 @opindex maix64
19957 @opindex maix32
19958 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19959 @code{long} type, and the infrastructure needed to support them.
19960 Specifying @option{-maix64} implies @option{-mpowerpc64},
19961 while @option{-maix32} disables the 64-bit ABI and
19962 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19964 @item -mxl-compat
19965 @itemx -mno-xl-compat
19966 @opindex mxl-compat
19967 @opindex mno-xl-compat
19968 Produce code that conforms more closely to IBM XL compiler semantics
19969 when using AIX-compatible ABI@.  Pass floating-point arguments to
19970 prototyped functions beyond the register save area (RSA) on the stack
19971 in addition to argument FPRs.  Do not assume that most significant
19972 double in 128-bit long double value is properly rounded when comparing
19973 values and converting to double.  Use XL symbol names for long double
19974 support routines.
19976 The AIX calling convention was extended but not initially documented to
19977 handle an obscure K&R C case of calling a function that takes the
19978 address of its arguments with fewer arguments than declared.  IBM XL
19979 compilers access floating-point arguments that do not fit in the
19980 RSA from the stack when a subroutine is compiled without
19981 optimization.  Because always storing floating-point arguments on the
19982 stack is inefficient and rarely needed, this option is not enabled by
19983 default and only is necessary when calling subroutines compiled by IBM
19984 XL compilers without optimization.
19986 @item -mpe
19987 @opindex mpe
19988 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19989 application written to use message passing with special startup code to
19990 enable the application to run.  The system must have PE installed in the
19991 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19992 must be overridden with the @option{-specs=} option to specify the
19993 appropriate directory location.  The Parallel Environment does not
19994 support threads, so the @option{-mpe} option and the @option{-pthread}
19995 option are incompatible.
19997 @item -malign-natural
19998 @itemx -malign-power
19999 @opindex malign-natural
20000 @opindex malign-power
20001 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
20002 @option{-malign-natural} overrides the ABI-defined alignment of larger
20003 types, such as floating-point doubles, on their natural size-based boundary.
20004 The option @option{-malign-power} instructs GCC to follow the ABI-specified
20005 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
20007 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
20008 is not supported.
20010 @item -msoft-float
20011 @itemx -mhard-float
20012 @opindex msoft-float
20013 @opindex mhard-float
20014 Generate code that does not use (uses) the floating-point register set.
20015 Software floating-point emulation is provided if you use the
20016 @option{-msoft-float} option, and pass the option to GCC when linking.
20018 @item -msingle-float
20019 @itemx -mdouble-float
20020 @opindex msingle-float
20021 @opindex mdouble-float
20022 Generate code for single- or double-precision floating-point operations.
20023 @option{-mdouble-float} implies @option{-msingle-float}.
20025 @item -msimple-fpu
20026 @opindex msimple-fpu
20027 Do not generate @code{sqrt} and @code{div} instructions for hardware
20028 floating-point unit.
20030 @item -mfpu=@var{name}
20031 @opindex mfpu
20032 Specify type of floating-point unit.  Valid values for @var{name} are
20033 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
20034 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
20035 @samp{sp_full} (equivalent to @option{-msingle-float}),
20036 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
20038 @item -mxilinx-fpu
20039 @opindex mxilinx-fpu
20040 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
20042 @item -mmultiple
20043 @itemx -mno-multiple
20044 @opindex mmultiple
20045 @opindex mno-multiple
20046 Generate code that uses (does not use) the load multiple word
20047 instructions and the store multiple word instructions.  These
20048 instructions are generated by default on POWER systems, and not
20049 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
20050 PowerPC systems, since those instructions do not work when the
20051 processor is in little-endian mode.  The exceptions are PPC740 and
20052 PPC750 which permit these instructions in little-endian mode.
20054 @item -mstring
20055 @itemx -mno-string
20056 @opindex mstring
20057 @opindex mno-string
20058 Generate code that uses (does not use) the load string instructions
20059 and the store string word instructions to save multiple registers and
20060 do small block moves.  These instructions are generated by default on
20061 POWER systems, and not generated on PowerPC systems.  Do not use
20062 @option{-mstring} on little-endian PowerPC systems, since those
20063 instructions do not work when the processor is in little-endian mode.
20064 The exceptions are PPC740 and PPC750 which permit these instructions
20065 in little-endian mode.
20067 @item -mupdate
20068 @itemx -mno-update
20069 @opindex mupdate
20070 @opindex mno-update
20071 Generate code that uses (does not use) the load or store instructions
20072 that update the base register to the address of the calculated memory
20073 location.  These instructions are generated by default.  If you use
20074 @option{-mno-update}, there is a small window between the time that the
20075 stack pointer is updated and the address of the previous frame is
20076 stored, which means code that walks the stack frame across interrupts or
20077 signals may get corrupted data.
20079 @item -mavoid-indexed-addresses
20080 @itemx -mno-avoid-indexed-addresses
20081 @opindex mavoid-indexed-addresses
20082 @opindex mno-avoid-indexed-addresses
20083 Generate code that tries to avoid (not avoid) the use of indexed load
20084 or store instructions. These instructions can incur a performance
20085 penalty on Power6 processors in certain situations, such as when
20086 stepping through large arrays that cross a 16M boundary.  This option
20087 is enabled by default when targeting Power6 and disabled otherwise.
20089 @item -mfused-madd
20090 @itemx -mno-fused-madd
20091 @opindex mfused-madd
20092 @opindex mno-fused-madd
20093 Generate code that uses (does not use) the floating-point multiply and
20094 accumulate instructions.  These instructions are generated by default
20095 if hardware floating point is used.  The machine-dependent
20096 @option{-mfused-madd} option is now mapped to the machine-independent
20097 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20098 mapped to @option{-ffp-contract=off}.
20100 @item -mmulhw
20101 @itemx -mno-mulhw
20102 @opindex mmulhw
20103 @opindex mno-mulhw
20104 Generate code that uses (does not use) the half-word multiply and
20105 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20106 These instructions are generated by default when targeting those
20107 processors.
20109 @item -mdlmzb
20110 @itemx -mno-dlmzb
20111 @opindex mdlmzb
20112 @opindex mno-dlmzb
20113 Generate code that uses (does not use) the string-search @samp{dlmzb}
20114 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20115 generated by default when targeting those processors.
20117 @item -mno-bit-align
20118 @itemx -mbit-align
20119 @opindex mno-bit-align
20120 @opindex mbit-align
20121 On System V.4 and embedded PowerPC systems do not (do) force structures
20122 and unions that contain bit-fields to be aligned to the base type of the
20123 bit-field.
20125 For example, by default a structure containing nothing but 8
20126 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20127 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20128 the structure is aligned to a 1-byte boundary and is 1 byte in
20129 size.
20131 @item -mno-strict-align
20132 @itemx -mstrict-align
20133 @opindex mno-strict-align
20134 @opindex mstrict-align
20135 On System V.4 and embedded PowerPC systems do not (do) assume that
20136 unaligned memory references are handled by the system.
20138 @item -mrelocatable
20139 @itemx -mno-relocatable
20140 @opindex mrelocatable
20141 @opindex mno-relocatable
20142 Generate code that allows (does not allow) a static executable to be
20143 relocated to a different address at run time.  A simple embedded
20144 PowerPC system loader should relocate the entire contents of
20145 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20146 a table of 32-bit addresses generated by this option.  For this to
20147 work, all objects linked together must be compiled with
20148 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20149 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20151 @item -mrelocatable-lib
20152 @itemx -mno-relocatable-lib
20153 @opindex mrelocatable-lib
20154 @opindex mno-relocatable-lib
20155 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20156 @code{.fixup} section to allow static executables to be relocated at
20157 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20158 alignment of @option{-mrelocatable}.  Objects compiled with
20159 @option{-mrelocatable-lib} may be linked with objects compiled with
20160 any combination of the @option{-mrelocatable} options.
20162 @item -mno-toc
20163 @itemx -mtoc
20164 @opindex mno-toc
20165 @opindex mtoc
20166 On System V.4 and embedded PowerPC systems do not (do) assume that
20167 register 2 contains a pointer to a global area pointing to the addresses
20168 used in the program.
20170 @item -mlittle
20171 @itemx -mlittle-endian
20172 @opindex mlittle
20173 @opindex mlittle-endian
20174 On System V.4 and embedded PowerPC systems compile code for the
20175 processor in little-endian mode.  The @option{-mlittle-endian} option is
20176 the same as @option{-mlittle}.
20178 @item -mbig
20179 @itemx -mbig-endian
20180 @opindex mbig
20181 @opindex mbig-endian
20182 On System V.4 and embedded PowerPC systems compile code for the
20183 processor in big-endian mode.  The @option{-mbig-endian} option is
20184 the same as @option{-mbig}.
20186 @item -mdynamic-no-pic
20187 @opindex mdynamic-no-pic
20188 On Darwin and Mac OS X systems, compile code so that it is not
20189 relocatable, but that its external references are relocatable.  The
20190 resulting code is suitable for applications, but not shared
20191 libraries.
20193 @item -msingle-pic-base
20194 @opindex msingle-pic-base
20195 Treat the register used for PIC addressing as read-only, rather than
20196 loading it in the prologue for each function.  The runtime system is
20197 responsible for initializing this register with an appropriate value
20198 before execution begins.
20200 @item -mprioritize-restricted-insns=@var{priority}
20201 @opindex mprioritize-restricted-insns
20202 This option controls the priority that is assigned to
20203 dispatch-slot restricted instructions during the second scheduling
20204 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20205 or @samp{2} to assign no, highest, or second-highest (respectively) 
20206 priority to dispatch-slot restricted
20207 instructions.
20209 @item -msched-costly-dep=@var{dependence_type}
20210 @opindex msched-costly-dep
20211 This option controls which dependences are considered costly
20212 by the target during instruction scheduling.  The argument
20213 @var{dependence_type} takes one of the following values:
20215 @table @asis
20216 @item @samp{no}
20217 No dependence is costly.
20219 @item @samp{all}
20220 All dependences are costly.
20222 @item @samp{true_store_to_load}
20223 A true dependence from store to load is costly.
20225 @item @samp{store_to_load}
20226 Any dependence from store to load is costly.
20228 @item @var{number}
20229 Any dependence for which the latency is greater than or equal to 
20230 @var{number} is costly.
20231 @end table
20233 @item -minsert-sched-nops=@var{scheme}
20234 @opindex minsert-sched-nops
20235 This option controls which NOP insertion scheme is used during
20236 the second scheduling pass.  The argument @var{scheme} takes one of the
20237 following values:
20239 @table @asis
20240 @item @samp{no}
20241 Don't insert NOPs.
20243 @item @samp{pad}
20244 Pad with NOPs any dispatch group that has vacant issue slots,
20245 according to the scheduler's grouping.
20247 @item @samp{regroup_exact}
20248 Insert NOPs to force costly dependent insns into
20249 separate groups.  Insert exactly as many NOPs as needed to force an insn
20250 to a new group, according to the estimated processor grouping.
20252 @item @var{number}
20253 Insert NOPs to force costly dependent insns into
20254 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20255 @end table
20257 @item -mcall-sysv
20258 @opindex mcall-sysv
20259 On System V.4 and embedded PowerPC systems compile code using calling
20260 conventions that adhere to the March 1995 draft of the System V
20261 Application Binary Interface, PowerPC processor supplement.  This is the
20262 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20264 @item -mcall-sysv-eabi
20265 @itemx -mcall-eabi
20266 @opindex mcall-sysv-eabi
20267 @opindex mcall-eabi
20268 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20270 @item -mcall-sysv-noeabi
20271 @opindex mcall-sysv-noeabi
20272 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20274 @item -mcall-aixdesc
20275 @opindex m
20276 On System V.4 and embedded PowerPC systems compile code for the AIX
20277 operating system.
20279 @item -mcall-linux
20280 @opindex mcall-linux
20281 On System V.4 and embedded PowerPC systems compile code for the
20282 Linux-based GNU system.
20284 @item -mcall-freebsd
20285 @opindex mcall-freebsd
20286 On System V.4 and embedded PowerPC systems compile code for the
20287 FreeBSD operating system.
20289 @item -mcall-netbsd
20290 @opindex mcall-netbsd
20291 On System V.4 and embedded PowerPC systems compile code for the
20292 NetBSD operating system.
20294 @item -mcall-openbsd
20295 @opindex mcall-netbsd
20296 On System V.4 and embedded PowerPC systems compile code for the
20297 OpenBSD operating system.
20299 @item -maix-struct-return
20300 @opindex maix-struct-return
20301 Return all structures in memory (as specified by the AIX ABI)@.
20303 @item -msvr4-struct-return
20304 @opindex msvr4-struct-return
20305 Return structures smaller than 8 bytes in registers (as specified by the
20306 SVR4 ABI)@.
20308 @item -mabi=@var{abi-type}
20309 @opindex mabi
20310 Extend the current ABI with a particular extension, or remove such extension.
20311 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
20312 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
20313 @var{elfv1}, @var{elfv2}@.
20315 @item -mabi=spe
20316 @opindex mabi=spe
20317 Extend the current ABI with SPE ABI extensions.  This does not change
20318 the default ABI, instead it adds the SPE ABI extensions to the current
20319 ABI@.
20321 @item -mabi=no-spe
20322 @opindex mabi=no-spe
20323 Disable Book-E SPE ABI extensions for the current ABI@.
20325 @item -mabi=ibmlongdouble
20326 @opindex mabi=ibmlongdouble
20327 Change the current ABI to use IBM extended-precision long double.
20328 This is a PowerPC 32-bit SYSV ABI option.
20330 @item -mabi=ieeelongdouble
20331 @opindex mabi=ieeelongdouble
20332 Change the current ABI to use IEEE extended-precision long double.
20333 This is a PowerPC 32-bit Linux ABI option.
20335 @item -mabi=elfv1
20336 @opindex mabi=elfv1
20337 Change the current ABI to use the ELFv1 ABI.
20338 This is the default ABI for big-endian PowerPC 64-bit Linux.
20339 Overriding the default ABI requires special system support and is
20340 likely to fail in spectacular ways.
20342 @item -mabi=elfv2
20343 @opindex mabi=elfv2
20344 Change the current ABI to use the ELFv2 ABI.
20345 This is the default ABI for little-endian PowerPC 64-bit Linux.
20346 Overriding the default ABI requires special system support and is
20347 likely to fail in spectacular ways.
20349 @item -mprototype
20350 @itemx -mno-prototype
20351 @opindex mprototype
20352 @opindex mno-prototype
20353 On System V.4 and embedded PowerPC systems assume that all calls to
20354 variable argument functions are properly prototyped.  Otherwise, the
20355 compiler must insert an instruction before every non-prototyped call to
20356 set or clear bit 6 of the condition code register (@var{CR}) to
20357 indicate whether floating-point values are passed in the floating-point
20358 registers in case the function takes variable arguments.  With
20359 @option{-mprototype}, only calls to prototyped variable argument functions
20360 set or clear the bit.
20362 @item -msim
20363 @opindex msim
20364 On embedded PowerPC systems, assume that the startup module is called
20365 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20366 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20367 configurations.
20369 @item -mmvme
20370 @opindex mmvme
20371 On embedded PowerPC systems, assume that the startup module is called
20372 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20373 @file{libc.a}.
20375 @item -mads
20376 @opindex mads
20377 On embedded PowerPC systems, assume that the startup module is called
20378 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20379 @file{libc.a}.
20381 @item -myellowknife
20382 @opindex myellowknife
20383 On embedded PowerPC systems, assume that the startup module is called
20384 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20385 @file{libc.a}.
20387 @item -mvxworks
20388 @opindex mvxworks
20389 On System V.4 and embedded PowerPC systems, specify that you are
20390 compiling for a VxWorks system.
20392 @item -memb
20393 @opindex memb
20394 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20395 header to indicate that @samp{eabi} extended relocations are used.
20397 @item -meabi
20398 @itemx -mno-eabi
20399 @opindex meabi
20400 @opindex mno-eabi
20401 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20402 Embedded Applications Binary Interface (EABI), which is a set of
20403 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20404 means that the stack is aligned to an 8-byte boundary, a function
20405 @code{__eabi} is called from @code{main} to set up the EABI
20406 environment, and the @option{-msdata} option can use both @code{r2} and
20407 @code{r13} to point to two separate small data areas.  Selecting
20408 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20409 no EABI initialization function is called from @code{main}, and the
20410 @option{-msdata} option only uses @code{r13} to point to a single
20411 small data area.  The @option{-meabi} option is on by default if you
20412 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20414 @item -msdata=eabi
20415 @opindex msdata=eabi
20416 On System V.4 and embedded PowerPC systems, put small initialized
20417 @code{const} global and static data in the @samp{.sdata2} section, which
20418 is pointed to by register @code{r2}.  Put small initialized
20419 non-@code{const} global and static data in the @samp{.sdata} section,
20420 which is pointed to by register @code{r13}.  Put small uninitialized
20421 global and static data in the @samp{.sbss} section, which is adjacent to
20422 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20423 incompatible with the @option{-mrelocatable} option.  The
20424 @option{-msdata=eabi} option also sets the @option{-memb} option.
20426 @item -msdata=sysv
20427 @opindex msdata=sysv
20428 On System V.4 and embedded PowerPC systems, put small global and static
20429 data in the @samp{.sdata} section, which is pointed to by register
20430 @code{r13}.  Put small uninitialized global and static data in the
20431 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20432 The @option{-msdata=sysv} option is incompatible with the
20433 @option{-mrelocatable} option.
20435 @item -msdata=default
20436 @itemx -msdata
20437 @opindex msdata=default
20438 @opindex msdata
20439 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20440 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20441 same as @option{-msdata=sysv}.
20443 @item -msdata=data
20444 @opindex msdata=data
20445 On System V.4 and embedded PowerPC systems, put small global
20446 data in the @samp{.sdata} section.  Put small uninitialized global
20447 data in the @samp{.sbss} section.  Do not use register @code{r13}
20448 to address small data however.  This is the default behavior unless
20449 other @option{-msdata} options are used.
20451 @item -msdata=none
20452 @itemx -mno-sdata
20453 @opindex msdata=none
20454 @opindex mno-sdata
20455 On embedded PowerPC systems, put all initialized global and static data
20456 in the @samp{.data} section, and all uninitialized data in the
20457 @samp{.bss} section.
20459 @item -mblock-move-inline-limit=@var{num}
20460 @opindex mblock-move-inline-limit
20461 Inline all block moves (such as calls to @code{memcpy} or structure
20462 copies) less than or equal to @var{num} bytes.  The minimum value for
20463 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20464 targets.  The default value is target-specific.
20466 @item -G @var{num}
20467 @opindex G
20468 @cindex smaller data references (PowerPC)
20469 @cindex .sdata/.sdata2 references (PowerPC)
20470 On embedded PowerPC systems, put global and static items less than or
20471 equal to @var{num} bytes into the small data or BSS sections instead of
20472 the normal data or BSS section.  By default, @var{num} is 8.  The
20473 @option{-G @var{num}} switch is also passed to the linker.
20474 All modules should be compiled with the same @option{-G @var{num}} value.
20476 @item -mregnames
20477 @itemx -mno-regnames
20478 @opindex mregnames
20479 @opindex mno-regnames
20480 On System V.4 and embedded PowerPC systems do (do not) emit register
20481 names in the assembly language output using symbolic forms.
20483 @item -mlongcall
20484 @itemx -mno-longcall
20485 @opindex mlongcall
20486 @opindex mno-longcall
20487 By default assume that all calls are far away so that a longer and more
20488 expensive calling sequence is required.  This is required for calls
20489 farther than 32 megabytes (33,554,432 bytes) from the current location.
20490 A short call is generated if the compiler knows
20491 the call cannot be that far away.  This setting can be overridden by
20492 the @code{shortcall} function attribute, or by @code{#pragma
20493 longcall(0)}.
20495 Some linkers are capable of detecting out-of-range calls and generating
20496 glue code on the fly.  On these systems, long calls are unnecessary and
20497 generate slower code.  As of this writing, the AIX linker can do this,
20498 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20499 to the GNU linker for 32-bit PowerPC systems as well.
20501 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20502 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20503 addresses represent the callee and the branch island.  The
20504 Darwin/PPC linker prefers the first address and generates a @code{bl
20505 callee} if the PPC @code{bl} instruction reaches the callee directly;
20506 otherwise, the linker generates @code{bl L42} to call the branch
20507 island.  The branch island is appended to the body of the
20508 calling function; it computes the full 32-bit address of the callee
20509 and jumps to it.
20511 On Mach-O (Darwin) systems, this option directs the compiler emit to
20512 the glue for every direct call, and the Darwin linker decides whether
20513 to use or discard it.
20515 In the future, GCC may ignore all longcall specifications
20516 when the linker is known to generate glue.
20518 @item -mtls-markers
20519 @itemx -mno-tls-markers
20520 @opindex mtls-markers
20521 @opindex mno-tls-markers
20522 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20523 specifying the function argument.  The relocation allows the linker to
20524 reliably associate function call with argument setup instructions for
20525 TLS optimization, which in turn allows GCC to better schedule the
20526 sequence.
20528 @item -pthread
20529 @opindex pthread
20530 Adds support for multithreading with the @dfn{pthreads} library.
20531 This option sets flags for both the preprocessor and linker.
20533 @item -mrecip
20534 @itemx -mno-recip
20535 @opindex mrecip
20536 This option enables use of the reciprocal estimate and
20537 reciprocal square root estimate instructions with additional
20538 Newton-Raphson steps to increase precision instead of doing a divide or
20539 square root and divide for floating-point arguments.  You should use
20540 the @option{-ffast-math} option when using @option{-mrecip} (or at
20541 least @option{-funsafe-math-optimizations},
20542 @option{-finite-math-only}, @option{-freciprocal-math} and
20543 @option{-fno-trapping-math}).  Note that while the throughput of the
20544 sequence is generally higher than the throughput of the non-reciprocal
20545 instruction, the precision of the sequence can be decreased by up to 2
20546 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20547 roots.
20549 @item -mrecip=@var{opt}
20550 @opindex mrecip=opt
20551 This option controls which reciprocal estimate instructions
20552 may be used.  @var{opt} is a comma-separated list of options, which may
20553 be preceded by a @code{!} to invert the option:
20554 @code{all}: enable all estimate instructions,
20555 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20556 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20557 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20558 @code{divf}: enable the single-precision reciprocal approximation instructions;
20559 @code{divd}: enable the double-precision reciprocal approximation instructions;
20560 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20561 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20562 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20564 So, for example, @option{-mrecip=all,!rsqrtd} enables
20565 all of the reciprocal estimate instructions, except for the
20566 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20567 which handle the double-precision reciprocal square root calculations.
20569 @item -mrecip-precision
20570 @itemx -mno-recip-precision
20571 @opindex mrecip-precision
20572 Assume (do not assume) that the reciprocal estimate instructions
20573 provide higher-precision estimates than is mandated by the PowerPC
20574 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20575 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20576 The double-precision square root estimate instructions are not generated by
20577 default on low-precision machines, since they do not provide an
20578 estimate that converges after three steps.
20580 @item -mveclibabi=@var{type}
20581 @opindex mveclibabi
20582 Specifies the ABI type to use for vectorizing intrinsics using an
20583 external library.  The only type supported at present is @code{mass},
20584 which specifies to use IBM's Mathematical Acceleration Subsystem
20585 (MASS) libraries for vectorizing intrinsics using external libraries.
20586 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20587 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20588 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20589 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20590 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20591 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20592 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20593 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20594 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20595 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20596 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20597 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20598 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20599 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20600 for power7.  Both @option{-ftree-vectorize} and
20601 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20602 libraries must be specified at link time.
20604 @item -mfriz
20605 @itemx -mno-friz
20606 @opindex mfriz
20607 Generate (do not generate) the @code{friz} instruction when the
20608 @option{-funsafe-math-optimizations} option is used to optimize
20609 rounding of floating-point values to 64-bit integer and back to floating
20610 point.  The @code{friz} instruction does not return the same value if
20611 the floating-point number is too large to fit in an integer.
20613 @item -mpointers-to-nested-functions
20614 @itemx -mno-pointers-to-nested-functions
20615 @opindex mpointers-to-nested-functions
20616 Generate (do not generate) code to load up the static chain register
20617 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20618 systems where a function pointer points to a 3-word descriptor giving
20619 the function address, TOC value to be loaded in register @var{r2}, and
20620 static chain value to be loaded in register @var{r11}.  The
20621 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20622 call through pointers to nested functions or pointers
20623 to functions compiled in other languages that use the static chain if
20624 you use the @option{-mno-pointers-to-nested-functions}.
20626 @item -msave-toc-indirect
20627 @itemx -mno-save-toc-indirect
20628 @opindex msave-toc-indirect
20629 Generate (do not generate) code to save the TOC value in the reserved
20630 stack location in the function prologue if the function calls through
20631 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20632 saved in the prologue, it is saved just before the call through the
20633 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20635 @item -mcompat-align-parm
20636 @itemx -mno-compat-align-parm
20637 @opindex mcompat-align-parm
20638 Generate (do not generate) code to pass structure parameters with a
20639 maximum alignment of 64 bits, for compatibility with older versions
20640 of GCC.
20642 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20643 structure parameter on a 128-bit boundary when that structure contained
20644 a member requiring 128-bit alignment.  This is corrected in more
20645 recent versions of GCC.  This option may be used to generate code
20646 that is compatible with functions compiled with older versions of
20647 GCC.
20649 The @option{-mno-compat-align-parm} option is the default.
20650 @end table
20652 @node RX Options
20653 @subsection RX Options
20654 @cindex RX Options
20656 These command-line options are defined for RX targets:
20658 @table @gcctabopt
20659 @item -m64bit-doubles
20660 @itemx -m32bit-doubles
20661 @opindex m64bit-doubles
20662 @opindex m32bit-doubles
20663 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20664 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20665 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20666 works on 32-bit values, which is why the default is
20667 @option{-m32bit-doubles}.
20669 @item -fpu
20670 @itemx -nofpu
20671 @opindex fpu
20672 @opindex nofpu
20673 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20674 floating-point hardware.  The default is enabled for the @var{RX600}
20675 series and disabled for the @var{RX200} series.
20677 Floating-point instructions are only generated for 32-bit floating-point 
20678 values, however, so the FPU hardware is not used for doubles if the
20679 @option{-m64bit-doubles} option is used.
20681 @emph{Note} If the @option{-fpu} option is enabled then
20682 @option{-funsafe-math-optimizations} is also enabled automatically.
20683 This is because the RX FPU instructions are themselves unsafe.
20685 @item -mcpu=@var{name}
20686 @opindex -mcpu
20687 Selects the type of RX CPU to be targeted.  Currently three types are
20688 supported, the generic @var{RX600} and @var{RX200} series hardware and
20689 the specific @var{RX610} CPU.  The default is @var{RX600}.
20691 The only difference between @var{RX600} and @var{RX610} is that the
20692 @var{RX610} does not support the @code{MVTIPL} instruction.
20694 The @var{RX200} series does not have a hardware floating-point unit
20695 and so @option{-nofpu} is enabled by default when this type is
20696 selected.
20698 @item -mbig-endian-data
20699 @itemx -mlittle-endian-data
20700 @opindex mbig-endian-data
20701 @opindex mlittle-endian-data
20702 Store data (but not code) in the big-endian format.  The default is
20703 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20704 format.
20706 @item -msmall-data-limit=@var{N}
20707 @opindex msmall-data-limit
20708 Specifies the maximum size in bytes of global and static variables
20709 which can be placed into the small data area.  Using the small data
20710 area can lead to smaller and faster code, but the size of area is
20711 limited and it is up to the programmer to ensure that the area does
20712 not overflow.  Also when the small data area is used one of the RX's
20713 registers (usually @code{r13}) is reserved for use pointing to this
20714 area, so it is no longer available for use by the compiler.  This
20715 could result in slower and/or larger code if variables are pushed onto
20716 the stack instead of being held in this register.
20718 Note, common variables (variables that have not been initialized) and
20719 constants are not placed into the small data area as they are assigned
20720 to other sections in the output executable.
20722 The default value is zero, which disables this feature.  Note, this
20723 feature is not enabled by default with higher optimization levels
20724 (@option{-O2} etc) because of the potentially detrimental effects of
20725 reserving a register.  It is up to the programmer to experiment and
20726 discover whether this feature is of benefit to their program.  See the
20727 description of the @option{-mpid} option for a description of how the
20728 actual register to hold the small data area pointer is chosen.
20730 @item -msim
20731 @itemx -mno-sim
20732 @opindex msim
20733 @opindex mno-sim
20734 Use the simulator runtime.  The default is to use the libgloss
20735 board-specific runtime.
20737 @item -mas100-syntax
20738 @itemx -mno-as100-syntax
20739 @opindex mas100-syntax
20740 @opindex mno-as100-syntax
20741 When generating assembler output use a syntax that is compatible with
20742 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20743 assembler, but it has some restrictions so it is not generated by default.
20745 @item -mmax-constant-size=@var{N}
20746 @opindex mmax-constant-size
20747 Specifies the maximum size, in bytes, of a constant that can be used as
20748 an operand in a RX instruction.  Although the RX instruction set does
20749 allow constants of up to 4 bytes in length to be used in instructions,
20750 a longer value equates to a longer instruction.  Thus in some
20751 circumstances it can be beneficial to restrict the size of constants
20752 that are used in instructions.  Constants that are too big are instead
20753 placed into a constant pool and referenced via register indirection.
20755 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20756 or 4 means that constants of any size are allowed.
20758 @item -mrelax
20759 @opindex mrelax
20760 Enable linker relaxation.  Linker relaxation is a process whereby the
20761 linker attempts to reduce the size of a program by finding shorter
20762 versions of various instructions.  Disabled by default.
20764 @item -mint-register=@var{N}
20765 @opindex mint-register
20766 Specify the number of registers to reserve for fast interrupt handler
20767 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20768 means that register @code{r13} is reserved for the exclusive use
20769 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20770 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20771 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20772 A value of 0, the default, does not reserve any registers.
20774 @item -msave-acc-in-interrupts
20775 @opindex msave-acc-in-interrupts
20776 Specifies that interrupt handler functions should preserve the
20777 accumulator register.  This is only necessary if normal code might use
20778 the accumulator register, for example because it performs 64-bit
20779 multiplications.  The default is to ignore the accumulator as this
20780 makes the interrupt handlers faster.
20782 @item -mpid
20783 @itemx -mno-pid
20784 @opindex mpid
20785 @opindex mno-pid
20786 Enables the generation of position independent data.  When enabled any
20787 access to constant data is done via an offset from a base address
20788 held in a register.  This allows the location of constant data to be
20789 determined at run time without requiring the executable to be
20790 relocated, which is a benefit to embedded applications with tight
20791 memory constraints.  Data that can be modified is not affected by this
20792 option.
20794 Note, using this feature reserves a register, usually @code{r13}, for
20795 the constant data base address.  This can result in slower and/or
20796 larger code, especially in complicated functions.
20798 The actual register chosen to hold the constant data base address
20799 depends upon whether the @option{-msmall-data-limit} and/or the
20800 @option{-mint-register} command-line options are enabled.  Starting
20801 with register @code{r13} and proceeding downwards, registers are
20802 allocated first to satisfy the requirements of @option{-mint-register},
20803 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20804 is possible for the small data area register to be @code{r8} if both
20805 @option{-mint-register=4} and @option{-mpid} are specified on the
20806 command line.
20808 By default this feature is not enabled.  The default can be restored
20809 via the @option{-mno-pid} command-line option.
20811 @item -mno-warn-multiple-fast-interrupts
20812 @itemx -mwarn-multiple-fast-interrupts
20813 @opindex mno-warn-multiple-fast-interrupts
20814 @opindex mwarn-multiple-fast-interrupts
20815 Prevents GCC from issuing a warning message if it finds more than one
20816 fast interrupt handler when it is compiling a file.  The default is to
20817 issue a warning for each extra fast interrupt handler found, as the RX
20818 only supports one such interrupt.
20820 @end table
20822 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20823 has special significance to the RX port when used with the
20824 @code{interrupt} function attribute.  This attribute indicates a
20825 function intended to process fast interrupts.  GCC ensures
20826 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20827 and/or @code{r13} and only provided that the normal use of the
20828 corresponding registers have been restricted via the
20829 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20830 options.
20832 @node S/390 and zSeries Options
20833 @subsection S/390 and zSeries Options
20834 @cindex S/390 and zSeries Options
20836 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20838 @table @gcctabopt
20839 @item -mhard-float
20840 @itemx -msoft-float
20841 @opindex mhard-float
20842 @opindex msoft-float
20843 Use (do not use) the hardware floating-point instructions and registers
20844 for floating-point operations.  When @option{-msoft-float} is specified,
20845 functions in @file{libgcc.a} are used to perform floating-point
20846 operations.  When @option{-mhard-float} is specified, the compiler
20847 generates IEEE floating-point instructions.  This is the default.
20849 @item -mhard-dfp
20850 @itemx -mno-hard-dfp
20851 @opindex mhard-dfp
20852 @opindex mno-hard-dfp
20853 Use (do not use) the hardware decimal-floating-point instructions for
20854 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20855 specified, functions in @file{libgcc.a} are used to perform
20856 decimal-floating-point operations.  When @option{-mhard-dfp} is
20857 specified, the compiler generates decimal-floating-point hardware
20858 instructions.  This is the default for @option{-march=z9-ec} or higher.
20860 @item -mlong-double-64
20861 @itemx -mlong-double-128
20862 @opindex mlong-double-64
20863 @opindex mlong-double-128
20864 These switches control the size of @code{long double} type. A size
20865 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20866 type. This is the default.
20868 @item -mbackchain
20869 @itemx -mno-backchain
20870 @opindex mbackchain
20871 @opindex mno-backchain
20872 Store (do not store) the address of the caller's frame as backchain pointer
20873 into the callee's stack frame.
20874 A backchain may be needed to allow debugging using tools that do not understand
20875 DWARF 2 call frame information.
20876 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20877 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20878 the backchain is placed into the topmost word of the 96/160 byte register
20879 save area.
20881 In general, code compiled with @option{-mbackchain} is call-compatible with
20882 code compiled with @option{-mmo-backchain}; however, use of the backchain
20883 for debugging purposes usually requires that the whole binary is built with
20884 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20885 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20886 to build a linux kernel use @option{-msoft-float}.
20888 The default is to not maintain the backchain.
20890 @item -mpacked-stack
20891 @itemx -mno-packed-stack
20892 @opindex mpacked-stack
20893 @opindex mno-packed-stack
20894 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20895 specified, the compiler uses the all fields of the 96/160 byte register save
20896 area only for their default purpose; unused fields still take up stack space.
20897 When @option{-mpacked-stack} is specified, register save slots are densely
20898 packed at the top of the register save area; unused space is reused for other
20899 purposes, allowing for more efficient use of the available stack space.
20900 However, when @option{-mbackchain} is also in effect, the topmost word of
20901 the save area is always used to store the backchain, and the return address
20902 register is always saved two words below the backchain.
20904 As long as the stack frame backchain is not used, code generated with
20905 @option{-mpacked-stack} is call-compatible with code generated with
20906 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20907 S/390 or zSeries generated code that uses the stack frame backchain at run
20908 time, not just for debugging purposes.  Such code is not call-compatible
20909 with code compiled with @option{-mpacked-stack}.  Also, note that the
20910 combination of @option{-mbackchain},
20911 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20912 to build a linux kernel use @option{-msoft-float}.
20914 The default is to not use the packed stack layout.
20916 @item -msmall-exec
20917 @itemx -mno-small-exec
20918 @opindex msmall-exec
20919 @opindex mno-small-exec
20920 Generate (or do not generate) code using the @code{bras} instruction
20921 to do subroutine calls.
20922 This only works reliably if the total executable size does not
20923 exceed 64k.  The default is to use the @code{basr} instruction instead,
20924 which does not have this limitation.
20926 @item -m64
20927 @itemx -m31
20928 @opindex m64
20929 @opindex m31
20930 When @option{-m31} is specified, generate code compliant to the
20931 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20932 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20933 particular to generate 64-bit instructions.  For the @samp{s390}
20934 targets, the default is @option{-m31}, while the @samp{s390x}
20935 targets default to @option{-m64}.
20937 @item -mzarch
20938 @itemx -mesa
20939 @opindex mzarch
20940 @opindex mesa
20941 When @option{-mzarch} is specified, generate code using the
20942 instructions available on z/Architecture.
20943 When @option{-mesa} is specified, generate code using the
20944 instructions available on ESA/390.  Note that @option{-mesa} is
20945 not possible with @option{-m64}.
20946 When generating code compliant to the GNU/Linux for S/390 ABI,
20947 the default is @option{-mesa}.  When generating code compliant
20948 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20950 @item -mmvcle
20951 @itemx -mno-mvcle
20952 @opindex mmvcle
20953 @opindex mno-mvcle
20954 Generate (or do not generate) code using the @code{mvcle} instruction
20955 to perform block moves.  When @option{-mno-mvcle} is specified,
20956 use a @code{mvc} loop instead.  This is the default unless optimizing for
20957 size.
20959 @item -mdebug
20960 @itemx -mno-debug
20961 @opindex mdebug
20962 @opindex mno-debug
20963 Print (or do not print) additional debug information when compiling.
20964 The default is to not print debug information.
20966 @item -march=@var{cpu-type}
20967 @opindex march
20968 Generate code that runs on @var{cpu-type}, which is the name of a system
20969 representing a certain processor type.  Possible values for
20970 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20971 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20972 When generating code using the instructions available on z/Architecture,
20973 the default is @option{-march=z900}.  Otherwise, the default is
20974 @option{-march=g5}.
20976 @item -mtune=@var{cpu-type}
20977 @opindex mtune
20978 Tune to @var{cpu-type} everything applicable about the generated code,
20979 except for the ABI and the set of available instructions.
20980 The list of @var{cpu-type} values is the same as for @option{-march}.
20981 The default is the value used for @option{-march}.
20983 @item -mtpf-trace
20984 @itemx -mno-tpf-trace
20985 @opindex mtpf-trace
20986 @opindex mno-tpf-trace
20987 Generate code that adds (does not add) in TPF OS specific branches to trace
20988 routines in the operating system.  This option is off by default, even
20989 when compiling for the TPF OS@.
20991 @item -mfused-madd
20992 @itemx -mno-fused-madd
20993 @opindex mfused-madd
20994 @opindex mno-fused-madd
20995 Generate code that uses (does not use) the floating-point multiply and
20996 accumulate instructions.  These instructions are generated by default if
20997 hardware floating point is used.
20999 @item -mwarn-framesize=@var{framesize}
21000 @opindex mwarn-framesize
21001 Emit a warning if the current function exceeds the given frame size.  Because
21002 this is a compile-time check it doesn't need to be a real problem when the program
21003 runs.  It is intended to identify functions that most probably cause
21004 a stack overflow.  It is useful to be used in an environment with limited stack
21005 size e.g.@: the linux kernel.
21007 @item -mwarn-dynamicstack
21008 @opindex mwarn-dynamicstack
21009 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
21010 arrays.  This is generally a bad idea with a limited stack size.
21012 @item -mstack-guard=@var{stack-guard}
21013 @itemx -mstack-size=@var{stack-size}
21014 @opindex mstack-guard
21015 @opindex mstack-size
21016 If these options are provided the S/390 back end emits additional instructions in
21017 the function prologue that trigger a trap if the stack size is @var{stack-guard}
21018 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
21019 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
21020 the frame size of the compiled function is chosen.
21021 These options are intended to be used to help debugging stack overflow problems.
21022 The additionally emitted code causes only little overhead and hence can also be
21023 used in production-like systems without greater performance degradation.  The given
21024 values have to be exact powers of 2 and @var{stack-size} has to be greater than
21025 @var{stack-guard} without exceeding 64k.
21026 In order to be efficient the extra code makes the assumption that the stack starts
21027 at an address aligned to the value given by @var{stack-size}.
21028 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
21030 @item -mhotpatch[=@var{halfwords}]
21031 @itemx -mno-hotpatch
21032 @opindex mhotpatch
21033 If the hotpatch option is enabled, a ``hot-patching'' function
21034 prologue is generated for all functions in the compilation unit.
21035 The funtion label is prepended with the given number of two-byte
21036 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
21037 instructions if no argument is present.  Functions with a
21038 hot-patching prologue are never inlined automatically, and a
21039 hot-patching prologue is never generated for functions
21040 that are explicitly inline.
21042 This option can be overridden for individual functions with the
21043 @code{hotpatch} attribute.
21044 @end table
21046 @node Score Options
21047 @subsection Score Options
21048 @cindex Score Options
21050 These options are defined for Score implementations:
21052 @table @gcctabopt
21053 @item -meb
21054 @opindex meb
21055 Compile code for big-endian mode.  This is the default.
21057 @item -mel
21058 @opindex mel
21059 Compile code for little-endian mode.
21061 @item -mnhwloop
21062 @opindex mnhwloop
21063 Disable generation of @code{bcnz} instructions.
21065 @item -muls
21066 @opindex muls
21067 Enable generation of unaligned load and store instructions.
21069 @item -mmac
21070 @opindex mmac
21071 Enable the use of multiply-accumulate instructions. Disabled by default.
21073 @item -mscore5
21074 @opindex mscore5
21075 Specify the SCORE5 as the target architecture.
21077 @item -mscore5u
21078 @opindex mscore5u
21079 Specify the SCORE5U of the target architecture.
21081 @item -mscore7
21082 @opindex mscore7
21083 Specify the SCORE7 as the target architecture. This is the default.
21085 @item -mscore7d
21086 @opindex mscore7d
21087 Specify the SCORE7D as the target architecture.
21088 @end table
21090 @node SH Options
21091 @subsection SH Options
21093 These @samp{-m} options are defined for the SH implementations:
21095 @table @gcctabopt
21096 @item -m1
21097 @opindex m1
21098 Generate code for the SH1.
21100 @item -m2
21101 @opindex m2
21102 Generate code for the SH2.
21104 @item -m2e
21105 Generate code for the SH2e.
21107 @item -m2a-nofpu
21108 @opindex m2a-nofpu
21109 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21110 that the floating-point unit is not used.
21112 @item -m2a-single-only
21113 @opindex m2a-single-only
21114 Generate code for the SH2a-FPU, in such a way that no double-precision
21115 floating-point operations are used.
21117 @item -m2a-single
21118 @opindex m2a-single
21119 Generate code for the SH2a-FPU assuming the floating-point unit is in
21120 single-precision mode by default.
21122 @item -m2a
21123 @opindex m2a
21124 Generate code for the SH2a-FPU assuming the floating-point unit is in
21125 double-precision mode by default.
21127 @item -m3
21128 @opindex m3
21129 Generate code for the SH3.
21131 @item -m3e
21132 @opindex m3e
21133 Generate code for the SH3e.
21135 @item -m4-nofpu
21136 @opindex m4-nofpu
21137 Generate code for the SH4 without a floating-point unit.
21139 @item -m4-single-only
21140 @opindex m4-single-only
21141 Generate code for the SH4 with a floating-point unit that only
21142 supports single-precision arithmetic.
21144 @item -m4-single
21145 @opindex m4-single
21146 Generate code for the SH4 assuming the floating-point unit is in
21147 single-precision mode by default.
21149 @item -m4
21150 @opindex m4
21151 Generate code for the SH4.
21153 @item -m4-100
21154 @opindex m4-100
21155 Generate code for SH4-100.
21157 @item -m4-100-nofpu
21158 @opindex m4-100-nofpu
21159 Generate code for SH4-100 in such a way that the
21160 floating-point unit is not used.
21162 @item -m4-100-single
21163 @opindex m4-100-single
21164 Generate code for SH4-100 assuming the floating-point unit is in
21165 single-precision mode by default.
21167 @item -m4-100-single-only
21168 @opindex m4-100-single-only
21169 Generate code for SH4-100 in such a way that no double-precision
21170 floating-point operations are used.
21172 @item -m4-200
21173 @opindex m4-200
21174 Generate code for SH4-200.
21176 @item -m4-200-nofpu
21177 @opindex m4-200-nofpu
21178 Generate code for SH4-200 without in such a way that the
21179 floating-point unit is not used.
21181 @item -m4-200-single
21182 @opindex m4-200-single
21183 Generate code for SH4-200 assuming the floating-point unit is in
21184 single-precision mode by default.
21186 @item -m4-200-single-only
21187 @opindex m4-200-single-only
21188 Generate code for SH4-200 in such a way that no double-precision
21189 floating-point operations are used.
21191 @item -m4-300
21192 @opindex m4-300
21193 Generate code for SH4-300.
21195 @item -m4-300-nofpu
21196 @opindex m4-300-nofpu
21197 Generate code for SH4-300 without in such a way that the
21198 floating-point unit is not used.
21200 @item -m4-300-single
21201 @opindex m4-300-single
21202 Generate code for SH4-300 in such a way that no double-precision
21203 floating-point operations are used.
21205 @item -m4-300-single-only
21206 @opindex m4-300-single-only
21207 Generate code for SH4-300 in such a way that no double-precision
21208 floating-point operations are used.
21210 @item -m4-340
21211 @opindex m4-340
21212 Generate code for SH4-340 (no MMU, no FPU).
21214 @item -m4-500
21215 @opindex m4-500
21216 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21217 assembler.
21219 @item -m4a-nofpu
21220 @opindex m4a-nofpu
21221 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21222 floating-point unit is not used.
21224 @item -m4a-single-only
21225 @opindex m4a-single-only
21226 Generate code for the SH4a, in such a way that no double-precision
21227 floating-point operations are used.
21229 @item -m4a-single
21230 @opindex m4a-single
21231 Generate code for the SH4a assuming the floating-point unit is in
21232 single-precision mode by default.
21234 @item -m4a
21235 @opindex m4a
21236 Generate code for the SH4a.
21238 @item -m4al
21239 @opindex m4al
21240 Same as @option{-m4a-nofpu}, except that it implicitly passes
21241 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21242 instructions at the moment.
21244 @item -m5-32media
21245 @opindex m5-32media
21246 Generate 32-bit code for SHmedia.
21248 @item -m5-32media-nofpu
21249 @opindex m5-32media-nofpu
21250 Generate 32-bit code for SHmedia in such a way that the
21251 floating-point unit is not used.
21253 @item -m5-64media
21254 @opindex m5-64media
21255 Generate 64-bit code for SHmedia.
21257 @item -m5-64media-nofpu
21258 @opindex m5-64media-nofpu
21259 Generate 64-bit code for SHmedia in such a way that the
21260 floating-point unit is not used.
21262 @item -m5-compact
21263 @opindex m5-compact
21264 Generate code for SHcompact.
21266 @item -m5-compact-nofpu
21267 @opindex m5-compact-nofpu
21268 Generate code for SHcompact in such a way that the
21269 floating-point unit is not used.
21271 @item -mb
21272 @opindex mb
21273 Compile code for the processor in big-endian mode.
21275 @item -ml
21276 @opindex ml
21277 Compile code for the processor in little-endian mode.
21279 @item -mdalign
21280 @opindex mdalign
21281 Align doubles at 64-bit boundaries.  Note that this changes the calling
21282 conventions, and thus some functions from the standard C library do
21283 not work unless you recompile it first with @option{-mdalign}.
21285 @item -mrelax
21286 @opindex mrelax
21287 Shorten some address references at link time, when possible; uses the
21288 linker option @option{-relax}.
21290 @item -mbigtable
21291 @opindex mbigtable
21292 Use 32-bit offsets in @code{switch} tables.  The default is to use
21293 16-bit offsets.
21295 @item -mbitops
21296 @opindex mbitops
21297 Enable the use of bit manipulation instructions on SH2A.
21299 @item -mfmovd
21300 @opindex mfmovd
21301 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21302 alignment constraints.
21304 @item -mrenesas
21305 @opindex mrenesas
21306 Comply with the calling conventions defined by Renesas.
21308 @item -mno-renesas
21309 @opindex mno-renesas
21310 Comply with the calling conventions defined for GCC before the Renesas
21311 conventions were available.  This option is the default for all
21312 targets of the SH toolchain.
21314 @item -mnomacsave
21315 @opindex mnomacsave
21316 Mark the @code{MAC} register as call-clobbered, even if
21317 @option{-mrenesas} is given.
21319 @item -mieee
21320 @itemx -mno-ieee
21321 @opindex mieee
21322 @opindex mno-ieee
21323 Control the IEEE compliance of floating-point comparisons, which affects the
21324 handling of cases where the result of a comparison is unordered.  By default
21325 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21326 enabled @option{-mno-ieee} is implicitly set, which results in faster
21327 floating-point greater-equal and less-equal comparisons.  The implcit settings
21328 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21330 @item -minline-ic_invalidate
21331 @opindex minline-ic_invalidate
21332 Inline code to invalidate instruction cache entries after setting up
21333 nested function trampolines.
21334 This option has no effect if @option{-musermode} is in effect and the selected
21335 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21336 instruction.
21337 If the selected code generation option does not allow the use of the @code{icbi}
21338 instruction, and @option{-musermode} is not in effect, the inlined code
21339 manipulates the instruction cache address array directly with an associative
21340 write.  This not only requires privileged mode at run time, but it also
21341 fails if the cache line had been mapped via the TLB and has become unmapped.
21343 @item -misize
21344 @opindex misize
21345 Dump instruction size and location in the assembly code.
21347 @item -mpadstruct
21348 @opindex mpadstruct
21349 This option is deprecated.  It pads structures to multiple of 4 bytes,
21350 which is incompatible with the SH ABI@.
21352 @item -matomic-model=@var{model}
21353 @opindex matomic-model=@var{model}
21354 Sets the model of atomic operations and additional parameters as a comma
21355 separated list.  For details on the atomic built-in functions see
21356 @ref{__atomic Builtins}.  The following models and parameters are supported:
21358 @table @samp
21360 @item none
21361 Disable compiler generated atomic sequences and emit library calls for atomic
21362 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21364 @item soft-gusa
21365 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21366 built-in functions.  The generated atomic sequences require additional support
21367 from the interrupt/exception handling code of the system and are only suitable
21368 for SH3* and SH4* single-core systems.  This option is enabled by default when
21369 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21370 this option will also partially utilize the hardware atomic instructions
21371 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21372 @samp{strict} is specified.  
21374 @item soft-tcb
21375 Generate software atomic sequences that use a variable in the thread control
21376 block.  This is a variation of the gUSA sequences which can also be used on
21377 SH1* and SH2* targets.  The generated atomic sequences require additional
21378 support from the interrupt/exception handling code of the system and are only
21379 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21380 parameter has to be specified as well.
21382 @item soft-imask
21383 Generate software atomic sequences that temporarily disable interrupts by
21384 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21385 in privileged mode and is only suitable for single-core systems.  Additional
21386 support from the interrupt/exception handling code of the system is not
21387 required.  This model is enabled by default when the target is
21388 @code{sh*-*-linux*} and SH1* or SH2*.
21390 @item hard-llcs
21391 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21392 instructions only.  This is only available on SH4A and is suitable for
21393 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21394 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21395 Code compiled with this option will also be compatible with other software
21396 atomic model interrupt/exception handling systems if executed on an SH4A
21397 system.  Additional support from the interrupt/exception handling code of the
21398 system is not required for this model.
21400 @item gbr-offset=
21401 This parameter specifies the offset in bytes of the variable in the thread
21402 control block structure that should be used by the generated atomic sequences
21403 when the @samp{soft-tcb} model has been selected.  For other models this
21404 parameter is ignored.  The specified value must be an integer multiple of four
21405 and in the range 0-1020.
21407 @item strict
21408 This parameter prevents mixed usage of multiple atomic models, even though they
21409 would be compatible, and will make the compiler generate atomic sequences of the
21410 specified model only.
21412 @end table
21414 @item -mtas
21415 @opindex mtas
21416 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21417 Notice that depending on the particular hardware and software configuration
21418 this can degrade overall performance due to the operand cache line flushes
21419 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21420 processors the @code{tas.b} instruction must be used with caution since it
21421 can result in data corruption for certain cache configurations.
21423 @item -mprefergot
21424 @opindex mprefergot
21425 When generating position-independent code, emit function calls using
21426 the Global Offset Table instead of the Procedure Linkage Table.
21428 @item -musermode
21429 @itemx -mno-usermode
21430 @opindex musermode
21431 @opindex mno-usermode
21432 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21433 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21434 inlined code would not work in user mode.  @option{-musermode} is the default
21435 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21436 @option{-musermode} has no effect, since there is no user mode.
21438 @item -multcost=@var{number}
21439 @opindex multcost=@var{number}
21440 Set the cost to assume for a multiply insn.
21442 @item -mdiv=@var{strategy}
21443 @opindex mdiv=@var{strategy}
21444 Set the division strategy to be used for integer division operations.
21445 For SHmedia @var{strategy} can be one of: 
21447 @table @samp
21449 @item fp 
21450 Performs the operation in floating point.  This has a very high latency,
21451 but needs only a few instructions, so it might be a good choice if
21452 your code has enough easily-exploitable ILP to allow the compiler to
21453 schedule the floating-point instructions together with other instructions.
21454 Division by zero causes a floating-point exception.
21456 @item inv
21457 Uses integer operations to calculate the inverse of the divisor,
21458 and then multiplies the dividend with the inverse.  This strategy allows
21459 CSE and hoisting of the inverse calculation.  Division by zero calculates
21460 an unspecified result, but does not trap.
21462 @item inv:minlat
21463 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21464 have been found, or if the entire operation has been hoisted to the same
21465 place, the last stages of the inverse calculation are intertwined with the
21466 final multiply to reduce the overall latency, at the expense of using a few
21467 more instructions, and thus offering fewer scheduling opportunities with
21468 other code.
21470 @item call
21471 Calls a library function that usually implements the @samp{inv:minlat}
21472 strategy.
21473 This gives high code density for @code{m5-*media-nofpu} compilations.
21475 @item call2
21476 Uses a different entry point of the same library function, where it
21477 assumes that a pointer to a lookup table has already been set up, which
21478 exposes the pointer load to CSE and code hoisting optimizations.
21480 @item inv:call
21481 @itemx inv:call2
21482 @itemx inv:fp
21483 Use the @samp{inv} algorithm for initial
21484 code generation, but if the code stays unoptimized, revert to the @samp{call},
21485 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21486 potentially-trapping side effect of division by zero is carried by a
21487 separate instruction, so it is possible that all the integer instructions
21488 are hoisted out, but the marker for the side effect stays where it is.
21489 A recombination to floating-point operations or a call is not possible
21490 in that case.
21492 @item inv20u
21493 @itemx inv20l
21494 Variants of the @samp{inv:minlat} strategy.  In the case
21495 that the inverse calculation is not separated from the multiply, they speed
21496 up division where the dividend fits into 20 bits (plus sign where applicable)
21497 by inserting a test to skip a number of operations in this case; this test
21498 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21499 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21501 @end table
21503 For targets other than SHmedia @var{strategy} can be one of:
21505 @table @samp
21507 @item call-div1
21508 Calls a library function that uses the single-step division instruction
21509 @code{div1} to perform the operation.  Division by zero calculates an
21510 unspecified result and does not trap.  This is the default except for SH4,
21511 SH2A and SHcompact.
21513 @item call-fp
21514 Calls a library function that performs the operation in double precision
21515 floating point.  Division by zero causes a floating-point exception.  This is
21516 the default for SHcompact with FPU.  Specifying this for targets that do not
21517 have a double precision FPU will default to @code{call-div1}.
21519 @item call-table
21520 Calls a library function that uses a lookup table for small divisors and
21521 the @code{div1} instruction with case distinction for larger divisors.  Division
21522 by zero calculates an unspecified result and does not trap.  This is the default
21523 for SH4.  Specifying this for targets that do not have dynamic shift
21524 instructions will default to @code{call-div1}.
21526 @end table
21528 When a division strategy has not been specified the default strategy will be
21529 selected based on the current target.  For SH2A the default strategy is to
21530 use the @code{divs} and @code{divu} instructions instead of library function
21531 calls.
21533 @item -maccumulate-outgoing-args
21534 @opindex maccumulate-outgoing-args
21535 Reserve space once for outgoing arguments in the function prologue rather
21536 than around each call.  Generally beneficial for performance and size.  Also
21537 needed for unwinding to avoid changing the stack frame around conditional code.
21539 @item -mdivsi3_libfunc=@var{name}
21540 @opindex mdivsi3_libfunc=@var{name}
21541 Set the name of the library function used for 32-bit signed division to
21542 @var{name}.
21543 This only affects the name used in the @samp{call} and @samp{inv:call}
21544 division strategies, and the compiler still expects the same
21545 sets of input/output/clobbered registers as if this option were not present.
21547 @item -mfixed-range=@var{register-range}
21548 @opindex mfixed-range
21549 Generate code treating the given register range as fixed registers.
21550 A fixed register is one that the register allocator can not use.  This is
21551 useful when compiling kernel code.  A register range is specified as
21552 two registers separated by a dash.  Multiple register ranges can be
21553 specified separated by a comma.
21555 @item -mindexed-addressing
21556 @opindex mindexed-addressing
21557 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21558 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21559 semantics for the indexed addressing mode.  The architecture allows the
21560 implementation of processors with 64-bit MMU, which the OS could use to
21561 get 32-bit addressing, but since no current hardware implementation supports
21562 this or any other way to make the indexed addressing mode safe to use in
21563 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21565 @item -mgettrcost=@var{number}
21566 @opindex mgettrcost=@var{number}
21567 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21568 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21570 @item -mpt-fixed
21571 @opindex mpt-fixed
21572 Assume @code{pt*} instructions won't trap.  This generally generates
21573 better-scheduled code, but is unsafe on current hardware.
21574 The current architecture
21575 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21576 anded with 3 is 3.
21577 This has the unintentional effect of making it unsafe to schedule these
21578 instructions before a branch, or hoist them out of a loop.  For example,
21579 @code{__do_global_ctors}, a part of @file{libgcc}
21580 that runs constructors at program
21581 startup, calls functions in a list which is delimited by @minus{}1.  With the
21582 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21583 That means that all the constructors run a bit more quickly, but when
21584 the loop comes to the end of the list, the program crashes because @code{ptabs}
21585 loads @minus{}1 into a target register.  
21587 Since this option is unsafe for any
21588 hardware implementing the current architecture specification, the default
21589 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21590 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21591 this deters register allocation from using target registers for storing
21592 ordinary integers.
21594 @item -minvalid-symbols
21595 @opindex minvalid-symbols
21596 Assume symbols might be invalid.  Ordinary function symbols generated by
21597 the compiler are always valid to load with
21598 @code{movi}/@code{shori}/@code{ptabs} or
21599 @code{movi}/@code{shori}/@code{ptrel},
21600 but with assembler and/or linker tricks it is possible
21601 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21602 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21603 It prevents cross-basic-block CSE, hoisting and most scheduling
21604 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21606 @item -mbranch-cost=@var{num}
21607 @opindex mbranch-cost=@var{num}
21608 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21609 make the compiler try to generate more branch-free code if possible.  
21610 If not specified the value is selected depending on the processor type that
21611 is being compiled for.
21613 @item -mzdcbranch
21614 @itemx -mno-zdcbranch
21615 @opindex mzdcbranch
21616 @opindex mno-zdcbranch
21617 Assume (do not assume) that zero displacement conditional branch instructions
21618 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21619 compiler will try to prefer zero displacement branch code sequences.  This is
21620 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21621 disabled by specifying @option{-mno-zdcbranch}.
21623 @item -mfused-madd
21624 @itemx -mno-fused-madd
21625 @opindex mfused-madd
21626 @opindex mno-fused-madd
21627 Generate code that uses (does not use) the floating-point multiply and
21628 accumulate instructions.  These instructions are generated by default
21629 if hardware floating point is used.  The machine-dependent
21630 @option{-mfused-madd} option is now mapped to the machine-independent
21631 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21632 mapped to @option{-ffp-contract=off}.
21634 @item -mfsca
21635 @itemx -mno-fsca
21636 @opindex mfsca
21637 @opindex mno-fsca
21638 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21639 and cosine approximations.  The option @code{-mfsca} must be used in
21640 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21641 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21642 approximations even if @code{-funsafe-math-optimizations} is in effect.
21644 @item -mfsrra
21645 @itemx -mno-fsrra
21646 @opindex mfsrra
21647 @opindex mno-fsrra
21648 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21649 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21650 in combination with @code{-funsafe-math-optimizations} and
21651 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21652 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21653 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21654 in effect.
21656 @item -mpretend-cmove
21657 @opindex mpretend-cmove
21658 Prefer zero-displacement conditional branches for conditional move instruction
21659 patterns.  This can result in faster code on the SH4 processor.
21661 @end table
21663 @node Solaris 2 Options
21664 @subsection Solaris 2 Options
21665 @cindex Solaris 2 options
21667 These @samp{-m} options are supported on Solaris 2:
21669 @table @gcctabopt
21670 @item -mclear-hwcap
21671 @opindex mclear-hwcap
21672 @option{-mclear-hwcap} tells the compiler to remove the hardware
21673 capabilities generated by the Solaris assembler.  This is only necessary
21674 when object files use ISA extensions not supported by the current
21675 machine, but check at runtime whether or not to use them.
21677 @item -mimpure-text
21678 @opindex mimpure-text
21679 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21680 the compiler to not pass @option{-z text} to the linker when linking a
21681 shared object.  Using this option, you can link position-dependent
21682 code into a shared object.
21684 @option{-mimpure-text} suppresses the ``relocations remain against
21685 allocatable but non-writable sections'' linker error message.
21686 However, the necessary relocations trigger copy-on-write, and the
21687 shared object is not actually shared across processes.  Instead of
21688 using @option{-mimpure-text}, you should compile all source code with
21689 @option{-fpic} or @option{-fPIC}.
21691 @end table
21693 These switches are supported in addition to the above on Solaris 2:
21695 @table @gcctabopt
21696 @item -pthreads
21697 @opindex pthreads
21698 Add support for multithreading using the POSIX threads library.  This
21699 option sets flags for both the preprocessor and linker.  This option does
21700 not affect the thread safety of object code produced  by the compiler or
21701 that of libraries supplied with it.
21703 @item -pthread
21704 @opindex pthread
21705 This is a synonym for @option{-pthreads}.
21706 @end table
21708 @node SPARC Options
21709 @subsection SPARC Options
21710 @cindex SPARC options
21712 These @samp{-m} options are supported on the SPARC:
21714 @table @gcctabopt
21715 @item -mno-app-regs
21716 @itemx -mapp-regs
21717 @opindex mno-app-regs
21718 @opindex mapp-regs
21719 Specify @option{-mapp-regs} to generate output using the global registers
21720 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21721 global register 1, each global register 2 through 4 is then treated as an
21722 allocable register that is clobbered by function calls.  This is the default.
21724 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21725 specify @option{-mno-app-regs}.  You should compile libraries and system
21726 software with this option.
21728 @item -mflat
21729 @itemx -mno-flat
21730 @opindex mflat
21731 @opindex mno-flat
21732 With @option{-mflat}, the compiler does not generate save/restore instructions
21733 and uses a ``flat'' or single register window model.  This model is compatible
21734 with the regular register window model.  The local registers and the input
21735 registers (0--5) are still treated as ``call-saved'' registers and are
21736 saved on the stack as needed.
21738 With @option{-mno-flat} (the default), the compiler generates save/restore
21739 instructions (except for leaf functions).  This is the normal operating mode.
21741 @item -mfpu
21742 @itemx -mhard-float
21743 @opindex mfpu
21744 @opindex mhard-float
21745 Generate output containing floating-point instructions.  This is the
21746 default.
21748 @item -mno-fpu
21749 @itemx -msoft-float
21750 @opindex mno-fpu
21751 @opindex msoft-float
21752 Generate output containing library calls for floating point.
21753 @strong{Warning:} the requisite libraries are not available for all SPARC
21754 targets.  Normally the facilities of the machine's usual C compiler are
21755 used, but this cannot be done directly in cross-compilation.  You must make
21756 your own arrangements to provide suitable library functions for
21757 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21758 @samp{sparclite-*-*} do provide software floating-point support.
21760 @option{-msoft-float} changes the calling convention in the output file;
21761 therefore, it is only useful if you compile @emph{all} of a program with
21762 this option.  In particular, you need to compile @file{libgcc.a}, the
21763 library that comes with GCC, with @option{-msoft-float} in order for
21764 this to work.
21766 @item -mhard-quad-float
21767 @opindex mhard-quad-float
21768 Generate output containing quad-word (long double) floating-point
21769 instructions.
21771 @item -msoft-quad-float
21772 @opindex msoft-quad-float
21773 Generate output containing library calls for quad-word (long double)
21774 floating-point instructions.  The functions called are those specified
21775 in the SPARC ABI@.  This is the default.
21777 As of this writing, there are no SPARC implementations that have hardware
21778 support for the quad-word floating-point instructions.  They all invoke
21779 a trap handler for one of these instructions, and then the trap handler
21780 emulates the effect of the instruction.  Because of the trap handler overhead,
21781 this is much slower than calling the ABI library routines.  Thus the
21782 @option{-msoft-quad-float} option is the default.
21784 @item -mno-unaligned-doubles
21785 @itemx -munaligned-doubles
21786 @opindex mno-unaligned-doubles
21787 @opindex munaligned-doubles
21788 Assume that doubles have 8-byte alignment.  This is the default.
21790 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21791 alignment only if they are contained in another type, or if they have an
21792 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21793 Specifying this option avoids some rare compatibility problems with code
21794 generated by other compilers.  It is not the default because it results
21795 in a performance loss, especially for floating-point code.
21797 @item -muser-mode
21798 @itemx -mno-user-mode
21799 @opindex muser-mode
21800 @opindex mno-user-mode
21801 Do not generate code that can only run in supervisor mode.  This is relevant
21802 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21803 default is @option{-mno-user-mode}.
21805 @item -mno-faster-structs
21806 @itemx -mfaster-structs
21807 @opindex mno-faster-structs
21808 @opindex mfaster-structs
21809 With @option{-mfaster-structs}, the compiler assumes that structures
21810 should have 8-byte alignment.  This enables the use of pairs of
21811 @code{ldd} and @code{std} instructions for copies in structure
21812 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21813 However, the use of this changed alignment directly violates the SPARC
21814 ABI@.  Thus, it's intended only for use on targets where the developer
21815 acknowledges that their resulting code is not directly in line with
21816 the rules of the ABI@.
21818 @item -mcpu=@var{cpu_type}
21819 @opindex mcpu
21820 Set the instruction set, register set, and instruction scheduling parameters
21821 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21822 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21823 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21824 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21825 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21826 @samp{niagara3} and @samp{niagara4}.
21828 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21829 which selects the best architecture option for the host processor.
21830 @option{-mcpu=native} has no effect if GCC does not recognize
21831 the processor.
21833 Default instruction scheduling parameters are used for values that select
21834 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21835 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21837 Here is a list of each supported architecture and their supported
21838 implementations.
21840 @table @asis
21841 @item v7
21842 cypress, leon3v7
21844 @item v8
21845 supersparc, hypersparc, leon, leon3
21847 @item sparclite
21848 f930, f934, sparclite86x
21850 @item sparclet
21851 tsc701
21853 @item v9
21854 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21855 @end table
21857 By default (unless configured otherwise), GCC generates code for the V7
21858 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21859 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21860 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21861 SPARCStation 1, 2, IPX etc.
21863 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21864 architecture.  The only difference from V7 code is that the compiler emits
21865 the integer multiply and integer divide instructions which exist in SPARC-V8
21866 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21867 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21868 2000 series.
21870 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21871 the SPARC architecture.  This adds the integer multiply, integer divide step
21872 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21873 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21874 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21875 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21876 MB86934 chip, which is the more recent SPARClite with FPU@.
21878 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21879 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21880 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21881 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21882 optimizes it for the TEMIC SPARClet chip.
21884 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21885 architecture.  This adds 64-bit integer and floating-point move instructions,
21886 3 additional floating-point condition code registers and conditional move
21887 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21888 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21889 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21890 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21891 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21892 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21893 additionally optimizes it for Sun UltraSPARC T2 chips. With
21894 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21895 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21896 additionally optimizes it for Sun UltraSPARC T4 chips.
21898 @item -mtune=@var{cpu_type}
21899 @opindex mtune
21900 Set the instruction scheduling parameters for machine type
21901 @var{cpu_type}, but do not set the instruction set or register set that the
21902 option @option{-mcpu=@var{cpu_type}} does.
21904 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21905 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21906 that select a particular CPU implementation.  Those are @samp{cypress},
21907 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21908 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21909 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21910 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21911 toolchains, @samp{native} can also be used.
21913 @item -mv8plus
21914 @itemx -mno-v8plus
21915 @opindex mv8plus
21916 @opindex mno-v8plus
21917 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21918 difference from the V8 ABI is that the global and out registers are
21919 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21920 mode for all SPARC-V9 processors.
21922 @item -mvis
21923 @itemx -mno-vis
21924 @opindex mvis
21925 @opindex mno-vis
21926 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21927 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21929 @item -mvis2
21930 @itemx -mno-vis2
21931 @opindex mvis2
21932 @opindex mno-vis2
21933 With @option{-mvis2}, GCC generates code that takes advantage of
21934 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21935 default is @option{-mvis2} when targeting a cpu that supports such
21936 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21937 also sets @option{-mvis}.
21939 @item -mvis3
21940 @itemx -mno-vis3
21941 @opindex mvis3
21942 @opindex mno-vis3
21943 With @option{-mvis3}, GCC generates code that takes advantage of
21944 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21945 default is @option{-mvis3} when targeting a cpu that supports such
21946 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21947 also sets @option{-mvis2} and @option{-mvis}.
21949 @item -mcbcond
21950 @itemx -mno-cbcond
21951 @opindex mcbcond
21952 @opindex mno-cbcond
21953 With @option{-mcbcond}, GCC generates code that takes advantage of
21954 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21955 The default is @option{-mcbcond} when targeting a cpu that supports such
21956 instructions, such as niagara-4 and later.
21958 @item -mpopc
21959 @itemx -mno-popc
21960 @opindex mpopc
21961 @opindex mno-popc
21962 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21963 population count instruction.  The default is @option{-mpopc}
21964 when targeting a cpu that supports such instructions, such as Niagara-2 and
21965 later.
21967 @item -mfmaf
21968 @itemx -mno-fmaf
21969 @opindex mfmaf
21970 @opindex mno-fmaf
21971 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21972 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21973 when targeting a cpu that supports such instructions, such as Niagara-3 and
21974 later.
21976 @item -mfix-at697f
21977 @opindex mfix-at697f
21978 Enable the documented workaround for the single erratum of the Atmel AT697F
21979 processor (which corresponds to erratum #13 of the AT697E processor).
21981 @item -mfix-ut699
21982 @opindex mfix-ut699
21983 Enable the documented workarounds for the floating-point errata and the data
21984 cache nullify errata of the UT699 processor.
21985 @end table
21987 These @samp{-m} options are supported in addition to the above
21988 on SPARC-V9 processors in 64-bit environments:
21990 @table @gcctabopt
21991 @item -m32
21992 @itemx -m64
21993 @opindex m32
21994 @opindex m64
21995 Generate code for a 32-bit or 64-bit environment.
21996 The 32-bit environment sets int, long and pointer to 32 bits.
21997 The 64-bit environment sets int to 32 bits and long and pointer
21998 to 64 bits.
22000 @item -mcmodel=@var{which}
22001 @opindex mcmodel
22002 Set the code model to one of
22004 @table @samp
22005 @item medlow
22006 The Medium/Low code model: 64-bit addresses, programs
22007 must be linked in the low 32 bits of memory.  Programs can be statically
22008 or dynamically linked.
22010 @item medmid
22011 The Medium/Middle code model: 64-bit addresses, programs
22012 must be linked in the low 44 bits of memory, the text and data segments must
22013 be less than 2GB in size and the data segment must be located within 2GB of
22014 the text segment.
22016 @item medany
22017 The Medium/Anywhere code model: 64-bit addresses, programs
22018 may be linked anywhere in memory, the text and data segments must be less
22019 than 2GB in size and the data segment must be located within 2GB of the
22020 text segment.
22022 @item embmedany
22023 The Medium/Anywhere code model for embedded systems:
22024 64-bit addresses, the text and data segments must be less than 2GB in
22025 size, both starting anywhere in memory (determined at link time).  The
22026 global register %g4 points to the base of the data segment.  Programs
22027 are statically linked and PIC is not supported.
22028 @end table
22030 @item -mmemory-model=@var{mem-model}
22031 @opindex mmemory-model
22032 Set the memory model in force on the processor to one of
22034 @table @samp
22035 @item default
22036 The default memory model for the processor and operating system.
22038 @item rmo
22039 Relaxed Memory Order
22041 @item pso
22042 Partial Store Order
22044 @item tso
22045 Total Store Order
22047 @item sc
22048 Sequential Consistency
22049 @end table
22051 These memory models are formally defined in Appendix D of the Sparc V9
22052 architecture manual, as set in the processor's @code{PSTATE.MM} field.
22054 @item -mstack-bias
22055 @itemx -mno-stack-bias
22056 @opindex mstack-bias
22057 @opindex mno-stack-bias
22058 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
22059 frame pointer if present, are offset by @minus{}2047 which must be added back
22060 when making stack frame references.  This is the default in 64-bit mode.
22061 Otherwise, assume no such offset is present.
22062 @end table
22064 @node SPU Options
22065 @subsection SPU Options
22066 @cindex SPU options
22068 These @samp{-m} options are supported on the SPU:
22070 @table @gcctabopt
22071 @item -mwarn-reloc
22072 @itemx -merror-reloc
22073 @opindex mwarn-reloc
22074 @opindex merror-reloc
22076 The loader for SPU does not handle dynamic relocations.  By default, GCC
22077 gives an error when it generates code that requires a dynamic
22078 relocation.  @option{-mno-error-reloc} disables the error,
22079 @option{-mwarn-reloc} generates a warning instead.
22081 @item -msafe-dma
22082 @itemx -munsafe-dma
22083 @opindex msafe-dma
22084 @opindex munsafe-dma
22086 Instructions that initiate or test completion of DMA must not be
22087 reordered with respect to loads and stores of the memory that is being
22088 accessed.
22089 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
22090 memory accesses, but that can lead to inefficient code in places where the
22091 memory is known to not change.  Rather than mark the memory as volatile,
22092 you can use @option{-msafe-dma} to tell the compiler to treat
22093 the DMA instructions as potentially affecting all memory.  
22095 @item -mbranch-hints
22096 @opindex mbranch-hints
22098 By default, GCC generates a branch hint instruction to avoid
22099 pipeline stalls for always-taken or probably-taken branches.  A hint
22100 is not generated closer than 8 instructions away from its branch.
22101 There is little reason to disable them, except for debugging purposes,
22102 or to make an object a little bit smaller.
22104 @item -msmall-mem
22105 @itemx -mlarge-mem
22106 @opindex msmall-mem
22107 @opindex mlarge-mem
22109 By default, GCC generates code assuming that addresses are never larger
22110 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22111 a full 32-bit address.
22113 @item -mstdmain
22114 @opindex mstdmain
22116 By default, GCC links against startup code that assumes the SPU-style
22117 main function interface (which has an unconventional parameter list).
22118 With @option{-mstdmain}, GCC links your program against startup
22119 code that assumes a C99-style interface to @code{main}, including a
22120 local copy of @code{argv} strings.
22122 @item -mfixed-range=@var{register-range}
22123 @opindex mfixed-range
22124 Generate code treating the given register range as fixed registers.
22125 A fixed register is one that the register allocator cannot use.  This is
22126 useful when compiling kernel code.  A register range is specified as
22127 two registers separated by a dash.  Multiple register ranges can be
22128 specified separated by a comma.
22130 @item -mea32
22131 @itemx -mea64
22132 @opindex mea32
22133 @opindex mea64
22134 Compile code assuming that pointers to the PPU address space accessed
22135 via the @code{__ea} named address space qualifier are either 32 or 64
22136 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22137 all object code in an executable must be compiled with the same setting.
22139 @item -maddress-space-conversion
22140 @itemx -mno-address-space-conversion
22141 @opindex maddress-space-conversion
22142 @opindex mno-address-space-conversion
22143 Allow/disallow treating the @code{__ea} address space as superset
22144 of the generic address space.  This enables explicit type casts
22145 between @code{__ea} and generic pointer as well as implicit
22146 conversions of generic pointers to @code{__ea} pointers.  The
22147 default is to allow address space pointer conversions.
22149 @item -mcache-size=@var{cache-size}
22150 @opindex mcache-size
22151 This option controls the version of libgcc that the compiler links to an
22152 executable and selects a software-managed cache for accessing variables
22153 in the @code{__ea} address space with a particular cache size.  Possible
22154 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22155 and @samp{128}.  The default cache size is 64KB.
22157 @item -matomic-updates
22158 @itemx -mno-atomic-updates
22159 @opindex matomic-updates
22160 @opindex mno-atomic-updates
22161 This option controls the version of libgcc that the compiler links to an
22162 executable and selects whether atomic updates to the software-managed
22163 cache of PPU-side variables are used.  If you use atomic updates, changes
22164 to a PPU variable from SPU code using the @code{__ea} named address space
22165 qualifier do not interfere with changes to other PPU variables residing
22166 in the same cache line from PPU code.  If you do not use atomic updates,
22167 such interference may occur; however, writing back cache lines is
22168 more efficient.  The default behavior is to use atomic updates.
22170 @item -mdual-nops
22171 @itemx -mdual-nops=@var{n}
22172 @opindex mdual-nops
22173 By default, GCC inserts nops to increase dual issue when it expects
22174 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22175 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22176 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22178 @item -mhint-max-nops=@var{n}
22179 @opindex mhint-max-nops
22180 Maximum number of nops to insert for a branch hint.  A branch hint must
22181 be at least 8 instructions away from the branch it is affecting.  GCC
22182 inserts up to @var{n} nops to enforce this, otherwise it does not
22183 generate the branch hint.
22185 @item -mhint-max-distance=@var{n}
22186 @opindex mhint-max-distance
22187 The encoding of the branch hint instruction limits the hint to be within
22188 256 instructions of the branch it is affecting.  By default, GCC makes
22189 sure it is within 125.
22191 @item -msafe-hints
22192 @opindex msafe-hints
22193 Work around a hardware bug that causes the SPU to stall indefinitely.
22194 By default, GCC inserts the @code{hbrp} instruction to make sure
22195 this stall won't happen.
22197 @end table
22199 @node System V Options
22200 @subsection Options for System V
22202 These additional options are available on System V Release 4 for
22203 compatibility with other compilers on those systems:
22205 @table @gcctabopt
22206 @item -G
22207 @opindex G
22208 Create a shared object.
22209 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22211 @item -Qy
22212 @opindex Qy
22213 Identify the versions of each tool used by the compiler, in a
22214 @code{.ident} assembler directive in the output.
22216 @item -Qn
22217 @opindex Qn
22218 Refrain from adding @code{.ident} directives to the output file (this is
22219 the default).
22221 @item -YP,@var{dirs}
22222 @opindex YP
22223 Search the directories @var{dirs}, and no others, for libraries
22224 specified with @option{-l}.
22226 @item -Ym,@var{dir}
22227 @opindex Ym
22228 Look in the directory @var{dir} to find the M4 preprocessor.
22229 The assembler uses this option.
22230 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22231 @c the generic assembler that comes with Solaris takes just -Ym.
22232 @end table
22234 @node TILE-Gx Options
22235 @subsection TILE-Gx Options
22236 @cindex TILE-Gx options
22238 These @samp{-m} options are supported on the TILE-Gx:
22240 @table @gcctabopt
22241 @item -mcmodel=small
22242 @opindex mcmodel=small
22243 Generate code for the small model.  The distance for direct calls is
22244 limited to 500M in either direction.  PC-relative addresses are 32
22245 bits.  Absolute addresses support the full address range.
22247 @item -mcmodel=large
22248 @opindex mcmodel=large
22249 Generate code for the large model.  There is no limitation on call
22250 distance, pc-relative addresses, or absolute addresses.
22252 @item -mcpu=@var{name}
22253 @opindex mcpu
22254 Selects the type of CPU to be targeted.  Currently the only supported
22255 type is @samp{tilegx}.
22257 @item -m32
22258 @itemx -m64
22259 @opindex m32
22260 @opindex m64
22261 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22262 environment sets int, long, and pointer to 32 bits.  The 64-bit
22263 environment sets int to 32 bits and long and pointer to 64 bits.
22265 @item -mbig-endian
22266 @itemx -mlittle-endian
22267 @opindex mbig-endian
22268 @opindex mlittle-endian
22269 Generate code in big/little endian mode, respectively.
22270 @end table
22272 @node TILEPro Options
22273 @subsection TILEPro Options
22274 @cindex TILEPro options
22276 These @samp{-m} options are supported on the TILEPro:
22278 @table @gcctabopt
22279 @item -mcpu=@var{name}
22280 @opindex mcpu
22281 Selects the type of CPU to be targeted.  Currently the only supported
22282 type is @samp{tilepro}.
22284 @item -m32
22285 @opindex m32
22286 Generate code for a 32-bit environment, which sets int, long, and
22287 pointer to 32 bits.  This is the only supported behavior so the flag
22288 is essentially ignored.
22289 @end table
22291 @node V850 Options
22292 @subsection V850 Options
22293 @cindex V850 Options
22295 These @samp{-m} options are defined for V850 implementations:
22297 @table @gcctabopt
22298 @item -mlong-calls
22299 @itemx -mno-long-calls
22300 @opindex mlong-calls
22301 @opindex mno-long-calls
22302 Treat all calls as being far away (near).  If calls are assumed to be
22303 far away, the compiler always loads the function's address into a
22304 register, and calls indirect through the pointer.
22306 @item -mno-ep
22307 @itemx -mep
22308 @opindex mno-ep
22309 @opindex mep
22310 Do not optimize (do optimize) basic blocks that use the same index
22311 pointer 4 or more times to copy pointer into the @code{ep} register, and
22312 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22313 option is on by default if you optimize.
22315 @item -mno-prolog-function
22316 @itemx -mprolog-function
22317 @opindex mno-prolog-function
22318 @opindex mprolog-function
22319 Do not use (do use) external functions to save and restore registers
22320 at the prologue and epilogue of a function.  The external functions
22321 are slower, but use less code space if more than one function saves
22322 the same number of registers.  The @option{-mprolog-function} option
22323 is on by default if you optimize.
22325 @item -mspace
22326 @opindex mspace
22327 Try to make the code as small as possible.  At present, this just turns
22328 on the @option{-mep} and @option{-mprolog-function} options.
22330 @item -mtda=@var{n}
22331 @opindex mtda
22332 Put static or global variables whose size is @var{n} bytes or less into
22333 the tiny data area that register @code{ep} points to.  The tiny data
22334 area can hold up to 256 bytes in total (128 bytes for byte references).
22336 @item -msda=@var{n}
22337 @opindex msda
22338 Put static or global variables whose size is @var{n} bytes or less into
22339 the small data area that register @code{gp} points to.  The small data
22340 area can hold up to 64 kilobytes.
22342 @item -mzda=@var{n}
22343 @opindex mzda
22344 Put static or global variables whose size is @var{n} bytes or less into
22345 the first 32 kilobytes of memory.
22347 @item -mv850
22348 @opindex mv850
22349 Specify that the target processor is the V850.
22351 @item -mv850e3v5
22352 @opindex mv850e3v5
22353 Specify that the target processor is the V850E3V5.  The preprocessor
22354 constant @samp{__v850e3v5__} is defined if this option is used.
22356 @item -mv850e2v4
22357 @opindex mv850e2v4
22358 Specify that the target processor is the V850E3V5.  This is an alias for
22359 the @option{-mv850e3v5} option.
22361 @item -mv850e2v3
22362 @opindex mv850e2v3
22363 Specify that the target processor is the V850E2V3.  The preprocessor
22364 constant @samp{__v850e2v3__} is defined if this option is used.
22366 @item -mv850e2
22367 @opindex mv850e2
22368 Specify that the target processor is the V850E2.  The preprocessor
22369 constant @samp{__v850e2__} is defined if this option is used.
22371 @item -mv850e1
22372 @opindex mv850e1
22373 Specify that the target processor is the V850E1.  The preprocessor
22374 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22375 this option is used.
22377 @item -mv850es
22378 @opindex mv850es
22379 Specify that the target processor is the V850ES.  This is an alias for
22380 the @option{-mv850e1} option.
22382 @item -mv850e
22383 @opindex mv850e
22384 Specify that the target processor is the V850E@.  The preprocessor
22385 constant @samp{__v850e__} is defined if this option is used.
22387 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22388 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22389 are defined then a default target processor is chosen and the
22390 relevant @samp{__v850*__} preprocessor constant is defined.
22392 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22393 defined, regardless of which processor variant is the target.
22395 @item -mdisable-callt
22396 @itemx -mno-disable-callt
22397 @opindex mdisable-callt
22398 @opindex mno-disable-callt
22399 This option suppresses generation of the @code{CALLT} instruction for the
22400 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22401 architecture.
22403 This option is enabled by default when the RH850 ABI is
22404 in use (see @option{-mrh850-abi}), and disabled by default when the
22405 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22406 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22408 @item -mrelax
22409 @itemx -mno-relax
22410 @opindex mrelax
22411 @opindex mno-relax
22412 Pass on (or do not pass on) the @option{-mrelax} command line option
22413 to the assembler.
22415 @item -mlong-jumps
22416 @itemx -mno-long-jumps
22417 @opindex mlong-jumps
22418 @opindex mno-long-jumps
22419 Disable (or re-enable) the generation of PC-relative jump instructions.
22421 @item -msoft-float
22422 @itemx -mhard-float
22423 @opindex msoft-float
22424 @opindex mhard-float
22425 Disable (or re-enable) the generation of hardware floating point
22426 instructions.  This option is only significant when the target
22427 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22428 instructions are being generated then the C preprocessor symbol
22429 @code{__FPU_OK__} will be defined, otherwise the symbol
22430 @code{__NO_FPU__} will be defined.
22432 @item -mloop
22433 @opindex mloop
22434 Enables the use of the e3v5 LOOP instruction.  The use of this
22435 instruction is not enabled by default when the e3v5 architecture is
22436 selected because its use is still experimental.
22438 @item -mrh850-abi
22439 @itemx -mghs
22440 @opindex mrh850-abi
22441 @opindex mghs
22442 Enables support for the RH850 version of the V850 ABI.  This is the
22443 default.  With this version of the ABI the following rules apply:
22445 @itemize
22446 @item
22447 Integer sized structures and unions are returned via a memory pointer
22448 rather than a register.
22450 @item
22451 Large structures and unions (more than 8 bytes in size) are passed by
22452 value.
22454 @item
22455 Functions are aligned to 16-bit boundaries.
22457 @item
22458 The @option{-m8byte-align} command line option is supported.
22460 @item
22461 The @option{-mdisable-callt} command line option is enabled by
22462 default.  The @option{-mno-disable-callt} command line option is not
22463 supported.
22464 @end itemize
22466 When this version of the ABI is enabled the C preprocessor symbol
22467 @code{__V850_RH850_ABI__} is defined.
22469 @item -mgcc-abi
22470 @opindex mgcc-abi
22471 Enables support for the old GCC version of the V850 ABI.  With this
22472 version of the ABI the following rules apply:
22474 @itemize
22475 @item
22476 Integer sized structures and unions are returned in register @code{r10}.
22478 @item
22479 Large structures and unions (more than 8 bytes in size) are passed by
22480 reference.
22482 @item
22483 Functions are aligned to 32-bit boundaries, unless optimizing for
22484 size.
22486 @item
22487 The @option{-m8byte-align} command line option is not supported.
22489 @item
22490 The @option{-mdisable-callt} command line option is supported but not
22491 enabled by default.
22492 @end itemize
22494 When this version of the ABI is enabled the C preprocessor symbol
22495 @code{__V850_GCC_ABI__} is defined.
22497 @item -m8byte-align
22498 @itemx -mno-8byte-align
22499 @opindex m8byte-align
22500 @opindex mno-8byte-align
22501 Enables support for @code{doubles} and @code{long long} types to be
22502 aligned on 8-byte boundaries.  The default is to restrict the
22503 alignment of all objects to at most 4-bytes.  When
22504 @option{-m8byte-align} is in effect the C preprocessor symbol
22505 @code{__V850_8BYTE_ALIGN__} will be defined.
22507 @item -mbig-switch
22508 @opindex mbig-switch
22509 Generate code suitable for big switch tables.  Use this option only if
22510 the assembler/linker complain about out of range branches within a switch
22511 table.
22513 @item -mapp-regs
22514 @opindex mapp-regs
22515 This option causes r2 and r5 to be used in the code generated by
22516 the compiler.  This setting is the default.
22518 @item -mno-app-regs
22519 @opindex mno-app-regs
22520 This option causes r2 and r5 to be treated as fixed registers.
22522 @end table
22524 @node VAX Options
22525 @subsection VAX Options
22526 @cindex VAX options
22528 These @samp{-m} options are defined for the VAX:
22530 @table @gcctabopt
22531 @item -munix
22532 @opindex munix
22533 Do not output certain jump instructions (@code{aobleq} and so on)
22534 that the Unix assembler for the VAX cannot handle across long
22535 ranges.
22537 @item -mgnu
22538 @opindex mgnu
22539 Do output those jump instructions, on the assumption that the
22540 GNU assembler is being used.
22542 @item -mg
22543 @opindex mg
22544 Output code for G-format floating-point numbers instead of D-format.
22545 @end table
22547 @node VMS Options
22548 @subsection VMS Options
22550 These @samp{-m} options are defined for the VMS implementations:
22552 @table @gcctabopt
22553 @item -mvms-return-codes
22554 @opindex mvms-return-codes
22555 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22556 condition (e.g.@ error) codes.
22558 @item -mdebug-main=@var{prefix}
22559 @opindex mdebug-main=@var{prefix}
22560 Flag the first routine whose name starts with @var{prefix} as the main
22561 routine for the debugger.
22563 @item -mmalloc64
22564 @opindex mmalloc64
22565 Default to 64-bit memory allocation routines.
22567 @item -mpointer-size=@var{size}
22568 @opindex -mpointer-size=@var{size}
22569 Set the default size of pointers. Possible options for @var{size} are
22570 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22571 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22572 The later option disables @code{pragma pointer_size}.
22573 @end table
22575 @node VxWorks Options
22576 @subsection VxWorks Options
22577 @cindex VxWorks Options
22579 The options in this section are defined for all VxWorks targets.
22580 Options specific to the target hardware are listed with the other
22581 options for that target.
22583 @table @gcctabopt
22584 @item -mrtp
22585 @opindex mrtp
22586 GCC can generate code for both VxWorks kernels and real time processes
22587 (RTPs).  This option switches from the former to the latter.  It also
22588 defines the preprocessor macro @code{__RTP__}.
22590 @item -non-static
22591 @opindex non-static
22592 Link an RTP executable against shared libraries rather than static
22593 libraries.  The options @option{-static} and @option{-shared} can
22594 also be used for RTPs (@pxref{Link Options}); @option{-static}
22595 is the default.
22597 @item -Bstatic
22598 @itemx -Bdynamic
22599 @opindex Bstatic
22600 @opindex Bdynamic
22601 These options are passed down to the linker.  They are defined for
22602 compatibility with Diab.
22604 @item -Xbind-lazy
22605 @opindex Xbind-lazy
22606 Enable lazy binding of function calls.  This option is equivalent to
22607 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22609 @item -Xbind-now
22610 @opindex Xbind-now
22611 Disable lazy binding of function calls.  This option is the default and
22612 is defined for compatibility with Diab.
22613 @end table
22615 @node x86-64 Options
22616 @subsection x86-64 Options
22617 @cindex x86-64 options
22619 These are listed under @xref{i386 and x86-64 Options}.
22621 @node Xstormy16 Options
22622 @subsection Xstormy16 Options
22623 @cindex Xstormy16 Options
22625 These options are defined for Xstormy16:
22627 @table @gcctabopt
22628 @item -msim
22629 @opindex msim
22630 Choose startup files and linker script suitable for the simulator.
22631 @end table
22633 @node Xtensa Options
22634 @subsection Xtensa Options
22635 @cindex Xtensa Options
22637 These options are supported for Xtensa targets:
22639 @table @gcctabopt
22640 @item -mconst16
22641 @itemx -mno-const16
22642 @opindex mconst16
22643 @opindex mno-const16
22644 Enable or disable use of @code{CONST16} instructions for loading
22645 constant values.  The @code{CONST16} instruction is currently not a
22646 standard option from Tensilica.  When enabled, @code{CONST16}
22647 instructions are always used in place of the standard @code{L32R}
22648 instructions.  The use of @code{CONST16} is enabled by default only if
22649 the @code{L32R} instruction is not available.
22651 @item -mfused-madd
22652 @itemx -mno-fused-madd
22653 @opindex mfused-madd
22654 @opindex mno-fused-madd
22655 Enable or disable use of fused multiply/add and multiply/subtract
22656 instructions in the floating-point option.  This has no effect if the
22657 floating-point option is not also enabled.  Disabling fused multiply/add
22658 and multiply/subtract instructions forces the compiler to use separate
22659 instructions for the multiply and add/subtract operations.  This may be
22660 desirable in some cases where strict IEEE 754-compliant results are
22661 required: the fused multiply add/subtract instructions do not round the
22662 intermediate result, thereby producing results with @emph{more} bits of
22663 precision than specified by the IEEE standard.  Disabling fused multiply
22664 add/subtract instructions also ensures that the program output is not
22665 sensitive to the compiler's ability to combine multiply and add/subtract
22666 operations.
22668 @item -mserialize-volatile
22669 @itemx -mno-serialize-volatile
22670 @opindex mserialize-volatile
22671 @opindex mno-serialize-volatile
22672 When this option is enabled, GCC inserts @code{MEMW} instructions before
22673 @code{volatile} memory references to guarantee sequential consistency.
22674 The default is @option{-mserialize-volatile}.  Use
22675 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22677 @item -mforce-no-pic
22678 @opindex mforce-no-pic
22679 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22680 position-independent code (PIC), this option disables PIC for compiling
22681 kernel code.
22683 @item -mtext-section-literals
22684 @itemx -mno-text-section-literals
22685 @opindex mtext-section-literals
22686 @opindex mno-text-section-literals
22687 Control the treatment of literal pools.  The default is
22688 @option{-mno-text-section-literals}, which places literals in a separate
22689 section in the output file.  This allows the literal pool to be placed
22690 in a data RAM/ROM, and it also allows the linker to combine literal
22691 pools from separate object files to remove redundant literals and
22692 improve code size.  With @option{-mtext-section-literals}, the literals
22693 are interspersed in the text section in order to keep them as close as
22694 possible to their references.  This may be necessary for large assembly
22695 files.
22697 @item -mtarget-align
22698 @itemx -mno-target-align
22699 @opindex mtarget-align
22700 @opindex mno-target-align
22701 When this option is enabled, GCC instructs the assembler to
22702 automatically align instructions to reduce branch penalties at the
22703 expense of some code density.  The assembler attempts to widen density
22704 instructions to align branch targets and the instructions following call
22705 instructions.  If there are not enough preceding safe density
22706 instructions to align a target, no widening is performed.  The
22707 default is @option{-mtarget-align}.  These options do not affect the
22708 treatment of auto-aligned instructions like @code{LOOP}, which the
22709 assembler always aligns, either by widening density instructions or
22710 by inserting NOP instructions.
22712 @item -mlongcalls
22713 @itemx -mno-longcalls
22714 @opindex mlongcalls
22715 @opindex mno-longcalls
22716 When this option is enabled, GCC instructs the assembler to translate
22717 direct calls to indirect calls unless it can determine that the target
22718 of a direct call is in the range allowed by the call instruction.  This
22719 translation typically occurs for calls to functions in other source
22720 files.  Specifically, the assembler translates a direct @code{CALL}
22721 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22722 The default is @option{-mno-longcalls}.  This option should be used in
22723 programs where the call target can potentially be out of range.  This
22724 option is implemented in the assembler, not the compiler, so the
22725 assembly code generated by GCC still shows direct call
22726 instructions---look at the disassembled object code to see the actual
22727 instructions.  Note that the assembler uses an indirect call for
22728 every cross-file call, not just those that really are out of range.
22729 @end table
22731 @node zSeries Options
22732 @subsection zSeries Options
22733 @cindex zSeries options
22735 These are listed under @xref{S/390 and zSeries Options}.
22737 @node Code Gen Options
22738 @section Options for Code Generation Conventions
22739 @cindex code generation conventions
22740 @cindex options, code generation
22741 @cindex run-time options
22743 These machine-independent options control the interface conventions
22744 used in code generation.
22746 Most of them have both positive and negative forms; the negative form
22747 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22748 one of the forms is listed---the one that is not the default.  You
22749 can figure out the other form by either removing @samp{no-} or adding
22752 @table @gcctabopt
22753 @item -fbounds-check
22754 @opindex fbounds-check
22755 For front ends that support it, generate additional code to check that
22756 indices used to access arrays are within the declared range.  This is
22757 currently only supported by the Java and Fortran front ends, where
22758 this option defaults to true and false respectively.
22760 @item -fstack-reuse=@var{reuse-level}
22761 @opindex fstack_reuse
22762 This option controls stack space reuse for user declared local/auto variables
22763 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22764 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22765 local variables and temporaries, @samp{named_vars} enables the reuse only for
22766 user defined local variables with names, and @samp{none} disables stack reuse
22767 completely. The default value is @samp{all}. The option is needed when the
22768 program extends the lifetime of a scoped local variable or a compiler generated
22769 temporary beyond the end point defined by the language.  When a lifetime of
22770 a variable ends, and if the variable lives in memory, the optimizing compiler
22771 has the freedom to reuse its stack space with other temporaries or scoped
22772 local variables whose live range does not overlap with it. Legacy code extending
22773 local lifetime will likely to break with the stack reuse optimization.
22775 For example,
22777 @smallexample
22778    int *p;
22779    @{
22780      int local1;
22782      p = &local1;
22783      local1 = 10;
22784      ....
22785    @}
22786    @{
22787       int local2;
22788       local2 = 20;
22789       ...
22790    @}
22792    if (*p == 10)  // out of scope use of local1
22793      @{
22795      @}
22796 @end smallexample
22798 Another example:
22799 @smallexample
22801    struct A
22802    @{
22803        A(int k) : i(k), j(k) @{ @}
22804        int i;
22805        int j;
22806    @};
22808    A *ap;
22810    void foo(const A& ar)
22811    @{
22812       ap = &ar;
22813    @}
22815    void bar()
22816    @{
22817       foo(A(10)); // temp object's lifetime ends when foo returns
22819       @{
22820         A a(20);
22821         ....
22822       @}
22823       ap->i+= 10;  // ap references out of scope temp whose space
22824                    // is reused with a. What is the value of ap->i?
22825    @}
22827 @end smallexample
22829 The lifetime of a compiler generated temporary is well defined by the C++
22830 standard. When a lifetime of a temporary ends, and if the temporary lives
22831 in memory, the optimizing compiler has the freedom to reuse its stack
22832 space with other temporaries or scoped local variables whose live range
22833 does not overlap with it. However some of the legacy code relies on
22834 the behavior of older compilers in which temporaries' stack space is
22835 not reused, the aggressive stack reuse can lead to runtime errors. This
22836 option is used to control the temporary stack reuse optimization.
22838 @item -ftrapv
22839 @opindex ftrapv
22840 This option generates traps for signed overflow on addition, subtraction,
22841 multiplication operations.
22843 @item -fwrapv
22844 @opindex fwrapv
22845 This option instructs the compiler to assume that signed arithmetic
22846 overflow of addition, subtraction and multiplication wraps around
22847 using twos-complement representation.  This flag enables some optimizations
22848 and disables others.  This option is enabled by default for the Java
22849 front end, as required by the Java language specification.
22851 @item -fexceptions
22852 @opindex fexceptions
22853 Enable exception handling.  Generates extra code needed to propagate
22854 exceptions.  For some targets, this implies GCC generates frame
22855 unwind information for all functions, which can produce significant data
22856 size overhead, although it does not affect execution.  If you do not
22857 specify this option, GCC enables it by default for languages like
22858 C++ that normally require exception handling, and disables it for
22859 languages like C that do not normally require it.  However, you may need
22860 to enable this option when compiling C code that needs to interoperate
22861 properly with exception handlers written in C++.  You may also wish to
22862 disable this option if you are compiling older C++ programs that don't
22863 use exception handling.
22865 @item -fnon-call-exceptions
22866 @opindex fnon-call-exceptions
22867 Generate code that allows trapping instructions to throw exceptions.
22868 Note that this requires platform-specific runtime support that does
22869 not exist everywhere.  Moreover, it only allows @emph{trapping}
22870 instructions to throw exceptions, i.e.@: memory references or floating-point
22871 instructions.  It does not allow exceptions to be thrown from
22872 arbitrary signal handlers such as @code{SIGALRM}.
22874 @item -fdelete-dead-exceptions
22875 @opindex fdelete-dead-exceptions
22876 Consider that instructions that may throw exceptions but don't otherwise
22877 contribute to the execution of the program can be optimized away.
22878 This option is enabled by default for the Ada front end, as permitted by
22879 the Ada language specification.
22880 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22882 @item -funwind-tables
22883 @opindex funwind-tables
22884 Similar to @option{-fexceptions}, except that it just generates any needed
22885 static data, but does not affect the generated code in any other way.
22886 You normally do not need to enable this option; instead, a language processor
22887 that needs this handling enables it on your behalf.
22889 @item -fasynchronous-unwind-tables
22890 @opindex fasynchronous-unwind-tables
22891 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22892 table is exact at each instruction boundary, so it can be used for stack
22893 unwinding from asynchronous events (such as debugger or garbage collector).
22895 @item -fno-gnu-unique
22896 @opindex fno-gnu-unique
22897 On systems with recent GNU assembler and C library, the C++ compiler
22898 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22899 of template static data members and static local variables in inline
22900 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22901 is necessary to avoid problems with a library used by two different
22902 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22903 therefore disagreeing with the other one about the binding of the
22904 symbol.  But this causes @code{dlclose} to be ignored for affected
22905 DSOs; if your program relies on reinitialization of a DSO via
22906 @code{dlclose} and @code{dlopen}, you can use
22907 @option{-fno-gnu-unique}.
22909 @item -fpcc-struct-return
22910 @opindex fpcc-struct-return
22911 Return ``short'' @code{struct} and @code{union} values in memory like
22912 longer ones, rather than in registers.  This convention is less
22913 efficient, but it has the advantage of allowing intercallability between
22914 GCC-compiled files and files compiled with other compilers, particularly
22915 the Portable C Compiler (pcc).
22917 The precise convention for returning structures in memory depends
22918 on the target configuration macros.
22920 Short structures and unions are those whose size and alignment match
22921 that of some integer type.
22923 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22924 switch is not binary compatible with code compiled with the
22925 @option{-freg-struct-return} switch.
22926 Use it to conform to a non-default application binary interface.
22928 @item -freg-struct-return
22929 @opindex freg-struct-return
22930 Return @code{struct} and @code{union} values in registers when possible.
22931 This is more efficient for small structures than
22932 @option{-fpcc-struct-return}.
22934 If you specify neither @option{-fpcc-struct-return} nor
22935 @option{-freg-struct-return}, GCC defaults to whichever convention is
22936 standard for the target.  If there is no standard convention, GCC
22937 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22938 the principal compiler.  In those cases, we can choose the standard, and
22939 we chose the more efficient register return alternative.
22941 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22942 switch is not binary compatible with code compiled with the
22943 @option{-fpcc-struct-return} switch.
22944 Use it to conform to a non-default application binary interface.
22946 @item -fshort-enums
22947 @opindex fshort-enums
22948 Allocate to an @code{enum} type only as many bytes as it needs for the
22949 declared range of possible values.  Specifically, the @code{enum} type
22950 is equivalent to the smallest integer type that has enough room.
22952 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22953 code that is not binary compatible with code generated without that switch.
22954 Use it to conform to a non-default application binary interface.
22956 @item -fshort-double
22957 @opindex fshort-double
22958 Use the same size for @code{double} as for @code{float}.
22960 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22961 code that is not binary compatible with code generated without that switch.
22962 Use it to conform to a non-default application binary interface.
22964 @item -fshort-wchar
22965 @opindex fshort-wchar
22966 Override the underlying type for @samp{wchar_t} to be @samp{short
22967 unsigned int} instead of the default for the target.  This option is
22968 useful for building programs to run under WINE@.
22970 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22971 code that is not binary compatible with code generated without that switch.
22972 Use it to conform to a non-default application binary interface.
22974 @item -fno-common
22975 @opindex fno-common
22976 In C code, controls the placement of uninitialized global variables.
22977 Unix C compilers have traditionally permitted multiple definitions of
22978 such variables in different compilation units by placing the variables
22979 in a common block.
22980 This is the behavior specified by @option{-fcommon}, and is the default
22981 for GCC on most targets.
22982 On the other hand, this behavior is not required by ISO C, and on some
22983 targets may carry a speed or code size penalty on variable references.
22984 The @option{-fno-common} option specifies that the compiler should place
22985 uninitialized global variables in the data section of the object file,
22986 rather than generating them as common blocks.
22987 This has the effect that if the same variable is declared
22988 (without @code{extern}) in two different compilations,
22989 you get a multiple-definition error when you link them.
22990 In this case, you must compile with @option{-fcommon} instead.
22991 Compiling with @option{-fno-common} is useful on targets for which
22992 it provides better performance, or if you wish to verify that the
22993 program will work on other systems that always treat uninitialized
22994 variable declarations this way.
22996 @item -fno-ident
22997 @opindex fno-ident
22998 Ignore the @samp{#ident} directive.
23000 @item -finhibit-size-directive
23001 @opindex finhibit-size-directive
23002 Don't output a @code{.size} assembler directive, or anything else that
23003 would cause trouble if the function is split in the middle, and the
23004 two halves are placed at locations far apart in memory.  This option is
23005 used when compiling @file{crtstuff.c}; you should not need to use it
23006 for anything else.
23008 @item -fverbose-asm
23009 @opindex fverbose-asm
23010 Put extra commentary information in the generated assembly code to
23011 make it more readable.  This option is generally only of use to those
23012 who actually need to read the generated assembly code (perhaps while
23013 debugging the compiler itself).
23015 @option{-fno-verbose-asm}, the default, causes the
23016 extra information to be omitted and is useful when comparing two assembler
23017 files.
23019 @item -frecord-gcc-switches
23020 @opindex frecord-gcc-switches
23021 This switch causes the command line used to invoke the
23022 compiler to be recorded into the object file that is being created.
23023 This switch is only implemented on some targets and the exact format
23024 of the recording is target and binary file format dependent, but it
23025 usually takes the form of a section containing ASCII text.  This
23026 switch is related to the @option{-fverbose-asm} switch, but that
23027 switch only records information in the assembler output file as
23028 comments, so it never reaches the object file.
23029 See also @option{-grecord-gcc-switches} for another
23030 way of storing compiler options into the object file.
23032 @item -fpic
23033 @opindex fpic
23034 @cindex global offset table
23035 @cindex PIC
23036 Generate position-independent code (PIC) suitable for use in a shared
23037 library, if supported for the target machine.  Such code accesses all
23038 constant addresses through a global offset table (GOT)@.  The dynamic
23039 loader resolves the GOT entries when the program starts (the dynamic
23040 loader is not part of GCC; it is part of the operating system).  If
23041 the GOT size for the linked executable exceeds a machine-specific
23042 maximum size, you get an error message from the linker indicating that
23043 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23044 instead.  (These maximums are 8k on the SPARC and 32k
23045 on the m68k and RS/6000.  The 386 has no such limit.)
23047 Position-independent code requires special support, and therefore works
23048 only on certain machines.  For the 386, GCC supports PIC for System V
23049 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23050 position-independent.
23052 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23053 are defined to 1.
23055 @item -fPIC
23056 @opindex fPIC
23057 If supported for the target machine, emit position-independent code,
23058 suitable for dynamic linking and avoiding any limit on the size of the
23059 global offset table.  This option makes a difference on the m68k,
23060 PowerPC and SPARC@.
23062 Position-independent code requires special support, and therefore works
23063 only on certain machines.
23065 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23066 are defined to 2.
23068 @item -fpie
23069 @itemx -fPIE
23070 @opindex fpie
23071 @opindex fPIE
23072 These options are similar to @option{-fpic} and @option{-fPIC}, but
23073 generated position independent code can be only linked into executables.
23074 Usually these options are used when @option{-pie} GCC option is
23075 used during linking.
23077 @option{-fpie} and @option{-fPIE} both define the macros
23078 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23079 for @option{-fpie} and 2 for @option{-fPIE}.
23081 @item -fno-jump-tables
23082 @opindex fno-jump-tables
23083 Do not use jump tables for switch statements even where it would be
23084 more efficient than other code generation strategies.  This option is
23085 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23086 building code that forms part of a dynamic linker and cannot
23087 reference the address of a jump table.  On some targets, jump tables
23088 do not require a GOT and this option is not needed.
23090 @item -ffixed-@var{reg}
23091 @opindex ffixed
23092 Treat the register named @var{reg} as a fixed register; generated code
23093 should never refer to it (except perhaps as a stack pointer, frame
23094 pointer or in some other fixed role).
23096 @var{reg} must be the name of a register.  The register names accepted
23097 are machine-specific and are defined in the @code{REGISTER_NAMES}
23098 macro in the machine description macro file.
23100 This flag does not have a negative form, because it specifies a
23101 three-way choice.
23103 @item -fcall-used-@var{reg}
23104 @opindex fcall-used
23105 Treat the register named @var{reg} as an allocable register that is
23106 clobbered by function calls.  It may be allocated for temporaries or
23107 variables that do not live across a call.  Functions compiled this way
23108 do not save and restore the register @var{reg}.
23110 It is an error to use this flag with the frame pointer or stack pointer.
23111 Use of this flag for other registers that have fixed pervasive roles in
23112 the machine's execution model produces disastrous results.
23114 This flag does not have a negative form, because it specifies a
23115 three-way choice.
23117 @item -fcall-saved-@var{reg}
23118 @opindex fcall-saved
23119 Treat the register named @var{reg} as an allocable register saved by
23120 functions.  It may be allocated even for temporaries or variables that
23121 live across a call.  Functions compiled this way save and restore
23122 the register @var{reg} if they use it.
23124 It is an error to use this flag with the frame pointer or stack pointer.
23125 Use of this flag for other registers that have fixed pervasive roles in
23126 the machine's execution model produces disastrous results.
23128 A different sort of disaster results from the use of this flag for
23129 a register in which function values may be returned.
23131 This flag does not have a negative form, because it specifies a
23132 three-way choice.
23134 @item -fpack-struct[=@var{n}]
23135 @opindex fpack-struct
23136 Without a value specified, pack all structure members together without
23137 holes.  When a value is specified (which must be a small power of two), pack
23138 structure members according to this value, representing the maximum
23139 alignment (that is, objects with default alignment requirements larger than
23140 this are output potentially unaligned at the next fitting location.
23142 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23143 code that is not binary compatible with code generated without that switch.
23144 Additionally, it makes the code suboptimal.
23145 Use it to conform to a non-default application binary interface.
23147 @item -finstrument-functions
23148 @opindex finstrument-functions
23149 Generate instrumentation calls for entry and exit to functions.  Just
23150 after function entry and just before function exit, the following
23151 profiling functions are called with the address of the current
23152 function and its call site.  (On some platforms,
23153 @code{__builtin_return_address} does not work beyond the current
23154 function, so the call site information may not be available to the
23155 profiling functions otherwise.)
23157 @smallexample
23158 void __cyg_profile_func_enter (void *this_fn,
23159                                void *call_site);
23160 void __cyg_profile_func_exit  (void *this_fn,
23161                                void *call_site);
23162 @end smallexample
23164 The first argument is the address of the start of the current function,
23165 which may be looked up exactly in the symbol table.
23167 This instrumentation is also done for functions expanded inline in other
23168 functions.  The profiling calls indicate where, conceptually, the
23169 inline function is entered and exited.  This means that addressable
23170 versions of such functions must be available.  If all your uses of a
23171 function are expanded inline, this may mean an additional expansion of
23172 code size.  If you use @samp{extern inline} in your C code, an
23173 addressable version of such functions must be provided.  (This is
23174 normally the case anyway, but if you get lucky and the optimizer always
23175 expands the functions inline, you might have gotten away without
23176 providing static copies.)
23178 A function may be given the attribute @code{no_instrument_function}, in
23179 which case this instrumentation is not done.  This can be used, for
23180 example, for the profiling functions listed above, high-priority
23181 interrupt routines, and any functions from which the profiling functions
23182 cannot safely be called (perhaps signal handlers, if the profiling
23183 routines generate output or allocate memory).
23185 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23186 @opindex finstrument-functions-exclude-file-list
23188 Set the list of functions that are excluded from instrumentation (see
23189 the description of @code{-finstrument-functions}).  If the file that
23190 contains a function definition matches with one of @var{file}, then
23191 that function is not instrumented.  The match is done on substrings:
23192 if the @var{file} parameter is a substring of the file name, it is
23193 considered to be a match.
23195 For example:
23197 @smallexample
23198 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23199 @end smallexample
23201 @noindent
23202 excludes any inline function defined in files whose pathnames
23203 contain @code{/bits/stl} or @code{include/sys}.
23205 If, for some reason, you want to include letter @code{','} in one of
23206 @var{sym}, write @code{'\,'}. For example,
23207 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
23208 (note the single quote surrounding the option).
23210 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23211 @opindex finstrument-functions-exclude-function-list
23213 This is similar to @code{-finstrument-functions-exclude-file-list},
23214 but this option sets the list of function names to be excluded from
23215 instrumentation.  The function name to be matched is its user-visible
23216 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23217 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23218 match is done on substrings: if the @var{sym} parameter is a substring
23219 of the function name, it is considered to be a match.  For C99 and C++
23220 extended identifiers, the function name must be given in UTF-8, not
23221 using universal character names.
23223 @item -fstack-check
23224 @opindex fstack-check
23225 Generate code to verify that you do not go beyond the boundary of the
23226 stack.  You should specify this flag if you are running in an
23227 environment with multiple threads, but you only rarely need to specify it in
23228 a single-threaded environment since stack overflow is automatically
23229 detected on nearly all systems if there is only one stack.
23231 Note that this switch does not actually cause checking to be done; the
23232 operating system or the language runtime must do that.  The switch causes
23233 generation of code to ensure that they see the stack being extended.
23235 You can additionally specify a string parameter: @code{no} means no
23236 checking, @code{generic} means force the use of old-style checking,
23237 @code{specific} means use the best checking method and is equivalent
23238 to bare @option{-fstack-check}.
23240 Old-style checking is a generic mechanism that requires no specific
23241 target support in the compiler but comes with the following drawbacks:
23243 @enumerate
23244 @item
23245 Modified allocation strategy for large objects: they are always
23246 allocated dynamically if their size exceeds a fixed threshold.
23248 @item
23249 Fixed limit on the size of the static frame of functions: when it is
23250 topped by a particular function, stack checking is not reliable and
23251 a warning is issued by the compiler.
23253 @item
23254 Inefficiency: because of both the modified allocation strategy and the
23255 generic implementation, code performance is hampered.
23256 @end enumerate
23258 Note that old-style stack checking is also the fallback method for
23259 @code{specific} if no target support has been added in the compiler.
23261 @item -fstack-limit-register=@var{reg}
23262 @itemx -fstack-limit-symbol=@var{sym}
23263 @itemx -fno-stack-limit
23264 @opindex fstack-limit-register
23265 @opindex fstack-limit-symbol
23266 @opindex fno-stack-limit
23267 Generate code to ensure that the stack does not grow beyond a certain value,
23268 either the value of a register or the address of a symbol.  If a larger
23269 stack is required, a signal is raised at run time.  For most targets,
23270 the signal is raised before the stack overruns the boundary, so
23271 it is possible to catch the signal without taking special precautions.
23273 For instance, if the stack starts at absolute address @samp{0x80000000}
23274 and grows downwards, you can use the flags
23275 @option{-fstack-limit-symbol=__stack_limit} and
23276 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23277 of 128KB@.  Note that this may only work with the GNU linker.
23279 @item -fsplit-stack
23280 @opindex fsplit-stack
23281 Generate code to automatically split the stack before it overflows.
23282 The resulting program has a discontiguous stack which can only
23283 overflow if the program is unable to allocate any more memory.  This
23284 is most useful when running threaded programs, as it is no longer
23285 necessary to calculate a good stack size to use for each thread.  This
23286 is currently only implemented for the i386 and x86_64 back ends running
23287 GNU/Linux.
23289 When code compiled with @option{-fsplit-stack} calls code compiled
23290 without @option{-fsplit-stack}, there may not be much stack space
23291 available for the latter code to run.  If compiling all code,
23292 including library code, with @option{-fsplit-stack} is not an option,
23293 then the linker can fix up these calls so that the code compiled
23294 without @option{-fsplit-stack} always has a large stack.  Support for
23295 this is implemented in the gold linker in GNU binutils release 2.21
23296 and later.
23298 @item -fleading-underscore
23299 @opindex fleading-underscore
23300 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23301 change the way C symbols are represented in the object file.  One use
23302 is to help link with legacy assembly code.
23304 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23305 generate code that is not binary compatible with code generated without that
23306 switch.  Use it to conform to a non-default application binary interface.
23307 Not all targets provide complete support for this switch.
23309 @item -ftls-model=@var{model}
23310 @opindex ftls-model
23311 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23312 The @var{model} argument should be one of @code{global-dynamic},
23313 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
23314 Note that the choice is subject to optimization: the compiler may use
23315 a more efficient model for symbols not visible outside of the translation
23316 unit, or if @option{-fpic} is not given on the command line.
23318 The default without @option{-fpic} is @code{initial-exec}; with
23319 @option{-fpic} the default is @code{global-dynamic}.
23321 @item -fvisibility=@var{default|internal|hidden|protected}
23322 @opindex fvisibility
23323 Set the default ELF image symbol visibility to the specified option---all
23324 symbols are marked with this unless overridden within the code.
23325 Using this feature can very substantially improve linking and
23326 load times of shared object libraries, produce more optimized
23327 code, provide near-perfect API export and prevent symbol clashes.
23328 It is @strong{strongly} recommended that you use this in any shared objects
23329 you distribute.
23331 Despite the nomenclature, @code{default} always means public; i.e.,
23332 available to be linked against from outside the shared object.
23333 @code{protected} and @code{internal} are pretty useless in real-world
23334 usage so the only other commonly used option is @code{hidden}.
23335 The default if @option{-fvisibility} isn't specified is
23336 @code{default}, i.e., make every
23337 symbol public---this causes the same behavior as previous versions of
23338 GCC@.
23340 A good explanation of the benefits offered by ensuring ELF
23341 symbols have the correct visibility is given by ``How To Write
23342 Shared Libraries'' by Ulrich Drepper (which can be found at
23343 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23344 solution made possible by this option to marking things hidden when
23345 the default is public is to make the default hidden and mark things
23346 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23347 and @code{__attribute__ ((visibility("default")))} instead of
23348 @code{__declspec(dllexport)} you get almost identical semantics with
23349 identical syntax.  This is a great boon to those working with
23350 cross-platform projects.
23352 For those adding visibility support to existing code, you may find
23353 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23354 the declarations you wish to set visibility for with (for example)
23355 @samp{#pragma GCC visibility push(hidden)} and
23356 @samp{#pragma GCC visibility pop}.
23357 Bear in mind that symbol visibility should be viewed @strong{as
23358 part of the API interface contract} and thus all new code should
23359 always specify visibility when it is not the default; i.e., declarations
23360 only for use within the local DSO should @strong{always} be marked explicitly
23361 as hidden as so to avoid PLT indirection overheads---making this
23362 abundantly clear also aids readability and self-documentation of the code.
23363 Note that due to ISO C++ specification requirements, @code{operator new} and
23364 @code{operator delete} must always be of default visibility.
23366 Be aware that headers from outside your project, in particular system
23367 headers and headers from any other library you use, may not be
23368 expecting to be compiled with visibility other than the default.  You
23369 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23370 before including any such headers.
23372 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23373 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23374 no modifications.  However, this means that calls to @code{extern}
23375 functions with no explicit visibility use the PLT, so it is more
23376 effective to use @code{__attribute ((visibility))} and/or
23377 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23378 declarations should be treated as hidden.
23380 Note that @option{-fvisibility} does affect C++ vague linkage
23381 entities. This means that, for instance, an exception class that is
23382 be thrown between DSOs must be explicitly marked with default
23383 visibility so that the @samp{type_info} nodes are unified between
23384 the DSOs.
23386 An overview of these techniques, their benefits and how to use them
23387 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23389 @item -fstrict-volatile-bitfields
23390 @opindex fstrict-volatile-bitfields
23391 This option should be used if accesses to volatile bit-fields (or other
23392 structure fields, although the compiler usually honors those types
23393 anyway) should use a single access of the width of the
23394 field's type, aligned to a natural alignment if possible.  For
23395 example, targets with memory-mapped peripheral registers might require
23396 all such accesses to be 16 bits wide; with this flag you can
23397 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23398 is 16 bits on these targets) to force GCC to use 16-bit accesses
23399 instead of, perhaps, a more efficient 32-bit access.
23401 If this option is disabled, the compiler uses the most efficient
23402 instruction.  In the previous example, that might be a 32-bit load
23403 instruction, even though that accesses bytes that do not contain
23404 any portion of the bit-field, or memory-mapped registers unrelated to
23405 the one being updated.
23407 In some cases, such as when the @code{packed} attribute is applied to a 
23408 structure field, it may not be possible to access the field with a single
23409 read or write that is correctly aligned for the target machine.  In this
23410 case GCC falls back to generating multiple accesses rather than code that 
23411 will fault or truncate the result at run time.
23413 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23414 not allowed to touch non bit-field members.  It is therefore recommended
23415 to define all bits of the field's type as bit-field members.
23417 The default value of this option is determined by the application binary
23418 interface for the target processor.
23420 @item -fsync-libcalls
23421 @opindex fsync-libcalls
23422 This option controls whether any out-of-line instance of the @code{__sync}
23423 family of functions may be used to implement the C++11 @code{__atomic}
23424 family of functions.
23426 The default value of this option is enabled, thus the only useful form
23427 of the option is @option{-fno-sync-libcalls}.  This option is used in
23428 the implementation of the @file{libatomic} runtime library.
23430 @end table
23432 @c man end
23434 @node Environment Variables
23435 @section Environment Variables Affecting GCC
23436 @cindex environment variables
23438 @c man begin ENVIRONMENT
23439 This section describes several environment variables that affect how GCC
23440 operates.  Some of them work by specifying directories or prefixes to use
23441 when searching for various kinds of files.  Some are used to specify other
23442 aspects of the compilation environment.
23444 Note that you can also specify places to search using options such as
23445 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23446 take precedence over places specified using environment variables, which
23447 in turn take precedence over those specified by the configuration of GCC@.
23448 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23449 GNU Compiler Collection (GCC) Internals}.
23451 @table @env
23452 @item LANG
23453 @itemx LC_CTYPE
23454 @c @itemx LC_COLLATE
23455 @itemx LC_MESSAGES
23456 @c @itemx LC_MONETARY
23457 @c @itemx LC_NUMERIC
23458 @c @itemx LC_TIME
23459 @itemx LC_ALL
23460 @findex LANG
23461 @findex LC_CTYPE
23462 @c @findex LC_COLLATE
23463 @findex LC_MESSAGES
23464 @c @findex LC_MONETARY
23465 @c @findex LC_NUMERIC
23466 @c @findex LC_TIME
23467 @findex LC_ALL
23468 @cindex locale
23469 These environment variables control the way that GCC uses
23470 localization information which allows GCC to work with different
23471 national conventions.  GCC inspects the locale categories
23472 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23473 so.  These locale categories can be set to any value supported by your
23474 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23475 Kingdom encoded in UTF-8.
23477 The @env{LC_CTYPE} environment variable specifies character
23478 classification.  GCC uses it to determine the character boundaries in
23479 a string; this is needed for some multibyte encodings that contain quote
23480 and escape characters that are otherwise interpreted as a string
23481 end or escape.
23483 The @env{LC_MESSAGES} environment variable specifies the language to
23484 use in diagnostic messages.
23486 If the @env{LC_ALL} environment variable is set, it overrides the value
23487 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23488 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23489 environment variable.  If none of these variables are set, GCC
23490 defaults to traditional C English behavior.
23492 @item TMPDIR
23493 @findex TMPDIR
23494 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23495 files.  GCC uses temporary files to hold the output of one stage of
23496 compilation which is to be used as input to the next stage: for example,
23497 the output of the preprocessor, which is the input to the compiler
23498 proper.
23500 @item GCC_COMPARE_DEBUG
23501 @findex GCC_COMPARE_DEBUG
23502 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23503 @option{-fcompare-debug} to the compiler driver.  See the documentation
23504 of this option for more details.
23506 @item GCC_EXEC_PREFIX
23507 @findex GCC_EXEC_PREFIX
23508 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23509 names of the subprograms executed by the compiler.  No slash is added
23510 when this prefix is combined with the name of a subprogram, but you can
23511 specify a prefix that ends with a slash if you wish.
23513 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23514 an appropriate prefix to use based on the pathname it is invoked with.
23516 If GCC cannot find the subprogram using the specified prefix, it
23517 tries looking in the usual places for the subprogram.
23519 The default value of @env{GCC_EXEC_PREFIX} is
23520 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23521 the installed compiler. In many cases @var{prefix} is the value
23522 of @code{prefix} when you ran the @file{configure} script.
23524 Other prefixes specified with @option{-B} take precedence over this prefix.
23526 This prefix is also used for finding files such as @file{crt0.o} that are
23527 used for linking.
23529 In addition, the prefix is used in an unusual way in finding the
23530 directories to search for header files.  For each of the standard
23531 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23532 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23533 replacing that beginning with the specified prefix to produce an
23534 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23535 @file{foo/bar} just before it searches the standard directory 
23536 @file{/usr/local/lib/bar}.
23537 If a standard directory begins with the configured
23538 @var{prefix} then the value of @var{prefix} is replaced by
23539 @env{GCC_EXEC_PREFIX} when looking for header files.
23541 @item COMPILER_PATH
23542 @findex COMPILER_PATH
23543 The value of @env{COMPILER_PATH} is a colon-separated list of
23544 directories, much like @env{PATH}.  GCC tries the directories thus
23545 specified when searching for subprograms, if it can't find the
23546 subprograms using @env{GCC_EXEC_PREFIX}.
23548 @item LIBRARY_PATH
23549 @findex LIBRARY_PATH
23550 The value of @env{LIBRARY_PATH} is a colon-separated list of
23551 directories, much like @env{PATH}.  When configured as a native compiler,
23552 GCC tries the directories thus specified when searching for special
23553 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23554 using GCC also uses these directories when searching for ordinary
23555 libraries for the @option{-l} option (but directories specified with
23556 @option{-L} come first).
23558 @item LANG
23559 @findex LANG
23560 @cindex locale definition
23561 This variable is used to pass locale information to the compiler.  One way in
23562 which this information is used is to determine the character set to be used
23563 when character literals, string literals and comments are parsed in C and C++.
23564 When the compiler is configured to allow multibyte characters,
23565 the following values for @env{LANG} are recognized:
23567 @table @samp
23568 @item C-JIS
23569 Recognize JIS characters.
23570 @item C-SJIS
23571 Recognize SJIS characters.
23572 @item C-EUCJP
23573 Recognize EUCJP characters.
23574 @end table
23576 If @env{LANG} is not defined, or if it has some other value, then the
23577 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23578 recognize and translate multibyte characters.
23579 @end table
23581 @noindent
23582 Some additional environment variables affect the behavior of the
23583 preprocessor.
23585 @include cppenv.texi
23587 @c man end
23589 @node Precompiled Headers
23590 @section Using Precompiled Headers
23591 @cindex precompiled headers
23592 @cindex speed of compilation
23594 Often large projects have many header files that are included in every
23595 source file.  The time the compiler takes to process these header files
23596 over and over again can account for nearly all of the time required to
23597 build the project.  To make builds faster, GCC allows you to
23598 @dfn{precompile} a header file.
23600 To create a precompiled header file, simply compile it as you would any
23601 other file, if necessary using the @option{-x} option to make the driver
23602 treat it as a C or C++ header file.  You may want to use a
23603 tool like @command{make} to keep the precompiled header up-to-date when
23604 the headers it contains change.
23606 A precompiled header file is searched for when @code{#include} is
23607 seen in the compilation.  As it searches for the included file
23608 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23609 compiler looks for a precompiled header in each directory just before it
23610 looks for the include file in that directory.  The name searched for is
23611 the name specified in the @code{#include} with @samp{.gch} appended.  If
23612 the precompiled header file can't be used, it is ignored.
23614 For instance, if you have @code{#include "all.h"}, and you have
23615 @file{all.h.gch} in the same directory as @file{all.h}, then the
23616 precompiled header file is used if possible, and the original
23617 header is used otherwise.
23619 Alternatively, you might decide to put the precompiled header file in a
23620 directory and use @option{-I} to ensure that directory is searched
23621 before (or instead of) the directory containing the original header.
23622 Then, if you want to check that the precompiled header file is always
23623 used, you can put a file of the same name as the original header in this
23624 directory containing an @code{#error} command.
23626 This also works with @option{-include}.  So yet another way to use
23627 precompiled headers, good for projects not designed with precompiled
23628 header files in mind, is to simply take most of the header files used by
23629 a project, include them from another header file, precompile that header
23630 file, and @option{-include} the precompiled header.  If the header files
23631 have guards against multiple inclusion, they are skipped because
23632 they've already been included (in the precompiled header).
23634 If you need to precompile the same header file for different
23635 languages, targets, or compiler options, you can instead make a
23636 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23637 header in the directory, perhaps using @option{-o}.  It doesn't matter
23638 what you call the files in the directory; every precompiled header in
23639 the directory is considered.  The first precompiled header
23640 encountered in the directory that is valid for this compilation is
23641 used; they're searched in no particular order.
23643 There are many other possibilities, limited only by your imagination,
23644 good sense, and the constraints of your build system.
23646 A precompiled header file can be used only when these conditions apply:
23648 @itemize
23649 @item
23650 Only one precompiled header can be used in a particular compilation.
23652 @item
23653 A precompiled header can't be used once the first C token is seen.  You
23654 can have preprocessor directives before a precompiled header; you cannot
23655 include a precompiled header from inside another header.
23657 @item
23658 The precompiled header file must be produced for the same language as
23659 the current compilation.  You can't use a C precompiled header for a C++
23660 compilation.
23662 @item
23663 The precompiled header file must have been produced by the same compiler
23664 binary as the current compilation is using.
23666 @item
23667 Any macros defined before the precompiled header is included must
23668 either be defined in the same way as when the precompiled header was
23669 generated, or must not affect the precompiled header, which usually
23670 means that they don't appear in the precompiled header at all.
23672 The @option{-D} option is one way to define a macro before a
23673 precompiled header is included; using a @code{#define} can also do it.
23674 There are also some options that define macros implicitly, like
23675 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23676 defined this way.
23678 @item If debugging information is output when using the precompiled
23679 header, using @option{-g} or similar, the same kind of debugging information
23680 must have been output when building the precompiled header.  However,
23681 a precompiled header built using @option{-g} can be used in a compilation
23682 when no debugging information is being output.
23684 @item The same @option{-m} options must generally be used when building
23685 and using the precompiled header.  @xref{Submodel Options},
23686 for any cases where this rule is relaxed.
23688 @item Each of the following options must be the same when building and using
23689 the precompiled header:
23691 @gccoptlist{-fexceptions}
23693 @item
23694 Some other command-line options starting with @option{-f},
23695 @option{-p}, or @option{-O} must be defined in the same way as when
23696 the precompiled header was generated.  At present, it's not clear
23697 which options are safe to change and which are not; the safest choice
23698 is to use exactly the same options when generating and using the
23699 precompiled header.  The following are known to be safe:
23701 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23702 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23703 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23704 -pedantic-errors}
23706 @end itemize
23708 For all of these except the last, the compiler automatically
23709 ignores the precompiled header if the conditions aren't met.  If you
23710 find an option combination that doesn't work and doesn't cause the
23711 precompiled header to be ignored, please consider filing a bug report,
23712 see @ref{Bugs}.
23714 If you do use differing options when generating and using the
23715 precompiled header, the actual behavior is a mixture of the
23716 behavior for the options.  For instance, if you use @option{-g} to
23717 generate the precompiled header but not when using it, you may or may
23718 not get debugging information for routines in the precompiled header.