MIPS32R6 and MIPS64R6 support
[official-gcc.git] / gcc / doc / invoke.texi
blobe37c777e89562b54a4b64d4c78111a75ee6f3660
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 -Wno-discarded-qualifiers @gol
252 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
253 -Wno-endif-labels -Werror  -Werror=* @gol
254 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
255 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
256 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
257 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
258 -Wignored-qualifiers  -Wincompatible-pointer-types @gol
259 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
260 -Winit-self  -Winline  -Wno-int-conversion @gol
261 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
262 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
263 -Wlogical-op -Wlogical-not-parentheses -Wlong-long @gol
264 -Wmain -Wmaybe-uninitialized -Wmemset-transposed-args -Wmissing-braces @gol
265 -Wmissing-field-initializers -Wmissing-include-dirs @gol
266 -Wno-multichar  -Wnonnull  -Wnormalized=@r{[}none@r{|}id@r{|}nfc@r{|}nfkc@r{]} @gol
267  -Wodr  -Wno-overflow  -Wopenmp-simd @gol
268 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
269 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
270 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
271 -Wredundant-decls  -Wno-return-local-addr @gol
272 -Wreturn-type  -Wsequence-point  -Wshadow  -Wno-shadow-ivar @gol
273 -Wshift-count-negative -Wshift-count-overflow @gol
274 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
275 -Wsizeof-pointer-memaccess  -Wsizeof-array-argument @gol
276 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
277 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
278 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
279 -Wsuggest-final-types @gol -Wsuggest-final-methods @gol
280 -Wmissing-format-attribute @gol
281 -Wswitch  -Wswitch-default  -Wswitch-enum -Wswitch-bool -Wsync-nand @gol
282 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
283 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
284 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
285 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
286 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
287 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
288 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
289 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
291 @item C and Objective-C-only Warning Options
292 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
293 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
294 -Wold-style-declaration  -Wold-style-definition @gol
295 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
296 -Wdeclaration-after-statement -Wpointer-sign}
298 @item Debugging Options
299 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
300 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
301 -fsanitize=@var{style} -fsanitize-recover -fsanitize-recover=@var{style} @gol
302 -fasan-shadow-offset=@var{number} -fsanitize-undefined-trap-on-error @gol
303 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
304 -fdisable-ipa-@var{pass_name} @gol
305 -fdisable-rtl-@var{pass_name} @gol
306 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
307 -fdisable-tree-@var{pass_name} @gol
308 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
309 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
310 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
311 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
312 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
313 -fdump-passes @gol
314 -fdump-statistics @gol
315 -fdump-tree-all @gol
316 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
317 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-cfg -fdump-tree-alias @gol
319 -fdump-tree-ch @gol
320 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
321 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-gimple@r{[}-raw@r{]} @gol
323 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
324 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
325 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
327 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
328 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
329 -fdump-tree-nrv -fdump-tree-vect @gol
330 -fdump-tree-sink @gol
331 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
332 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
333 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
334 -fdump-tree-vtable-verify @gol
335 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
336 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
337 -fdump-final-insns=@var{file} @gol
338 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
339 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
340 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
341 -fenable-@var{kind}-@var{pass} @gol
342 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
343 -fdebug-types-section -fmem-report-wpa @gol
344 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
345 -fopt-info @gol
346 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
347 -frandom-seed=@var{number} -fsched-verbose=@var{n} @gol
348 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
349 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
350 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
351 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
352 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
353 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
354 -gvms  -gxcoff  -gxcoff+ -gz@r{[}=@var{type}@r{]} @gol
355 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
356 -fdebug-prefix-map=@var{old}=@var{new} @gol
357 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
358 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
359 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
360 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
361 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
362 -print-sysroot -print-sysroot-headers-suffix @gol
363 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
365 @item Optimization Options
366 @xref{Optimize Options,,Options that Control Optimization}.
367 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
368 -falign-jumps[=@var{n}] @gol
369 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
370 -fassociative-math -fauto-profile -fauto-profile[=@var{path}] @gol
371 -fauto-inc-dec -fbranch-probabilities @gol
372 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
373 -fbtr-bb-exclusive -fcaller-saves @gol
374 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
375 -fcompare-elim -fcprop-registers -fcrossjumping @gol
376 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
377 -fcx-limited-range @gol
378 -fdata-sections -fdce -fdelayed-branch @gol
379 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively @gol
380 -devirtualize-at-ltrans -fdse @gol
381 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
382 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
383 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
384 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
385 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
386 -fif-conversion2 -findirect-inlining @gol
387 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
388 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
389 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference -fipa-icf @gol
390 -fira-algorithm=@var{algorithm} @gol
391 -fira-region=@var{region} -fira-hoist-pressure @gol
392 -fira-loop-pressure -fno-ira-share-save-slots @gol
393 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
394 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute @gol
395 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
396 -floop-block -floop-interchange -floop-strip-mine @gol  
397 -floop-unroll-and-jam -floop-nest-optimize @gol
398 -floop-parallelize-all -flra-remat -flto -flto-compression-level @gol
399 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
400 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
401 -fmove-loop-invariants -fno-branch-count-reg @gol
402 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
403 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
404 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
405 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
406 -fomit-frame-pointer -foptimize-sibling-calls @gol
407 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
408 -fprefetch-loop-arrays -fprofile-report @gol
409 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
410 -fprofile-generate=@var{path} @gol
411 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
412 -freciprocal-math -free -frename-registers -fschedule-fusion -freorder-blocks @gol
413 -freorder-blocks-and-partition -freorder-functions @gol
414 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
415 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
416 -fsched-spec-load -fsched-spec-load-dangerous @gol
417 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
418 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
419 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
420 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
421 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
422 -fselective-scheduling -fselective-scheduling2 @gol
423 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
424 -fsemantic-interposition @gol
425 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
426 -fsplit-ivs-in-unroller -fsplit-wide-types -fssa-phiopt -fstack-protector @gol
427 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
428 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
429 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
430 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
431 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
432 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
433 -ftree-loop-if-convert-stores -ftree-loop-im @gol
434 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
435 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
436 -ftree-loop-vectorize @gol
437 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
438 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
439 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
440 -ftree-vectorize -ftree-vrp @gol
441 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
442 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
443 -fipa-ra -fvariable-expansion-in-unroller -fvect-cost-model -fvpt @gol
444 -fweb -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
445 --param @var{name}=@var{value}
446 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
448 @item Preprocessor Options
449 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
450 @gccoptlist{-A@var{question}=@var{answer} @gol
451 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
452 -C  -dD  -dI  -dM  -dN @gol
453 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
454 -idirafter @var{dir} @gol
455 -include @var{file}  -imacros @var{file} @gol
456 -iprefix @var{file}  -iwithprefix @var{dir} @gol
457 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
458 -imultilib @var{dir} -isysroot @var{dir} @gol
459 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
460 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
461 -remap -trigraphs  -undef  -U@var{macro}  @gol
462 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
464 @item Assembler Option
465 @xref{Assembler Options,,Passing Options to the Assembler}.
466 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
468 @item Linker Options
469 @xref{Link Options,,Options for Linking}.
470 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
471 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
472 -s  -static -static-libgcc -static-libstdc++ @gol
473 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
474 -shared -shared-libgcc  -symbolic @gol
475 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
476 -u @var{symbol} -z @var{keyword}}
478 @item Directory Options
479 @xref{Directory Options,,Options for Directory Search}.
480 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
481 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
482 --sysroot=@var{dir} --no-sysroot-suffix}
484 @item Machine Dependent Options
485 @xref{Submodel Options,,Hardware Models and Configurations}.
486 @c This list is ordered alphanumerically by subsection name.
487 @c Try and put the significant identifier (CPU or system) first,
488 @c so users have a clue at guessing where the ones they want will be.
490 @emph{AArch64 Options}
491 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
492 -mgeneral-regs-only @gol
493 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
494 -mstrict-align @gol
495 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
496 -mtls-dialect=desc  -mtls-dialect=traditional @gol
497 -mfix-cortex-a53-835769  -mno-fix-cortex-a53-835769 @gol
498 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
500 @emph{Adapteva Epiphany Options}
501 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
502 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
503 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
504 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
505 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
506 -msplit-vecmove-early -m1reg-@var{reg}}
508 @emph{ARC Options}
509 @gccoptlist{-mbarrel-shifter @gol
510 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
511 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
512 -mea -mno-mpy -mmul32x16 -mmul64 @gol
513 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
514 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
515 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
516 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
517 -mucb-mcount -mvolatile-cache @gol
518 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
519 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
520 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
521 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
522 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
523 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
525 @emph{ARM Options}
526 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
527 -mabi=@var{name} @gol
528 -mapcs-stack-check  -mno-apcs-stack-check @gol
529 -mapcs-float  -mno-apcs-float @gol
530 -mapcs-reentrant  -mno-apcs-reentrant @gol
531 -msched-prolog  -mno-sched-prolog @gol
532 -mlittle-endian  -mbig-endian @gol
533 -mfloat-abi=@var{name} @gol
534 -mfp16-format=@var{name}
535 -mthumb-interwork  -mno-thumb-interwork @gol
536 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
537 -mstructure-size-boundary=@var{n} @gol
538 -mabort-on-noreturn @gol
539 -mlong-calls  -mno-long-calls @gol
540 -msingle-pic-base  -mno-single-pic-base @gol
541 -mpic-register=@var{reg} @gol
542 -mnop-fun-dllimport @gol
543 -mpoke-function-name @gol
544 -mthumb  -marm @gol
545 -mtpcs-frame  -mtpcs-leaf-frame @gol
546 -mcaller-super-interworking  -mcallee-super-interworking @gol
547 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
548 -mword-relocations @gol
549 -mfix-cortex-m3-ldrd @gol
550 -munaligned-access @gol
551 -mneon-for-64bits @gol
552 -mslow-flash-data @gol
553 -masm-syntax-unified @gol
554 -mrestrict-it}
556 @emph{AVR Options}
557 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
558 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
559 -mstrict-X -mtiny-stack -Waddr-space-convert}
561 @emph{Blackfin Options}
562 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
563 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
564 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
565 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
566 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
567 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
568 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
569 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
570 -micplb}
572 @emph{C6X Options}
573 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
574 -msim -msdata=@var{sdata-type}}
576 @emph{CRIS Options}
577 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
578 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
579 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
580 -mstack-align  -mdata-align  -mconst-align @gol
581 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
582 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
583 -mmul-bug-workaround  -mno-mul-bug-workaround}
585 @emph{CR16 Options}
586 @gccoptlist{-mmac @gol
587 -mcr16cplus -mcr16c @gol
588 -msim -mint32 -mbit-ops
589 -mdata-model=@var{model}}
591 @emph{Darwin Options}
592 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
593 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
594 -client_name  -compatibility_version  -current_version @gol
595 -dead_strip @gol
596 -dependency-file  -dylib_file  -dylinker_install_name @gol
597 -dynamic  -dynamiclib  -exported_symbols_list @gol
598 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
599 -force_flat_namespace  -headerpad_max_install_names @gol
600 -iframework @gol
601 -image_base  -init  -install_name  -keep_private_externs @gol
602 -multi_module  -multiply_defined  -multiply_defined_unused @gol
603 -noall_load   -no_dead_strip_inits_and_terms @gol
604 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
605 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
606 -private_bundle  -read_only_relocs  -sectalign @gol
607 -sectobjectsymbols  -whyload  -seg1addr @gol
608 -sectcreate  -sectobjectsymbols  -sectorder @gol
609 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
610 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
611 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
612 -single_module  -static  -sub_library  -sub_umbrella @gol
613 -twolevel_namespace  -umbrella  -undefined @gol
614 -unexported_symbols_list  -weak_reference_mismatches @gol
615 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
616 -mkernel -mone-byte-bool}
618 @emph{DEC Alpha Options}
619 @gccoptlist{-mno-fp-regs  -msoft-float @gol
620 -mieee  -mieee-with-inexact  -mieee-conformant @gol
621 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
622 -mtrap-precision=@var{mode}  -mbuild-constants @gol
623 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
624 -mbwx  -mmax  -mfix  -mcix @gol
625 -mfloat-vax  -mfloat-ieee @gol
626 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
627 -msmall-text  -mlarge-text @gol
628 -mmemory-latency=@var{time}}
630 @emph{FR30 Options}
631 @gccoptlist{-msmall-model -mno-lsim}
633 @emph{FRV Options}
634 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
635 -mhard-float  -msoft-float @gol
636 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
637 -mdouble  -mno-double @gol
638 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
639 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
640 -mlinked-fp  -mlong-calls  -malign-labels @gol
641 -mlibrary-pic  -macc-4  -macc-8 @gol
642 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
643 -moptimize-membar -mno-optimize-membar @gol
644 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
645 -mvliw-branch  -mno-vliw-branch @gol
646 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
647 -mno-nested-cond-exec  -mtomcat-stats @gol
648 -mTLS -mtls @gol
649 -mcpu=@var{cpu}}
651 @emph{GNU/Linux Options}
652 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
653 -tno-android-cc -tno-android-ld}
655 @emph{H8/300 Options}
656 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
658 @emph{HPPA Options}
659 @gccoptlist{-march=@var{architecture-type} @gol
660 -mdisable-fpregs  -mdisable-indexing @gol
661 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
662 -mfixed-range=@var{register-range} @gol
663 -mjump-in-delay -mlinker-opt -mlong-calls @gol
664 -mlong-load-store  -mno-disable-fpregs @gol
665 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
666 -mno-jump-in-delay  -mno-long-load-store @gol
667 -mno-portable-runtime  -mno-soft-float @gol
668 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
669 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
670 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
671 -munix=@var{unix-std}  -nolibdld  -static  -threads}
673 @emph{i386 and x86-64 Options}
674 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
675 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
676 -mfpmath=@var{unit} @gol
677 -masm=@var{dialect}  -mno-fancy-math-387 @gol
678 -mno-fp-ret-in-387  -msoft-float @gol
679 -mno-wide-multiply  -mrtd  -malign-double @gol
680 -mpreferred-stack-boundary=@var{num} @gol
681 -mincoming-stack-boundary=@var{num} @gol
682 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
683 -mrecip -mrecip=@var{opt} @gol
684 -mvzeroupper -mprefer-avx128 @gol
685 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
686 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
687 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
688 -mclflushopt -mxsavec -mxsaves @gol
689 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
690 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mmpx -mthreads @gol
691 -mno-align-stringops  -minline-all-stringops @gol
692 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
693 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
694 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
695 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
696 -mregparm=@var{num}  -msseregparm @gol
697 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
698 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
699 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
700 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
701 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
702 -msse2avx -mfentry -mrecord-mcount -mnop-mcount -m8bit-idiv @gol
703 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
704 -malign-data=@var{type} -mstack-protector-guard=@var{guard}}
706 @emph{i386 and x86-64 Windows Options}
707 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
708 -mnop-fun-dllimport -mthread @gol
709 -municode -mwin32 -mwindows -fno-set-stack-executable}
711 @emph{IA-64 Options}
712 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
713 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
714 -mconstant-gp  -mauto-pic  -mfused-madd @gol
715 -minline-float-divide-min-latency @gol
716 -minline-float-divide-max-throughput @gol
717 -mno-inline-float-divide @gol
718 -minline-int-divide-min-latency @gol
719 -minline-int-divide-max-throughput  @gol
720 -mno-inline-int-divide @gol
721 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
722 -mno-inline-sqrt @gol
723 -mdwarf2-asm -mearly-stop-bits @gol
724 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
725 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
726 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
727 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
728 -msched-spec-ldc -msched-spec-control-ldc @gol
729 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
730 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
731 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
732 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
734 @emph{LM32 Options}
735 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
736 -msign-extend-enabled -muser-enabled}
738 @emph{M32R/D Options}
739 @gccoptlist{-m32r2 -m32rx -m32r @gol
740 -mdebug @gol
741 -malign-loops -mno-align-loops @gol
742 -missue-rate=@var{number} @gol
743 -mbranch-cost=@var{number} @gol
744 -mmodel=@var{code-size-model-type} @gol
745 -msdata=@var{sdata-type} @gol
746 -mno-flush-func -mflush-func=@var{name} @gol
747 -mno-flush-trap -mflush-trap=@var{number} @gol
748 -G @var{num}}
750 @emph{M32C Options}
751 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
753 @emph{M680x0 Options}
754 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
755 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
756 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
757 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
758 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
759 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
760 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
761 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
762 -mxgot -mno-xgot}
764 @emph{MCore Options}
765 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
766 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
767 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
768 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
769 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
771 @emph{MeP Options}
772 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
773 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
774 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
775 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
776 -mtiny=@var{n}}
778 @emph{MicroBlaze Options}
779 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
780 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
781 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
782 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
783 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
785 @emph{MIPS Options}
786 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
787 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2  -mips32r3  -mips32r5 @gol
788 -mips32r6  -mips64  -mips64r2  -mips64r3  -mips64r5  -mips64r6 @gol
789 -mips16  -mno-mips16  -mflip-mips16 @gol
790 -minterlink-compressed -mno-interlink-compressed @gol
791 -minterlink-mips16  -mno-interlink-mips16 @gol
792 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
793 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
794 -mgp32  -mgp64  -mfp32  -mfpxx  -mfp64  -mhard-float  -msoft-float @gol
795 -mno-float  -msingle-float  -mdouble-float @gol
796 -modd-spreg -mno-odd-spreg @gol
797 -mabs=@var{mode}  -mnan=@var{encoding} @gol
798 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
799 -mmcu -mmno-mcu @gol
800 -meva -mno-eva @gol
801 -mvirt -mno-virt @gol
802 -mxpa -mno-xpa @gol
803 -mmicromips -mno-micromips @gol
804 -mfpu=@var{fpu-type} @gol
805 -msmartmips  -mno-smartmips @gol
806 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
807 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
808 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
809 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
810 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
811 -membedded-data  -mno-embedded-data @gol
812 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
813 -mcode-readable=@var{setting} @gol
814 -msplit-addresses  -mno-split-addresses @gol
815 -mexplicit-relocs  -mno-explicit-relocs @gol
816 -mcheck-zero-division  -mno-check-zero-division @gol
817 -mdivide-traps  -mdivide-breaks @gol
818 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
819 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
820 -mfix-24k -mno-fix-24k @gol
821 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
822 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
823 -mfix-vr4120  -mno-fix-vr4120 @gol
824 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
825 -mflush-func=@var{func}  -mno-flush-func @gol
826 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
827 -mfp-exceptions -mno-fp-exceptions @gol
828 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
829 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
831 @emph{MMIX Options}
832 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
833 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
834 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
835 -mno-base-addresses  -msingle-exit  -mno-single-exit}
837 @emph{MN10300 Options}
838 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
839 -mno-am33 -mam33 -mam33-2 -mam34 @gol
840 -mtune=@var{cpu-type} @gol
841 -mreturn-pointer-on-d0 @gol
842 -mno-crt0  -mrelax -mliw -msetlb}
844 @emph{Moxie Options}
845 @gccoptlist{-meb -mel -mno-crt0}
847 @emph{MSP430 Options}
848 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
849 -mhwmult= -minrt}
851 @emph{NDS32 Options}
852 @gccoptlist{-mbig-endian -mlittle-endian @gol
853 -mreduced-regs -mfull-regs @gol
854 -mcmov -mno-cmov @gol
855 -mperf-ext -mno-perf-ext @gol
856 -mv3push -mno-v3push @gol
857 -m16bit -mno-16bit @gol
858 -mgp-direct -mno-gp-direct @gol
859 -misr-vector-size=@var{num} @gol
860 -mcache-block-size=@var{num} @gol
861 -march=@var{arch} @gol
862 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
863 -mex9 -mctor-dtor -mrelax}
865 @emph{Nios II Options}
866 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
867 -mno-bypass-cache -mbypass-cache @gol
868 -mno-cache-volatile -mcache-volatile @gol
869 -mno-fast-sw-div -mfast-sw-div @gol
870 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
871 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
872 -mcustom-fpu-cfg=@var{name} @gol
873 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
875 @emph{PDP-11 Options}
876 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
877 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
878 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
879 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
880 -mbranch-expensive  -mbranch-cheap @gol
881 -munix-asm  -mdec-asm}
883 @emph{picoChip Options}
884 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
885 -msymbol-as-address -mno-inefficient-warnings}
887 @emph{PowerPC Options}
888 See RS/6000 and PowerPC Options.
890 @emph{RL78 Options}
891 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78 @gol
892 -m64bit-doubles -m32bit-doubles}
894 @emph{RS/6000 and PowerPC Options}
895 @gccoptlist{-mcpu=@var{cpu-type} @gol
896 -mtune=@var{cpu-type} @gol
897 -mcmodel=@var{code-model} @gol
898 -mpowerpc64 @gol
899 -maltivec  -mno-altivec @gol
900 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
901 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
902 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
903 -mfprnd  -mno-fprnd @gol
904 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
905 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
906 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
907 -malign-power  -malign-natural @gol
908 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
909 -msingle-float -mdouble-float -msimple-fpu @gol
910 -mstring  -mno-string  -mupdate  -mno-update @gol
911 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
912 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
913 -mstrict-align  -mno-strict-align  -mrelocatable @gol
914 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
915 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
916 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
917 -mprioritize-restricted-insns=@var{priority} @gol
918 -msched-costly-dep=@var{dependence_type} @gol
919 -minsert-sched-nops=@var{scheme} @gol
920 -mcall-sysv  -mcall-netbsd @gol
921 -maix-struct-return  -msvr4-struct-return @gol
922 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
923 -mblock-move-inline-limit=@var{num} @gol
924 -misel -mno-isel @gol
925 -misel=yes  -misel=no @gol
926 -mspe -mno-spe @gol
927 -mspe=yes  -mspe=no @gol
928 -mpaired @gol
929 -mgen-cell-microcode -mwarn-cell-microcode @gol
930 -mvrsave -mno-vrsave @gol
931 -mmulhw -mno-mulhw @gol
932 -mdlmzb -mno-dlmzb @gol
933 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
934 -mprototype  -mno-prototype @gol
935 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
936 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
937 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
938 -mno-recip-precision @gol
939 -mveclibabi=@var{type} -mfriz -mno-friz @gol
940 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
941 -msave-toc-indirect -mno-save-toc-indirect @gol
942 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
943 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
944 -mquad-memory -mno-quad-memory @gol
945 -mquad-memory-atomic -mno-quad-memory-atomic @gol
946 -mcompat-align-parm -mno-compat-align-parm @gol
947 -mupper-regs-df -mno-upper-regs-df -mupper-regs-sf -mno-upper-regs-sf @gol
948 -mupper-regs -mno-upper-regs}
950 @emph{RX Options}
951 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
952 -mcpu=@gol
953 -mbig-endian-data -mlittle-endian-data @gol
954 -msmall-data @gol
955 -msim  -mno-sim@gol
956 -mas100-syntax -mno-as100-syntax@gol
957 -mrelax@gol
958 -mmax-constant-size=@gol
959 -mint-register=@gol
960 -mpid@gol
961 -mno-warn-multiple-fast-interrupts@gol
962 -msave-acc-in-interrupts}
964 @emph{S/390 and zSeries Options}
965 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
966 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
967 -mlong-double-64 -mlong-double-128 @gol
968 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
969 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
970 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
971 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
972 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
973 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
975 @emph{Score Options}
976 @gccoptlist{-meb -mel @gol
977 -mnhwloop @gol
978 -muls @gol
979 -mmac @gol
980 -mscore5 -mscore5u -mscore7 -mscore7d}
982 @emph{SH Options}
983 @gccoptlist{-m1  -m2  -m2e @gol
984 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
985 -m3  -m3e @gol
986 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
987 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
988 -m5-64media  -m5-64media-nofpu @gol
989 -m5-32media  -m5-32media-nofpu @gol
990 -m5-compact  -m5-compact-nofpu @gol
991 -mb  -ml  -mdalign  -mrelax @gol
992 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
993 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
994 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
995 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
996 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
997 -maccumulate-outgoing-args -minvalid-symbols @gol
998 -matomic-model=@var{atomic-model} @gol
999 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
1000 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
1001 -mpretend-cmove -mtas}
1003 @emph{Solaris 2 Options}
1004 @gccoptlist{-mclear-hwcap -mno-clear-hwcap -mimpure-text  -mno-impure-text @gol
1005 -pthreads -pthread}
1007 @emph{SPARC Options}
1008 @gccoptlist{-mcpu=@var{cpu-type} @gol
1009 -mtune=@var{cpu-type} @gol
1010 -mcmodel=@var{code-model} @gol
1011 -mmemory-model=@var{mem-model} @gol
1012 -m32  -m64  -mapp-regs  -mno-app-regs @gol
1013 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
1014 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
1015 -mhard-quad-float  -msoft-quad-float @gol
1016 -mstack-bias  -mno-stack-bias @gol
1017 -munaligned-doubles  -mno-unaligned-doubles @gol
1018 -muser-mode  -mno-user-mode @gol
1019 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
1020 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
1021 -mcbcond -mno-cbcond @gol
1022 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1023 -mfix-at697f -mfix-ut699}
1025 @emph{SPU Options}
1026 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1027 -msafe-dma -munsafe-dma @gol
1028 -mbranch-hints @gol
1029 -msmall-mem -mlarge-mem -mstdmain @gol
1030 -mfixed-range=@var{register-range} @gol
1031 -mea32 -mea64 @gol
1032 -maddress-space-conversion -mno-address-space-conversion @gol
1033 -mcache-size=@var{cache-size} @gol
1034 -matomic-updates -mno-atomic-updates}
1036 @emph{System V Options}
1037 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1039 @emph{TILE-Gx Options}
1040 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1041 -mcmodel=@var{code-model}}
1043 @emph{TILEPro Options}
1044 @gccoptlist{-mcpu=@var{cpu} -m32}
1046 @emph{V850 Options}
1047 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1048 -mprolog-function  -mno-prolog-function  -mspace @gol
1049 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1050 -mapp-regs  -mno-app-regs @gol
1051 -mdisable-callt  -mno-disable-callt @gol
1052 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1053 -mv850e -mv850 -mv850e3v5 @gol
1054 -mloop @gol
1055 -mrelax @gol
1056 -mlong-jumps @gol
1057 -msoft-float @gol
1058 -mhard-float @gol
1059 -mgcc-abi @gol
1060 -mrh850-abi @gol
1061 -mbig-switch}
1063 @emph{VAX Options}
1064 @gccoptlist{-mg  -mgnu  -munix}
1066 @emph{VMS Options}
1067 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1068 -mpointer-size=@var{size}}
1070 @emph{VxWorks Options}
1071 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1072 -Xbind-lazy  -Xbind-now}
1074 @emph{x86-64 Options}
1075 See i386 and x86-64 Options.
1077 @emph{Xstormy16 Options}
1078 @gccoptlist{-msim}
1080 @emph{Xtensa Options}
1081 @gccoptlist{-mconst16 -mno-const16 @gol
1082 -mfused-madd  -mno-fused-madd @gol
1083 -mforce-no-pic @gol
1084 -mserialize-volatile  -mno-serialize-volatile @gol
1085 -mtext-section-literals  -mno-text-section-literals @gol
1086 -mtarget-align  -mno-target-align @gol
1087 -mlongcalls  -mno-longcalls}
1089 @emph{zSeries Options}
1090 See S/390 and zSeries Options.
1092 @item Code Generation Options
1093 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1094 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1095 -ffixed-@var{reg}  -fexceptions @gol
1096 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1097 -fasynchronous-unwind-tables @gol
1098 -fno-gnu-unique @gol
1099 -finhibit-size-directive  -finstrument-functions @gol
1100 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1101 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1102 -fno-common  -fno-ident @gol
1103 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1104 -fno-jump-tables @gol
1105 -frecord-gcc-switches @gol
1106 -freg-struct-return  -fshort-enums @gol
1107 -fshort-double  -fshort-wchar @gol
1108 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1109 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1110 -fno-stack-limit -fsplit-stack @gol
1111 -fleading-underscore  -ftls-model=@var{model} @gol
1112 -fstack-reuse=@var{reuse_level} @gol
1113 -ftrapv  -fwrapv  -fbounds-check @gol
1114 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1115 @end table
1118 @node Overall Options
1119 @section Options Controlling the Kind of Output
1121 Compilation can involve up to four stages: preprocessing, compilation
1122 proper, assembly and linking, always in that order.  GCC is capable of
1123 preprocessing and compiling several files either into several
1124 assembler input files, or into one assembler input file; then each
1125 assembler input file produces an object file, and linking combines all
1126 the object files (those newly compiled, and those specified as input)
1127 into an executable file.
1129 @cindex file name suffix
1130 For any given input file, the file name suffix determines what kind of
1131 compilation is done:
1133 @table @gcctabopt
1134 @item @var{file}.c
1135 C source code that must be preprocessed.
1137 @item @var{file}.i
1138 C source code that should not be preprocessed.
1140 @item @var{file}.ii
1141 C++ source code that should not be preprocessed.
1143 @item @var{file}.m
1144 Objective-C source code.  Note that you must link with the @file{libobjc}
1145 library to make an Objective-C program work.
1147 @item @var{file}.mi
1148 Objective-C source code that should not be preprocessed.
1150 @item @var{file}.mm
1151 @itemx @var{file}.M
1152 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1153 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1154 to a literal capital M@.
1156 @item @var{file}.mii
1157 Objective-C++ source code that should not be preprocessed.
1159 @item @var{file}.h
1160 C, C++, Objective-C or Objective-C++ header file to be turned into a
1161 precompiled header (default), or C, C++ header file to be turned into an
1162 Ada spec (via the @option{-fdump-ada-spec} switch).
1164 @item @var{file}.cc
1165 @itemx @var{file}.cp
1166 @itemx @var{file}.cxx
1167 @itemx @var{file}.cpp
1168 @itemx @var{file}.CPP
1169 @itemx @var{file}.c++
1170 @itemx @var{file}.C
1171 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1172 the last two letters must both be literally @samp{x}.  Likewise,
1173 @samp{.C} refers to a literal capital C@.
1175 @item @var{file}.mm
1176 @itemx @var{file}.M
1177 Objective-C++ source code that must be preprocessed.
1179 @item @var{file}.mii
1180 Objective-C++ source code that should not be preprocessed.
1182 @item @var{file}.hh
1183 @itemx @var{file}.H
1184 @itemx @var{file}.hp
1185 @itemx @var{file}.hxx
1186 @itemx @var{file}.hpp
1187 @itemx @var{file}.HPP
1188 @itemx @var{file}.h++
1189 @itemx @var{file}.tcc
1190 C++ header file to be turned into a precompiled header or Ada spec.
1192 @item @var{file}.f
1193 @itemx @var{file}.for
1194 @itemx @var{file}.ftn
1195 Fixed form Fortran source code that should not be preprocessed.
1197 @item @var{file}.F
1198 @itemx @var{file}.FOR
1199 @itemx @var{file}.fpp
1200 @itemx @var{file}.FPP
1201 @itemx @var{file}.FTN
1202 Fixed form Fortran source code that must be preprocessed (with the traditional
1203 preprocessor).
1205 @item @var{file}.f90
1206 @itemx @var{file}.f95
1207 @itemx @var{file}.f03
1208 @itemx @var{file}.f08
1209 Free form Fortran source code that should not be preprocessed.
1211 @item @var{file}.F90
1212 @itemx @var{file}.F95
1213 @itemx @var{file}.F03
1214 @itemx @var{file}.F08
1215 Free form Fortran source code that must be preprocessed (with the
1216 traditional preprocessor).
1218 @item @var{file}.go
1219 Go source code.
1221 @c FIXME: Descriptions of Java file types.
1222 @c @var{file}.java
1223 @c @var{file}.class
1224 @c @var{file}.zip
1225 @c @var{file}.jar
1227 @item @var{file}.ads
1228 Ada source code file that contains a library unit declaration (a
1229 declaration of a package, subprogram, or generic, or a generic
1230 instantiation), or a library unit renaming declaration (a package,
1231 generic, or subprogram renaming declaration).  Such files are also
1232 called @dfn{specs}.
1234 @item @var{file}.adb
1235 Ada source code file containing a library unit body (a subprogram or
1236 package body).  Such files are also called @dfn{bodies}.
1238 @c GCC also knows about some suffixes for languages not yet included:
1239 @c Pascal:
1240 @c @var{file}.p
1241 @c @var{file}.pas
1242 @c Ratfor:
1243 @c @var{file}.r
1245 @item @var{file}.s
1246 Assembler code.
1248 @item @var{file}.S
1249 @itemx @var{file}.sx
1250 Assembler code that must be preprocessed.
1252 @item @var{other}
1253 An object file to be fed straight into linking.
1254 Any file name with no recognized suffix is treated this way.
1255 @end table
1257 @opindex x
1258 You can specify the input language explicitly with the @option{-x} option:
1260 @table @gcctabopt
1261 @item -x @var{language}
1262 Specify explicitly the @var{language} for the following input files
1263 (rather than letting the compiler choose a default based on the file
1264 name suffix).  This option applies to all following input files until
1265 the next @option{-x} option.  Possible values for @var{language} are:
1266 @smallexample
1267 c  c-header  cpp-output
1268 c++  c++-header  c++-cpp-output
1269 objective-c  objective-c-header  objective-c-cpp-output
1270 objective-c++ objective-c++-header objective-c++-cpp-output
1271 assembler  assembler-with-cpp
1273 f77  f77-cpp-input f95  f95-cpp-input
1275 java
1276 @end smallexample
1278 @item -x none
1279 Turn off any specification of a language, so that subsequent files are
1280 handled according to their file name suffixes (as they are if @option{-x}
1281 has not been used at all).
1283 @item -pass-exit-codes
1284 @opindex pass-exit-codes
1285 Normally the @command{gcc} program exits with the code of 1 if any
1286 phase of the compiler returns a non-success return code.  If you specify
1287 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1288 the numerically highest error produced by any phase returning an error
1289 indication.  The C, C++, and Fortran front ends return 4 if an internal
1290 compiler error is encountered.
1291 @end table
1293 If you only want some of the stages of compilation, you can use
1294 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1295 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1296 @command{gcc} is to stop.  Note that some combinations (for example,
1297 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1299 @table @gcctabopt
1300 @item -c
1301 @opindex c
1302 Compile or assemble the source files, but do not link.  The linking
1303 stage simply is not done.  The ultimate output is in the form of an
1304 object file for each source file.
1306 By default, the object file name for a source file is made by replacing
1307 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1309 Unrecognized input files, not requiring compilation or assembly, are
1310 ignored.
1312 @item -S
1313 @opindex S
1314 Stop after the stage of compilation proper; do not assemble.  The output
1315 is in the form of an assembler code file for each non-assembler input
1316 file specified.
1318 By default, the assembler file name for a source file is made by
1319 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1321 Input files that don't require compilation are ignored.
1323 @item -E
1324 @opindex E
1325 Stop after the preprocessing stage; do not run the compiler proper.  The
1326 output is in the form of preprocessed source code, which is sent to the
1327 standard output.
1329 Input files that don't require preprocessing are ignored.
1331 @cindex output file option
1332 @item -o @var{file}
1333 @opindex o
1334 Place output in file @var{file}.  This applies to whatever
1335 sort of output is being produced, whether it be an executable file,
1336 an object file, an assembler file or preprocessed C code.
1338 If @option{-o} is not specified, the default is to put an executable
1339 file in @file{a.out}, the object file for
1340 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1341 assembler file in @file{@var{source}.s}, a precompiled header file in
1342 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1343 standard output.
1345 @item -v
1346 @opindex v
1347 Print (on standard error output) the commands executed to run the stages
1348 of compilation.  Also print the version number of the compiler driver
1349 program and of the preprocessor and the compiler proper.
1351 @item -###
1352 @opindex ###
1353 Like @option{-v} except the commands are not executed and arguments
1354 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1355 This is useful for shell scripts to capture the driver-generated command lines.
1357 @item -pipe
1358 @opindex pipe
1359 Use pipes rather than temporary files for communication between the
1360 various stages of compilation.  This fails to work on some systems where
1361 the assembler is unable to read from a pipe; but the GNU assembler has
1362 no trouble.
1364 @item --help
1365 @opindex help
1366 Print (on the standard output) a description of the command-line options
1367 understood by @command{gcc}.  If the @option{-v} option is also specified
1368 then @option{--help} is also passed on to the various processes
1369 invoked by @command{gcc}, so that they can display the command-line options
1370 they accept.  If the @option{-Wextra} option has also been specified
1371 (prior to the @option{--help} option), then command-line options that
1372 have no documentation associated with them are also displayed.
1374 @item --target-help
1375 @opindex target-help
1376 Print (on the standard output) a description of target-specific command-line
1377 options for each tool.  For some targets extra target-specific
1378 information may also be printed.
1380 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1381 Print (on the standard output) a description of the command-line
1382 options understood by the compiler that fit into all specified classes
1383 and qualifiers.  These are the supported classes:
1385 @table @asis
1386 @item @samp{optimizers}
1387 Display all of the optimization options supported by the
1388 compiler.
1390 @item @samp{warnings}
1391 Display all of the options controlling warning messages
1392 produced by the compiler.
1394 @item @samp{target}
1395 Display target-specific options.  Unlike the
1396 @option{--target-help} option however, target-specific options of the
1397 linker and assembler are not displayed.  This is because those
1398 tools do not currently support the extended @option{--help=} syntax.
1400 @item @samp{params}
1401 Display the values recognized by the @option{--param}
1402 option.
1404 @item @var{language}
1405 Display the options supported for @var{language}, where
1406 @var{language} is the name of one of the languages supported in this
1407 version of GCC@.
1409 @item @samp{common}
1410 Display the options that are common to all languages.
1411 @end table
1413 These are the supported qualifiers:
1415 @table @asis
1416 @item @samp{undocumented}
1417 Display only those options that are undocumented.
1419 @item @samp{joined}
1420 Display options taking an argument that appears after an equal
1421 sign in the same continuous piece of text, such as:
1422 @samp{--help=target}.
1424 @item @samp{separate}
1425 Display options taking an argument that appears as a separate word
1426 following the original option, such as: @samp{-o output-file}.
1427 @end table
1429 Thus for example to display all the undocumented target-specific
1430 switches supported by the compiler, use:
1432 @smallexample
1433 --help=target,undocumented
1434 @end smallexample
1436 The sense of a qualifier can be inverted by prefixing it with the
1437 @samp{^} character, so for example to display all binary warning
1438 options (i.e., ones that are either on or off and that do not take an
1439 argument) that have a description, use:
1441 @smallexample
1442 --help=warnings,^joined,^undocumented
1443 @end smallexample
1445 The argument to @option{--help=} should not consist solely of inverted
1446 qualifiers.
1448 Combining several classes is possible, although this usually
1449 restricts the output so much that there is nothing to display.  One
1450 case where it does work, however, is when one of the classes is
1451 @var{target}.  For example, to display all the target-specific
1452 optimization options, use:
1454 @smallexample
1455 --help=target,optimizers
1456 @end smallexample
1458 The @option{--help=} option can be repeated on the command line.  Each
1459 successive use displays its requested class of options, skipping
1460 those that have already been displayed.
1462 If the @option{-Q} option appears on the command line before the
1463 @option{--help=} option, then the descriptive text displayed by
1464 @option{--help=} is changed.  Instead of describing the displayed
1465 options, an indication is given as to whether the option is enabled,
1466 disabled or set to a specific value (assuming that the compiler
1467 knows this at the point where the @option{--help=} option is used).
1469 Here is a truncated example from the ARM port of @command{gcc}:
1471 @smallexample
1472   % gcc -Q -mabi=2 --help=target -c
1473   The following options are target specific:
1474   -mabi=                                2
1475   -mabort-on-noreturn                   [disabled]
1476   -mapcs                                [disabled]
1477 @end smallexample
1479 The output is sensitive to the effects of previous command-line
1480 options, so for example it is possible to find out which optimizations
1481 are enabled at @option{-O2} by using:
1483 @smallexample
1484 -Q -O2 --help=optimizers
1485 @end smallexample
1487 Alternatively you can discover which binary optimizations are enabled
1488 by @option{-O3} by using:
1490 @smallexample
1491 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1492 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1493 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1494 @end smallexample
1496 @item -no-canonical-prefixes
1497 @opindex no-canonical-prefixes
1498 Do not expand any symbolic links, resolve references to @samp{/../}
1499 or @samp{/./}, or make the path absolute when generating a relative
1500 prefix.
1502 @item --version
1503 @opindex version
1504 Display the version number and copyrights of the invoked GCC@.
1506 @item -wrapper
1507 @opindex wrapper
1508 Invoke all subcommands under a wrapper program.  The name of the
1509 wrapper program and its parameters are passed as a comma separated
1510 list.
1512 @smallexample
1513 gcc -c t.c -wrapper gdb,--args
1514 @end smallexample
1516 @noindent
1517 This invokes all subprograms of @command{gcc} under
1518 @samp{gdb --args}, thus the invocation of @command{cc1} is
1519 @samp{gdb --args cc1 @dots{}}.
1521 @item -fplugin=@var{name}.so
1522 @opindex fplugin
1523 Load the plugin code in file @var{name}.so, assumed to be a
1524 shared object to be dlopen'd by the compiler.  The base name of
1525 the shared object file is used to identify the plugin for the
1526 purposes of argument parsing (See
1527 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1528 Each plugin should define the callback functions specified in the
1529 Plugins API.
1531 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1532 @opindex fplugin-arg
1533 Define an argument called @var{key} with a value of @var{value}
1534 for the plugin called @var{name}.
1536 @item -fdump-ada-spec@r{[}-slim@r{]}
1537 @opindex fdump-ada-spec
1538 For C and C++ source and include files, generate corresponding Ada specs.
1539 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1540 GNAT User's Guide}, which provides detailed documentation on this feature.
1542 @item -fada-spec-parent=@var{unit}
1543 @opindex fada-spec-parent
1544 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1545 Ada specs as child units of parent @var{unit}.
1547 @item -fdump-go-spec=@var{file}
1548 @opindex fdump-go-spec
1549 For input files in any language, generate corresponding Go
1550 declarations in @var{file}.  This generates Go @code{const},
1551 @code{type}, @code{var}, and @code{func} declarations which may be a
1552 useful way to start writing a Go interface to code written in some
1553 other language.
1555 @include @value{srcdir}/../libiberty/at-file.texi
1556 @end table
1558 @node Invoking G++
1559 @section Compiling C++ Programs
1561 @cindex suffixes for C++ source
1562 @cindex C++ source file suffixes
1563 C++ source files conventionally use one of the suffixes @samp{.C},
1564 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1565 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1566 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1567 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1568 files with these names and compiles them as C++ programs even if you
1569 call the compiler the same way as for compiling C programs (usually
1570 with the name @command{gcc}).
1572 @findex g++
1573 @findex c++
1574 However, the use of @command{gcc} does not add the C++ library.
1575 @command{g++} is a program that calls GCC and automatically specifies linking
1576 against the C++ library.  It treats @samp{.c},
1577 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1578 files unless @option{-x} is used.  This program is also useful when
1579 precompiling a C header file with a @samp{.h} extension for use in C++
1580 compilations.  On many systems, @command{g++} is also installed with
1581 the name @command{c++}.
1583 @cindex invoking @command{g++}
1584 When you compile C++ programs, you may specify many of the same
1585 command-line options that you use for compiling programs in any
1586 language; or command-line options meaningful for C and related
1587 languages; or options that are meaningful only for C++ programs.
1588 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1589 explanations of options for languages related to C@.
1590 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1591 explanations of options that are meaningful only for C++ programs.
1593 @node C Dialect Options
1594 @section Options Controlling C Dialect
1595 @cindex dialect options
1596 @cindex language dialect options
1597 @cindex options, dialect
1599 The following options control the dialect of C (or languages derived
1600 from C, such as C++, Objective-C and Objective-C++) that the compiler
1601 accepts:
1603 @table @gcctabopt
1604 @cindex ANSI support
1605 @cindex ISO support
1606 @item -ansi
1607 @opindex ansi
1608 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1609 equivalent to @option{-std=c++98}.
1611 This turns off certain features of GCC that are incompatible with ISO
1612 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1613 such as the @code{asm} and @code{typeof} keywords, and
1614 predefined macros such as @code{unix} and @code{vax} that identify the
1615 type of system you are using.  It also enables the undesirable and
1616 rarely used ISO trigraph feature.  For the C compiler,
1617 it disables recognition of C++ style @samp{//} comments as well as
1618 the @code{inline} keyword.
1620 The alternate keywords @code{__asm__}, @code{__extension__},
1621 @code{__inline__} and @code{__typeof__} continue to work despite
1622 @option{-ansi}.  You would not want to use them in an ISO C program, of
1623 course, but it is useful to put them in header files that might be included
1624 in compilations done with @option{-ansi}.  Alternate predefined macros
1625 such as @code{__unix__} and @code{__vax__} are also available, with or
1626 without @option{-ansi}.
1628 The @option{-ansi} option does not cause non-ISO programs to be
1629 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1630 addition to @option{-ansi}.  @xref{Warning Options}.
1632 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1633 option is used.  Some header files may notice this macro and refrain
1634 from declaring certain functions or defining certain macros that the
1635 ISO standard doesn't call for; this is to avoid interfering with any
1636 programs that might use these names for other things.
1638 Functions that are normally built in but do not have semantics
1639 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1640 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1641 built-in functions provided by GCC}, for details of the functions
1642 affected.
1644 @item -std=
1645 @opindex std
1646 Determine the language standard. @xref{Standards,,Language Standards
1647 Supported by GCC}, for details of these standard versions.  This option
1648 is currently only supported when compiling C or C++.
1650 The compiler can accept several base standards, such as @samp{c90} or
1651 @samp{c++98}, and GNU dialects of those standards, such as
1652 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1653 compiler accepts all programs following that standard plus those
1654 using GNU extensions that do not contradict it.  For example,
1655 @option{-std=c90} turns off certain features of GCC that are
1656 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1657 keywords, but not other GNU extensions that do not have a meaning in
1658 ISO C90, such as omitting the middle term of a @code{?:}
1659 expression. On the other hand, when a GNU dialect of a standard is
1660 specified, all features supported by the compiler are enabled, even when
1661 those features change the meaning of the base standard.  As a result, some
1662 strict-conforming programs may be rejected.  The particular standard
1663 is used by @option{-Wpedantic} to identify which features are GNU
1664 extensions given that version of the standard. For example
1665 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1666 comments, while @option{-std=gnu99 -Wpedantic} does not.
1668 A value for this option must be provided; possible values are
1670 @table @samp
1671 @item c90
1672 @itemx c89
1673 @itemx iso9899:1990
1674 Support all ISO C90 programs (certain GNU extensions that conflict
1675 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1677 @item iso9899:199409
1678 ISO C90 as modified in amendment 1.
1680 @item c99
1681 @itemx c9x
1682 @itemx iso9899:1999
1683 @itemx iso9899:199x
1684 ISO C99.  This standard is substantially completely supported, modulo
1685 bugs and floating-point issues
1686 (mainly but not entirely relating to optional C99 features from
1687 Annexes F and G).  See
1688 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1689 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1691 @item c11
1692 @itemx c1x
1693 @itemx iso9899:2011
1694 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1695 substantially completely supported, modulo bugs, floating-point issues
1696 (mainly but not entirely relating to optional C11 features from
1697 Annexes F and G) and the optional Annexes K (Bounds-checking
1698 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1700 @item gnu90
1701 @itemx gnu89
1702 GNU dialect of ISO C90 (including some C99 features).
1704 @item gnu99
1705 @itemx gnu9x
1706 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1708 @item gnu11
1709 @itemx gnu1x
1710 GNU dialect of ISO C11.  This is the default for C code.
1711 The name @samp{gnu1x} is deprecated.
1713 @item c++98
1714 @itemx c++03
1715 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1716 additional defect reports. Same as @option{-ansi} for C++ code.
1718 @item gnu++98
1719 @itemx gnu++03
1720 GNU dialect of @option{-std=c++98}.  This is the default for
1721 C++ code.
1723 @item c++11
1724 @itemx c++0x
1725 The 2011 ISO C++ standard plus amendments.
1726 The name @samp{c++0x} is deprecated.
1728 @item gnu++11
1729 @itemx gnu++0x
1730 GNU dialect of @option{-std=c++11}.
1731 The name @samp{gnu++0x} is deprecated.
1733 @item c++14
1734 @itemx c++1y
1735 The 2014 ISO C++ standard plus amendments.
1736 The name @samp{c++1y} is deprecated.
1738 @item gnu++14
1739 @itemx gnu++1y
1740 GNU dialect of @option{-std=c++14}.
1741 The name @samp{gnu++1y} is deprecated.
1743 @item c++1z
1744 The next revision of the ISO C++ standard, tentatively planned for
1745 2017.  Support is highly experimental, and will almost certainly
1746 change in incompatible ways in future releases.
1748 @item gnu++1z
1749 GNU dialect of @option{-std=c++1z}.  Support is highly experimental,
1750 and will almost certainly change in incompatible ways in future
1751 releases.
1752 @end table
1754 @item -fgnu89-inline
1755 @opindex fgnu89-inline
1756 The option @option{-fgnu89-inline} tells GCC to use the traditional
1757 GNU semantics for @code{inline} functions when in C99 mode.
1758 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1759 is accepted and ignored by GCC versions 4.1.3 up to but not including
1760 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1761 C99 mode.  Using this option is roughly equivalent to adding the
1762 @code{gnu_inline} function attribute to all inline functions
1763 (@pxref{Function Attributes}).
1765 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1766 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1767 specifies the default behavior).  This option was first supported in
1768 GCC 4.3.  This option is not supported in @option{-std=c90} or
1769 @option{-std=gnu90} mode.
1771 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1772 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1773 in effect for @code{inline} functions.  @xref{Common Predefined
1774 Macros,,,cpp,The C Preprocessor}.
1776 @item -aux-info @var{filename}
1777 @opindex aux-info
1778 Output to the given filename prototyped declarations for all functions
1779 declared and/or defined in a translation unit, including those in header
1780 files.  This option is silently ignored in any language other than C@.
1782 Besides declarations, the file indicates, in comments, the origin of
1783 each declaration (source file and line), whether the declaration was
1784 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1785 @samp{O} for old, respectively, in the first character after the line
1786 number and the colon), and whether it came from a declaration or a
1787 definition (@samp{C} or @samp{F}, respectively, in the following
1788 character).  In the case of function definitions, a K&R-style list of
1789 arguments followed by their declarations is also provided, inside
1790 comments, after the declaration.
1792 @item -fallow-parameterless-variadic-functions
1793 @opindex fallow-parameterless-variadic-functions
1794 Accept variadic functions without named parameters.
1796 Although it is possible to define such a function, this is not very
1797 useful as it is not possible to read the arguments.  This is only
1798 supported for C as this construct is allowed by C++.
1800 @item -fno-asm
1801 @opindex fno-asm
1802 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1803 keyword, so that code can use these words as identifiers.  You can use
1804 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1805 instead.  @option{-ansi} implies @option{-fno-asm}.
1807 In C++, this switch only affects the @code{typeof} keyword, since
1808 @code{asm} and @code{inline} are standard keywords.  You may want to
1809 use the @option{-fno-gnu-keywords} flag instead, which has the same
1810 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1811 switch only affects the @code{asm} and @code{typeof} keywords, since
1812 @code{inline} is a standard keyword in ISO C99.
1814 @item -fno-builtin
1815 @itemx -fno-builtin-@var{function}
1816 @opindex fno-builtin
1817 @cindex built-in functions
1818 Don't recognize built-in functions that do not begin with
1819 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1820 functions provided by GCC}, for details of the functions affected,
1821 including those which are not built-in functions when @option{-ansi} or
1822 @option{-std} options for strict ISO C conformance are used because they
1823 do not have an ISO standard meaning.
1825 GCC normally generates special code to handle certain built-in functions
1826 more efficiently; for instance, calls to @code{alloca} may become single
1827 instructions which adjust the stack directly, and calls to @code{memcpy}
1828 may become inline copy loops.  The resulting code is often both smaller
1829 and faster, but since the function calls no longer appear as such, you
1830 cannot set a breakpoint on those calls, nor can you change the behavior
1831 of the functions by linking with a different library.  In addition,
1832 when a function is recognized as a built-in function, GCC may use
1833 information about that function to warn about problems with calls to
1834 that function, or to generate more efficient code, even if the
1835 resulting code still contains calls to that function.  For example,
1836 warnings are given with @option{-Wformat} for bad calls to
1837 @code{printf} when @code{printf} is built in and @code{strlen} is
1838 known not to modify global memory.
1840 With the @option{-fno-builtin-@var{function}} option
1841 only the built-in function @var{function} is
1842 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1843 function is named that is not built-in in this version of GCC, this
1844 option is ignored.  There is no corresponding
1845 @option{-fbuiltin-@var{function}} option; if you wish to enable
1846 built-in functions selectively when using @option{-fno-builtin} or
1847 @option{-ffreestanding}, you may define macros such as:
1849 @smallexample
1850 #define abs(n)          __builtin_abs ((n))
1851 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1852 @end smallexample
1854 @item -fhosted
1855 @opindex fhosted
1856 @cindex hosted environment
1858 Assert that compilation targets a hosted environment.  This implies
1859 @option{-fbuiltin}.  A hosted environment is one in which the
1860 entire standard library is available, and in which @code{main} has a return
1861 type of @code{int}.  Examples are nearly everything except a kernel.
1862 This is equivalent to @option{-fno-freestanding}.
1864 @item -ffreestanding
1865 @opindex ffreestanding
1866 @cindex hosted environment
1868 Assert that compilation targets a freestanding environment.  This
1869 implies @option{-fno-builtin}.  A freestanding environment
1870 is one in which the standard library may not exist, and program startup may
1871 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1872 This is equivalent to @option{-fno-hosted}.
1874 @xref{Standards,,Language Standards Supported by GCC}, for details of
1875 freestanding and hosted environments.
1877 @item -fopenmp
1878 @opindex fopenmp
1879 @cindex OpenMP parallel
1880 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1881 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1882 compiler generates parallel code according to the OpenMP Application
1883 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1884 implies @option{-pthread}, and thus is only supported on targets that
1885 have support for @option{-pthread}. @option{-fopenmp} implies
1886 @option{-fopenmp-simd}.
1888 @item -fopenmp-simd
1889 @opindex fopenmp-simd
1890 @cindex OpenMP SIMD
1891 @cindex SIMD
1892 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1893 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1894 are ignored.
1896 @item -fcilkplus
1897 @opindex fcilkplus
1898 @cindex Enable Cilk Plus
1899 Enable the usage of Cilk Plus language extension features for C/C++.
1900 When the option @option{-fcilkplus} is specified, enable the usage of
1901 the Cilk Plus Language extension features for C/C++.  The present
1902 implementation follows ABI version 1.2.  This is an experimental
1903 feature that is only partially complete, and whose interface may
1904 change in future versions of GCC as the official specification
1905 changes.  Currently, all features but @code{_Cilk_for} have been
1906 implemented.
1908 @item -fgnu-tm
1909 @opindex fgnu-tm
1910 When the option @option{-fgnu-tm} is specified, the compiler
1911 generates code for the Linux variant of Intel's current Transactional
1912 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1913 an experimental feature whose interface may change in future versions
1914 of GCC, as the official specification changes.  Please note that not
1915 all architectures are supported for this feature.
1917 For more information on GCC's support for transactional memory,
1918 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1919 Transactional Memory Library}.
1921 Note that the transactional memory feature is not supported with
1922 non-call exceptions (@option{-fnon-call-exceptions}).
1924 @item -fms-extensions
1925 @opindex fms-extensions
1926 Accept some non-standard constructs used in Microsoft header files.
1928 In C++ code, this allows member names in structures to be similar
1929 to previous types declarations.
1931 @smallexample
1932 typedef int UOW;
1933 struct ABC @{
1934   UOW UOW;
1936 @end smallexample
1938 Some cases of unnamed fields in structures and unions are only
1939 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1940 fields within structs/unions}, for details.
1942 Note that this option is off for all targets but i?86 and x86_64
1943 targets using ms-abi.
1944 @item -fplan9-extensions
1945 Accept some non-standard constructs used in Plan 9 code.
1947 This enables @option{-fms-extensions}, permits passing pointers to
1948 structures with anonymous fields to functions that expect pointers to
1949 elements of the type of the field, and permits referring to anonymous
1950 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1951 struct/union fields within structs/unions}, for details.  This is only
1952 supported for C, not C++.
1954 @item -trigraphs
1955 @opindex trigraphs
1956 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1957 options for strict ISO C conformance) implies @option{-trigraphs}.
1959 @cindex traditional C language
1960 @cindex C language, traditional
1961 @item -traditional
1962 @itemx -traditional-cpp
1963 @opindex traditional-cpp
1964 @opindex traditional
1965 Formerly, these options caused GCC to attempt to emulate a pre-standard
1966 C compiler.  They are now only supported with the @option{-E} switch.
1967 The preprocessor continues to support a pre-standard mode.  See the GNU
1968 CPP manual for details.
1970 @item -fcond-mismatch
1971 @opindex fcond-mismatch
1972 Allow conditional expressions with mismatched types in the second and
1973 third arguments.  The value of such an expression is void.  This option
1974 is not supported for C++.
1976 @item -flax-vector-conversions
1977 @opindex flax-vector-conversions
1978 Allow implicit conversions between vectors with differing numbers of
1979 elements and/or incompatible element types.  This option should not be
1980 used for new code.
1982 @item -funsigned-char
1983 @opindex funsigned-char
1984 Let the type @code{char} be unsigned, like @code{unsigned char}.
1986 Each kind of machine has a default for what @code{char} should
1987 be.  It is either like @code{unsigned char} by default or like
1988 @code{signed char} by default.
1990 Ideally, a portable program should always use @code{signed char} or
1991 @code{unsigned char} when it depends on the signedness of an object.
1992 But many programs have been written to use plain @code{char} and
1993 expect it to be signed, or expect it to be unsigned, depending on the
1994 machines they were written for.  This option, and its inverse, let you
1995 make such a program work with the opposite default.
1997 The type @code{char} is always a distinct type from each of
1998 @code{signed char} or @code{unsigned char}, even though its behavior
1999 is always just like one of those two.
2001 @item -fsigned-char
2002 @opindex fsigned-char
2003 Let the type @code{char} be signed, like @code{signed char}.
2005 Note that this is equivalent to @option{-fno-unsigned-char}, which is
2006 the negative form of @option{-funsigned-char}.  Likewise, the option
2007 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
2009 @item -fsigned-bitfields
2010 @itemx -funsigned-bitfields
2011 @itemx -fno-signed-bitfields
2012 @itemx -fno-unsigned-bitfields
2013 @opindex fsigned-bitfields
2014 @opindex funsigned-bitfields
2015 @opindex fno-signed-bitfields
2016 @opindex fno-unsigned-bitfields
2017 These options control whether a bit-field is signed or unsigned, when the
2018 declaration does not use either @code{signed} or @code{unsigned}.  By
2019 default, such a bit-field is signed, because this is consistent: the
2020 basic integer types such as @code{int} are signed types.
2021 @end table
2023 @node C++ Dialect Options
2024 @section Options Controlling C++ Dialect
2026 @cindex compiler options, C++
2027 @cindex C++ options, command-line
2028 @cindex options, C++
2029 This section describes the command-line options that are only meaningful
2030 for C++ programs.  You can also use most of the GNU compiler options
2031 regardless of what language your program is in.  For example, you
2032 might compile a file @code{firstClass.C} like this:
2034 @smallexample
2035 g++ -g -frepo -O -c firstClass.C
2036 @end smallexample
2038 @noindent
2039 In this example, only @option{-frepo} is an option meant
2040 only for C++ programs; you can use the other options with any
2041 language supported by GCC@.
2043 Here is a list of options that are @emph{only} for compiling C++ programs:
2045 @table @gcctabopt
2047 @item -fabi-version=@var{n}
2048 @opindex fabi-version
2049 Use version @var{n} of the C++ ABI@.  The default is version 0.
2051 Version 0 refers to the version conforming most closely to
2052 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2053 will change in different versions of G++ as ABI bugs are fixed.
2055 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2057 Version 2 is the version of the C++ ABI that first appeared in G++
2058 3.4, and was the default through G++ 4.9.
2060 Version 3 corrects an error in mangling a constant address as a
2061 template argument.
2063 Version 4, which first appeared in G++ 4.5, implements a standard
2064 mangling for vector types.
2066 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2067 attribute const/volatile on function pointer types, decltype of a
2068 plain decl, and use of a function parameter in the declaration of
2069 another parameter.
2071 Version 6, which first appeared in G++ 4.7, corrects the promotion
2072 behavior of C++11 scoped enums and the mangling of template argument
2073 packs, const/static_cast, prefix ++ and --, and a class scope function
2074 used as a template argument.
2076 Version 7, which first appeared in G++ 4.8, that treats nullptr_t as a
2077 builtin type and corrects the mangling of lambdas in default argument
2078 scope.
2080 Version 8, which first appeared in G++ 4.9, corrects the substitution
2081 behavior of function types with function-cv-qualifiers.
2083 See also @option{-Wabi}.
2085 @item -fabi-compat-version=@var{n}
2086 @opindex fabi-compat-version
2087 Starting with GCC 4.5, on targets that support strong aliases, G++
2088 works around mangling changes by creating an alias with the correct
2089 mangled name when defining a symbol with an incorrect mangled name.
2090 This switch specifies which ABI version to use for the alias.
2092 With @option{-fabi-version=0} (the default), this defaults to 2.  If
2093 another ABI version is explicitly selected, this defaults to 0.
2095 The compatibility version is also set by @option{-Wabi=@var{n}}.
2097 @item -fno-access-control
2098 @opindex fno-access-control
2099 Turn off all access checking.  This switch is mainly useful for working
2100 around bugs in the access control code.
2102 @item -fcheck-new
2103 @opindex fcheck-new
2104 Check that the pointer returned by @code{operator new} is non-null
2105 before attempting to modify the storage allocated.  This check is
2106 normally unnecessary because the C++ standard specifies that
2107 @code{operator new} only returns @code{0} if it is declared
2108 @samp{throw()}, in which case the compiler always checks the
2109 return value even without this option.  In all other cases, when
2110 @code{operator new} has a non-empty exception specification, memory
2111 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2112 @samp{new (nothrow)}.
2114 @item -fconstexpr-depth=@var{n}
2115 @opindex fconstexpr-depth
2116 Set the maximum nested evaluation depth for C++11 constexpr functions
2117 to @var{n}.  A limit is needed to detect endless recursion during
2118 constant expression evaluation.  The minimum specified by the standard
2119 is 512.
2121 @item -fdeduce-init-list
2122 @opindex fdeduce-init-list
2123 Enable deduction of a template type parameter as
2124 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2126 @smallexample
2127 template <class T> auto forward(T t) -> decltype (realfn (t))
2129   return realfn (t);
2132 void f()
2134   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2136 @end smallexample
2138 This deduction was implemented as a possible extension to the
2139 originally proposed semantics for the C++11 standard, but was not part
2140 of the final standard, so it is disabled by default.  This option is
2141 deprecated, and may be removed in a future version of G++.
2143 @item -ffriend-injection
2144 @opindex ffriend-injection
2145 Inject friend functions into the enclosing namespace, so that they are
2146 visible outside the scope of the class in which they are declared.
2147 Friend functions were documented to work this way in the old Annotated
2148 C++ Reference Manual, and versions of G++ before 4.1 always worked
2149 that way.  However, in ISO C++ a friend function that is not declared
2150 in an enclosing scope can only be found using argument dependent
2151 lookup.  This option causes friends to be injected as they were in
2152 earlier releases.
2154 This option is for compatibility, and may be removed in a future
2155 release of G++.
2157 @item -fno-elide-constructors
2158 @opindex fno-elide-constructors
2159 The C++ standard allows an implementation to omit creating a temporary
2160 that is only used to initialize another object of the same type.
2161 Specifying this option disables that optimization, and forces G++ to
2162 call the copy constructor in all cases.
2164 @item -fno-enforce-eh-specs
2165 @opindex fno-enforce-eh-specs
2166 Don't generate code to check for violation of exception specifications
2167 at run time.  This option violates the C++ standard, but may be useful
2168 for reducing code size in production builds, much like defining
2169 @samp{NDEBUG}.  This does not give user code permission to throw
2170 exceptions in violation of the exception specifications; the compiler
2171 still optimizes based on the specifications, so throwing an
2172 unexpected exception results in undefined behavior at run time.
2174 @item -fextern-tls-init
2175 @itemx -fno-extern-tls-init
2176 @opindex fextern-tls-init
2177 @opindex fno-extern-tls-init
2178 The C++11 and OpenMP standards allow @samp{thread_local} and
2179 @samp{threadprivate} variables to have dynamic (runtime)
2180 initialization.  To support this, any use of such a variable goes
2181 through a wrapper function that performs any necessary initialization.
2182 When the use and definition of the variable are in the same
2183 translation unit, this overhead can be optimized away, but when the
2184 use is in a different translation unit there is significant overhead
2185 even if the variable doesn't actually need dynamic initialization.  If
2186 the programmer can be sure that no use of the variable in a
2187 non-defining TU needs to trigger dynamic initialization (either
2188 because the variable is statically initialized, or a use of the
2189 variable in the defining TU will be executed before any uses in
2190 another TU), they can avoid this overhead with the
2191 @option{-fno-extern-tls-init} option.
2193 On targets that support symbol aliases, the default is
2194 @option{-fextern-tls-init}.  On targets that do not support symbol
2195 aliases, the default is @option{-fno-extern-tls-init}.
2197 @item -ffor-scope
2198 @itemx -fno-for-scope
2199 @opindex ffor-scope
2200 @opindex fno-for-scope
2201 If @option{-ffor-scope} is specified, the scope of variables declared in
2202 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2203 as specified by the C++ standard.
2204 If @option{-fno-for-scope} is specified, the scope of variables declared in
2205 a @i{for-init-statement} extends to the end of the enclosing scope,
2206 as was the case in old versions of G++, and other (traditional)
2207 implementations of C++.
2209 If neither flag is given, the default is to follow the standard,
2210 but to allow and give a warning for old-style code that would
2211 otherwise be invalid, or have different behavior.
2213 @item -fno-gnu-keywords
2214 @opindex fno-gnu-keywords
2215 Do not recognize @code{typeof} as a keyword, so that code can use this
2216 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2217 @option{-ansi} implies @option{-fno-gnu-keywords}.
2219 @item -fno-implicit-templates
2220 @opindex fno-implicit-templates
2221 Never emit code for non-inline templates that are instantiated
2222 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2223 @xref{Template Instantiation}, for more information.
2225 @item -fno-implicit-inline-templates
2226 @opindex fno-implicit-inline-templates
2227 Don't emit code for implicit instantiations of inline templates, either.
2228 The default is to handle inlines differently so that compiles with and
2229 without optimization need the same set of explicit instantiations.
2231 @item -fno-implement-inlines
2232 @opindex fno-implement-inlines
2233 To save space, do not emit out-of-line copies of inline functions
2234 controlled by @samp{#pragma implementation}.  This causes linker
2235 errors if these functions are not inlined everywhere they are called.
2237 @item -fms-extensions
2238 @opindex fms-extensions
2239 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2240 int and getting a pointer to member function via non-standard syntax.
2242 @item -fno-nonansi-builtins
2243 @opindex fno-nonansi-builtins
2244 Disable built-in declarations of functions that are not mandated by
2245 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2246 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2248 @item -fnothrow-opt
2249 @opindex fnothrow-opt
2250 Treat a @code{throw()} exception specification as if it were a
2251 @code{noexcept} specification to reduce or eliminate the text size
2252 overhead relative to a function with no exception specification.  If
2253 the function has local variables of types with non-trivial
2254 destructors, the exception specification actually makes the
2255 function smaller because the EH cleanups for those variables can be
2256 optimized away.  The semantic effect is that an exception thrown out of
2257 a function with such an exception specification results in a call
2258 to @code{terminate} rather than @code{unexpected}.
2260 @item -fno-operator-names
2261 @opindex fno-operator-names
2262 Do not treat the operator name keywords @code{and}, @code{bitand},
2263 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2264 synonyms as keywords.
2266 @item -fno-optional-diags
2267 @opindex fno-optional-diags
2268 Disable diagnostics that the standard says a compiler does not need to
2269 issue.  Currently, the only such diagnostic issued by G++ is the one for
2270 a name having multiple meanings within a class.
2272 @item -fpermissive
2273 @opindex fpermissive
2274 Downgrade some diagnostics about nonconformant code from errors to
2275 warnings.  Thus, using @option{-fpermissive} allows some
2276 nonconforming code to compile.
2278 @item -fno-pretty-templates
2279 @opindex fno-pretty-templates
2280 When an error message refers to a specialization of a function
2281 template, the compiler normally prints the signature of the
2282 template followed by the template arguments and any typedefs or
2283 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2284 rather than @code{void f(int)}) so that it's clear which template is
2285 involved.  When an error message refers to a specialization of a class
2286 template, the compiler omits any template arguments that match
2287 the default template arguments for that template.  If either of these
2288 behaviors make it harder to understand the error message rather than
2289 easier, you can use @option{-fno-pretty-templates} to disable them.
2291 @item -frepo
2292 @opindex frepo
2293 Enable automatic template instantiation at link time.  This option also
2294 implies @option{-fno-implicit-templates}.  @xref{Template
2295 Instantiation}, for more information.
2297 @item -fno-rtti
2298 @opindex fno-rtti
2299 Disable generation of information about every class with virtual
2300 functions for use by the C++ run-time type identification features
2301 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2302 of the language, you can save some space by using this flag.  Note that
2303 exception handling uses the same information, but G++ generates it as
2304 needed. The @samp{dynamic_cast} operator can still be used for casts that
2305 do not require run-time type information, i.e.@: casts to @code{void *} or to
2306 unambiguous base classes.
2308 @item -fsized-deallocation
2309 @opindex fsized-deallocation
2310 Enable the built-in global declarations
2311 @smallexample
2312 void operator delete (void *, std::size_t) noexcept;
2313 void operator delete[] (void *, std::size_t) noexcept;
2314 @end smallexample
2315 as introduced in C++14.  This is useful for user-defined replacement
2316 deallocation functions that, for example, use the size of the object
2317 to make deallocation faster.  Enabled by default under
2318 @samp{-std=c++14} and above.  The flag @option{-Wsized-deallocation} will
2319 warn about places that might want to add a definition.
2321 @item -fstats
2322 @opindex fstats
2323 Emit statistics about front-end processing at the end of the compilation.
2324 This information is generally only useful to the G++ development team.
2326 @item -fstrict-enums
2327 @opindex fstrict-enums
2328 Allow the compiler to optimize using the assumption that a value of
2329 enumerated type can only be one of the values of the enumeration (as
2330 defined in the C++ standard; basically, a value that can be
2331 represented in the minimum number of bits needed to represent all the
2332 enumerators).  This assumption may not be valid if the program uses a
2333 cast to convert an arbitrary integer value to the enumerated type.
2335 @item -ftemplate-backtrace-limit=@var{n}
2336 @opindex ftemplate-backtrace-limit
2337 Set the maximum number of template instantiation notes for a single
2338 warning or error to @var{n}.  The default value is 10.
2340 @item -ftemplate-depth=@var{n}
2341 @opindex ftemplate-depth
2342 Set the maximum instantiation depth for template classes to @var{n}.
2343 A limit on the template instantiation depth is needed to detect
2344 endless recursions during template class instantiation.  ANSI/ISO C++
2345 conforming programs must not rely on a maximum depth greater than 17
2346 (changed to 1024 in C++11).  The default value is 900, as the compiler
2347 can run out of stack space before hitting 1024 in some situations.
2349 @item -fno-threadsafe-statics
2350 @opindex fno-threadsafe-statics
2351 Do not emit the extra code to use the routines specified in the C++
2352 ABI for thread-safe initialization of local statics.  You can use this
2353 option to reduce code size slightly in code that doesn't need to be
2354 thread-safe.
2356 @item -fuse-cxa-atexit
2357 @opindex fuse-cxa-atexit
2358 Register destructors for objects with static storage duration with the
2359 @code{__cxa_atexit} function rather than the @code{atexit} function.
2360 This option is required for fully standards-compliant handling of static
2361 destructors, but only works if your C library supports
2362 @code{__cxa_atexit}.
2364 @item -fno-use-cxa-get-exception-ptr
2365 @opindex fno-use-cxa-get-exception-ptr
2366 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2367 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2368 if the runtime routine is not available.
2370 @item -fvisibility-inlines-hidden
2371 @opindex fvisibility-inlines-hidden
2372 This switch declares that the user does not attempt to compare
2373 pointers to inline functions or methods where the addresses of the two functions
2374 are taken in different shared objects.
2376 The effect of this is that GCC may, effectively, mark inline methods with
2377 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2378 appear in the export table of a DSO and do not require a PLT indirection
2379 when used within the DSO@.  Enabling this option can have a dramatic effect
2380 on load and link times of a DSO as it massively reduces the size of the
2381 dynamic export table when the library makes heavy use of templates.
2383 The behavior of this switch is not quite the same as marking the
2384 methods as hidden directly, because it does not affect static variables
2385 local to the function or cause the compiler to deduce that
2386 the function is defined in only one shared object.
2388 You may mark a method as having a visibility explicitly to negate the
2389 effect of the switch for that method.  For example, if you do want to
2390 compare pointers to a particular inline method, you might mark it as
2391 having default visibility.  Marking the enclosing class with explicit
2392 visibility has no effect.
2394 Explicitly instantiated inline methods are unaffected by this option
2395 as their linkage might otherwise cross a shared library boundary.
2396 @xref{Template Instantiation}.
2398 @item -fvisibility-ms-compat
2399 @opindex fvisibility-ms-compat
2400 This flag attempts to use visibility settings to make GCC's C++
2401 linkage model compatible with that of Microsoft Visual Studio.
2403 The flag makes these changes to GCC's linkage model:
2405 @enumerate
2406 @item
2407 It sets the default visibility to @code{hidden}, like
2408 @option{-fvisibility=hidden}.
2410 @item
2411 Types, but not their members, are not hidden by default.
2413 @item
2414 The One Definition Rule is relaxed for types without explicit
2415 visibility specifications that are defined in more than one
2416 shared object: those declarations are permitted if they are
2417 permitted when this option is not used.
2418 @end enumerate
2420 In new code it is better to use @option{-fvisibility=hidden} and
2421 export those classes that are intended to be externally visible.
2422 Unfortunately it is possible for code to rely, perhaps accidentally,
2423 on the Visual Studio behavior.
2425 Among the consequences of these changes are that static data members
2426 of the same type with the same name but defined in different shared
2427 objects are different, so changing one does not change the other;
2428 and that pointers to function members defined in different shared
2429 objects may not compare equal.  When this flag is given, it is a
2430 violation of the ODR to define types with the same name differently.
2432 @item -fvtable-verify=@var{std|preinit|none}
2433 @opindex fvtable-verify
2434 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2435 feature that verifies at runtime, for every virtual call that is made, that
2436 the vtable pointer through which the call is made is valid for the type of
2437 the object, and has not been corrupted or overwritten.  If an invalid vtable
2438 pointer is detected (at runtime), an error is reported and execution of the
2439 program is immediately halted.
2441 This option causes runtime data structures to be built, at program start up,
2442 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2443 control the timing of when these data structures are built.  In both cases the
2444 data structures are built before execution reaches 'main'.  The
2445 @option{-fvtable-verify=std} causes these data structure to be built after the
2446 shared libraries have been loaded and initialized.
2447 @option{-fvtable-verify=preinit} causes them to be built before the shared
2448 libraries have been loaded and initialized.
2450 If this option appears multiple times in the compiler line, with different
2451 values specified, 'none' will take highest priority over both 'std' and
2452 'preinit'; 'preinit' will take priority over 'std'.
2454 @item -fvtv-debug
2455 @opindex (fvtv-debug)
2456 Causes debug versions of the runtime functions for the vtable verification 
2457 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2458 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2459 compiler to keep track of which vtable pointers it found for each class, and
2460 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2461 file directory on the user's machine.
2463 Note:  This feature APPENDS data to the log file. If you want a fresh log
2464 file, be sure to delete any existing one.
2466 @item -fvtv-counts
2467 @opindex fvtv-counts
2468 This is a debugging flag.  When used in conjunction with
2469 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2470 causes the compiler to keep track of the total number of virtual calls
2471 it encountered and the number of verifications it inserted.  It also
2472 counts the number of calls to certain runtime library functions
2473 that it inserts.  This information, for each compilation unit, is written
2474 to a file named ``vtv_count_data.log'', in the dump_file directory on
2475 the user's machine.   It also counts the size of the vtable pointer sets
2476 for each class, and writes this information to ``vtv_class_set_sizes.log''
2477 in the same directory.
2479 Note:  This feature APPENDS data to the log files.  To get a fresh log
2480 files, be sure to delete any existing ones.
2482 @item -fno-weak
2483 @opindex fno-weak
2484 Do not use weak symbol support, even if it is provided by the linker.
2485 By default, G++ uses weak symbols if they are available.  This
2486 option exists only for testing, and should not be used by end-users;
2487 it results in inferior code and has no benefits.  This option may
2488 be removed in a future release of G++.
2490 @item -nostdinc++
2491 @opindex nostdinc++
2492 Do not search for header files in the standard directories specific to
2493 C++, but do still search the other standard directories.  (This option
2494 is used when building the C++ library.)
2495 @end table
2497 In addition, these optimization, warning, and code generation options
2498 have meanings only for C++ programs:
2500 @table @gcctabopt
2501 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2502 @opindex Wabi
2503 @opindex Wno-abi
2504 When an explicit @option{-fabi-version=@var{n}} option is used, causes
2505 G++ to warn when it generates code that is probably not compatible with the
2506 vendor-neutral C++ ABI@.  Since G++ now defaults to
2507 @option{-fabi-version=0}, @option{-Wabi} has no effect unless either
2508 an older ABI version is selected (with @option{-fabi-version=@var{n}})
2509 or an older compatibility version is selected (with
2510 @option{-Wabi=@var{n}} or @option{-fabi-compat-version=@var{n}}).
2512 Although an effort has been made to warn about
2513 all such cases, there are probably some cases that are not warned about,
2514 even though G++ is generating incompatible code.  There may also be
2515 cases where warnings are emitted even though the code that is generated
2516 is compatible.
2518 You should rewrite your code to avoid these warnings if you are
2519 concerned about the fact that code generated by G++ may not be binary
2520 compatible with code generated by other compilers.
2522 @option{-Wabi} can also be used with an explicit version number to
2523 warn about compatibility with a particular @option{-fabi-version}
2524 level, e.g. @option{-Wabi=2} to warn about changes relative to
2525 @option{-fabi-version=2}.  Specifying a version number also sets
2526 @option{-fabi-compat-version=@var{n}}.
2528 The known incompatibilities in @option{-fabi-version=2} (which was the
2529 default from GCC 3.4 to 4.9) include:
2531 @itemize @bullet
2533 @item
2534 A template with a non-type template parameter of reference type was
2535 mangled incorrectly:
2536 @smallexample
2537 extern int N;
2538 template <int &> struct S @{@};
2539 void n (S<N>) @{2@}
2540 @end smallexample
2542 This was fixed in @option{-fabi-version=3}.
2544 @item
2545 SIMD vector types declared using @code{__attribute ((vector_size))} were
2546 mangled in a non-standard way that does not allow for overloading of
2547 functions taking vectors of different sizes.
2549 The mangling was changed in @option{-fabi-version=4}.
2551 @item
2552 @code{__attribute ((const))} and @code{noreturn} were mangled as type
2553 qualifiers, and @code{decltype} of a plain declaration was folded away.
2555 These mangling issues were fixed in @option{-fabi-version=5}.
2557 @item
2558 Scoped enumerators passed as arguments to a variadic function are
2559 promoted like unscoped enumerators, causing @samp{va_arg} to complain.
2560 On most targets this does not actually affect the parameter passing
2561 ABI, as there is no way to pass an argument smaller than @samp{int}.
2563 Also, the ABI changed the mangling of template argument packs,
2564 @code{const_cast}, @code{static_cast}, prefix increment/decrement, and
2565 a class scope function used as a template argument.
2567 These issues were corrected in @option{-fabi-version=6}.
2569 @item
2570 Lambdas in default argument scope were mangled incorrectly, and the
2571 ABI changed the mangling of nullptr_t.
2573 These issues were corrected in @option{-fabi-version=7}.
2575 @item
2576 When mangling a function type with function-cv-qualifiers, the
2577 un-qualified function type was incorrectly treated as a substitution
2578 candidate.
2580 This was fixed in @option{-fabi-version=8}.
2581 @end itemize
2583 It also warns about psABI-related changes.  The known psABI changes at this
2584 point include:
2586 @itemize @bullet
2588 @item
2589 For SysV/x86-64, unions with @code{long double} members are 
2590 passed in memory as specified in psABI.  For example:
2592 @smallexample
2593 union U @{
2594   long double ld;
2595   int i;
2597 @end smallexample
2599 @noindent
2600 @code{union U} is always passed in memory.
2602 @end itemize
2604 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2605 @opindex Wctor-dtor-privacy
2606 @opindex Wno-ctor-dtor-privacy
2607 Warn when a class seems unusable because all the constructors or
2608 destructors in that class are private, and it has neither friends nor
2609 public static member functions.  Also warn if there are no non-private
2610 methods, and there's at least one private member function that isn't
2611 a constructor or destructor.
2613 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2614 @opindex Wdelete-non-virtual-dtor
2615 @opindex Wno-delete-non-virtual-dtor
2616 Warn when @samp{delete} is used to destroy an instance of a class that
2617 has virtual functions and non-virtual destructor. It is unsafe to delete
2618 an instance of a derived class through a pointer to a base class if the
2619 base class does not have a virtual destructor.  This warning is enabled
2620 by @option{-Wall}.
2622 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2623 @opindex Wliteral-suffix
2624 @opindex Wno-literal-suffix
2625 Warn when a string or character literal is followed by a ud-suffix which does
2626 not begin with an underscore.  As a conforming extension, GCC treats such
2627 suffixes as separate preprocessing tokens in order to maintain backwards
2628 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2629 For example:
2631 @smallexample
2632 #define __STDC_FORMAT_MACROS
2633 #include <inttypes.h>
2634 #include <stdio.h>
2636 int main() @{
2637   int64_t i64 = 123;
2638   printf("My int64: %"PRId64"\n", i64);
2640 @end smallexample
2642 In this case, @code{PRId64} is treated as a separate preprocessing token.
2644 This warning is enabled by default.
2646 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2647 @opindex Wnarrowing
2648 @opindex Wno-narrowing
2649 Warn when a narrowing conversion prohibited by C++11 occurs within
2650 @samp{@{ @}}, e.g.
2652 @smallexample
2653 int i = @{ 2.2 @}; // error: narrowing from double to int
2654 @end smallexample
2656 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2658 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses for
2659 non-constants the diagnostic required by the standard.  Note that this
2660 does not affect the meaning of well-formed code; narrowing conversions
2661 are still considered ill-formed in SFINAE context.
2663 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2664 @opindex Wnoexcept
2665 @opindex Wno-noexcept
2666 Warn when a noexcept-expression evaluates to false because of a call
2667 to a function that does not have a non-throwing exception
2668 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2669 the compiler to never throw an exception.
2671 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2672 @opindex Wnon-virtual-dtor
2673 @opindex Wno-non-virtual-dtor
2674 Warn when a class has virtual functions and an accessible non-virtual
2675 destructor itself or in an accessible polymorphic base class, in which
2676 case it is possible but unsafe to delete an instance of a derived
2677 class through a pointer to the class itself or base class.  This
2678 warning is automatically enabled if @option{-Weffc++} is specified.
2680 @item -Wreorder @r{(C++ and Objective-C++ only)}
2681 @opindex Wreorder
2682 @opindex Wno-reorder
2683 @cindex reordering, warning
2684 @cindex warning for reordering of member initializers
2685 Warn when the order of member initializers given in the code does not
2686 match the order in which they must be executed.  For instance:
2688 @smallexample
2689 struct A @{
2690   int i;
2691   int j;
2692   A(): j (0), i (1) @{ @}
2694 @end smallexample
2696 @noindent
2697 The compiler rearranges the member initializers for @samp{i}
2698 and @samp{j} to match the declaration order of the members, emitting
2699 a warning to that effect.  This warning is enabled by @option{-Wall}.
2701 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2702 @opindex fext-numeric-literals
2703 @opindex fno-ext-numeric-literals
2704 Accept imaginary, fixed-point, or machine-defined
2705 literal number suffixes as GNU extensions.
2706 When this option is turned off these suffixes are treated
2707 as C++11 user-defined literal numeric suffixes.
2708 This is on by default for all pre-C++11 dialects and all GNU dialects:
2709 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2710 @option{-std=gnu++14}.
2711 This option is off by default
2712 for ISO C++11 onwards (@option{-std=c++11}, ...).
2713 @end table
2715 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2717 @table @gcctabopt
2718 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2719 @opindex Weffc++
2720 @opindex Wno-effc++
2721 Warn about violations of the following style guidelines from Scott Meyers'
2722 @cite{Effective C++} series of books:
2724 @itemize @bullet
2725 @item
2726 Define a copy constructor and an assignment operator for classes
2727 with dynamically-allocated memory.
2729 @item
2730 Prefer initialization to assignment in constructors.
2732 @item
2733 Have @code{operator=} return a reference to @code{*this}.
2735 @item
2736 Don't try to return a reference when you must return an object.
2738 @item
2739 Distinguish between prefix and postfix forms of increment and
2740 decrement operators.
2742 @item
2743 Never overload @code{&&}, @code{||}, or @code{,}.
2745 @end itemize
2747 This option also enables @option{-Wnon-virtual-dtor}, which is also
2748 one of the effective C++ recommendations.  However, the check is
2749 extended to warn about the lack of virtual destructor in accessible
2750 non-polymorphic bases classes too.
2752 When selecting this option, be aware that the standard library
2753 headers do not obey all of these guidelines; use @samp{grep -v}
2754 to filter out those warnings.
2756 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2757 @opindex Wstrict-null-sentinel
2758 @opindex Wno-strict-null-sentinel
2759 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2760 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2761 to @code{__null}.  Although it is a null pointer constant rather than a
2762 null pointer, it is guaranteed to be of the same size as a pointer.
2763 But this use is not portable across different compilers.
2765 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2766 @opindex Wno-non-template-friend
2767 @opindex Wnon-template-friend
2768 Disable warnings when non-templatized friend functions are declared
2769 within a template.  Since the advent of explicit template specification
2770 support in G++, if the name of the friend is an unqualified-id (i.e.,
2771 @samp{friend foo(int)}), the C++ language specification demands that the
2772 friend declare or define an ordinary, nontemplate function.  (Section
2773 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2774 could be interpreted as a particular specialization of a templatized
2775 function.  Because this non-conforming behavior is no longer the default
2776 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2777 check existing code for potential trouble spots and is on by default.
2778 This new compiler behavior can be turned off with
2779 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2780 but disables the helpful warning.
2782 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2783 @opindex Wold-style-cast
2784 @opindex Wno-old-style-cast
2785 Warn if an old-style (C-style) cast to a non-void type is used within
2786 a C++ program.  The new-style casts (@samp{dynamic_cast},
2787 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2788 less vulnerable to unintended effects and much easier to search for.
2790 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2791 @opindex Woverloaded-virtual
2792 @opindex Wno-overloaded-virtual
2793 @cindex overloaded virtual function, warning
2794 @cindex warning for overloaded virtual function
2795 Warn when a function declaration hides virtual functions from a
2796 base class.  For example, in:
2798 @smallexample
2799 struct A @{
2800   virtual void f();
2803 struct B: public A @{
2804   void f(int);
2806 @end smallexample
2808 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2809 like:
2811 @smallexample
2812 B* b;
2813 b->f();
2814 @end smallexample
2816 @noindent
2817 fails to compile.
2819 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2820 @opindex Wno-pmf-conversions
2821 @opindex Wpmf-conversions
2822 Disable the diagnostic for converting a bound pointer to member function
2823 to a plain pointer.
2825 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2826 @opindex Wsign-promo
2827 @opindex Wno-sign-promo
2828 Warn when overload resolution chooses a promotion from unsigned or
2829 enumerated type to a signed type, over a conversion to an unsigned type of
2830 the same size.  Previous versions of G++ tried to preserve
2831 unsignedness, but the standard mandates the current behavior.
2832 @end table
2834 @node Objective-C and Objective-C++ Dialect Options
2835 @section Options Controlling Objective-C and Objective-C++ Dialects
2837 @cindex compiler options, Objective-C and Objective-C++
2838 @cindex Objective-C and Objective-C++ options, command-line
2839 @cindex options, Objective-C and Objective-C++
2840 (NOTE: This manual does not describe the Objective-C and Objective-C++
2841 languages themselves.  @xref{Standards,,Language Standards
2842 Supported by GCC}, for references.)
2844 This section describes the command-line options that are only meaningful
2845 for Objective-C and Objective-C++ programs.  You can also use most of
2846 the language-independent GNU compiler options.
2847 For example, you might compile a file @code{some_class.m} like this:
2849 @smallexample
2850 gcc -g -fgnu-runtime -O -c some_class.m
2851 @end smallexample
2853 @noindent
2854 In this example, @option{-fgnu-runtime} is an option meant only for
2855 Objective-C and Objective-C++ programs; you can use the other options with
2856 any language supported by GCC@.
2858 Note that since Objective-C is an extension of the C language, Objective-C
2859 compilations may also use options specific to the C front-end (e.g.,
2860 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2861 C++-specific options (e.g., @option{-Wabi}).
2863 Here is a list of options that are @emph{only} for compiling Objective-C
2864 and Objective-C++ programs:
2866 @table @gcctabopt
2867 @item -fconstant-string-class=@var{class-name}
2868 @opindex fconstant-string-class
2869 Use @var{class-name} as the name of the class to instantiate for each
2870 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2871 class name is @code{NXConstantString} if the GNU runtime is being used, and
2872 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2873 @option{-fconstant-cfstrings} option, if also present, overrides the
2874 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2875 to be laid out as constant CoreFoundation strings.
2877 @item -fgnu-runtime
2878 @opindex fgnu-runtime
2879 Generate object code compatible with the standard GNU Objective-C
2880 runtime.  This is the default for most types of systems.
2882 @item -fnext-runtime
2883 @opindex fnext-runtime
2884 Generate output compatible with the NeXT runtime.  This is the default
2885 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2886 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2887 used.
2889 @item -fno-nil-receivers
2890 @opindex fno-nil-receivers
2891 Assume that all Objective-C message dispatches (@code{[receiver
2892 message:arg]}) in this translation unit ensure that the receiver is
2893 not @code{nil}.  This allows for more efficient entry points in the
2894 runtime to be used.  This option is only available in conjunction with
2895 the NeXT runtime and ABI version 0 or 1.
2897 @item -fobjc-abi-version=@var{n}
2898 @opindex fobjc-abi-version
2899 Use version @var{n} of the Objective-C ABI for the selected runtime.
2900 This option is currently supported only for the NeXT runtime.  In that
2901 case, Version 0 is the traditional (32-bit) ABI without support for
2902 properties and other Objective-C 2.0 additions.  Version 1 is the
2903 traditional (32-bit) ABI with support for properties and other
2904 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2905 nothing is specified, the default is Version 0 on 32-bit target
2906 machines, and Version 2 on 64-bit target machines.
2908 @item -fobjc-call-cxx-cdtors
2909 @opindex fobjc-call-cxx-cdtors
2910 For each Objective-C class, check if any of its instance variables is a
2911 C++ object with a non-trivial default constructor.  If so, synthesize a
2912 special @code{- (id) .cxx_construct} instance method which runs
2913 non-trivial default constructors on any such instance variables, in order,
2914 and then return @code{self}.  Similarly, check if any instance variable
2915 is a C++ object with a non-trivial destructor, and if so, synthesize a
2916 special @code{- (void) .cxx_destruct} method which runs
2917 all such default destructors, in reverse order.
2919 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2920 methods thusly generated only operate on instance variables
2921 declared in the current Objective-C class, and not those inherited
2922 from superclasses.  It is the responsibility of the Objective-C
2923 runtime to invoke all such methods in an object's inheritance
2924 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2925 by the runtime immediately after a new object instance is allocated;
2926 the @code{- (void) .cxx_destruct} methods are invoked immediately
2927 before the runtime deallocates an object instance.
2929 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2930 support for invoking the @code{- (id) .cxx_construct} and
2931 @code{- (void) .cxx_destruct} methods.
2933 @item -fobjc-direct-dispatch
2934 @opindex fobjc-direct-dispatch
2935 Allow fast jumps to the message dispatcher.  On Darwin this is
2936 accomplished via the comm page.
2938 @item -fobjc-exceptions
2939 @opindex fobjc-exceptions
2940 Enable syntactic support for structured exception handling in
2941 Objective-C, similar to what is offered by C++ and Java.  This option
2942 is required to use the Objective-C keywords @code{@@try},
2943 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2944 @code{@@synchronized}.  This option is available with both the GNU
2945 runtime and the NeXT runtime (but not available in conjunction with
2946 the NeXT runtime on Mac OS X 10.2 and earlier).
2948 @item -fobjc-gc
2949 @opindex fobjc-gc
2950 Enable garbage collection (GC) in Objective-C and Objective-C++
2951 programs.  This option is only available with the NeXT runtime; the
2952 GNU runtime has a different garbage collection implementation that
2953 does not require special compiler flags.
2955 @item -fobjc-nilcheck
2956 @opindex fobjc-nilcheck
2957 For the NeXT runtime with version 2 of the ABI, check for a nil
2958 receiver in method invocations before doing the actual method call.
2959 This is the default and can be disabled using
2960 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2961 checked for nil in this way no matter what this flag is set to.
2962 Currently this flag does nothing when the GNU runtime, or an older
2963 version of the NeXT runtime ABI, is used.
2965 @item -fobjc-std=objc1
2966 @opindex fobjc-std
2967 Conform to the language syntax of Objective-C 1.0, the language
2968 recognized by GCC 4.0.  This only affects the Objective-C additions to
2969 the C/C++ language; it does not affect conformance to C/C++ standards,
2970 which is controlled by the separate C/C++ dialect option flags.  When
2971 this option is used with the Objective-C or Objective-C++ compiler,
2972 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2973 This is useful if you need to make sure that your Objective-C code can
2974 be compiled with older versions of GCC@.
2976 @item -freplace-objc-classes
2977 @opindex freplace-objc-classes
2978 Emit a special marker instructing @command{ld(1)} not to statically link in
2979 the resulting object file, and allow @command{dyld(1)} to load it in at
2980 run time instead.  This is used in conjunction with the Fix-and-Continue
2981 debugging mode, where the object file in question may be recompiled and
2982 dynamically reloaded in the course of program execution, without the need
2983 to restart the program itself.  Currently, Fix-and-Continue functionality
2984 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2985 and later.
2987 @item -fzero-link
2988 @opindex fzero-link
2989 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2990 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2991 compile time) with static class references that get initialized at load time,
2992 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2993 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2994 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2995 for individual class implementations to be modified during program execution.
2996 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2997 regardless of command-line options.
2999 @item -fno-local-ivars
3000 @opindex fno-local-ivars
3001 @opindex flocal-ivars
3002 By default instance variables in Objective-C can be accessed as if
3003 they were local variables from within the methods of the class they're
3004 declared in.  This can lead to shadowing between instance variables
3005 and other variables declared either locally inside a class method or
3006 globally with the same name.  Specifying the @option{-fno-local-ivars}
3007 flag disables this behavior thus avoiding variable shadowing issues.
3009 @item -fivar-visibility=@var{public|protected|private|package}
3010 @opindex fivar-visibility
3011 Set the default instance variable visibility to the specified option
3012 so that instance variables declared outside the scope of any access
3013 modifier directives default to the specified visibility.
3015 @item -gen-decls
3016 @opindex gen-decls
3017 Dump interface declarations for all classes seen in the source file to a
3018 file named @file{@var{sourcename}.decl}.
3020 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
3021 @opindex Wassign-intercept
3022 @opindex Wno-assign-intercept
3023 Warn whenever an Objective-C assignment is being intercepted by the
3024 garbage collector.
3026 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
3027 @opindex Wno-protocol
3028 @opindex Wprotocol
3029 If a class is declared to implement a protocol, a warning is issued for
3030 every method in the protocol that is not implemented by the class.  The
3031 default behavior is to issue a warning for every method not explicitly
3032 implemented in the class, even if a method implementation is inherited
3033 from the superclass.  If you use the @option{-Wno-protocol} option, then
3034 methods inherited from the superclass are considered to be implemented,
3035 and no warning is issued for them.
3037 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3038 @opindex Wselector
3039 @opindex Wno-selector
3040 Warn if multiple methods of different types for the same selector are
3041 found during compilation.  The check is performed on the list of methods
3042 in the final stage of compilation.  Additionally, a check is performed
3043 for each selector appearing in a @code{@@selector(@dots{})}
3044 expression, and a corresponding method for that selector has been found
3045 during compilation.  Because these checks scan the method table only at
3046 the end of compilation, these warnings are not produced if the final
3047 stage of compilation is not reached, for example because an error is
3048 found during compilation, or because the @option{-fsyntax-only} option is
3049 being used.
3051 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3052 @opindex Wstrict-selector-match
3053 @opindex Wno-strict-selector-match
3054 Warn if multiple methods with differing argument and/or return types are
3055 found for a given selector when attempting to send a message using this
3056 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3057 is off (which is the default behavior), the compiler omits such warnings
3058 if any differences found are confined to types that share the same size
3059 and alignment.
3061 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3062 @opindex Wundeclared-selector
3063 @opindex Wno-undeclared-selector
3064 Warn if a @code{@@selector(@dots{})} expression referring to an
3065 undeclared selector is found.  A selector is considered undeclared if no
3066 method with that name has been declared before the
3067 @code{@@selector(@dots{})} expression, either explicitly in an
3068 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3069 an @code{@@implementation} section.  This option always performs its
3070 checks as soon as a @code{@@selector(@dots{})} expression is found,
3071 while @option{-Wselector} only performs its checks in the final stage of
3072 compilation.  This also enforces the coding style convention
3073 that methods and selectors must be declared before being used.
3075 @item -print-objc-runtime-info
3076 @opindex print-objc-runtime-info
3077 Generate C header describing the largest structure that is passed by
3078 value, if any.
3080 @end table
3082 @node Language Independent Options
3083 @section Options to Control Diagnostic Messages Formatting
3084 @cindex options to control diagnostics formatting
3085 @cindex diagnostic messages
3086 @cindex message formatting
3088 Traditionally, diagnostic messages have been formatted irrespective of
3089 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3090 options described below
3091 to control the formatting algorithm for diagnostic messages, 
3092 e.g.@: how many characters per line, how often source location
3093 information should be reported.  Note that some language front ends may not
3094 honor these options.
3096 @table @gcctabopt
3097 @item -fmessage-length=@var{n}
3098 @opindex fmessage-length
3099 Try to format error messages so that they fit on lines of about
3100 @var{n} characters.  If @var{n} is zero, then no line-wrapping will be
3101 done; each error message will appear on a single line.  This is the
3102 default for all front ends.
3104 @item -fdiagnostics-show-location=once
3105 @opindex fdiagnostics-show-location
3106 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3107 reporter to emit source location information @emph{once}; that is, in
3108 case the message is too long to fit on a single physical line and has to
3109 be wrapped, the source location won't be emitted (as prefix) again,
3110 over and over, in subsequent continuation lines.  This is the default
3111 behavior.
3113 @item -fdiagnostics-show-location=every-line
3114 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3115 messages reporter to emit the same source location information (as
3116 prefix) for physical lines that result from the process of breaking
3117 a message which is too long to fit on a single line.
3119 @item -fdiagnostics-color[=@var{WHEN}]
3120 @itemx -fno-diagnostics-color
3121 @opindex fdiagnostics-color
3122 @cindex highlight, color, colour
3123 @vindex GCC_COLORS @r{environment variable}
3124 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3125 or @samp{auto}.  The default depends on how the compiler has been configured,
3126 it can be any of the above @var{WHEN} options or also @samp{never}
3127 if @env{GCC_COLORS} environment variable isn't present in the environment,
3128 and @samp{auto} otherwise.
3129 @samp{auto} means to use color only when the standard error is a terminal.
3130 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3131 aliases for @option{-fdiagnostics-color=always} and
3132 @option{-fdiagnostics-color=never}, respectively.
3134 The colors are defined by the environment variable @env{GCC_COLORS}.
3135 Its value is a colon-separated list of capabilities and Select Graphic
3136 Rendition (SGR) substrings. SGR commands are interpreted by the
3137 terminal or terminal emulator.  (See the section in the documentation
3138 of your text terminal for permitted values and their meanings as
3139 character attributes.)  These substring values are integers in decimal
3140 representation and can be concatenated with semicolons.
3141 Common values to concatenate include
3142 @samp{1} for bold,
3143 @samp{4} for underline,
3144 @samp{5} for blink,
3145 @samp{7} for inverse,
3146 @samp{39} for default foreground color,
3147 @samp{30} to @samp{37} for foreground colors,
3148 @samp{90} to @samp{97} for 16-color mode foreground colors,
3149 @samp{38;5;0} to @samp{38;5;255}
3150 for 88-color and 256-color modes foreground colors,
3151 @samp{49} for default background color,
3152 @samp{40} to @samp{47} for background colors,
3153 @samp{100} to @samp{107} for 16-color mode background colors,
3154 and @samp{48;5;0} to @samp{48;5;255}
3155 for 88-color and 256-color modes background colors.
3157 The default @env{GCC_COLORS} is
3158 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3159 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3160 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3161 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3162 string disables colors.
3163 Supported capabilities are as follows.
3165 @table @code
3166 @item error=
3167 @vindex error GCC_COLORS @r{capability}
3168 SGR substring for error: markers.
3170 @item warning=
3171 @vindex warning GCC_COLORS @r{capability}
3172 SGR substring for warning: markers.
3174 @item note=
3175 @vindex note GCC_COLORS @r{capability}
3176 SGR substring for note: markers.
3178 @item caret=
3179 @vindex caret GCC_COLORS @r{capability}
3180 SGR substring for caret line.
3182 @item locus=
3183 @vindex locus GCC_COLORS @r{capability}
3184 SGR substring for location information, @samp{file:line} or
3185 @samp{file:line:column} etc.
3187 @item quote=
3188 @vindex quote GCC_COLORS @r{capability}
3189 SGR substring for information printed within quotes.
3190 @end table
3192 @item -fno-diagnostics-show-option
3193 @opindex fno-diagnostics-show-option
3194 @opindex fdiagnostics-show-option
3195 By default, each diagnostic emitted includes text indicating the
3196 command-line option that directly controls the diagnostic (if such an
3197 option is known to the diagnostic machinery).  Specifying the
3198 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3200 @item -fno-diagnostics-show-caret
3201 @opindex fno-diagnostics-show-caret
3202 @opindex fdiagnostics-show-caret
3203 By default, each diagnostic emitted includes the original source line
3204 and a caret '^' indicating the column.  This option suppresses this
3205 information.  The source line is truncated to @var{n} characters, if
3206 the @option{-fmessage-length=n} is given.  When the output is done
3207 to the terminal, the width is limited to the width given by the
3208 @env{COLUMNS} environment variable or, if not set, to the terminal width.
3210 @end table
3212 @node Warning Options
3213 @section Options to Request or Suppress Warnings
3214 @cindex options to control warnings
3215 @cindex warning messages
3216 @cindex messages, warning
3217 @cindex suppressing warnings
3219 Warnings are diagnostic messages that report constructions that
3220 are not inherently erroneous but that are risky or suggest there
3221 may have been an error.
3223 The following language-independent options do not enable specific
3224 warnings but control the kinds of diagnostics produced by GCC@.
3226 @table @gcctabopt
3227 @cindex syntax checking
3228 @item -fsyntax-only
3229 @opindex fsyntax-only
3230 Check the code for syntax errors, but don't do anything beyond that.
3232 @item -fmax-errors=@var{n}
3233 @opindex fmax-errors
3234 Limits the maximum number of error messages to @var{n}, at which point
3235 GCC bails out rather than attempting to continue processing the source
3236 code.  If @var{n} is 0 (the default), there is no limit on the number
3237 of error messages produced.  If @option{-Wfatal-errors} is also
3238 specified, then @option{-Wfatal-errors} takes precedence over this
3239 option.
3241 @item -w
3242 @opindex w
3243 Inhibit all warning messages.
3245 @item -Werror
3246 @opindex Werror
3247 @opindex Wno-error
3248 Make all warnings into errors.
3250 @item -Werror=
3251 @opindex Werror=
3252 @opindex Wno-error=
3253 Make the specified warning into an error.  The specifier for a warning
3254 is appended; for example @option{-Werror=switch} turns the warnings
3255 controlled by @option{-Wswitch} into errors.  This switch takes a
3256 negative form, to be used to negate @option{-Werror} for specific
3257 warnings; for example @option{-Wno-error=switch} makes
3258 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3259 is in effect.
3261 The warning message for each controllable warning includes the
3262 option that controls the warning.  That option can then be used with
3263 @option{-Werror=} and @option{-Wno-error=} as described above.
3264 (Printing of the option in the warning message can be disabled using the
3265 @option{-fno-diagnostics-show-option} flag.)
3267 Note that specifying @option{-Werror=}@var{foo} automatically implies
3268 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3269 imply anything.
3271 @item -Wfatal-errors
3272 @opindex Wfatal-errors
3273 @opindex Wno-fatal-errors
3274 This option causes the compiler to abort compilation on the first error
3275 occurred rather than trying to keep going and printing further error
3276 messages.
3278 @end table
3280 You can request many specific warnings with options beginning with
3281 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3282 implicit declarations.  Each of these specific warning options also
3283 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3284 example, @option{-Wno-implicit}.  This manual lists only one of the
3285 two forms, whichever is not the default.  For further
3286 language-specific options also refer to @ref{C++ Dialect Options} and
3287 @ref{Objective-C and Objective-C++ Dialect Options}.
3289 Some options, such as @option{-Wall} and @option{-Wextra}, turn on other
3290 options, such as @option{-Wunused}, which may turn on further options,
3291 such as @option{-Wunused-value}. The combined effect of positive and
3292 negative forms is that more specific options have priority over less
3293 specific ones, independently of their position in the command-line. For
3294 options of the same specificity, the last one takes effect. Options
3295 enabled or disabled via pragmas (@pxref{Diagnostic Pragmas}) take effect
3296 as if they appeared at the end of the command-line.
3298 When an unrecognized warning option is requested (e.g.,
3299 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3300 that the option is not recognized.  However, if the @option{-Wno-} form
3301 is used, the behavior is slightly different: no diagnostic is
3302 produced for @option{-Wno-unknown-warning} unless other diagnostics
3303 are being produced.  This allows the use of new @option{-Wno-} options
3304 with old compilers, but if something goes wrong, the compiler
3305 warns that an unrecognized option is present.
3307 @table @gcctabopt
3308 @item -Wpedantic
3309 @itemx -pedantic
3310 @opindex pedantic
3311 @opindex Wpedantic
3312 Issue all the warnings demanded by strict ISO C and ISO C++;
3313 reject all programs that use forbidden extensions, and some other
3314 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3315 version of the ISO C standard specified by any @option{-std} option used.
3317 Valid ISO C and ISO C++ programs should compile properly with or without
3318 this option (though a rare few require @option{-ansi} or a
3319 @option{-std} option specifying the required version of ISO C)@.  However,
3320 without this option, certain GNU extensions and traditional C and C++
3321 features are supported as well.  With this option, they are rejected.
3323 @option{-Wpedantic} does not cause warning messages for use of the
3324 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3325 warnings are also disabled in the expression that follows
3326 @code{__extension__}.  However, only system header files should use
3327 these escape routes; application programs should avoid them.
3328 @xref{Alternate Keywords}.
3330 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3331 C conformance.  They soon find that it does not do quite what they want:
3332 it finds some non-ISO practices, but not all---only those for which
3333 ISO C @emph{requires} a diagnostic, and some others for which
3334 diagnostics have been added.
3336 A feature to report any failure to conform to ISO C might be useful in
3337 some instances, but would require considerable additional work and would
3338 be quite different from @option{-Wpedantic}.  We don't have plans to
3339 support such a feature in the near future.
3341 Where the standard specified with @option{-std} represents a GNU
3342 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3343 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3344 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3345 where they are required by the base standard.  (It does not make sense
3346 for such warnings to be given only for features not in the specified GNU
3347 C dialect, since by definition the GNU dialects of C include all
3348 features the compiler supports with the given option, and there would be
3349 nothing to warn about.)
3351 @item -pedantic-errors
3352 @opindex pedantic-errors
3353 Give an error whenever the @dfn{base standard} (see @option{-Wpedantic})
3354 requires a diagnostic, in some cases where there is undefined behavior
3355 at compile-time and in some other cases that do not prevent compilation
3356 of programs that are valid according to the standard. This is not
3357 equivalent to @option{-Werror=pedantic}, since there are errors enabled
3358 by this option and not enabled by the latter and vice versa.
3360 @item -Wall
3361 @opindex Wall
3362 @opindex Wno-all
3363 This enables all the warnings about constructions that some users
3364 consider questionable, and that are easy to avoid (or modify to
3365 prevent the warning), even in conjunction with macros.  This also
3366 enables some language-specific warnings described in @ref{C++ Dialect
3367 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3369 @option{-Wall} turns on the following warning flags:
3371 @gccoptlist{-Waddress   @gol
3372 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3373 -Wc++11-compat  -Wc++14-compat@gol
3374 -Wchar-subscripts  @gol
3375 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3376 -Wimplicit-int @r{(C and Objective-C only)} @gol
3377 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3378 -Wcomment  @gol
3379 -Wformat   @gol
3380 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3381 -Wmaybe-uninitialized @gol
3382 -Wmissing-braces @r{(only for C/ObjC)} @gol
3383 -Wnonnull  @gol
3384 -Wopenmp-simd @gol
3385 -Wparentheses  @gol
3386 -Wpointer-sign  @gol
3387 -Wreorder   @gol
3388 -Wreturn-type  @gol
3389 -Wsequence-point  @gol
3390 -Wsign-compare @r{(only in C++)}  @gol
3391 -Wstrict-aliasing  @gol
3392 -Wstrict-overflow=1  @gol
3393 -Wswitch  @gol
3394 -Wtrigraphs  @gol
3395 -Wuninitialized  @gol
3396 -Wunknown-pragmas  @gol
3397 -Wunused-function  @gol
3398 -Wunused-label     @gol
3399 -Wunused-value     @gol
3400 -Wunused-variable  @gol
3401 -Wvolatile-register-var @gol
3404 Note that some warning flags are not implied by @option{-Wall}.  Some of
3405 them warn about constructions that users generally do not consider
3406 questionable, but which occasionally you might wish to check for;
3407 others warn about constructions that are necessary or hard to avoid in
3408 some cases, and there is no simple way to modify the code to suppress
3409 the warning. Some of them are enabled by @option{-Wextra} but many of
3410 them must be enabled individually.
3412 @item -Wextra
3413 @opindex W
3414 @opindex Wextra
3415 @opindex Wno-extra
3416 This enables some extra warning flags that are not enabled by
3417 @option{-Wall}. (This option used to be called @option{-W}.  The older
3418 name is still supported, but the newer name is more descriptive.)
3420 @gccoptlist{-Wclobbered  @gol
3421 -Wempty-body  @gol
3422 -Wignored-qualifiers @gol
3423 -Wmissing-field-initializers  @gol
3424 -Wmissing-parameter-type @r{(C only)}  @gol
3425 -Wold-style-declaration @r{(C only)}  @gol
3426 -Woverride-init  @gol
3427 -Wsign-compare  @gol
3428 -Wtype-limits  @gol
3429 -Wuninitialized  @gol
3430 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3431 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3434 The option @option{-Wextra} also prints warning messages for the
3435 following cases:
3437 @itemize @bullet
3439 @item
3440 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3441 @samp{>}, or @samp{>=}.
3443 @item
3444 (C++ only) An enumerator and a non-enumerator both appear in a
3445 conditional expression.
3447 @item
3448 (C++ only) Ambiguous virtual bases.
3450 @item
3451 (C++ only) Subscripting an array that has been declared @samp{register}.
3453 @item
3454 (C++ only) Taking the address of a variable that has been declared
3455 @samp{register}.
3457 @item
3458 (C++ only) A base class is not initialized in a derived class's copy
3459 constructor.
3461 @end itemize
3463 @item -Wchar-subscripts
3464 @opindex Wchar-subscripts
3465 @opindex Wno-char-subscripts
3466 Warn if an array subscript has type @code{char}.  This is a common cause
3467 of error, as programmers often forget that this type is signed on some
3468 machines.
3469 This warning is enabled by @option{-Wall}.
3471 @item -Wcomment
3472 @opindex Wcomment
3473 @opindex Wno-comment
3474 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3475 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3476 This warning is enabled by @option{-Wall}.
3478 @item -Wno-coverage-mismatch
3479 @opindex Wno-coverage-mismatch
3480 Warn if feedback profiles do not match when using the
3481 @option{-fprofile-use} option.
3482 If a source file is changed between compiling with @option{-fprofile-gen} and
3483 with @option{-fprofile-use}, the files with the profile feedback can fail
3484 to match the source file and GCC cannot use the profile feedback
3485 information.  By default, this warning is enabled and is treated as an
3486 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3487 warning or @option{-Wno-error=coverage-mismatch} can be used to
3488 disable the error.  Disabling the error for this warning can result in
3489 poorly optimized code and is useful only in the
3490 case of very minor changes such as bug fixes to an existing code-base.
3491 Completely disabling the warning is not recommended.
3493 @item -Wno-cpp
3494 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3496 Suppress warning messages emitted by @code{#warning} directives.
3498 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3499 @opindex Wdouble-promotion
3500 @opindex Wno-double-promotion
3501 Give a warning when a value of type @code{float} is implicitly
3502 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3503 floating-point unit implement @code{float} in hardware, but emulate
3504 @code{double} in software.  On such a machine, doing computations
3505 using @code{double} values is much more expensive because of the
3506 overhead required for software emulation.
3508 It is easy to accidentally do computations with @code{double} because
3509 floating-point literals are implicitly of type @code{double}.  For
3510 example, in:
3511 @smallexample
3512 @group
3513 float area(float radius)
3515    return 3.14159 * radius * radius;
3517 @end group
3518 @end smallexample
3519 the compiler performs the entire computation with @code{double}
3520 because the floating-point literal is a @code{double}.
3522 @item -Wformat
3523 @itemx -Wformat=@var{n}
3524 @opindex Wformat
3525 @opindex Wno-format
3526 @opindex ffreestanding
3527 @opindex fno-builtin
3528 @opindex Wformat=
3529 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3530 the arguments supplied have types appropriate to the format string
3531 specified, and that the conversions specified in the format string make
3532 sense.  This includes standard functions, and others specified by format
3533 attributes (@pxref{Function Attributes}), in the @code{printf},
3534 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3535 not in the C standard) families (or other target-specific families).
3536 Which functions are checked without format attributes having been
3537 specified depends on the standard version selected, and such checks of
3538 functions without the attribute specified are disabled by
3539 @option{-ffreestanding} or @option{-fno-builtin}.
3541 The formats are checked against the format features supported by GNU
3542 libc version 2.2.  These include all ISO C90 and C99 features, as well
3543 as features from the Single Unix Specification and some BSD and GNU
3544 extensions.  Other library implementations may not support all these
3545 features; GCC does not support warning about features that go beyond a
3546 particular library's limitations.  However, if @option{-Wpedantic} is used
3547 with @option{-Wformat}, warnings are given about format features not
3548 in the selected standard version (but not for @code{strfmon} formats,
3549 since those are not in any version of the C standard).  @xref{C Dialect
3550 Options,,Options Controlling C Dialect}.
3552 @table @gcctabopt
3553 @item -Wformat=1
3554 @itemx -Wformat
3555 @opindex Wformat
3556 @opindex Wformat=1
3557 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3558 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3559 @option{-Wformat} also checks for null format arguments for several
3560 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3561 aspects of this level of format checking can be disabled by the
3562 options: @option{-Wno-format-contains-nul},
3563 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3564 @option{-Wformat} is enabled by @option{-Wall}.
3566 @item -Wno-format-contains-nul
3567 @opindex Wno-format-contains-nul
3568 @opindex Wformat-contains-nul
3569 If @option{-Wformat} is specified, do not warn about format strings that
3570 contain NUL bytes.
3572 @item -Wno-format-extra-args
3573 @opindex Wno-format-extra-args
3574 @opindex Wformat-extra-args
3575 If @option{-Wformat} is specified, do not warn about excess arguments to a
3576 @code{printf} or @code{scanf} format function.  The C standard specifies
3577 that such arguments are ignored.
3579 Where the unused arguments lie between used arguments that are
3580 specified with @samp{$} operand number specifications, normally
3581 warnings are still given, since the implementation could not know what
3582 type to pass to @code{va_arg} to skip the unused arguments.  However,
3583 in the case of @code{scanf} formats, this option suppresses the
3584 warning if the unused arguments are all pointers, since the Single
3585 Unix Specification says that such unused arguments are allowed.
3587 @item -Wno-format-zero-length
3588 @opindex Wno-format-zero-length
3589 @opindex Wformat-zero-length
3590 If @option{-Wformat} is specified, do not warn about zero-length formats.
3591 The C standard specifies that zero-length formats are allowed.
3594 @item -Wformat=2
3595 @opindex Wformat=2
3596 Enable @option{-Wformat} plus additional format checks.  Currently
3597 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3598 -Wformat-signedness -Wformat-y2k}.
3600 @item -Wformat-nonliteral
3601 @opindex Wformat-nonliteral
3602 @opindex Wno-format-nonliteral
3603 If @option{-Wformat} is specified, also warn if the format string is not a
3604 string literal and so cannot be checked, unless the format function
3605 takes its format arguments as a @code{va_list}.
3607 @item -Wformat-security
3608 @opindex Wformat-security
3609 @opindex Wno-format-security
3610 If @option{-Wformat} is specified, also warn about uses of format
3611 functions that represent possible security problems.  At present, this
3612 warns about calls to @code{printf} and @code{scanf} functions where the
3613 format string is not a string literal and there are no format arguments,
3614 as in @code{printf (foo);}.  This may be a security hole if the format
3615 string came from untrusted input and contains @samp{%n}.  (This is
3616 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3617 in future warnings may be added to @option{-Wformat-security} that are not
3618 included in @option{-Wformat-nonliteral}.)
3620 @item -Wformat-signedness
3621 @opindex Wformat-signedness
3622 @opindex Wno-format-signedness
3623 If @option{-Wformat} is specified, also warn if the format string
3624 requires an unsigned argument and the argument is signed and vice versa.
3626 @item -Wformat-y2k
3627 @opindex Wformat-y2k
3628 @opindex Wno-format-y2k
3629 If @option{-Wformat} is specified, also warn about @code{strftime}
3630 formats that may yield only a two-digit year.
3631 @end table
3633 @item -Wnonnull
3634 @opindex Wnonnull
3635 @opindex Wno-nonnull
3636 Warn about passing a null pointer for arguments marked as
3637 requiring a non-null value by the @code{nonnull} function attribute.
3639 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3640 can be disabled with the @option{-Wno-nonnull} option.
3642 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3643 @opindex Winit-self
3644 @opindex Wno-init-self
3645 Warn about uninitialized variables that are initialized with themselves.
3646 Note this option can only be used with the @option{-Wuninitialized} option.
3648 For example, GCC warns about @code{i} being uninitialized in the
3649 following snippet only when @option{-Winit-self} has been specified:
3650 @smallexample
3651 @group
3652 int f()
3654   int i = i;
3655   return i;
3657 @end group
3658 @end smallexample
3660 This warning is enabled by @option{-Wall} in C++.
3662 @item -Wimplicit-int @r{(C and Objective-C only)}
3663 @opindex Wimplicit-int
3664 @opindex Wno-implicit-int
3665 Warn when a declaration does not specify a type.
3666 This warning is enabled by @option{-Wall}.
3668 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3669 @opindex Wimplicit-function-declaration
3670 @opindex Wno-implicit-function-declaration
3671 Give a warning whenever a function is used before being declared. In
3672 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3673 enabled by default and it is made into an error by
3674 @option{-pedantic-errors}. This warning is also enabled by
3675 @option{-Wall}.
3677 @item -Wimplicit @r{(C and Objective-C only)}
3678 @opindex Wimplicit
3679 @opindex Wno-implicit
3680 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3681 This warning is enabled by @option{-Wall}.
3683 @item -Wignored-qualifiers @r{(C and C++ only)}
3684 @opindex Wignored-qualifiers
3685 @opindex Wno-ignored-qualifiers
3686 Warn if the return type of a function has a type qualifier
3687 such as @code{const}.  For ISO C such a type qualifier has no effect,
3688 since the value returned by a function is not an lvalue.
3689 For C++, the warning is only emitted for scalar types or @code{void}.
3690 ISO C prohibits qualified @code{void} return types on function
3691 definitions, so such return types always receive a warning
3692 even without this option.
3694 This warning is also enabled by @option{-Wextra}.
3696 @item -Wmain
3697 @opindex Wmain
3698 @opindex Wno-main
3699 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3700 a function with external linkage, returning int, taking either zero
3701 arguments, two, or three arguments of appropriate types.  This warning
3702 is enabled by default in C++ and is enabled by either @option{-Wall}
3703 or @option{-Wpedantic}.
3705 @item -Wmissing-braces
3706 @opindex Wmissing-braces
3707 @opindex Wno-missing-braces
3708 Warn if an aggregate or union initializer is not fully bracketed.  In
3709 the following example, the initializer for @samp{a} is not fully
3710 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3711 enabled by @option{-Wall} in C.
3713 @smallexample
3714 int a[2][2] = @{ 0, 1, 2, 3 @};
3715 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3716 @end smallexample
3718 This warning is enabled by @option{-Wall}.
3720 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3721 @opindex Wmissing-include-dirs
3722 @opindex Wno-missing-include-dirs
3723 Warn if a user-supplied include directory does not exist.
3725 @item -Wparentheses
3726 @opindex Wparentheses
3727 @opindex Wno-parentheses
3728 Warn if parentheses are omitted in certain contexts, such
3729 as when there is an assignment in a context where a truth value
3730 is expected, or when operators are nested whose precedence people
3731 often get confused about.
3733 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3734 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3735 interpretation from that of ordinary mathematical notation.
3737 Also warn about constructions where there may be confusion to which
3738 @code{if} statement an @code{else} branch belongs.  Here is an example of
3739 such a case:
3741 @smallexample
3742 @group
3744   if (a)
3745     if (b)
3746       foo ();
3747   else
3748     bar ();
3750 @end group
3751 @end smallexample
3753 In C/C++, every @code{else} branch belongs to the innermost possible
3754 @code{if} statement, which in this example is @code{if (b)}.  This is
3755 often not what the programmer expected, as illustrated in the above
3756 example by indentation the programmer chose.  When there is the
3757 potential for this confusion, GCC issues a warning when this flag
3758 is specified.  To eliminate the warning, add explicit braces around
3759 the innermost @code{if} statement so there is no way the @code{else}
3760 can belong to the enclosing @code{if}.  The resulting code
3761 looks like this:
3763 @smallexample
3764 @group
3766   if (a)
3767     @{
3768       if (b)
3769         foo ();
3770       else
3771         bar ();
3772     @}
3774 @end group
3775 @end smallexample
3777 Also warn for dangerous uses of the GNU extension to
3778 @code{?:} with omitted middle operand. When the condition
3779 in the @code{?}: operator is a boolean expression, the omitted value is
3780 always 1.  Often programmers expect it to be a value computed
3781 inside the conditional expression instead.
3783 This warning is enabled by @option{-Wall}.
3785 @item -Wsequence-point
3786 @opindex Wsequence-point
3787 @opindex Wno-sequence-point
3788 Warn about code that may have undefined semantics because of violations
3789 of sequence point rules in the C and C++ standards.
3791 The C and C++ standards define the order in which expressions in a C/C++
3792 program are evaluated in terms of @dfn{sequence points}, which represent
3793 a partial ordering between the execution of parts of the program: those
3794 executed before the sequence point, and those executed after it.  These
3795 occur after the evaluation of a full expression (one which is not part
3796 of a larger expression), after the evaluation of the first operand of a
3797 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3798 function is called (but after the evaluation of its arguments and the
3799 expression denoting the called function), and in certain other places.
3800 Other than as expressed by the sequence point rules, the order of
3801 evaluation of subexpressions of an expression is not specified.  All
3802 these rules describe only a partial order rather than a total order,
3803 since, for example, if two functions are called within one expression
3804 with no sequence point between them, the order in which the functions
3805 are called is not specified.  However, the standards committee have
3806 ruled that function calls do not overlap.
3808 It is not specified when between sequence points modifications to the
3809 values of objects take effect.  Programs whose behavior depends on this
3810 have undefined behavior; the C and C++ standards specify that ``Between
3811 the previous and next sequence point an object shall have its stored
3812 value modified at most once by the evaluation of an expression.
3813 Furthermore, the prior value shall be read only to determine the value
3814 to be stored.''.  If a program breaks these rules, the results on any
3815 particular implementation are entirely unpredictable.
3817 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3818 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3819 diagnosed by this option, and it may give an occasional false positive
3820 result, but in general it has been found fairly effective at detecting
3821 this sort of problem in programs.
3823 The standard is worded confusingly, therefore there is some debate
3824 over the precise meaning of the sequence point rules in subtle cases.
3825 Links to discussions of the problem, including proposed formal
3826 definitions, may be found on the GCC readings page, at
3827 @uref{http://gcc.gnu.org/@/readings.html}.
3829 This warning is enabled by @option{-Wall} for C and C++.
3831 @item -Wno-return-local-addr
3832 @opindex Wno-return-local-addr
3833 @opindex Wreturn-local-addr
3834 Do not warn about returning a pointer (or in C++, a reference) to a
3835 variable that goes out of scope after the function returns.
3837 @item -Wreturn-type
3838 @opindex Wreturn-type
3839 @opindex Wno-return-type
3840 Warn whenever a function is defined with a return type that defaults
3841 to @code{int}.  Also warn about any @code{return} statement with no
3842 return value in a function whose return type is not @code{void}
3843 (falling off the end of the function body is considered returning
3844 without a value), and about a @code{return} statement with an
3845 expression in a function whose return type is @code{void}.
3847 For C++, a function without return type always produces a diagnostic
3848 message, even when @option{-Wno-return-type} is specified.  The only
3849 exceptions are @samp{main} and functions defined in system headers.
3851 This warning is enabled by @option{-Wall}.
3853 @item -Wshift-count-negative
3854 @opindex Wshift-count-negative
3855 @opindex Wno-shift-count-negative
3856 Warn if shift count is negative. This warning is enabled by default.
3858 @item -Wshift-count-overflow
3859 @opindex Wshift-count-overflow
3860 @opindex Wno-shift-count-overflow
3861 Warn if shift count >= width of type. This warning is enabled by default.
3863 @item -Wswitch
3864 @opindex Wswitch
3865 @opindex Wno-switch
3866 Warn whenever a @code{switch} statement has an index of enumerated type
3867 and lacks a @code{case} for one or more of the named codes of that
3868 enumeration.  (The presence of a @code{default} label prevents this
3869 warning.)  @code{case} labels outside the enumeration range also
3870 provoke warnings when this option is used (even if there is a
3871 @code{default} label).
3872 This warning is enabled by @option{-Wall}.
3874 @item -Wswitch-default
3875 @opindex Wswitch-default
3876 @opindex Wno-switch-default
3877 Warn whenever a @code{switch} statement does not have a @code{default}
3878 case.
3880 @item -Wswitch-enum
3881 @opindex Wswitch-enum
3882 @opindex Wno-switch-enum
3883 Warn whenever a @code{switch} statement has an index of enumerated type
3884 and lacks a @code{case} for one or more of the named codes of that
3885 enumeration.  @code{case} labels outside the enumeration range also
3886 provoke warnings when this option is used.  The only difference
3887 between @option{-Wswitch} and this option is that this option gives a
3888 warning about an omitted enumeration code even if there is a
3889 @code{default} label.
3891 @item -Wswitch-bool
3892 @opindex Wswitch-bool
3893 @opindex Wno-switch-bool
3894 Warn whenever a @code{switch} statement has an index of boolean type.
3895 It is possible to suppress this warning by casting the controlling
3896 expression to a type other than @code{bool}.  For example:
3897 @smallexample
3898 @group
3899 switch ((int) (a == 4))
3900   @{
3901   @dots{}
3902   @}
3903 @end group
3904 @end smallexample
3905 This warning is enabled by default for C and C++ programs.
3907 @item -Wsync-nand @r{(C and C++ only)}
3908 @opindex Wsync-nand
3909 @opindex Wno-sync-nand
3910 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3911 built-in functions are used.  These functions changed semantics in GCC 4.4.
3913 @item -Wtrigraphs
3914 @opindex Wtrigraphs
3915 @opindex Wno-trigraphs
3916 Warn if any trigraphs are encountered that might change the meaning of
3917 the program (trigraphs within comments are not warned about).
3918 This warning is enabled by @option{-Wall}.
3920 @item -Wunused-but-set-parameter
3921 @opindex Wunused-but-set-parameter
3922 @opindex Wno-unused-but-set-parameter
3923 Warn whenever a function parameter is assigned to, but otherwise unused
3924 (aside from its declaration).
3926 To suppress this warning use the @samp{unused} attribute
3927 (@pxref{Variable Attributes}).
3929 This warning is also enabled by @option{-Wunused} together with
3930 @option{-Wextra}.
3932 @item -Wunused-but-set-variable
3933 @opindex Wunused-but-set-variable
3934 @opindex Wno-unused-but-set-variable
3935 Warn whenever a local variable is assigned to, but otherwise unused
3936 (aside from its declaration).
3937 This warning is enabled by @option{-Wall}.
3939 To suppress this warning use the @samp{unused} attribute
3940 (@pxref{Variable Attributes}).
3942 This warning is also enabled by @option{-Wunused}, which is enabled
3943 by @option{-Wall}.
3945 @item -Wunused-function
3946 @opindex Wunused-function
3947 @opindex Wno-unused-function
3948 Warn whenever a static function is declared but not defined or a
3949 non-inline static function is unused.
3950 This warning is enabled by @option{-Wall}.
3952 @item -Wunused-label
3953 @opindex Wunused-label
3954 @opindex Wno-unused-label
3955 Warn whenever a label is declared but not used.
3956 This warning is enabled by @option{-Wall}.
3958 To suppress this warning use the @samp{unused} attribute
3959 (@pxref{Variable Attributes}).
3961 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3962 @opindex Wunused-local-typedefs
3963 Warn when a typedef locally defined in a function is not used.
3964 This warning is enabled by @option{-Wall}.
3966 @item -Wunused-parameter
3967 @opindex Wunused-parameter
3968 @opindex Wno-unused-parameter
3969 Warn whenever a function parameter is unused aside from its declaration.
3971 To suppress this warning use the @samp{unused} attribute
3972 (@pxref{Variable Attributes}).
3974 @item -Wno-unused-result
3975 @opindex Wunused-result
3976 @opindex Wno-unused-result
3977 Do not warn if a caller of a function marked with attribute
3978 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3979 its return value. The default is @option{-Wunused-result}.
3981 @item -Wunused-variable
3982 @opindex Wunused-variable
3983 @opindex Wno-unused-variable
3984 Warn whenever a local variable or non-constant static variable is unused
3985 aside from its declaration.
3986 This warning is enabled by @option{-Wall}.
3988 To suppress this warning use the @samp{unused} attribute
3989 (@pxref{Variable Attributes}).
3991 @item -Wunused-value
3992 @opindex Wunused-value
3993 @opindex Wno-unused-value
3994 Warn whenever a statement computes a result that is explicitly not
3995 used. To suppress this warning cast the unused expression to
3996 @samp{void}. This includes an expression-statement or the left-hand
3997 side of a comma expression that contains no side effects. For example,
3998 an expression such as @samp{x[i,j]} causes a warning, while
3999 @samp{x[(void)i,j]} does not.
4001 This warning is enabled by @option{-Wall}.
4003 @item -Wunused
4004 @opindex Wunused
4005 @opindex Wno-unused
4006 All the above @option{-Wunused} options combined.
4008 In order to get a warning about an unused function parameter, you must
4009 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
4010 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
4012 @item -Wuninitialized
4013 @opindex Wuninitialized
4014 @opindex Wno-uninitialized
4015 Warn if an automatic variable is used without first being initialized
4016 or if a variable may be clobbered by a @code{setjmp} call. In C++,
4017 warn if a non-static reference or non-static @samp{const} member
4018 appears in a class without constructors.
4020 If you want to warn about code that uses the uninitialized value of the
4021 variable in its own initializer, use the @option{-Winit-self} option.
4023 These warnings occur for individual uninitialized or clobbered
4024 elements of structure, union or array variables as well as for
4025 variables that are uninitialized or clobbered as a whole.  They do
4026 not occur for variables or elements declared @code{volatile}.  Because
4027 these warnings depend on optimization, the exact variables or elements
4028 for which there are warnings depends on the precise optimization
4029 options and version of GCC used.
4031 Note that there may be no warning about a variable that is used only
4032 to compute a value that itself is never used, because such
4033 computations may be deleted by data flow analysis before the warnings
4034 are printed.
4036 @item -Wmaybe-uninitialized
4037 @opindex Wmaybe-uninitialized
4038 @opindex Wno-maybe-uninitialized
4039 For an automatic variable, if there exists a path from the function
4040 entry to a use of the variable that is initialized, but there exist
4041 some other paths for which the variable is not initialized, the compiler
4042 emits a warning if it cannot prove the uninitialized paths are not
4043 executed at run time. These warnings are made optional because GCC is
4044 not smart enough to see all the reasons why the code might be correct
4045 in spite of appearing to have an error.  Here is one example of how
4046 this can happen:
4048 @smallexample
4049 @group
4051   int x;
4052   switch (y)
4053     @{
4054     case 1: x = 1;
4055       break;
4056     case 2: x = 4;
4057       break;
4058     case 3: x = 5;
4059     @}
4060   foo (x);
4062 @end group
4063 @end smallexample
4065 @noindent
4066 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
4067 always initialized, but GCC doesn't know this. To suppress the
4068 warning, you need to provide a default case with assert(0) or
4069 similar code.
4071 @cindex @code{longjmp} warnings
4072 This option also warns when a non-volatile automatic variable might be
4073 changed by a call to @code{longjmp}.  These warnings as well are possible
4074 only in optimizing compilation.
4076 The compiler sees only the calls to @code{setjmp}.  It cannot know
4077 where @code{longjmp} will be called; in fact, a signal handler could
4078 call it at any point in the code.  As a result, you may get a warning
4079 even when there is in fact no problem because @code{longjmp} cannot
4080 in fact be called at the place that would cause a problem.
4082 Some spurious warnings can be avoided if you declare all the functions
4083 you use that never return as @code{noreturn}.  @xref{Function
4084 Attributes}.
4086 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4088 @item -Wunknown-pragmas
4089 @opindex Wunknown-pragmas
4090 @opindex Wno-unknown-pragmas
4091 @cindex warning for unknown pragmas
4092 @cindex unknown pragmas, warning
4093 @cindex pragmas, warning of unknown
4094 Warn when a @code{#pragma} directive is encountered that is not understood by 
4095 GCC@.  If this command-line option is used, warnings are even issued
4096 for unknown pragmas in system header files.  This is not the case if
4097 the warnings are only enabled by the @option{-Wall} command-line option.
4099 @item -Wno-pragmas
4100 @opindex Wno-pragmas
4101 @opindex Wpragmas
4102 Do not warn about misuses of pragmas, such as incorrect parameters,
4103 invalid syntax, or conflicts between pragmas.  See also
4104 @option{-Wunknown-pragmas}.
4106 @item -Wstrict-aliasing
4107 @opindex Wstrict-aliasing
4108 @opindex Wno-strict-aliasing
4109 This option is only active when @option{-fstrict-aliasing} is active.
4110 It warns about code that might break the strict aliasing rules that the
4111 compiler is using for optimization.  The warning does not catch all
4112 cases, but does attempt to catch the more common pitfalls.  It is
4113 included in @option{-Wall}.
4114 It is equivalent to @option{-Wstrict-aliasing=3}
4116 @item -Wstrict-aliasing=n
4117 @opindex Wstrict-aliasing=n
4118 This option is only active when @option{-fstrict-aliasing} is active.
4119 It warns about code that might break the strict aliasing rules that the
4120 compiler is using for optimization.
4121 Higher levels correspond to higher accuracy (fewer false positives).
4122 Higher levels also correspond to more effort, similar to the way @option{-O} 
4123 works.
4124 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4126 Level 1: Most aggressive, quick, least accurate.
4127 Possibly useful when higher levels
4128 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4129 false negatives.  However, it has many false positives.
4130 Warns for all pointer conversions between possibly incompatible types,
4131 even if never dereferenced.  Runs in the front end only.
4133 Level 2: Aggressive, quick, not too precise.
4134 May still have many false positives (not as many as level 1 though),
4135 and few false negatives (but possibly more than level 1).
4136 Unlike level 1, it only warns when an address is taken.  Warns about
4137 incomplete types.  Runs in the front end only.
4139 Level 3 (default for @option{-Wstrict-aliasing}):
4140 Should have very few false positives and few false
4141 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4142 Takes care of the common pun+dereference pattern in the front end:
4143 @code{*(int*)&some_float}.
4144 If optimization is enabled, it also runs in the back end, where it deals
4145 with multiple statement cases using flow-sensitive points-to information.
4146 Only warns when the converted pointer is dereferenced.
4147 Does not warn about incomplete types.
4149 @item -Wstrict-overflow
4150 @itemx -Wstrict-overflow=@var{n}
4151 @opindex Wstrict-overflow
4152 @opindex Wno-strict-overflow
4153 This option is only active when @option{-fstrict-overflow} is active.
4154 It warns about cases where the compiler optimizes based on the
4155 assumption that signed overflow does not occur.  Note that it does not
4156 warn about all cases where the code might overflow: it only warns
4157 about cases where the compiler implements some optimization.  Thus
4158 this warning depends on the optimization level.
4160 An optimization that assumes that signed overflow does not occur is
4161 perfectly safe if the values of the variables involved are such that
4162 overflow never does, in fact, occur.  Therefore this warning can
4163 easily give a false positive: a warning about code that is not
4164 actually a problem.  To help focus on important issues, several
4165 warning levels are defined.  No warnings are issued for the use of
4166 undefined signed overflow when estimating how many iterations a loop
4167 requires, in particular when determining whether a loop will be
4168 executed at all.
4170 @table @gcctabopt
4171 @item -Wstrict-overflow=1
4172 Warn about cases that are both questionable and easy to avoid.  For
4173 example,  with @option{-fstrict-overflow}, the compiler simplifies
4174 @code{x + 1 > x} to @code{1}.  This level of
4175 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4176 are not, and must be explicitly requested.
4178 @item -Wstrict-overflow=2
4179 Also warn about other cases where a comparison is simplified to a
4180 constant.  For example: @code{abs (x) >= 0}.  This can only be
4181 simplified when @option{-fstrict-overflow} is in effect, because
4182 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4183 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4184 @option{-Wstrict-overflow=2}.
4186 @item -Wstrict-overflow=3
4187 Also warn about other cases where a comparison is simplified.  For
4188 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4190 @item -Wstrict-overflow=4
4191 Also warn about other simplifications not covered by the above cases.
4192 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4194 @item -Wstrict-overflow=5
4195 Also warn about cases where the compiler reduces the magnitude of a
4196 constant involved in a comparison.  For example: @code{x + 2 > y} is
4197 simplified to @code{x + 1 >= y}.  This is reported only at the
4198 highest warning level because this simplification applies to many
4199 comparisons, so this warning level gives a very large number of
4200 false positives.
4201 @end table
4203 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4204 @opindex Wsuggest-attribute=
4205 @opindex Wno-suggest-attribute=
4206 Warn for cases where adding an attribute may be beneficial. The
4207 attributes currently supported are listed below.
4209 @table @gcctabopt
4210 @item -Wsuggest-attribute=pure
4211 @itemx -Wsuggest-attribute=const
4212 @itemx -Wsuggest-attribute=noreturn
4213 @opindex Wsuggest-attribute=pure
4214 @opindex Wno-suggest-attribute=pure
4215 @opindex Wsuggest-attribute=const
4216 @opindex Wno-suggest-attribute=const
4217 @opindex Wsuggest-attribute=noreturn
4218 @opindex Wno-suggest-attribute=noreturn
4220 Warn about functions that might be candidates for attributes
4221 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4222 functions visible in other compilation units or (in the case of @code{pure} and
4223 @code{const}) if it cannot prove that the function returns normally. A function
4224 returns normally if it doesn't contain an infinite loop or return abnormally
4225 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4226 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4227 higher.  Higher optimization levels improve the accuracy of the analysis.
4229 @item -Wsuggest-attribute=format
4230 @itemx -Wmissing-format-attribute
4231 @opindex Wsuggest-attribute=format
4232 @opindex Wmissing-format-attribute
4233 @opindex Wno-suggest-attribute=format
4234 @opindex Wno-missing-format-attribute
4235 @opindex Wformat
4236 @opindex Wno-format
4238 Warn about function pointers that might be candidates for @code{format}
4239 attributes.  Note these are only possible candidates, not absolute ones.
4240 GCC guesses that function pointers with @code{format} attributes that
4241 are used in assignment, initialization, parameter passing or return
4242 statements should have a corresponding @code{format} attribute in the
4243 resulting type.  I.e.@: the left-hand side of the assignment or
4244 initialization, the type of the parameter variable, or the return type
4245 of the containing function respectively should also have a @code{format}
4246 attribute to avoid the warning.
4248 GCC also warns about function definitions that might be
4249 candidates for @code{format} attributes.  Again, these are only
4250 possible candidates.  GCC guesses that @code{format} attributes
4251 might be appropriate for any function that calls a function like
4252 @code{vprintf} or @code{vscanf}, but this might not always be the
4253 case, and some functions for which @code{format} attributes are
4254 appropriate may not be detected.
4255 @end table
4257 @item -Wsuggest-final-types
4258 @opindex Wno-suggest-final-types
4259 @opindex Wsuggest-final-types
4260 Warn about types with virtual methods where code quality would be improved
4261 if the type was declared with the C++11 final specifier, or, if possible,
4262 declared in an anonymous namespace. This allows GCC to more aggressively
4263 devirtualize the polymorphic calls. This warning is more effective with link
4264 time optimization, where the information about the class hierarchy graph is
4265 more complete.
4267 @item -Wsuggest-final-methods
4268 @opindex Wno-suggest-final-methods
4269 @opindex Wsuggest-final-methods
4270 Warn about virtual methods where code quality would be improved if the method
4271 was declared with the C++11 final specifier, or, if possible, its type was
4272 declared in an anonymous namespace or with the final specifier. This warning is
4273 more effective with link time optimization, where the information about the
4274 class hierarchy graph is more complete. It is recommended to first consider
4275 suggestions of @option{-Wsuggest-final-types} and then rebuild with new
4276 annotations.
4278 @item -Warray-bounds
4279 @opindex Wno-array-bounds
4280 @opindex Warray-bounds
4281 This option is only active when @option{-ftree-vrp} is active
4282 (default for @option{-O2} and above). It warns about subscripts to arrays
4283 that are always out of bounds. This warning is enabled by @option{-Wall}.
4285 @item -Wbool-compare
4286 @opindex Wno-bool-compare
4287 @opindex Wbool-compare
4288 Warn about boolean expression compared with an integer value different from
4289 @code{true}/@code{false}.  For instance, the following comparison is
4290 always false:
4291 @smallexample
4292 int n = 5;
4293 @dots{}
4294 if ((n > 1) == 2) @{ @dots{} @}
4295 @end smallexample
4296 This warning is enabled by @option{-Wall}.
4298 @item -Wno-discarded-qualifiers @r{(C and Objective-C only)}
4299 @opindex Wno-discarded-qualifiers
4300 @opindex Wdiscarded-qualifiers
4301 Do not warn if type qualifiers on pointers are being discarded.
4302 Typically, the compiler will warn if a @code{const char *} variable is
4303 passed to a function that takes @code{char *} parameter.  This option
4304 can be used to suppress such a warning.
4306 @item -Wno-incompatible-pointer-types @r{(C and Objective-C only)}
4307 @opindex Wno-incompatible-pointer-types
4308 @opindex Wincompatible-pointer-types
4309 Do not warn when there is a conversion between pointers that have incompatible
4310 types.  This warning is for cases not covered by @option{-Wno-pointer-sign},
4311 which warns for pointer argument passing or assignment with different
4312 signedness.
4314 @item -Wno-int-conversion @r{(C and Objective-C only)}
4315 @opindex Wno-int-conversion
4316 @opindex Wint-conversion
4317 Do not warn about incompatible integer to pointer and pointer to integer
4318 conversions.  This warning is about implicit conversions; for explicit
4319 conversions the warnings @option{-Wno-int-to-pointer-cast} and
4320 @option{-Wno-pointer-to-int-cast} may be used.
4322 @item -Wno-div-by-zero
4323 @opindex Wno-div-by-zero
4324 @opindex Wdiv-by-zero
4325 Do not warn about compile-time integer division by zero.  Floating-point
4326 division by zero is not warned about, as it can be a legitimate way of
4327 obtaining infinities and NaNs.
4329 @item -Wsystem-headers
4330 @opindex Wsystem-headers
4331 @opindex Wno-system-headers
4332 @cindex warnings from system headers
4333 @cindex system headers, warnings from
4334 Print warning messages for constructs found in system header files.
4335 Warnings from system headers are normally suppressed, on the assumption
4336 that they usually do not indicate real problems and would only make the
4337 compiler output harder to read.  Using this command-line option tells
4338 GCC to emit warnings from system headers as if they occurred in user
4339 code.  However, note that using @option{-Wall} in conjunction with this
4340 option does @emph{not} warn about unknown pragmas in system
4341 headers---for that, @option{-Wunknown-pragmas} must also be used.
4343 @item -Wtrampolines
4344 @opindex Wtrampolines
4345 @opindex Wno-trampolines
4346 Warn about trampolines generated for pointers to nested functions.
4347 A trampoline is a small piece of data or code that is created at run
4348 time on the stack when the address of a nested function is taken, and is
4349 used to call the nested function indirectly.  For some targets, it is
4350 made up of data only and thus requires no special treatment.  But, for
4351 most targets, it is made up of code and thus requires the stack to be
4352 made executable in order for the program to work properly.
4354 @item -Wfloat-equal
4355 @opindex Wfloat-equal
4356 @opindex Wno-float-equal
4357 Warn if floating-point values are used in equality comparisons.
4359 The idea behind this is that sometimes it is convenient (for the
4360 programmer) to consider floating-point values as approximations to
4361 infinitely precise real numbers.  If you are doing this, then you need
4362 to compute (by analyzing the code, or in some other way) the maximum or
4363 likely maximum error that the computation introduces, and allow for it
4364 when performing comparisons (and when producing output, but that's a
4365 different problem).  In particular, instead of testing for equality, you
4366 should check to see whether the two values have ranges that overlap; and
4367 this is done with the relational operators, so equality comparisons are
4368 probably mistaken.
4370 @item -Wtraditional @r{(C and Objective-C only)}
4371 @opindex Wtraditional
4372 @opindex Wno-traditional
4373 Warn about certain constructs that behave differently in traditional and
4374 ISO C@.  Also warn about ISO C constructs that have no traditional C
4375 equivalent, and/or problematic constructs that should be avoided.
4377 @itemize @bullet
4378 @item
4379 Macro parameters that appear within string literals in the macro body.
4380 In traditional C macro replacement takes place within string literals,
4381 but in ISO C it does not.
4383 @item
4384 In traditional C, some preprocessor directives did not exist.
4385 Traditional preprocessors only considered a line to be a directive
4386 if the @samp{#} appeared in column 1 on the line.  Therefore
4387 @option{-Wtraditional} warns about directives that traditional C
4388 understands but ignores because the @samp{#} does not appear as the
4389 first character on the line.  It also suggests you hide directives like
4390 @samp{#pragma} not understood by traditional C by indenting them.  Some
4391 traditional implementations do not recognize @samp{#elif}, so this option
4392 suggests avoiding it altogether.
4394 @item
4395 A function-like macro that appears without arguments.
4397 @item
4398 The unary plus operator.
4400 @item
4401 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4402 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4403 constants.)  Note, these suffixes appear in macros defined in the system
4404 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4405 Use of these macros in user code might normally lead to spurious
4406 warnings, however GCC's integrated preprocessor has enough context to
4407 avoid warning in these cases.
4409 @item
4410 A function declared external in one block and then used after the end of
4411 the block.
4413 @item
4414 A @code{switch} statement has an operand of type @code{long}.
4416 @item
4417 A non-@code{static} function declaration follows a @code{static} one.
4418 This construct is not accepted by some traditional C compilers.
4420 @item
4421 The ISO type of an integer constant has a different width or
4422 signedness from its traditional type.  This warning is only issued if
4423 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4424 typically represent bit patterns, are not warned about.
4426 @item
4427 Usage of ISO string concatenation is detected.
4429 @item
4430 Initialization of automatic aggregates.
4432 @item
4433 Identifier conflicts with labels.  Traditional C lacks a separate
4434 namespace for labels.
4436 @item
4437 Initialization of unions.  If the initializer is zero, the warning is
4438 omitted.  This is done under the assumption that the zero initializer in
4439 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4440 initializer warnings and relies on default initialization to zero in the
4441 traditional C case.
4443 @item
4444 Conversions by prototypes between fixed/floating-point values and vice
4445 versa.  The absence of these prototypes when compiling with traditional
4446 C causes serious problems.  This is a subset of the possible
4447 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4449 @item
4450 Use of ISO C style function definitions.  This warning intentionally is
4451 @emph{not} issued for prototype declarations or variadic functions
4452 because these ISO C features appear in your code when using
4453 libiberty's traditional C compatibility macros, @code{PARAMS} and
4454 @code{VPARAMS}.  This warning is also bypassed for nested functions
4455 because that feature is already a GCC extension and thus not relevant to
4456 traditional C compatibility.
4457 @end itemize
4459 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4460 @opindex Wtraditional-conversion
4461 @opindex Wno-traditional-conversion
4462 Warn if a prototype causes a type conversion that is different from what
4463 would happen to the same argument in the absence of a prototype.  This
4464 includes conversions of fixed point to floating and vice versa, and
4465 conversions changing the width or signedness of a fixed-point argument
4466 except when the same as the default promotion.
4468 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4469 @opindex Wdeclaration-after-statement
4470 @opindex Wno-declaration-after-statement
4471 Warn when a declaration is found after a statement in a block.  This
4472 construct, known from C++, was introduced with ISO C99 and is by default
4473 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4474 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4476 @item -Wundef
4477 @opindex Wundef
4478 @opindex Wno-undef
4479 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4481 @item -Wno-endif-labels
4482 @opindex Wno-endif-labels
4483 @opindex Wendif-labels
4484 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4486 @item -Wshadow
4487 @opindex Wshadow
4488 @opindex Wno-shadow
4489 Warn whenever a local variable or type declaration shadows another
4490 variable, parameter, type, class member (in C++), or instance variable
4491 (in Objective-C) or whenever a built-in function is shadowed. Note
4492 that in C++, the compiler warns if a local variable shadows an
4493 explicit typedef, but not if it shadows a struct/class/enum.
4495 @item -Wno-shadow-ivar @r{(Objective-C only)}
4496 @opindex Wno-shadow-ivar
4497 @opindex Wshadow-ivar
4498 Do not warn whenever a local variable shadows an instance variable in an
4499 Objective-C method.
4501 @item -Wlarger-than=@var{len}
4502 @opindex Wlarger-than=@var{len}
4503 @opindex Wlarger-than-@var{len}
4504 Warn whenever an object of larger than @var{len} bytes is defined.
4506 @item -Wframe-larger-than=@var{len}
4507 @opindex Wframe-larger-than
4508 Warn if the size of a function frame is larger than @var{len} bytes.
4509 The computation done to determine the stack frame size is approximate
4510 and not conservative.
4511 The actual requirements may be somewhat greater than @var{len}
4512 even if you do not get a warning.  In addition, any space allocated
4513 via @code{alloca}, variable-length arrays, or related constructs
4514 is not included by the compiler when determining
4515 whether or not to issue a warning.
4517 @item -Wno-free-nonheap-object
4518 @opindex Wno-free-nonheap-object
4519 @opindex Wfree-nonheap-object
4520 Do not warn when attempting to free an object that was not allocated
4521 on the heap.
4523 @item -Wstack-usage=@var{len}
4524 @opindex Wstack-usage
4525 Warn if the stack usage of a function might be larger than @var{len} bytes.
4526 The computation done to determine the stack usage is conservative.
4527 Any space allocated via @code{alloca}, variable-length arrays, or related
4528 constructs is included by the compiler when determining whether or not to
4529 issue a warning.
4531 The message is in keeping with the output of @option{-fstack-usage}.
4533 @itemize
4534 @item
4535 If the stack usage is fully static but exceeds the specified amount, it's:
4537 @smallexample
4538   warning: stack usage is 1120 bytes
4539 @end smallexample
4540 @item
4541 If the stack usage is (partly) dynamic but bounded, it's:
4543 @smallexample
4544   warning: stack usage might be 1648 bytes
4545 @end smallexample
4546 @item
4547 If the stack usage is (partly) dynamic and not bounded, it's:
4549 @smallexample
4550   warning: stack usage might be unbounded
4551 @end smallexample
4552 @end itemize
4554 @item -Wunsafe-loop-optimizations
4555 @opindex Wunsafe-loop-optimizations
4556 @opindex Wno-unsafe-loop-optimizations
4557 Warn if the loop cannot be optimized because the compiler cannot
4558 assume anything on the bounds of the loop indices.  With
4559 @option{-funsafe-loop-optimizations} warn if the compiler makes
4560 such assumptions.
4562 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4563 @opindex Wno-pedantic-ms-format
4564 @opindex Wpedantic-ms-format
4565 When used in combination with @option{-Wformat}
4566 and @option{-pedantic} without GNU extensions, this option
4567 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4568 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4569 which depend on the MS runtime.
4571 @item -Wpointer-arith
4572 @opindex Wpointer-arith
4573 @opindex Wno-pointer-arith
4574 Warn about anything that depends on the ``size of'' a function type or
4575 of @code{void}.  GNU C assigns these types a size of 1, for
4576 convenience in calculations with @code{void *} pointers and pointers
4577 to functions.  In C++, warn also when an arithmetic operation involves
4578 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4580 @item -Wtype-limits
4581 @opindex Wtype-limits
4582 @opindex Wno-type-limits
4583 Warn if a comparison is always true or always false due to the limited
4584 range of the data type, but do not warn for constant expressions.  For
4585 example, warn if an unsigned variable is compared against zero with
4586 @samp{<} or @samp{>=}.  This warning is also enabled by
4587 @option{-Wextra}.
4589 @item -Wbad-function-cast @r{(C and Objective-C only)}
4590 @opindex Wbad-function-cast
4591 @opindex Wno-bad-function-cast
4592 Warn whenever a function call is cast to a non-matching type.
4593 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4595 @item -Wc90-c99-compat @r{(C and Objective-C only)}
4596 @opindex Wc90-c99-compat
4597 @opindex Wno-c90-c99-compat
4598 Warn about features not present in ISO C90, but present in ISO C99.
4599 For instance, warn about use of variable length arrays, @code{long long}
4600 type, @code{bool} type, compound literals, designated initializers, and so
4601 on.  This option is independent of the standards mode.  Warnings are disabled
4602 in the expression that follows @code{__extension__}.
4604 @item -Wc99-c11-compat @r{(C and Objective-C only)}
4605 @opindex Wc99-c11-compat
4606 @opindex Wno-c99-c11-compat
4607 Warn about features not present in ISO C99, but present in ISO C11.
4608 For instance, warn about use of anonymous structures and unions,
4609 @code{_Atomic} type qualifier, @code{_Thread_local} storage-class specifier,
4610 @code{_Alignas} specifier, @code{Alignof} operator, @code{_Generic} keyword,
4611 and so on.  This option is independent of the standards mode.  Warnings are
4612 disabled in the expression that follows @code{__extension__}.
4614 @item -Wc++-compat @r{(C and Objective-C only)}
4615 Warn about ISO C constructs that are outside of the common subset of
4616 ISO C and ISO C++, e.g.@: request for implicit conversion from
4617 @code{void *} to a pointer to non-@code{void} type.
4619 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4620 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4621 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4622 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4623 enabled by @option{-Wall}.
4625 @item -Wc++14-compat @r{(C++ and Objective-C++ only)}
4626 Warn about C++ constructs whose meaning differs between ISO C++ 2011
4627 and ISO C++ 2014.  This warning is enabled by @option{-Wall}.
4629 @item -Wcast-qual
4630 @opindex Wcast-qual
4631 @opindex Wno-cast-qual
4632 Warn whenever a pointer is cast so as to remove a type qualifier from
4633 the target type.  For example, warn if a @code{const char *} is cast
4634 to an ordinary @code{char *}.
4636 Also warn when making a cast that introduces a type qualifier in an
4637 unsafe way.  For example, casting @code{char **} to @code{const char **}
4638 is unsafe, as in this example:
4640 @smallexample
4641   /* p is char ** value.  */
4642   const char **q = (const char **) p;
4643   /* Assignment of readonly string to const char * is OK.  */
4644   *q = "string";
4645   /* Now char** pointer points to read-only memory.  */
4646   **p = 'b';
4647 @end smallexample
4649 @item -Wcast-align
4650 @opindex Wcast-align
4651 @opindex Wno-cast-align
4652 Warn whenever a pointer is cast such that the required alignment of the
4653 target is increased.  For example, warn if a @code{char *} is cast to
4654 an @code{int *} on machines where integers can only be accessed at
4655 two- or four-byte boundaries.
4657 @item -Wwrite-strings
4658 @opindex Wwrite-strings
4659 @opindex Wno-write-strings
4660 When compiling C, give string constants the type @code{const
4661 char[@var{length}]} so that copying the address of one into a
4662 non-@code{const} @code{char *} pointer produces a warning.  These
4663 warnings help you find at compile time code that can try to write
4664 into a string constant, but only if you have been very careful about
4665 using @code{const} in declarations and prototypes.  Otherwise, it is
4666 just a nuisance. This is why we did not make @option{-Wall} request
4667 these warnings.
4669 When compiling C++, warn about the deprecated conversion from string
4670 literals to @code{char *}.  This warning is enabled by default for C++
4671 programs.
4673 @item -Wclobbered
4674 @opindex Wclobbered
4675 @opindex Wno-clobbered
4676 Warn for variables that might be changed by @samp{longjmp} or
4677 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4679 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4680 @opindex Wconditionally-supported
4681 @opindex Wno-conditionally-supported
4682 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4684 @item -Wconversion
4685 @opindex Wconversion
4686 @opindex Wno-conversion
4687 Warn for implicit conversions that may alter a value. This includes
4688 conversions between real and integer, like @code{abs (x)} when
4689 @code{x} is @code{double}; conversions between signed and unsigned,
4690 like @code{unsigned ui = -1}; and conversions to smaller types, like
4691 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4692 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4693 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4694 conversions between signed and unsigned integers can be disabled by
4695 using @option{-Wno-sign-conversion}.
4697 For C++, also warn for confusing overload resolution for user-defined
4698 conversions; and conversions that never use a type conversion
4699 operator: conversions to @code{void}, the same type, a base class or a
4700 reference to them. Warnings about conversions between signed and
4701 unsigned integers are disabled by default in C++ unless
4702 @option{-Wsign-conversion} is explicitly enabled.
4704 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4705 @opindex Wconversion-null
4706 @opindex Wno-conversion-null
4707 Do not warn for conversions between @code{NULL} and non-pointer
4708 types. @option{-Wconversion-null} is enabled by default.
4710 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4711 @opindex Wzero-as-null-pointer-constant
4712 @opindex Wno-zero-as-null-pointer-constant
4713 Warn when a literal '0' is used as null pointer constant.  This can
4714 be useful to facilitate the conversion to @code{nullptr} in C++11.
4716 @item -Wdate-time
4717 @opindex Wdate-time
4718 @opindex Wno-date-time
4719 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4720 are encountered as they might prevent bit-wise-identical reproducible
4721 compilations.
4723 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4724 @opindex Wdelete-incomplete
4725 @opindex Wno-delete-incomplete
4726 Warn when deleting a pointer to incomplete type, which may cause
4727 undefined behavior at runtime.  This warning is enabled by default.
4729 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4730 @opindex Wuseless-cast
4731 @opindex Wno-useless-cast
4732 Warn when an expression is casted to its own type.
4734 @item -Wempty-body
4735 @opindex Wempty-body
4736 @opindex Wno-empty-body
4737 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4738 while} statement.  This warning is also enabled by @option{-Wextra}.
4740 @item -Wenum-compare
4741 @opindex Wenum-compare
4742 @opindex Wno-enum-compare
4743 Warn about a comparison between values of different enumerated types.
4744 In C++ enumeral mismatches in conditional expressions are also
4745 diagnosed and the warning is enabled by default.  In C this warning is 
4746 enabled by @option{-Wall}.
4748 @item -Wjump-misses-init @r{(C, Objective-C only)}
4749 @opindex Wjump-misses-init
4750 @opindex Wno-jump-misses-init
4751 Warn if a @code{goto} statement or a @code{switch} statement jumps
4752 forward across the initialization of a variable, or jumps backward to a
4753 label after the variable has been initialized.  This only warns about
4754 variables that are initialized when they are declared.  This warning is
4755 only supported for C and Objective-C; in C++ this sort of branch is an
4756 error in any case.
4758 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4759 can be disabled with the @option{-Wno-jump-misses-init} option.
4761 @item -Wsign-compare
4762 @opindex Wsign-compare
4763 @opindex Wno-sign-compare
4764 @cindex warning for comparison of signed and unsigned values
4765 @cindex comparison of signed and unsigned values, warning
4766 @cindex signed and unsigned values, comparison warning
4767 Warn when a comparison between signed and unsigned values could produce
4768 an incorrect result when the signed value is converted to unsigned.
4769 This warning is also enabled by @option{-Wextra}; to get the other warnings
4770 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4772 @item -Wsign-conversion
4773 @opindex Wsign-conversion
4774 @opindex Wno-sign-conversion
4775 Warn for implicit conversions that may change the sign of an integer
4776 value, like assigning a signed integer expression to an unsigned
4777 integer variable. An explicit cast silences the warning. In C, this
4778 option is enabled also by @option{-Wconversion}.
4780 @item -Wfloat-conversion
4781 @opindex Wfloat-conversion
4782 @opindex Wno-float-conversion
4783 Warn for implicit conversions that reduce the precision of a real value.
4784 This includes conversions from real to integer, and from higher precision
4785 real to lower precision real values.  This option is also enabled by
4786 @option{-Wconversion}.
4788 @item -Wsized-deallocation @r{(C++ and Objective-C++ only)}
4789 @opindex Wsized-deallocation
4790 @opindex -Wno-sized-deallocation
4791 Warn about a definition of an unsized deallocation function
4792 @smallexample
4793 void operator delete (void *) noexcept;
4794 void operator delete[] (void *) noexcept;
4795 @end smallexample
4796 without a definition of the corresponding sized deallocation function
4797 @smallexample
4798 void operator delete (void *, std::size_t) noexcept;
4799 void operator delete[] (void *, std::size_t) noexcept;
4800 @end smallexample
4801 or vice versa.  Enabled by @option{-Wextra} along with
4802 @option{-fsized-deallocation}.
4804 @item -Wsizeof-pointer-memaccess
4805 @opindex Wsizeof-pointer-memaccess
4806 @opindex Wno-sizeof-pointer-memaccess
4807 Warn for suspicious length parameters to certain string and memory built-in
4808 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4809 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4810 but a pointer, and suggests a possible fix, or about
4811 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4812 @option{-Wall}.
4814 @item -Wsizeof-array-argument
4815 @opindex Wsizeof-array-argument
4816 @opindex Wno-sizeof-array-argument
4817 Warn when the @code{sizeof} operator is applied to a parameter that is
4818 declared as an array in a function definition.  This warning is enabled by
4819 default for C and C++ programs.
4821 @item -Wmemset-transposed-args
4822 @opindex Wmemset-transposed-args
4823 @opindex Wno-memset-transposed-args
4824 Warn for suspicious calls to the @code{memset} built-in function, if the
4825 second argument is not zero and the third argument is zero.  This warns e.g.@
4826 about @code{memset (buf, sizeof buf, 0)} where most probably
4827 @code{memset (buf, 0, sizeof buf)} was meant instead.  The diagnostics
4828 is only emitted if the third argument is literal zero, if it is some expression
4829 that is folded to zero, or e.g. a cast of zero to some type etc., it
4830 is far less likely that user has mistakenly exchanged the arguments and
4831 no warning is emitted.  This warning is enabled by @option{-Wall}.
4833 @item -Waddress
4834 @opindex Waddress
4835 @opindex Wno-address
4836 Warn about suspicious uses of memory addresses. These include using
4837 the address of a function in a conditional expression, such as
4838 @code{void func(void); if (func)}, and comparisons against the memory
4839 address of a string literal, such as @code{if (x == "abc")}.  Such
4840 uses typically indicate a programmer error: the address of a function
4841 always evaluates to true, so their use in a conditional usually
4842 indicate that the programmer forgot the parentheses in a function
4843 call; and comparisons against string literals result in unspecified
4844 behavior and are not portable in C, so they usually indicate that the
4845 programmer intended to use @code{strcmp}.  This warning is enabled by
4846 @option{-Wall}.
4848 @item -Wlogical-op
4849 @opindex Wlogical-op
4850 @opindex Wno-logical-op
4851 Warn about suspicious uses of logical operators in expressions.
4852 This includes using logical operators in contexts where a
4853 bit-wise operator is likely to be expected.
4855 @item -Wlogical-not-parentheses
4856 @opindex Wlogical-not-parentheses
4857 @opindex Wno-logical-not-parentheses
4858 Warn about logical not used on the left hand side operand of a comparison.
4859 This option does not warn if the RHS operand is of a boolean type.  Its
4860 purpose is to detect suspicious code like the following:
4861 @smallexample
4862 int a;
4863 @dots{}
4864 if (!a > 1) @{ @dots{} @}
4865 @end smallexample
4867 It is possible to suppress the warning by wrapping the LHS into
4868 parentheses:
4869 @smallexample
4870 if ((!a) > 1) @{ @dots{} @}
4871 @end smallexample
4873 This warning is enabled by @option{-Wall}.
4875 @item -Waggregate-return
4876 @opindex Waggregate-return
4877 @opindex Wno-aggregate-return
4878 Warn if any functions that return structures or unions are defined or
4879 called.  (In languages where you can return an array, this also elicits
4880 a warning.)
4882 @item -Wno-aggressive-loop-optimizations
4883 @opindex Wno-aggressive-loop-optimizations
4884 @opindex Waggressive-loop-optimizations
4885 Warn if in a loop with constant number of iterations the compiler detects
4886 undefined behavior in some statement during one or more of the iterations.
4888 @item -Wno-attributes
4889 @opindex Wno-attributes
4890 @opindex Wattributes
4891 Do not warn if an unexpected @code{__attribute__} is used, such as
4892 unrecognized attributes, function attributes applied to variables,
4893 etc.  This does not stop errors for incorrect use of supported
4894 attributes.
4896 @item -Wno-builtin-macro-redefined
4897 @opindex Wno-builtin-macro-redefined
4898 @opindex Wbuiltin-macro-redefined
4899 Do not warn if certain built-in macros are redefined.  This suppresses
4900 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4901 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4903 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4904 @opindex Wstrict-prototypes
4905 @opindex Wno-strict-prototypes
4906 Warn if a function is declared or defined without specifying the
4907 argument types.  (An old-style function definition is permitted without
4908 a warning if preceded by a declaration that specifies the argument
4909 types.)
4911 @item -Wold-style-declaration @r{(C and Objective-C only)}
4912 @opindex Wold-style-declaration
4913 @opindex Wno-old-style-declaration
4914 Warn for obsolescent usages, according to the C Standard, in a
4915 declaration. For example, warn if storage-class specifiers like
4916 @code{static} are not the first things in a declaration.  This warning
4917 is also enabled by @option{-Wextra}.
4919 @item -Wold-style-definition @r{(C and Objective-C only)}
4920 @opindex Wold-style-definition
4921 @opindex Wno-old-style-definition
4922 Warn if an old-style function definition is used.  A warning is given
4923 even if there is a previous prototype.
4925 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4926 @opindex Wmissing-parameter-type
4927 @opindex Wno-missing-parameter-type
4928 A function parameter is declared without a type specifier in K&R-style
4929 functions:
4931 @smallexample
4932 void foo(bar) @{ @}
4933 @end smallexample
4935 This warning is also enabled by @option{-Wextra}.
4937 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4938 @opindex Wmissing-prototypes
4939 @opindex Wno-missing-prototypes
4940 Warn if a global function is defined without a previous prototype
4941 declaration.  This warning is issued even if the definition itself
4942 provides a prototype.  Use this option to detect global functions
4943 that do not have a matching prototype declaration in a header file.
4944 This option is not valid for C++ because all function declarations
4945 provide prototypes and a non-matching declaration will declare an
4946 overload rather than conflict with an earlier declaration.
4947 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4949 @item -Wmissing-declarations
4950 @opindex Wmissing-declarations
4951 @opindex Wno-missing-declarations
4952 Warn if a global function is defined without a previous declaration.
4953 Do so even if the definition itself provides a prototype.
4954 Use this option to detect global functions that are not declared in
4955 header files.  In C, no warnings are issued for functions with previous
4956 non-prototype declarations; use @option{-Wmissing-prototypes} to detect
4957 missing prototypes.  In C++, no warnings are issued for function templates,
4958 or for inline functions, or for functions in anonymous namespaces.
4960 @item -Wmissing-field-initializers
4961 @opindex Wmissing-field-initializers
4962 @opindex Wno-missing-field-initializers
4963 @opindex W
4964 @opindex Wextra
4965 @opindex Wno-extra
4966 Warn if a structure's initializer has some fields missing.  For
4967 example, the following code causes such a warning, because
4968 @code{x.h} is implicitly zero:
4970 @smallexample
4971 struct s @{ int f, g, h; @};
4972 struct s x = @{ 3, 4 @};
4973 @end smallexample
4975 This option does not warn about designated initializers, so the following
4976 modification does not trigger a warning:
4978 @smallexample
4979 struct s @{ int f, g, h; @};
4980 struct s x = @{ .f = 3, .g = 4 @};
4981 @end smallexample
4983 In C++ this option does not warn either about the empty @{ @}
4984 initializer, for example:
4986 @smallexample
4987 struct s @{ int f, g, h; @};
4988 s x = @{ @};
4989 @end smallexample
4991 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4992 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4994 @item -Wno-multichar
4995 @opindex Wno-multichar
4996 @opindex Wmultichar
4997 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4998 Usually they indicate a typo in the user's code, as they have
4999 implementation-defined values, and should not be used in portable code.
5001 @item -Wnormalized@r{[}=@r{<}none@r{|}id@r{|}nfc@r{|}nfkc@r{>]}
5002 @opindex Wnormalized=
5003 @opindex Wnormalized
5004 @opindex Wno-normalized
5005 @cindex NFC
5006 @cindex NFKC
5007 @cindex character set, input normalization
5008 In ISO C and ISO C++, two identifiers are different if they are
5009 different sequences of characters.  However, sometimes when characters
5010 outside the basic ASCII character set are used, you can have two
5011 different character sequences that look the same.  To avoid confusion,
5012 the ISO 10646 standard sets out some @dfn{normalization rules} which
5013 when applied ensure that two sequences that look the same are turned into
5014 the same sequence.  GCC can warn you if you are using identifiers that
5015 have not been normalized; this option controls that warning.
5017 There are four levels of warning supported by GCC@.  The default is
5018 @option{-Wnormalized=nfc}, which warns about any identifier that is
5019 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
5020 recommended form for most uses.  It is equivalent to
5021 @option{-Wnormalized}.
5023 Unfortunately, there are some characters allowed in identifiers by
5024 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
5025 identifiers.  That is, there's no way to use these symbols in portable
5026 ISO C or C++ and have all your identifiers in NFC@.
5027 @option{-Wnormalized=id} suppresses the warning for these characters.
5028 It is hoped that future versions of the standards involved will correct
5029 this, which is why this option is not the default.
5031 You can switch the warning off for all characters by writing
5032 @option{-Wnormalized=none} or @option{-Wno-normalized}.  You should
5033 only do this if you are using some other normalization scheme (like
5034 ``D''), because otherwise you can easily create bugs that are
5035 literally impossible to see.
5037 Some characters in ISO 10646 have distinct meanings but look identical
5038 in some fonts or display methodologies, especially once formatting has
5039 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
5040 LETTER N'', displays just like a regular @code{n} that has been
5041 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
5042 normalization scheme to convert all these into a standard form as
5043 well, and GCC warns if your code is not in NFKC if you use
5044 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
5045 about every identifier that contains the letter O because it might be
5046 confused with the digit 0, and so is not the default, but may be
5047 useful as a local coding convention if the programming environment 
5048 cannot be fixed to display these characters distinctly.
5050 @item -Wno-deprecated
5051 @opindex Wno-deprecated
5052 @opindex Wdeprecated
5053 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
5055 @item -Wno-deprecated-declarations
5056 @opindex Wno-deprecated-declarations
5057 @opindex Wdeprecated-declarations
5058 Do not warn about uses of functions (@pxref{Function Attributes}),
5059 variables (@pxref{Variable Attributes}), and types (@pxref{Type
5060 Attributes}) marked as deprecated by using the @code{deprecated}
5061 attribute.
5063 @item -Wno-overflow
5064 @opindex Wno-overflow
5065 @opindex Woverflow
5066 Do not warn about compile-time overflow in constant expressions.
5068 @item -Wno-odr
5069 @opindex Wno-odr
5070 @opindex Wodr
5071 Warn about One Definition Rule violations during link-time optimization.
5072 Requires @option{-flto-odr-type-merging} to be enabled.  Enabled by default.
5074 @item -Wopenmp-simd
5075 @opindex Wopenm-simd
5076 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
5077 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
5078 be used to relax the cost model.
5080 @item -Woverride-init @r{(C and Objective-C only)}
5081 @opindex Woverride-init
5082 @opindex Wno-override-init
5083 @opindex W
5084 @opindex Wextra
5085 @opindex Wno-extra
5086 Warn if an initialized field without side effects is overridden when
5087 using designated initializers (@pxref{Designated Inits, , Designated
5088 Initializers}).
5090 This warning is included in @option{-Wextra}.  To get other
5091 @option{-Wextra} warnings without this one, use @option{-Wextra
5092 -Wno-override-init}.
5094 @item -Wpacked
5095 @opindex Wpacked
5096 @opindex Wno-packed
5097 Warn if a structure is given the packed attribute, but the packed
5098 attribute has no effect on the layout or size of the structure.
5099 Such structures may be mis-aligned for little benefit.  For
5100 instance, in this code, the variable @code{f.x} in @code{struct bar}
5101 is misaligned even though @code{struct bar} does not itself
5102 have the packed attribute:
5104 @smallexample
5105 @group
5106 struct foo @{
5107   int x;
5108   char a, b, c, d;
5109 @} __attribute__((packed));
5110 struct bar @{
5111   char z;
5112   struct foo f;
5114 @end group
5115 @end smallexample
5117 @item -Wpacked-bitfield-compat
5118 @opindex Wpacked-bitfield-compat
5119 @opindex Wno-packed-bitfield-compat
5120 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
5121 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
5122 the change can lead to differences in the structure layout.  GCC
5123 informs you when the offset of such a field has changed in GCC 4.4.
5124 For example there is no longer a 4-bit padding between field @code{a}
5125 and @code{b} in this structure:
5127 @smallexample
5128 struct foo
5130   char a:4;
5131   char b:8;
5132 @} __attribute__ ((packed));
5133 @end smallexample
5135 This warning is enabled by default.  Use
5136 @option{-Wno-packed-bitfield-compat} to disable this warning.
5138 @item -Wpadded
5139 @opindex Wpadded
5140 @opindex Wno-padded
5141 Warn if padding is included in a structure, either to align an element
5142 of the structure or to align the whole structure.  Sometimes when this
5143 happens it is possible to rearrange the fields of the structure to
5144 reduce the padding and so make the structure smaller.
5146 @item -Wredundant-decls
5147 @opindex Wredundant-decls
5148 @opindex Wno-redundant-decls
5149 Warn if anything is declared more than once in the same scope, even in
5150 cases where multiple declaration is valid and changes nothing.
5152 @item -Wnested-externs @r{(C and Objective-C only)}
5153 @opindex Wnested-externs
5154 @opindex Wno-nested-externs
5155 Warn if an @code{extern} declaration is encountered within a function.
5157 @item -Wno-inherited-variadic-ctor
5158 @opindex Winherited-variadic-ctor
5159 @opindex Wno-inherited-variadic-ctor
5160 Suppress warnings about use of C++11 inheriting constructors when the
5161 base class inherited from has a C variadic constructor; the warning is
5162 on by default because the ellipsis is not inherited.
5164 @item -Winline
5165 @opindex Winline
5166 @opindex Wno-inline
5167 Warn if a function that is declared as inline cannot be inlined.
5168 Even with this option, the compiler does not warn about failures to
5169 inline functions declared in system headers.
5171 The compiler uses a variety of heuristics to determine whether or not
5172 to inline a function.  For example, the compiler takes into account
5173 the size of the function being inlined and the amount of inlining
5174 that has already been done in the current function.  Therefore,
5175 seemingly insignificant changes in the source program can cause the
5176 warnings produced by @option{-Winline} to appear or disappear.
5178 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
5179 @opindex Wno-invalid-offsetof
5180 @opindex Winvalid-offsetof
5181 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
5182 type.  According to the 2014 ISO C++ standard, applying @samp{offsetof}
5183 to a non-standard-layout type is undefined.  In existing C++ implementations,
5184 however, @samp{offsetof} typically gives meaningful results.
5185 This flag is for users who are aware that they are
5186 writing nonportable code and who have deliberately chosen to ignore the
5187 warning about it.
5189 The restrictions on @samp{offsetof} may be relaxed in a future version
5190 of the C++ standard.
5192 @item -Wno-int-to-pointer-cast
5193 @opindex Wno-int-to-pointer-cast
5194 @opindex Wint-to-pointer-cast
5195 Suppress warnings from casts to pointer type of an integer of a
5196 different size. In C++, casting to a pointer type of smaller size is
5197 an error. @option{Wint-to-pointer-cast} is enabled by default.
5200 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
5201 @opindex Wno-pointer-to-int-cast
5202 @opindex Wpointer-to-int-cast
5203 Suppress warnings from casts from a pointer to an integer type of a
5204 different size.
5206 @item -Winvalid-pch
5207 @opindex Winvalid-pch
5208 @opindex Wno-invalid-pch
5209 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
5210 the search path but can't be used.
5212 @item -Wlong-long
5213 @opindex Wlong-long
5214 @opindex Wno-long-long
5215 Warn if @samp{long long} type is used.  This is enabled by either
5216 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
5217 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
5219 @item -Wvariadic-macros
5220 @opindex Wvariadic-macros
5221 @opindex Wno-variadic-macros
5222 Warn if variadic macros are used in ISO C90 mode, or if the GNU
5223 alternate syntax is used in ISO C99 mode.  This is enabled by either
5224 @option{-Wpedantic} or @option{-Wtraditional}.  To inhibit the warning
5225 messages, use @option{-Wno-variadic-macros}.
5227 @item -Wvarargs
5228 @opindex Wvarargs
5229 @opindex Wno-varargs
5230 Warn upon questionable usage of the macros used to handle variable
5231 arguments like @samp{va_start}.  This is default.  To inhibit the
5232 warning messages, use @option{-Wno-varargs}.
5234 @item -Wvector-operation-performance
5235 @opindex Wvector-operation-performance
5236 @opindex Wno-vector-operation-performance
5237 Warn if vector operation is not implemented via SIMD capabilities of the
5238 architecture.  Mainly useful for the performance tuning.
5239 Vector operation can be implemented @code{piecewise}, which means that the
5240 scalar operation is performed on every vector element; 
5241 @code{in parallel}, which means that the vector operation is implemented
5242 using scalars of wider type, which normally is more performance efficient;
5243 and @code{as a single scalar}, which means that vector fits into a
5244 scalar type.
5246 @item -Wno-virtual-move-assign
5247 @opindex Wvirtual-move-assign
5248 @opindex Wno-virtual-move-assign
5249 Suppress warnings about inheriting from a virtual base with a
5250 non-trivial C++11 move assignment operator.  This is dangerous because
5251 if the virtual base is reachable along more than one path, it will be
5252 moved multiple times, which can mean both objects end up in the
5253 moved-from state.  If the move assignment operator is written to avoid
5254 moving from a moved-from object, this warning can be disabled.
5256 @item -Wvla
5257 @opindex Wvla
5258 @opindex Wno-vla
5259 Warn if variable length array is used in the code.
5260 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5261 the variable length array.
5263 @item -Wvolatile-register-var
5264 @opindex Wvolatile-register-var
5265 @opindex Wno-volatile-register-var
5266 Warn if a register variable is declared volatile.  The volatile
5267 modifier does not inhibit all optimizations that may eliminate reads
5268 and/or writes to register variables.  This warning is enabled by
5269 @option{-Wall}.
5271 @item -Wdisabled-optimization
5272 @opindex Wdisabled-optimization
5273 @opindex Wno-disabled-optimization
5274 Warn if a requested optimization pass is disabled.  This warning does
5275 not generally indicate that there is anything wrong with your code; it
5276 merely indicates that GCC's optimizers are unable to handle the code
5277 effectively.  Often, the problem is that your code is too big or too
5278 complex; GCC refuses to optimize programs when the optimization
5279 itself is likely to take inordinate amounts of time.
5281 @item -Wpointer-sign @r{(C and Objective-C only)}
5282 @opindex Wpointer-sign
5283 @opindex Wno-pointer-sign
5284 Warn for pointer argument passing or assignment with different signedness.
5285 This option is only supported for C and Objective-C@.  It is implied by
5286 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5287 @option{-Wno-pointer-sign}.
5289 @item -Wstack-protector
5290 @opindex Wstack-protector
5291 @opindex Wno-stack-protector
5292 This option is only active when @option{-fstack-protector} is active.  It
5293 warns about functions that are not protected against stack smashing.
5295 @item -Woverlength-strings
5296 @opindex Woverlength-strings
5297 @opindex Wno-overlength-strings
5298 Warn about string constants that are longer than the ``minimum
5299 maximum'' length specified in the C standard.  Modern compilers
5300 generally allow string constants that are much longer than the
5301 standard's minimum limit, but very portable programs should avoid
5302 using longer strings.
5304 The limit applies @emph{after} string constant concatenation, and does
5305 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5306 C99, it was raised to 4095.  C++98 does not specify a normative
5307 minimum maximum, so we do not diagnose overlength strings in C++@.
5309 This option is implied by @option{-Wpedantic}, and can be disabled with
5310 @option{-Wno-overlength-strings}.
5312 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5313 @opindex Wunsuffixed-float-constants
5315 Issue a warning for any floating constant that does not have
5316 a suffix.  When used together with @option{-Wsystem-headers} it
5317 warns about such constants in system header files.  This can be useful
5318 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5319 from the decimal floating-point extension to C99.
5321 @item -Wno-designated-init @r{(C and Objective-C only)}
5322 Suppress warnings when a positional initializer is used to initialize
5323 a structure that has been marked with the @code{designated_init}
5324 attribute.
5326 @end table
5328 @node Debugging Options
5329 @section Options for Debugging Your Program or GCC
5330 @cindex options, debugging
5331 @cindex debugging information options
5333 GCC has various special options that are used for debugging
5334 either your program or GCC:
5336 @table @gcctabopt
5337 @item -g
5338 @opindex g
5339 Produce debugging information in the operating system's native format
5340 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5341 information.
5343 On most systems that use stabs format, @option{-g} enables use of extra
5344 debugging information that only GDB can use; this extra information
5345 makes debugging work better in GDB but probably makes other debuggers
5346 crash or
5347 refuse to read the program.  If you want to control for certain whether
5348 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5349 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5351 GCC allows you to use @option{-g} with
5352 @option{-O}.  The shortcuts taken by optimized code may occasionally
5353 produce surprising results: some variables you declared may not exist
5354 at all; flow of control may briefly move where you did not expect it;
5355 some statements may not be executed because they compute constant
5356 results or their values are already at hand; some statements may
5357 execute in different places because they have been moved out of loops.
5359 Nevertheless it proves possible to debug optimized output.  This makes
5360 it reasonable to use the optimizer for programs that might have bugs.
5362 The following options are useful when GCC is generated with the
5363 capability for more than one debugging format.
5365 @item -gsplit-dwarf
5366 @opindex gsplit-dwarf
5367 Separate as much dwarf debugging information as possible into a
5368 separate output file with the extension .dwo.  This option allows
5369 the build system to avoid linking files with debug information.  To
5370 be useful, this option requires a debugger capable of reading .dwo
5371 files.
5373 @item -ggdb
5374 @opindex ggdb
5375 Produce debugging information for use by GDB@.  This means to use the
5376 most expressive format available (DWARF 2, stabs, or the native format
5377 if neither of those are supported), including GDB extensions if at all
5378 possible.
5380 @item -gpubnames
5381 @opindex gpubnames
5382 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5384 @item -ggnu-pubnames
5385 @opindex ggnu-pubnames
5386 Generate .debug_pubnames and .debug_pubtypes sections in a format
5387 suitable for conversion into a GDB@ index.  This option is only useful
5388 with a linker that can produce GDB@ index version 7.
5390 @item -gstabs
5391 @opindex gstabs
5392 Produce debugging information in stabs format (if that is supported),
5393 without GDB extensions.  This is the format used by DBX on most BSD
5394 systems.  On MIPS, Alpha and System V Release 4 systems this option
5395 produces stabs debugging output that is not understood by DBX or SDB@.
5396 On System V Release 4 systems this option requires the GNU assembler.
5398 @item -feliminate-unused-debug-symbols
5399 @opindex feliminate-unused-debug-symbols
5400 Produce debugging information in stabs format (if that is supported),
5401 for only symbols that are actually used.
5403 @item -femit-class-debug-always
5404 Instead of emitting debugging information for a C++ class in only one
5405 object file, emit it in all object files using the class.  This option
5406 should be used only with debuggers that are unable to handle the way GCC
5407 normally emits debugging information for classes because using this
5408 option increases the size of debugging information by as much as a
5409 factor of two.
5411 @item -fdebug-types-section
5412 @opindex fdebug-types-section
5413 @opindex fno-debug-types-section
5414 When using DWARF Version 4 or higher, type DIEs can be put into
5415 their own @code{.debug_types} section instead of making them part of the
5416 @code{.debug_info} section.  It is more efficient to put them in a separate
5417 comdat sections since the linker can then remove duplicates.
5418 But not all DWARF consumers support @code{.debug_types} sections yet
5419 and on some objects @code{.debug_types} produces larger instead of smaller
5420 debugging information.
5422 @item -gstabs+
5423 @opindex gstabs+
5424 Produce debugging information in stabs format (if that is supported),
5425 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5426 use of these extensions is likely to make other debuggers crash or
5427 refuse to read the program.
5429 @item -gcoff
5430 @opindex gcoff
5431 Produce debugging information in COFF format (if that is supported).
5432 This is the format used by SDB on most System V systems prior to
5433 System V Release 4.
5435 @item -gxcoff
5436 @opindex gxcoff
5437 Produce debugging information in XCOFF format (if that is supported).
5438 This is the format used by the DBX debugger on IBM RS/6000 systems.
5440 @item -gxcoff+
5441 @opindex gxcoff+
5442 Produce debugging information in XCOFF format (if that is supported),
5443 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5444 use of these extensions is likely to make other debuggers crash or
5445 refuse to read the program, and may cause assemblers other than the GNU
5446 assembler (GAS) to fail with an error.
5448 @item -gdwarf-@var{version}
5449 @opindex gdwarf-@var{version}
5450 Produce debugging information in DWARF format (if that is supported).
5451 The value of @var{version} may be either 2, 3, 4 or 5; the default version
5452 for most targets is 4.  DWARF Version 5 is only experimental.
5454 Note that with DWARF Version 2, some ports require and always
5455 use some non-conflicting DWARF 3 extensions in the unwind tables.
5457 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5458 for maximum benefit.
5460 @item -grecord-gcc-switches
5461 @opindex grecord-gcc-switches
5462 This switch causes the command-line options used to invoke the
5463 compiler that may affect code generation to be appended to the
5464 DW_AT_producer attribute in DWARF debugging information.  The options
5465 are concatenated with spaces separating them from each other and from
5466 the compiler version.  See also @option{-frecord-gcc-switches} for another
5467 way of storing compiler options into the object file.  This is the default.
5469 @item -gno-record-gcc-switches
5470 @opindex gno-record-gcc-switches
5471 Disallow appending command-line options to the DW_AT_producer attribute
5472 in DWARF debugging information.
5474 @item -gstrict-dwarf
5475 @opindex gstrict-dwarf
5476 Disallow using extensions of later DWARF standard version than selected
5477 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5478 DWARF extensions from later standard versions is allowed.
5480 @item -gno-strict-dwarf
5481 @opindex gno-strict-dwarf
5482 Allow using extensions of later DWARF standard version than selected with
5483 @option{-gdwarf-@var{version}}.
5485 @item -gz@r{[}=@var{type}@r{]}
5486 @opindex gz
5487 Produce compressed debug sections in DWARF format, if that is supported.
5488 If @var{type} is not given, the default type depends on the capabilities
5489 of the assembler and linker used.  @var{type} may be one of
5490 @option{none} (don't compress debug sections), @option{zlib} (use zlib
5491 compression in ELF gABI format), or @option{zlib-gnu} (use zlib
5492 compression in traditional GNU format).  If the linker doesn't support
5493 writing compressed debug sections, the option is rejected.  Otherwise,
5494 if the assembler does not support them, @option{-gz} is silently ignored
5495 when producing object files.
5497 @item -gvms
5498 @opindex gvms
5499 Produce debugging information in Alpha/VMS debug format (if that is
5500 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5502 @item -g@var{level}
5503 @itemx -ggdb@var{level}
5504 @itemx -gstabs@var{level}
5505 @itemx -gcoff@var{level}
5506 @itemx -gxcoff@var{level}
5507 @itemx -gvms@var{level}
5508 Request debugging information and also use @var{level} to specify how
5509 much information.  The default level is 2.
5511 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5512 @option{-g}.
5514 Level 1 produces minimal information, enough for making backtraces in
5515 parts of the program that you don't plan to debug.  This includes
5516 descriptions of functions and external variables, and line number
5517 tables, but no information about local variables.
5519 Level 3 includes extra information, such as all the macro definitions
5520 present in the program.  Some debuggers support macro expansion when
5521 you use @option{-g3}.
5523 @option{-gdwarf-2} does not accept a concatenated debug level, because
5524 GCC used to support an option @option{-gdwarf} that meant to generate
5525 debug information in version 1 of the DWARF format (which is very
5526 different from version 2), and it would have been too confusing.  That
5527 debug format is long obsolete, but the option cannot be changed now.
5528 Instead use an additional @option{-g@var{level}} option to change the
5529 debug level for DWARF.
5531 @item -gtoggle
5532 @opindex gtoggle
5533 Turn off generation of debug info, if leaving out this option
5534 generates it, or turn it on at level 2 otherwise.  The position of this
5535 argument in the command line does not matter; it takes effect after all
5536 other options are processed, and it does so only once, no matter how
5537 many times it is given.  This is mainly intended to be used with
5538 @option{-fcompare-debug}.
5540 @item -fsanitize=address
5541 @opindex fsanitize=address
5542 Enable AddressSanitizer, a fast memory error detector.
5543 Memory access instructions will be instrumented to detect
5544 out-of-bounds and use-after-free bugs.
5545 See @uref{http://code.google.com/p/address-sanitizer/} for
5546 more details.  The run-time behavior can be influenced using the
5547 @env{ASAN_OPTIONS} environment variable; see
5548 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5549 a list of supported options.
5551 @item -fsanitize=kernel-address
5552 @opindex fsanitize=kernel-address
5553 Enable AddressSanitizer for Linux kernel.
5554 See @uref{http://code.google.com/p/address-sanitizer/wiki/AddressSanitizerForKernel} for more details.
5556 @item -fsanitize=thread
5557 @opindex fsanitize=thread
5558 Enable ThreadSanitizer, a fast data race detector.
5559 Memory access instructions will be instrumented to detect
5560 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5561 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5562 environment variable; see
5563 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5564 supported options.
5566 @item -fsanitize=leak
5567 @opindex fsanitize=leak
5568 Enable LeakSanitizer, a memory leak detector.
5569 This option only matters for linking of executables and if neither
5570 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5571 case it will link the executable against a library that overrides @code{malloc}
5572 and other allocator functions.  See
5573 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5574 details.  The run-time behavior can be influenced using the
5575 @env{LSAN_OPTIONS} environment variable.
5577 @item -fsanitize=undefined
5578 @opindex fsanitize=undefined
5579 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5580 Various computations will be instrumented to detect undefined behavior
5581 at runtime.  Current suboptions are:
5583 @table @gcctabopt
5585 @item -fsanitize=shift
5586 @opindex fsanitize=shift
5587 This option enables checking that the result of a shift operation is
5588 not undefined.  Note that what exactly is considered undefined differs
5589 slightly between C and C++, as well as between ISO C90 and C99, etc.
5591 @item -fsanitize=integer-divide-by-zero
5592 @opindex fsanitize=integer-divide-by-zero
5593 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5595 @item -fsanitize=unreachable
5596 @opindex fsanitize=unreachable
5597 With this option, the compiler will turn the @code{__builtin_unreachable}
5598 call into a diagnostics message call instead.  When reaching the
5599 @code{__builtin_unreachable} call, the behavior is undefined.
5601 @item -fsanitize=vla-bound
5602 @opindex fsanitize=vla-bound
5603 This option instructs the compiler to check that the size of a variable
5604 length array is positive.  This option does not have any effect in
5605 @option{-std=c++14} mode, as the standard requires the exception be thrown
5606 instead.
5608 @item -fsanitize=null
5609 @opindex fsanitize=null
5610 This option enables pointer checking.  Particularly, the application
5611 built with this option turned on will issue an error message when it
5612 tries to dereference a NULL pointer, or if a reference (possibly an
5613 rvalue reference) is bound to a NULL pointer, or if a method is invoked
5614 on an object pointed by a NULL pointer.
5616 @item -fsanitize=return
5617 @opindex fsanitize=return
5618 This option enables return statement checking.  Programs
5619 built with this option turned on will issue an error message
5620 when the end of a non-void function is reached without actually
5621 returning a value.  This option works in C++ only.
5623 @item -fsanitize=signed-integer-overflow
5624 @opindex fsanitize=signed-integer-overflow
5625 This option enables signed integer overflow checking.  We check that
5626 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5627 does not overflow in the signed arithmetics.  Note, integer promotion
5628 rules must be taken into account.  That is, the following is not an
5629 overflow:
5630 @smallexample
5631 signed char a = SCHAR_MAX;
5632 a++;
5633 @end smallexample
5635 @item -fsanitize=bounds
5636 @opindex fsanitize=bounds
5637 This option enables instrumentation of array bounds.  Various out of bounds
5638 accesses are detected.  Flexible array members and initializers of variables
5639 with static storage are not instrumented.
5641 @item -fsanitize=alignment
5642 @opindex fsanitize=alignment
5644 This option enables checking of alignment of pointers when they are
5645 dereferenced, or when a reference is bound to insufficiently aligned target,
5646 or when a method or constructor is invoked on insufficiently aligned object.
5648 @item -fsanitize=object-size
5649 @opindex fsanitize=object-size
5650 This option enables instrumentation of memory references using the
5651 @code{__builtin_object_size} function.  Various out of bounds pointer
5652 accesses are detected.
5654 @item -fsanitize=float-divide-by-zero
5655 @opindex fsanitize=float-divide-by-zero
5656 Detect floating-point division by zero.  Unlike other similar options,
5657 @option{-fsanitize=float-divide-by-zero} is not enabled by
5658 @option{-fsanitize=undefined}, since floating-point division by zero can
5659 be a legitimate way of obtaining infinities and NaNs.
5661 @item -fsanitize=float-cast-overflow
5662 @opindex fsanitize=float-cast-overflow
5663 This option enables floating-point type to integer conversion checking.
5664 We check that the result of the conversion does not overflow.
5665 This option does not work well with @code{FE_INVALID} exceptions enabled.
5667 @item -fsanitize=nonnull-attribute
5668 @opindex fsanitize=nonnull-attribute
5670 This option enables instrumentation of calls, checking whether null values
5671 are not passed to arguments marked as requiring a non-null value by the
5672 @code{nonnull} function attribute.
5674 @item -fsanitize=returns-nonnull-attribute
5675 @opindex fsanitize=returns-nonnull-attribute
5677 This option enables instrumentation of return statements in functions
5678 marked with @code{returns_nonnull} function attribute, to detect returning
5679 of null values from such functions.
5681 @item -fsanitize=bool
5682 @opindex fsanitize=bool
5684 This option enables instrumentation of loads from bool.  If a value other
5685 than 0/1 is loaded, a run-time error is issued.
5687 @item -fsanitize=enum
5688 @opindex fsanitize=enum
5690 This option enables instrumentation of loads from an enum type.  If
5691 a value outside the range of values for the enum type is loaded,
5692 a run-time error is issued.
5694 @end table
5696 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5697 @option{-fsanitize=undefined} gives a diagnostic message.
5698 This currently works only for the C family of languages.
5700 @item -fasan-shadow-offset=@var{number}
5701 @opindex fasan-shadow-offset
5702 This option forces GCC to use custom shadow offset in AddressSanitizer checks.
5703 It is useful for experimenting with different shadow memory layouts in
5704 Kernel AddressSanitizer.
5706 @item -fsanitize-recover@r{[}=@var{opts}@r{]}
5707 @opindex fsanitize-recover
5708 @opindex fno-sanitize-recover
5709 @option{-fsanitize-recover=} controls error recovery mode for sanitizers
5710 mentioned in comma-separated list of @var{opts}.  Enabling this option
5711 for a sanitizer component would cause it to attempt to continue
5712 running the program as if no error happened.  This means multiple
5713 runtime errors can be reported in a single program run, and the exit
5714 code of the program may indicate success even when errors
5715 have been reported.  The @option{-fno-sanitize-recover=} can be used to alter
5716 this behavior, only the first detected error will be reported
5717 and program will exit after that with non-zero exit code.
5719 Currently this feature only works for @option{-fsanitize=undefined} (and its suboptions
5720 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return}),
5721 @option{-fsanitize=float-cast-overflow}, @option{-fsanitize=float-divide-by-zero} and
5722 @option{-fsanitize=kernel-address}.  For these sanitizers error recovery is turned on by default.
5724 Syntax without explicit @var{opts} parameter is deprecated.  It is equivalent to
5725 @option{-fsanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5726 Similarly @option{-fno-sanitize-recover} is equivalent to
5727 @option{-fno-sanitize-recover=undefined,float-cast-overflow,float-divide-by-zero,kernel-address}.
5729 @item -fsanitize-undefined-trap-on-error
5730 @opindex fsanitize-undefined-trap-on-error
5731 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5732 report undefined behavior using @code{__builtin_trap ()} rather than
5733 a @code{libubsan} library routine.  The advantage of this is that the
5734 @code{libubsan} library is not needed and will not be linked in, so this
5735 is usable even for use in freestanding environments.
5737 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5738 @opindex fdump-final-insns
5739 Dump the final internal representation (RTL) to @var{file}.  If the
5740 optional argument is omitted (or if @var{file} is @code{.}), the name
5741 of the dump file is determined by appending @code{.gkd} to the
5742 compilation output file name.
5744 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5745 @opindex fcompare-debug
5746 @opindex fno-compare-debug
5747 If no error occurs during compilation, run the compiler a second time,
5748 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5749 passed to the second compilation.  Dump the final internal
5750 representation in both compilations, and print an error if they differ.
5752 If the equal sign is omitted, the default @option{-gtoggle} is used.
5754 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5755 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5756 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5757 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5758 is used.
5760 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5761 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5762 of the final representation and the second compilation, preventing even
5763 @env{GCC_COMPARE_DEBUG} from taking effect.
5765 To verify full coverage during @option{-fcompare-debug} testing, set
5766 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5767 which GCC rejects as an invalid option in any actual compilation
5768 (rather than preprocessing, assembly or linking).  To get just a
5769 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5770 not overridden} will do.
5772 @item -fcompare-debug-second
5773 @opindex fcompare-debug-second
5774 This option is implicitly passed to the compiler for the second
5775 compilation requested by @option{-fcompare-debug}, along with options to
5776 silence warnings, and omitting other options that would cause
5777 side-effect compiler outputs to files or to the standard output.  Dump
5778 files and preserved temporary files are renamed so as to contain the
5779 @code{.gk} additional extension during the second compilation, to avoid
5780 overwriting those generated by the first.
5782 When this option is passed to the compiler driver, it causes the
5783 @emph{first} compilation to be skipped, which makes it useful for little
5784 other than debugging the compiler proper.
5786 @item -feliminate-dwarf2-dups
5787 @opindex feliminate-dwarf2-dups
5788 Compress DWARF 2 debugging information by eliminating duplicated
5789 information about each symbol.  This option only makes sense when
5790 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5792 @item -femit-struct-debug-baseonly
5793 @opindex femit-struct-debug-baseonly
5794 Emit debug information for struct-like types
5795 only when the base name of the compilation source file
5796 matches the base name of file in which the struct is defined.
5798 This option substantially reduces the size of debugging information,
5799 but at significant potential loss in type information to the debugger.
5800 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5801 See @option{-femit-struct-debug-detailed} for more detailed control.
5803 This option works only with DWARF 2.
5805 @item -femit-struct-debug-reduced
5806 @opindex femit-struct-debug-reduced
5807 Emit debug information for struct-like types
5808 only when the base name of the compilation source file
5809 matches the base name of file in which the type is defined,
5810 unless the struct is a template or defined in a system header.
5812 This option significantly reduces the size of debugging information,
5813 with some potential loss in type information to the debugger.
5814 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5815 See @option{-femit-struct-debug-detailed} for more detailed control.
5817 This option works only with DWARF 2.
5819 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5820 Specify the struct-like types
5821 for which the compiler generates debug information.
5822 The intent is to reduce duplicate struct debug information
5823 between different object files within the same program.
5825 This option is a detailed version of
5826 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5827 which serves for most needs.
5829 A specification has the syntax@*
5830 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5832 The optional first word limits the specification to
5833 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5834 A struct type is used directly when it is the type of a variable, member.
5835 Indirect uses arise through pointers to structs.
5836 That is, when use of an incomplete struct is valid, the use is indirect.
5837 An example is
5838 @samp{struct one direct; struct two * indirect;}.
5840 The optional second word limits the specification to
5841 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5842 Generic structs are a bit complicated to explain.
5843 For C++, these are non-explicit specializations of template classes,
5844 or non-template classes within the above.
5845 Other programming languages have generics,
5846 but @option{-femit-struct-debug-detailed} does not yet implement them.
5848 The third word specifies the source files for those
5849 structs for which the compiler should emit debug information.
5850 The values @samp{none} and @samp{any} have the normal meaning.
5851 The value @samp{base} means that
5852 the base of name of the file in which the type declaration appears
5853 must match the base of the name of the main compilation file.
5854 In practice, this means that when compiling @file{foo.c}, debug information
5855 is generated for types declared in that file and @file{foo.h},
5856 but not other header files.
5857 The value @samp{sys} means those types satisfying @samp{base}
5858 or declared in system or compiler headers.
5860 You may need to experiment to determine the best settings for your application.
5862 The default is @option{-femit-struct-debug-detailed=all}.
5864 This option works only with DWARF 2.
5866 @item -fno-merge-debug-strings
5867 @opindex fmerge-debug-strings
5868 @opindex fno-merge-debug-strings
5869 Direct the linker to not merge together strings in the debugging
5870 information that are identical in different object files.  Merging is
5871 not supported by all assemblers or linkers.  Merging decreases the size
5872 of the debug information in the output file at the cost of increasing
5873 link processing time.  Merging is enabled by default.
5875 @item -fdebug-prefix-map=@var{old}=@var{new}
5876 @opindex fdebug-prefix-map
5877 When compiling files in directory @file{@var{old}}, record debugging
5878 information describing them as in @file{@var{new}} instead.
5880 @item -fno-dwarf2-cfi-asm
5881 @opindex fdwarf2-cfi-asm
5882 @opindex fno-dwarf2-cfi-asm
5883 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5884 instead of using GAS @code{.cfi_*} directives.
5886 @cindex @command{prof}
5887 @item -p
5888 @opindex p
5889 Generate extra code to write profile information suitable for the
5890 analysis program @command{prof}.  You must use this option when compiling
5891 the source files you want data about, and you must also use it when
5892 linking.
5894 @cindex @command{gprof}
5895 @item -pg
5896 @opindex pg
5897 Generate extra code to write profile information suitable for the
5898 analysis program @command{gprof}.  You must use this option when compiling
5899 the source files you want data about, and you must also use it when
5900 linking.
5902 @item -Q
5903 @opindex Q
5904 Makes the compiler print out each function name as it is compiled, and
5905 print some statistics about each pass when it finishes.
5907 @item -ftime-report
5908 @opindex ftime-report
5909 Makes the compiler print some statistics about the time consumed by each
5910 pass when it finishes.
5912 @item -fmem-report
5913 @opindex fmem-report
5914 Makes the compiler print some statistics about permanent memory
5915 allocation when it finishes.
5917 @item -fmem-report-wpa
5918 @opindex fmem-report-wpa
5919 Makes the compiler print some statistics about permanent memory
5920 allocation for the WPA phase only.
5922 @item -fpre-ipa-mem-report
5923 @opindex fpre-ipa-mem-report
5924 @item -fpost-ipa-mem-report
5925 @opindex fpost-ipa-mem-report
5926 Makes the compiler print some statistics about permanent memory
5927 allocation before or after interprocedural optimization.
5929 @item -fprofile-report
5930 @opindex fprofile-report
5931 Makes the compiler print some statistics about consistency of the
5932 (estimated) profile and effect of individual passes.
5934 @item -fstack-usage
5935 @opindex fstack-usage
5936 Makes the compiler output stack usage information for the program, on a
5937 per-function basis.  The filename for the dump is made by appending
5938 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5939 the output file, if explicitly specified and it is not an executable,
5940 otherwise it is the basename of the source file.  An entry is made up
5941 of three fields:
5943 @itemize
5944 @item
5945 The name of the function.
5946 @item
5947 A number of bytes.
5948 @item
5949 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5950 @end itemize
5952 The qualifier @code{static} means that the function manipulates the stack
5953 statically: a fixed number of bytes are allocated for the frame on function
5954 entry and released on function exit; no stack adjustments are otherwise made
5955 in the function.  The second field is this fixed number of bytes.
5957 The qualifier @code{dynamic} means that the function manipulates the stack
5958 dynamically: in addition to the static allocation described above, stack
5959 adjustments are made in the body of the function, for example to push/pop
5960 arguments around function calls.  If the qualifier @code{bounded} is also
5961 present, the amount of these adjustments is bounded at compile time and
5962 the second field is an upper bound of the total amount of stack used by
5963 the function.  If it is not present, the amount of these adjustments is
5964 not bounded at compile time and the second field only represents the
5965 bounded part.
5967 @item -fprofile-arcs
5968 @opindex fprofile-arcs
5969 Add code so that program flow @dfn{arcs} are instrumented.  During
5970 execution the program records how many times each branch and call is
5971 executed and how many times it is taken or returns.  When the compiled
5972 program exits it saves this data to a file called
5973 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5974 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5975 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5976 @var{auxname} is generated from the name of the output file, if
5977 explicitly specified and it is not the final executable, otherwise it is
5978 the basename of the source file.  In both cases any suffix is removed
5979 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5980 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5981 @xref{Cross-profiling}.
5983 @cindex @command{gcov}
5984 @item --coverage
5985 @opindex coverage
5987 This option is used to compile and link code instrumented for coverage
5988 analysis.  The option is a synonym for @option{-fprofile-arcs}
5989 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5990 linking).  See the documentation for those options for more details.
5992 @itemize
5994 @item
5995 Compile the source files with @option{-fprofile-arcs} plus optimization
5996 and code generation options.  For test coverage analysis, use the
5997 additional @option{-ftest-coverage} option.  You do not need to profile
5998 every source file in a program.
6000 @item
6001 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
6002 (the latter implies the former).
6004 @item
6005 Run the program on a representative workload to generate the arc profile
6006 information.  This may be repeated any number of times.  You can run
6007 concurrent instances of your program, and provided that the file system
6008 supports locking, the data files will be correctly updated.  Also
6009 @code{fork} calls are detected and correctly handled (double counting
6010 will not happen).
6012 @item
6013 For profile-directed optimizations, compile the source files again with
6014 the same optimization and code generation options plus
6015 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
6016 Control Optimization}).
6018 @item
6019 For test coverage analysis, use @command{gcov} to produce human readable
6020 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
6021 @command{gcov} documentation for further information.
6023 @end itemize
6025 With @option{-fprofile-arcs}, for each function of your program GCC
6026 creates a program flow graph, then finds a spanning tree for the graph.
6027 Only arcs that are not on the spanning tree have to be instrumented: the
6028 compiler adds code to count the number of times that these arcs are
6029 executed.  When an arc is the only exit or only entrance to a block, the
6030 instrumentation code can be added to the block; otherwise, a new basic
6031 block must be created to hold the instrumentation code.
6033 @need 2000
6034 @item -ftest-coverage
6035 @opindex ftest-coverage
6036 Produce a notes file that the @command{gcov} code-coverage utility
6037 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
6038 show program coverage.  Each source file's note file is called
6039 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
6040 above for a description of @var{auxname} and instructions on how to
6041 generate test coverage data.  Coverage data matches the source files
6042 more closely if you do not optimize.
6044 @item -fdbg-cnt-list
6045 @opindex fdbg-cnt-list
6046 Print the name and the counter upper bound for all debug counters.
6049 @item -fdbg-cnt=@var{counter-value-list}
6050 @opindex fdbg-cnt
6051 Set the internal debug counter upper bound.  @var{counter-value-list}
6052 is a comma-separated list of @var{name}:@var{value} pairs
6053 which sets the upper bound of each debug counter @var{name} to @var{value}.
6054 All debug counters have the initial upper bound of @code{UINT_MAX};
6055 thus @code{dbg_cnt()} returns true always unless the upper bound
6056 is set by this option.
6057 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
6058 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
6060 @item -fenable-@var{kind}-@var{pass}
6061 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
6062 @opindex fdisable-
6063 @opindex fenable-
6065 This is a set of options that are used to explicitly disable/enable
6066 optimization passes.  These options are intended for use for debugging GCC.
6067 Compiler users should use regular options for enabling/disabling
6068 passes instead.
6070 @table @gcctabopt
6072 @item -fdisable-ipa-@var{pass}
6073 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
6074 statically invoked in the compiler multiple times, the pass name should be
6075 appended with a sequential number starting from 1.
6077 @item -fdisable-rtl-@var{pass}
6078 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
6079 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6080 statically invoked in the compiler multiple times, the pass name should be
6081 appended with a sequential number starting from 1.  @var{range-list} is a 
6082 comma-separated list of function ranges or assembler names.  Each range is a number
6083 pair separated by a colon.  The range is inclusive in both ends.  If the range
6084 is trivial, the number pair can be simplified as a single number.  If the
6085 function's call graph node's @var{uid} falls within one of the specified ranges,
6086 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
6087 function header of a dump file, and the pass names can be dumped by using
6088 option @option{-fdump-passes}.
6090 @item -fdisable-tree-@var{pass}
6091 @itemx -fdisable-tree-@var{pass}=@var{range-list}
6092 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
6093 option arguments.
6095 @item -fenable-ipa-@var{pass}
6096 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
6097 statically invoked in the compiler multiple times, the pass name should be
6098 appended with a sequential number starting from 1.
6100 @item -fenable-rtl-@var{pass}
6101 @itemx -fenable-rtl-@var{pass}=@var{range-list}
6102 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
6103 description and examples.
6105 @item -fenable-tree-@var{pass}
6106 @itemx -fenable-tree-@var{pass}=@var{range-list}
6107 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
6108 of option arguments.
6110 @end table
6112 Here are some examples showing uses of these options.
6114 @smallexample
6116 # disable ccp1 for all functions
6117    -fdisable-tree-ccp1
6118 # disable complete unroll for function whose cgraph node uid is 1
6119    -fenable-tree-cunroll=1
6120 # disable gcse2 for functions at the following ranges [1,1],
6121 # [300,400], and [400,1000]
6122 # disable gcse2 for functions foo and foo2
6123    -fdisable-rtl-gcse2=foo,foo2
6124 # disable early inlining
6125    -fdisable-tree-einline
6126 # disable ipa inlining
6127    -fdisable-ipa-inline
6128 # enable tree full unroll
6129    -fenable-tree-unroll
6131 @end smallexample
6133 @item -d@var{letters}
6134 @itemx -fdump-rtl-@var{pass}
6135 @itemx -fdump-rtl-@var{pass}=@var{filename}
6136 @opindex d
6137 @opindex fdump-rtl-@var{pass}
6138 Says to make debugging dumps during compilation at times specified by
6139 @var{letters}.  This is used for debugging the RTL-based passes of the
6140 compiler.  The file names for most of the dumps are made by appending
6141 a pass number and a word to the @var{dumpname}, and the files are
6142 created in the directory of the output file. In case of
6143 @option{=@var{filename}} option, the dump is output on the given file
6144 instead of the pass numbered dump files. Note that the pass number is
6145 computed statically as passes get registered into the pass manager.
6146 Thus the numbering is not related to the dynamic order of execution of
6147 passes.  In particular, a pass installed by a plugin could have a
6148 number over 200 even if it executed quite early.  @var{dumpname} is
6149 generated from the name of the output file, if explicitly specified
6150 and it is not an executable, otherwise it is the basename of the
6151 source file. These switches may have different effects when
6152 @option{-E} is used for preprocessing.
6154 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
6155 @option{-d} option @var{letters}.  Here are the possible
6156 letters for use in @var{pass} and @var{letters}, and their meanings:
6158 @table @gcctabopt
6160 @item -fdump-rtl-alignments
6161 @opindex fdump-rtl-alignments
6162 Dump after branch alignments have been computed.
6164 @item -fdump-rtl-asmcons
6165 @opindex fdump-rtl-asmcons
6166 Dump after fixing rtl statements that have unsatisfied in/out constraints.
6168 @item -fdump-rtl-auto_inc_dec
6169 @opindex fdump-rtl-auto_inc_dec
6170 Dump after auto-inc-dec discovery.  This pass is only run on
6171 architectures that have auto inc or auto dec instructions.
6173 @item -fdump-rtl-barriers
6174 @opindex fdump-rtl-barriers
6175 Dump after cleaning up the barrier instructions.
6177 @item -fdump-rtl-bbpart
6178 @opindex fdump-rtl-bbpart
6179 Dump after partitioning hot and cold basic blocks.
6181 @item -fdump-rtl-bbro
6182 @opindex fdump-rtl-bbro
6183 Dump after block reordering.
6185 @item -fdump-rtl-btl1
6186 @itemx -fdump-rtl-btl2
6187 @opindex fdump-rtl-btl2
6188 @opindex fdump-rtl-btl2
6189 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
6190 after the two branch
6191 target load optimization passes.
6193 @item -fdump-rtl-bypass
6194 @opindex fdump-rtl-bypass
6195 Dump after jump bypassing and control flow optimizations.
6197 @item -fdump-rtl-combine
6198 @opindex fdump-rtl-combine
6199 Dump after the RTL instruction combination pass.
6201 @item -fdump-rtl-compgotos
6202 @opindex fdump-rtl-compgotos
6203 Dump after duplicating the computed gotos.
6205 @item -fdump-rtl-ce1
6206 @itemx -fdump-rtl-ce2
6207 @itemx -fdump-rtl-ce3
6208 @opindex fdump-rtl-ce1
6209 @opindex fdump-rtl-ce2
6210 @opindex fdump-rtl-ce3
6211 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
6212 @option{-fdump-rtl-ce3} enable dumping after the three
6213 if conversion passes.
6215 @item -fdump-rtl-cprop_hardreg
6216 @opindex fdump-rtl-cprop_hardreg
6217 Dump after hard register copy propagation.
6219 @item -fdump-rtl-csa
6220 @opindex fdump-rtl-csa
6221 Dump after combining stack adjustments.
6223 @item -fdump-rtl-cse1
6224 @itemx -fdump-rtl-cse2
6225 @opindex fdump-rtl-cse1
6226 @opindex fdump-rtl-cse2
6227 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
6228 the two common subexpression elimination passes.
6230 @item -fdump-rtl-dce
6231 @opindex fdump-rtl-dce
6232 Dump after the standalone dead code elimination passes.
6234 @item -fdump-rtl-dbr
6235 @opindex fdump-rtl-dbr
6236 Dump after delayed branch scheduling.
6238 @item -fdump-rtl-dce1
6239 @itemx -fdump-rtl-dce2
6240 @opindex fdump-rtl-dce1
6241 @opindex fdump-rtl-dce2
6242 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
6243 the two dead store elimination passes.
6245 @item -fdump-rtl-eh
6246 @opindex fdump-rtl-eh
6247 Dump after finalization of EH handling code.
6249 @item -fdump-rtl-eh_ranges
6250 @opindex fdump-rtl-eh_ranges
6251 Dump after conversion of EH handling range regions.
6253 @item -fdump-rtl-expand
6254 @opindex fdump-rtl-expand
6255 Dump after RTL generation.
6257 @item -fdump-rtl-fwprop1
6258 @itemx -fdump-rtl-fwprop2
6259 @opindex fdump-rtl-fwprop1
6260 @opindex fdump-rtl-fwprop2
6261 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
6262 dumping after the two forward propagation passes.
6264 @item -fdump-rtl-gcse1
6265 @itemx -fdump-rtl-gcse2
6266 @opindex fdump-rtl-gcse1
6267 @opindex fdump-rtl-gcse2
6268 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
6269 after global common subexpression elimination.
6271 @item -fdump-rtl-init-regs
6272 @opindex fdump-rtl-init-regs
6273 Dump after the initialization of the registers.
6275 @item -fdump-rtl-initvals
6276 @opindex fdump-rtl-initvals
6277 Dump after the computation of the initial value sets.
6279 @item -fdump-rtl-into_cfglayout
6280 @opindex fdump-rtl-into_cfglayout
6281 Dump after converting to cfglayout mode.
6283 @item -fdump-rtl-ira
6284 @opindex fdump-rtl-ira
6285 Dump after iterated register allocation.
6287 @item -fdump-rtl-jump
6288 @opindex fdump-rtl-jump
6289 Dump after the second jump optimization.
6291 @item -fdump-rtl-loop2
6292 @opindex fdump-rtl-loop2
6293 @option{-fdump-rtl-loop2} enables dumping after the rtl
6294 loop optimization passes.
6296 @item -fdump-rtl-mach
6297 @opindex fdump-rtl-mach
6298 Dump after performing the machine dependent reorganization pass, if that
6299 pass exists.
6301 @item -fdump-rtl-mode_sw
6302 @opindex fdump-rtl-mode_sw
6303 Dump after removing redundant mode switches.
6305 @item -fdump-rtl-rnreg
6306 @opindex fdump-rtl-rnreg
6307 Dump after register renumbering.
6309 @item -fdump-rtl-outof_cfglayout
6310 @opindex fdump-rtl-outof_cfglayout
6311 Dump after converting from cfglayout mode.
6313 @item -fdump-rtl-peephole2
6314 @opindex fdump-rtl-peephole2
6315 Dump after the peephole pass.
6317 @item -fdump-rtl-postreload
6318 @opindex fdump-rtl-postreload
6319 Dump after post-reload optimizations.
6321 @item -fdump-rtl-pro_and_epilogue
6322 @opindex fdump-rtl-pro_and_epilogue
6323 Dump after generating the function prologues and epilogues.
6325 @item -fdump-rtl-sched1
6326 @itemx -fdump-rtl-sched2
6327 @opindex fdump-rtl-sched1
6328 @opindex fdump-rtl-sched2
6329 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
6330 after the basic block scheduling passes.
6332 @item -fdump-rtl-ree
6333 @opindex fdump-rtl-ree
6334 Dump after sign/zero extension elimination.
6336 @item -fdump-rtl-seqabstr
6337 @opindex fdump-rtl-seqabstr
6338 Dump after common sequence discovery.
6340 @item -fdump-rtl-shorten
6341 @opindex fdump-rtl-shorten
6342 Dump after shortening branches.
6344 @item -fdump-rtl-sibling
6345 @opindex fdump-rtl-sibling
6346 Dump after sibling call optimizations.
6348 @item -fdump-rtl-split1
6349 @itemx -fdump-rtl-split2
6350 @itemx -fdump-rtl-split3
6351 @itemx -fdump-rtl-split4
6352 @itemx -fdump-rtl-split5
6353 @opindex fdump-rtl-split1
6354 @opindex fdump-rtl-split2
6355 @opindex fdump-rtl-split3
6356 @opindex fdump-rtl-split4
6357 @opindex fdump-rtl-split5
6358 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6359 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6360 @option{-fdump-rtl-split5} enable dumping after five rounds of
6361 instruction splitting.
6363 @item -fdump-rtl-sms
6364 @opindex fdump-rtl-sms
6365 Dump after modulo scheduling.  This pass is only run on some
6366 architectures.
6368 @item -fdump-rtl-stack
6369 @opindex fdump-rtl-stack
6370 Dump after conversion from GCC's ``flat register file'' registers to the
6371 x87's stack-like registers.  This pass is only run on x86 variants.
6373 @item -fdump-rtl-subreg1
6374 @itemx -fdump-rtl-subreg2
6375 @opindex fdump-rtl-subreg1
6376 @opindex fdump-rtl-subreg2
6377 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6378 the two subreg expansion passes.
6380 @item -fdump-rtl-unshare
6381 @opindex fdump-rtl-unshare
6382 Dump after all rtl has been unshared.
6384 @item -fdump-rtl-vartrack
6385 @opindex fdump-rtl-vartrack
6386 Dump after variable tracking.
6388 @item -fdump-rtl-vregs
6389 @opindex fdump-rtl-vregs
6390 Dump after converting virtual registers to hard registers.
6392 @item -fdump-rtl-web
6393 @opindex fdump-rtl-web
6394 Dump after live range splitting.
6396 @item -fdump-rtl-regclass
6397 @itemx -fdump-rtl-subregs_of_mode_init
6398 @itemx -fdump-rtl-subregs_of_mode_finish
6399 @itemx -fdump-rtl-dfinit
6400 @itemx -fdump-rtl-dfinish
6401 @opindex fdump-rtl-regclass
6402 @opindex fdump-rtl-subregs_of_mode_init
6403 @opindex fdump-rtl-subregs_of_mode_finish
6404 @opindex fdump-rtl-dfinit
6405 @opindex fdump-rtl-dfinish
6406 These dumps are defined but always produce empty files.
6408 @item -da
6409 @itemx -fdump-rtl-all
6410 @opindex da
6411 @opindex fdump-rtl-all
6412 Produce all the dumps listed above.
6414 @item -dA
6415 @opindex dA
6416 Annotate the assembler output with miscellaneous debugging information.
6418 @item -dD
6419 @opindex dD
6420 Dump all macro definitions, at the end of preprocessing, in addition to
6421 normal output.
6423 @item -dH
6424 @opindex dH
6425 Produce a core dump whenever an error occurs.
6427 @item -dp
6428 @opindex dp
6429 Annotate the assembler output with a comment indicating which
6430 pattern and alternative is used.  The length of each instruction is
6431 also printed.
6433 @item -dP
6434 @opindex dP
6435 Dump the RTL in the assembler output as a comment before each instruction.
6436 Also turns on @option{-dp} annotation.
6438 @item -dx
6439 @opindex dx
6440 Just generate RTL for a function instead of compiling it.  Usually used
6441 with @option{-fdump-rtl-expand}.
6442 @end table
6444 @item -fdump-noaddr
6445 @opindex fdump-noaddr
6446 When doing debugging dumps, suppress address output.  This makes it more
6447 feasible to use diff on debugging dumps for compiler invocations with
6448 different compiler binaries and/or different
6449 text / bss / data / heap / stack / dso start locations.
6451 @item -freport-bug
6452 @opindex freport-bug
6453 Collect and dump debug information into temporary file if ICE in C/C++
6454 compiler occured.
6456 @item -fdump-unnumbered
6457 @opindex fdump-unnumbered
6458 When doing debugging dumps, suppress instruction numbers and address output.
6459 This makes it more feasible to use diff on debugging dumps for compiler
6460 invocations with different options, in particular with and without
6461 @option{-g}.
6463 @item -fdump-unnumbered-links
6464 @opindex fdump-unnumbered-links
6465 When doing debugging dumps (see @option{-d} option above), suppress
6466 instruction numbers for the links to the previous and next instructions
6467 in a sequence.
6469 @item -fdump-translation-unit @r{(C++ only)}
6470 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6471 @opindex fdump-translation-unit
6472 Dump a representation of the tree structure for the entire translation
6473 unit to a file.  The file name is made by appending @file{.tu} to the
6474 source file name, and the file is created in the same directory as the
6475 output file.  If the @samp{-@var{options}} form is used, @var{options}
6476 controls the details of the dump as described for the
6477 @option{-fdump-tree} options.
6479 @item -fdump-class-hierarchy @r{(C++ only)}
6480 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6481 @opindex fdump-class-hierarchy
6482 Dump a representation of each class's hierarchy and virtual function
6483 table layout to a file.  The file name is made by appending
6484 @file{.class} to the source file name, and the file is created in the
6485 same directory as the output file.  If the @samp{-@var{options}} form
6486 is used, @var{options} controls the details of the dump as described
6487 for the @option{-fdump-tree} options.
6489 @item -fdump-ipa-@var{switch}
6490 @opindex fdump-ipa
6491 Control the dumping at various stages of inter-procedural analysis
6492 language tree to a file.  The file name is generated by appending a
6493 switch specific suffix to the source file name, and the file is created
6494 in the same directory as the output file.  The following dumps are
6495 possible:
6497 @table @samp
6498 @item all
6499 Enables all inter-procedural analysis dumps.
6501 @item cgraph
6502 Dumps information about call-graph optimization, unused function removal,
6503 and inlining decisions.
6505 @item inline
6506 Dump after function inlining.
6508 @end table
6510 @item -fdump-passes
6511 @opindex fdump-passes
6512 Dump the list of optimization passes that are turned on and off by
6513 the current command-line options.
6515 @item -fdump-statistics-@var{option}
6516 @opindex fdump-statistics
6517 Enable and control dumping of pass statistics in a separate file.  The
6518 file name is generated by appending a suffix ending in
6519 @samp{.statistics} to the source file name, and the file is created in
6520 the same directory as the output file.  If the @samp{-@var{option}}
6521 form is used, @samp{-stats} causes counters to be summed over the
6522 whole compilation unit while @samp{-details} dumps every event as
6523 the passes generate them.  The default with no option is to sum
6524 counters for each function compiled.
6526 @item -fdump-tree-@var{switch}
6527 @itemx -fdump-tree-@var{switch}-@var{options}
6528 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6529 @opindex fdump-tree
6530 Control the dumping at various stages of processing the intermediate
6531 language tree to a file.  The file name is generated by appending a
6532 switch-specific suffix to the source file name, and the file is
6533 created in the same directory as the output file. In case of
6534 @option{=@var{filename}} option, the dump is output on the given file
6535 instead of the auto named dump files.  If the @samp{-@var{options}}
6536 form is used, @var{options} is a list of @samp{-} separated options
6537 which control the details of the dump.  Not all options are applicable
6538 to all dumps; those that are not meaningful are ignored.  The
6539 following options are available
6541 @table @samp
6542 @item address
6543 Print the address of each node.  Usually this is not meaningful as it
6544 changes according to the environment and source file.  Its primary use
6545 is for tying up a dump file with a debug environment.
6546 @item asmname
6547 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6548 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6549 use working backward from mangled names in the assembly file.
6550 @item slim
6551 When dumping front-end intermediate representations, inhibit dumping
6552 of members of a scope or body of a function merely because that scope
6553 has been reached.  Only dump such items when they are directly reachable
6554 by some other path.
6556 When dumping pretty-printed trees, this option inhibits dumping the
6557 bodies of control structures.
6559 When dumping RTL, print the RTL in slim (condensed) form instead of
6560 the default LISP-like representation.
6561 @item raw
6562 Print a raw representation of the tree.  By default, trees are
6563 pretty-printed into a C-like representation.
6564 @item details
6565 Enable more detailed dumps (not honored by every dump option). Also
6566 include information from the optimization passes.
6567 @item stats
6568 Enable dumping various statistics about the pass (not honored by every dump
6569 option).
6570 @item blocks
6571 Enable showing basic block boundaries (disabled in raw dumps).
6572 @item graph
6573 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6574 dump a representation of the control flow graph suitable for viewing with
6575 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6576 the file is pretty-printed as a subgraph, so that GraphViz can render them
6577 all in a single plot.
6579 This option currently only works for RTL dumps, and the RTL is always
6580 dumped in slim form.
6581 @item vops
6582 Enable showing virtual operands for every statement.
6583 @item lineno
6584 Enable showing line numbers for statements.
6585 @item uid
6586 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6587 @item verbose
6588 Enable showing the tree dump for each statement.
6589 @item eh
6590 Enable showing the EH region number holding each statement.
6591 @item scev
6592 Enable showing scalar evolution analysis details.
6593 @item optimized
6594 Enable showing optimization information (only available in certain
6595 passes).
6596 @item missed
6597 Enable showing missed optimization information (only available in certain
6598 passes).
6599 @item note
6600 Enable other detailed optimization information (only available in
6601 certain passes).
6602 @item =@var{filename}
6603 Instead of an auto named dump file, output into the given file
6604 name. The file names @file{stdout} and @file{stderr} are treated
6605 specially and are considered already open standard streams. For
6606 example,
6608 @smallexample
6609 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6610      -fdump-tree-pre=stderr file.c
6611 @end smallexample
6613 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6614 output on to @file{stderr}. If two conflicting dump filenames are
6615 given for the same pass, then the latter option overrides the earlier
6616 one.
6618 @item all
6619 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6620 and @option{lineno}.
6622 @item optall
6623 Turn on all optimization options, i.e., @option{optimized},
6624 @option{missed}, and @option{note}.
6625 @end table
6627 The following tree dumps are possible:
6628 @table @samp
6630 @item original
6631 @opindex fdump-tree-original
6632 Dump before any tree based optimization, to @file{@var{file}.original}.
6634 @item optimized
6635 @opindex fdump-tree-optimized
6636 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6638 @item gimple
6639 @opindex fdump-tree-gimple
6640 Dump each function before and after the gimplification pass to a file.  The
6641 file name is made by appending @file{.gimple} to the source file name.
6643 @item cfg
6644 @opindex fdump-tree-cfg
6645 Dump the control flow graph of each function to a file.  The file name is
6646 made by appending @file{.cfg} to the source file name.
6648 @item ch
6649 @opindex fdump-tree-ch
6650 Dump each function after copying loop headers.  The file name is made by
6651 appending @file{.ch} to the source file name.
6653 @item ssa
6654 @opindex fdump-tree-ssa
6655 Dump SSA related information to a file.  The file name is made by appending
6656 @file{.ssa} to the source file name.
6658 @item alias
6659 @opindex fdump-tree-alias
6660 Dump aliasing information for each function.  The file name is made by
6661 appending @file{.alias} to the source file name.
6663 @item ccp
6664 @opindex fdump-tree-ccp
6665 Dump each function after CCP@.  The file name is made by appending
6666 @file{.ccp} to the source file name.
6668 @item storeccp
6669 @opindex fdump-tree-storeccp
6670 Dump each function after STORE-CCP@.  The file name is made by appending
6671 @file{.storeccp} to the source file name.
6673 @item pre
6674 @opindex fdump-tree-pre
6675 Dump trees after partial redundancy elimination.  The file name is made
6676 by appending @file{.pre} to the source file name.
6678 @item fre
6679 @opindex fdump-tree-fre
6680 Dump trees after full redundancy elimination.  The file name is made
6681 by appending @file{.fre} to the source file name.
6683 @item copyprop
6684 @opindex fdump-tree-copyprop
6685 Dump trees after copy propagation.  The file name is made
6686 by appending @file{.copyprop} to the source file name.
6688 @item store_copyprop
6689 @opindex fdump-tree-store_copyprop
6690 Dump trees after store copy-propagation.  The file name is made
6691 by appending @file{.store_copyprop} to the source file name.
6693 @item dce
6694 @opindex fdump-tree-dce
6695 Dump each function after dead code elimination.  The file name is made by
6696 appending @file{.dce} to the source file name.
6698 @item sra
6699 @opindex fdump-tree-sra
6700 Dump each function after performing scalar replacement of aggregates.  The
6701 file name is made by appending @file{.sra} to the source file name.
6703 @item sink
6704 @opindex fdump-tree-sink
6705 Dump each function after performing code sinking.  The file name is made
6706 by appending @file{.sink} to the source file name.
6708 @item dom
6709 @opindex fdump-tree-dom
6710 Dump each function after applying dominator tree optimizations.  The file
6711 name is made by appending @file{.dom} to the source file name.
6713 @item dse
6714 @opindex fdump-tree-dse
6715 Dump each function after applying dead store elimination.  The file
6716 name is made by appending @file{.dse} to the source file name.
6718 @item phiopt
6719 @opindex fdump-tree-phiopt
6720 Dump each function after optimizing PHI nodes into straightline code.  The file
6721 name is made by appending @file{.phiopt} to the source file name.
6723 @item forwprop
6724 @opindex fdump-tree-forwprop
6725 Dump each function after forward propagating single use variables.  The file
6726 name is made by appending @file{.forwprop} to the source file name.
6728 @item copyrename
6729 @opindex fdump-tree-copyrename
6730 Dump each function after applying the copy rename optimization.  The file
6731 name is made by appending @file{.copyrename} to the source file name.
6733 @item nrv
6734 @opindex fdump-tree-nrv
6735 Dump each function after applying the named return value optimization on
6736 generic trees.  The file name is made by appending @file{.nrv} to the source
6737 file name.
6739 @item vect
6740 @opindex fdump-tree-vect
6741 Dump each function after applying vectorization of loops.  The file name is
6742 made by appending @file{.vect} to the source file name.
6744 @item slp
6745 @opindex fdump-tree-slp
6746 Dump each function after applying vectorization of basic blocks.  The file name
6747 is made by appending @file{.slp} to the source file name.
6749 @item vrp
6750 @opindex fdump-tree-vrp
6751 Dump each function after Value Range Propagation (VRP).  The file name
6752 is made by appending @file{.vrp} to the source file name.
6754 @item all
6755 @opindex fdump-tree-all
6756 Enable all the available tree dumps with the flags provided in this option.
6757 @end table
6759 @item -fopt-info
6760 @itemx -fopt-info-@var{options}
6761 @itemx -fopt-info-@var{options}=@var{filename}
6762 @opindex fopt-info
6763 Controls optimization dumps from various optimization passes. If the
6764 @samp{-@var{options}} form is used, @var{options} is a list of
6765 @samp{-} separated options to select the dump details and
6766 optimizations.  If @var{options} is not specified, it defaults to
6767 @option{optimized} for details and @option{optall} for optimization
6768 groups. If the @var{filename} is not specified, it defaults to
6769 @file{stderr}. Note that the output @var{filename} will be overwritten
6770 in case of multiple translation units. If a combined output from
6771 multiple translation units is desired, @file{stderr} should be used
6772 instead.
6774 The options can be divided into two groups, 1) options describing the
6775 verbosity of the dump, and 2) options describing which optimizations
6776 should be included. The options from both the groups can be freely
6777 mixed as they are non-overlapping. However, in case of any conflicts,
6778 the latter options override the earlier options on the command
6779 line. Though multiple -fopt-info options are accepted, only one of
6780 them can have @option{=filename}. If other filenames are provided then
6781 all but the first one are ignored.
6783 The dump verbosity has the following options
6785 @table @samp
6786 @item optimized
6787 Print information when an optimization is successfully applied. It is
6788 up to a pass to decide which information is relevant. For example, the
6789 vectorizer passes print the source location of loops which got
6790 successfully vectorized.
6791 @item missed
6792 Print information about missed optimizations. Individual passes
6793 control which information to include in the output. For example,
6795 @smallexample
6796 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6797 @end smallexample
6799 will print information about missed optimization opportunities from
6800 vectorization passes on stderr.
6801 @item note
6802 Print verbose information about optimizations, such as certain
6803 transformations, more detailed messages about decisions etc.
6804 @item all
6805 Print detailed optimization information. This includes
6806 @var{optimized}, @var{missed}, and @var{note}.
6807 @end table
6809 The second set of options describes a group of optimizations and may
6810 include one or more of the following.
6812 @table @samp
6813 @item ipa
6814 Enable dumps from all interprocedural optimizations.
6815 @item loop
6816 Enable dumps from all loop optimizations.
6817 @item inline
6818 Enable dumps from all inlining optimizations.
6819 @item vec
6820 Enable dumps from all vectorization optimizations.
6821 @item optall
6822 Enable dumps from all optimizations. This is a superset of
6823 the optimization groups listed above.
6824 @end table
6826 For example,
6827 @smallexample
6828 gcc -O3 -fopt-info-missed=missed.all
6829 @end smallexample
6831 outputs missed optimization report from all the passes into
6832 @file{missed.all}.
6834 As another example,
6835 @smallexample
6836 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6837 @end smallexample
6839 will output information about missed optimizations as well as
6840 optimized locations from all the inlining passes into
6841 @file{inline.txt}.
6843 If the @var{filename} is provided, then the dumps from all the
6844 applicable optimizations are concatenated into the @file{filename}.
6845 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6846 omitted, it defaults to @option{all-optall}, which means dump all
6847 available optimization info from all the passes. In the following
6848 example, all optimization info is output on to @file{stderr}.
6850 @smallexample
6851 gcc -O3 -fopt-info
6852 @end smallexample
6854 Note that @option{-fopt-info-vec-missed} behaves the same as
6855 @option{-fopt-info-missed-vec}.
6857 As another example, consider
6859 @smallexample
6860 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6861 @end smallexample
6863 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6864 in conflict since only one output file is allowed. In this case, only
6865 the first option takes effect and the subsequent options are
6866 ignored. Thus only the @file{vec.miss} is produced which contains
6867 dumps from the vectorizer about missed opportunities.
6869 @item -frandom-seed=@var{number}
6870 @opindex frandom-seed
6871 This option provides a seed that GCC uses in place of
6872 random numbers in generating certain symbol names
6873 that have to be different in every compiled file.  It is also used to
6874 place unique stamps in coverage data files and the object files that
6875 produce them.  You can use the @option{-frandom-seed} option to produce
6876 reproducibly identical object files.
6878 The @var{number} should be different for every file you compile.
6880 @item -fsched-verbose=@var{n}
6881 @opindex fsched-verbose
6882 On targets that use instruction scheduling, this option controls the
6883 amount of debugging output the scheduler prints.  This information is
6884 written to standard error, unless @option{-fdump-rtl-sched1} or
6885 @option{-fdump-rtl-sched2} is specified, in which case it is output
6886 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6887 respectively.  However for @var{n} greater than nine, the output is
6888 always printed to standard error.
6890 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6891 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6892 For @var{n} greater than one, it also output basic block probabilities,
6893 detailed ready list information and unit/insn info.  For @var{n} greater
6894 than two, it includes RTL at abort point, control-flow and regions info.
6895 And for @var{n} over four, @option{-fsched-verbose} also includes
6896 dependence info.
6898 @item -save-temps
6899 @itemx -save-temps=cwd
6900 @opindex save-temps
6901 Store the usual ``temporary'' intermediate files permanently; place them
6902 in the current directory and name them based on the source file.  Thus,
6903 compiling @file{foo.c} with @option{-c -save-temps} produces files
6904 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6905 preprocessed @file{foo.i} output file even though the compiler now
6906 normally uses an integrated preprocessor.
6908 When used in combination with the @option{-x} command-line option,
6909 @option{-save-temps} is sensible enough to avoid over writing an
6910 input source file with the same extension as an intermediate file.
6911 The corresponding intermediate file may be obtained by renaming the
6912 source file before using @option{-save-temps}.
6914 If you invoke GCC in parallel, compiling several different source
6915 files that share a common base name in different subdirectories or the
6916 same source file compiled for multiple output destinations, it is
6917 likely that the different parallel compilers will interfere with each
6918 other, and overwrite the temporary files.  For instance:
6920 @smallexample
6921 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6922 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6923 @end smallexample
6925 may result in @file{foo.i} and @file{foo.o} being written to
6926 simultaneously by both compilers.
6928 @item -save-temps=obj
6929 @opindex save-temps=obj
6930 Store the usual ``temporary'' intermediate files permanently.  If the
6931 @option{-o} option is used, the temporary files are based on the
6932 object file.  If the @option{-o} option is not used, the
6933 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6935 For example:
6937 @smallexample
6938 gcc -save-temps=obj -c foo.c
6939 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6940 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6941 @end smallexample
6943 @noindent
6944 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6945 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6946 @file{dir2/yfoobar.o}.
6948 @item -time@r{[}=@var{file}@r{]}
6949 @opindex time
6950 Report the CPU time taken by each subprocess in the compilation
6951 sequence.  For C source files, this is the compiler proper and assembler
6952 (plus the linker if linking is done).
6954 Without the specification of an output file, the output looks like this:
6956 @smallexample
6957 # cc1 0.12 0.01
6958 # as 0.00 0.01
6959 @end smallexample
6961 The first number on each line is the ``user time'', that is time spent
6962 executing the program itself.  The second number is ``system time'',
6963 time spent executing operating system routines on behalf of the program.
6964 Both numbers are in seconds.
6966 With the specification of an output file, the output is appended to the
6967 named file, and it looks like this:
6969 @smallexample
6970 0.12 0.01 cc1 @var{options}
6971 0.00 0.01 as @var{options}
6972 @end smallexample
6974 The ``user time'' and the ``system time'' are moved before the program
6975 name, and the options passed to the program are displayed, so that one
6976 can later tell what file was being compiled, and with which options.
6978 @item -fvar-tracking
6979 @opindex fvar-tracking
6980 Run variable tracking pass.  It computes where variables are stored at each
6981 position in code.  Better debugging information is then generated
6982 (if the debugging information format supports this information).
6984 It is enabled by default when compiling with optimization (@option{-Os},
6985 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6986 the debug info format supports it.
6988 @item -fvar-tracking-assignments
6989 @opindex fvar-tracking-assignments
6990 @opindex fno-var-tracking-assignments
6991 Annotate assignments to user variables early in the compilation and
6992 attempt to carry the annotations over throughout the compilation all the
6993 way to the end, in an attempt to improve debug information while
6994 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6996 It can be enabled even if var-tracking is disabled, in which case
6997 annotations are created and maintained, but discarded at the end.
6999 @item -fvar-tracking-assignments-toggle
7000 @opindex fvar-tracking-assignments-toggle
7001 @opindex fno-var-tracking-assignments-toggle
7002 Toggle @option{-fvar-tracking-assignments}, in the same way that
7003 @option{-gtoggle} toggles @option{-g}.
7005 @item -print-file-name=@var{library}
7006 @opindex print-file-name
7007 Print the full absolute name of the library file @var{library} that
7008 would be used when linking---and don't do anything else.  With this
7009 option, GCC does not compile or link anything; it just prints the
7010 file name.
7012 @item -print-multi-directory
7013 @opindex print-multi-directory
7014 Print the directory name corresponding to the multilib selected by any
7015 other switches present in the command line.  This directory is supposed
7016 to exist in @env{GCC_EXEC_PREFIX}.
7018 @item -print-multi-lib
7019 @opindex print-multi-lib
7020 Print the mapping from multilib directory names to compiler switches
7021 that enable them.  The directory name is separated from the switches by
7022 @samp{;}, and each switch starts with an @samp{@@} instead of the
7023 @samp{-}, without spaces between multiple switches.  This is supposed to
7024 ease shell processing.
7026 @item -print-multi-os-directory
7027 @opindex print-multi-os-directory
7028 Print the path to OS libraries for the selected
7029 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
7030 present in the @file{lib} subdirectory and no multilibs are used, this is
7031 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
7032 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
7033 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
7034 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
7036 @item -print-multiarch
7037 @opindex print-multiarch
7038 Print the path to OS libraries for the selected multiarch,
7039 relative to some @file{lib} subdirectory.
7041 @item -print-prog-name=@var{program}
7042 @opindex print-prog-name
7043 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
7045 @item -print-libgcc-file-name
7046 @opindex print-libgcc-file-name
7047 Same as @option{-print-file-name=libgcc.a}.
7049 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
7050 but you do want to link with @file{libgcc.a}.  You can do:
7052 @smallexample
7053 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
7054 @end smallexample
7056 @item -print-search-dirs
7057 @opindex print-search-dirs
7058 Print the name of the configured installation directory and a list of
7059 program and library directories @command{gcc} searches---and don't do anything else.
7061 This is useful when @command{gcc} prints the error message
7062 @samp{installation problem, cannot exec cpp0: No such file or directory}.
7063 To resolve this you either need to put @file{cpp0} and the other compiler
7064 components where @command{gcc} expects to find them, or you can set the environment
7065 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
7066 Don't forget the trailing @samp{/}.
7067 @xref{Environment Variables}.
7069 @item -print-sysroot
7070 @opindex print-sysroot
7071 Print the target sysroot directory that is used during
7072 compilation.  This is the target sysroot specified either at configure
7073 time or using the @option{--sysroot} option, possibly with an extra
7074 suffix that depends on compilation options.  If no target sysroot is
7075 specified, the option prints nothing.
7077 @item -print-sysroot-headers-suffix
7078 @opindex print-sysroot-headers-suffix
7079 Print the suffix added to the target sysroot when searching for
7080 headers, or give an error if the compiler is not configured with such
7081 a suffix---and don't do anything else.
7083 @item -dumpmachine
7084 @opindex dumpmachine
7085 Print the compiler's target machine (for example,
7086 @samp{i686-pc-linux-gnu})---and don't do anything else.
7088 @item -dumpversion
7089 @opindex dumpversion
7090 Print the compiler version (for example, @samp{3.0})---and don't do
7091 anything else.
7093 @item -dumpspecs
7094 @opindex dumpspecs
7095 Print the compiler's built-in specs---and don't do anything else.  (This
7096 is used when GCC itself is being built.)  @xref{Spec Files}.
7098 @item -fno-eliminate-unused-debug-types
7099 @opindex feliminate-unused-debug-types
7100 @opindex fno-eliminate-unused-debug-types
7101 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
7102 output for types that are nowhere used in the source file being compiled.
7103 Sometimes it is useful to have GCC emit debugging
7104 information for all types declared in a compilation
7105 unit, regardless of whether or not they are actually used
7106 in that compilation unit, for example 
7107 if, in the debugger, you want to cast a value to a type that is
7108 not actually used in your program (but is declared).  More often,
7109 however, this results in a significant amount of wasted space.
7110 @end table
7112 @node Optimize Options
7113 @section Options That Control Optimization
7114 @cindex optimize options
7115 @cindex options, optimization
7117 These options control various sorts of optimizations.
7119 Without any optimization option, the compiler's goal is to reduce the
7120 cost of compilation and to make debugging produce the expected
7121 results.  Statements are independent: if you stop the program with a
7122 breakpoint between statements, you can then assign a new value to any
7123 variable or change the program counter to any other statement in the
7124 function and get exactly the results you expect from the source
7125 code.
7127 Turning on optimization flags makes the compiler attempt to improve
7128 the performance and/or code size at the expense of compilation time
7129 and possibly the ability to debug the program.
7131 The compiler performs optimization based on the knowledge it has of the
7132 program.  Compiling multiple files at once to a single output file mode allows
7133 the compiler to use information gained from all of the files when compiling
7134 each of them.
7136 Not all optimizations are controlled directly by a flag.  Only
7137 optimizations that have a flag are listed in this section.
7139 Most optimizations are only enabled if an @option{-O} level is set on
7140 the command line.  Otherwise they are disabled, even if individual
7141 optimization flags are specified.
7143 Depending on the target and how GCC was configured, a slightly different
7144 set of optimizations may be enabled at each @option{-O} level than
7145 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
7146 to find out the exact set of optimizations that are enabled at each level.
7147 @xref{Overall Options}, for examples.
7149 @table @gcctabopt
7150 @item -O
7151 @itemx -O1
7152 @opindex O
7153 @opindex O1
7154 Optimize.  Optimizing compilation takes somewhat more time, and a lot
7155 more memory for a large function.
7157 With @option{-O}, the compiler tries to reduce code size and execution
7158 time, without performing any optimizations that take a great deal of
7159 compilation time.
7161 @option{-O} turns on the following optimization flags:
7162 @gccoptlist{
7163 -fauto-inc-dec @gol
7164 -fbranch-count-reg @gol
7165 -fcombine-stack-adjustments @gol
7166 -fcompare-elim @gol
7167 -fcprop-registers @gol
7168 -fdce @gol
7169 -fdefer-pop @gol
7170 -fdelayed-branch @gol
7171 -fdse @gol
7172 -fforward-propagate @gol
7173 -fguess-branch-probability @gol
7174 -fif-conversion2 @gol
7175 -fif-conversion @gol
7176 -finline-functions-called-once @gol
7177 -fipa-pure-const @gol
7178 -fipa-profile @gol
7179 -fipa-reference @gol
7180 -fmerge-constants @gol
7181 -fmove-loop-invariants @gol
7182 -fshrink-wrap @gol
7183 -fsplit-wide-types @gol
7184 -ftree-bit-ccp @gol
7185 -ftree-ccp @gol
7186 -fssa-phiopt @gol
7187 -ftree-ch @gol
7188 -ftree-copy-prop @gol
7189 -ftree-copyrename @gol
7190 -ftree-dce @gol
7191 -ftree-dominator-opts @gol
7192 -ftree-dse @gol
7193 -ftree-forwprop @gol
7194 -ftree-fre @gol
7195 -ftree-phiprop @gol
7196 -ftree-sink @gol
7197 -ftree-slsr @gol
7198 -ftree-sra @gol
7199 -ftree-pta @gol
7200 -ftree-ter @gol
7201 -funit-at-a-time}
7203 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
7204 where doing so does not interfere with debugging.
7206 @item -O2
7207 @opindex O2
7208 Optimize even more.  GCC performs nearly all supported optimizations
7209 that do not involve a space-speed tradeoff.
7210 As compared to @option{-O}, this option increases both compilation time
7211 and the performance of the generated code.
7213 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
7214 also turns on the following optimization flags:
7215 @gccoptlist{-fthread-jumps @gol
7216 -falign-functions  -falign-jumps @gol
7217 -falign-loops  -falign-labels @gol
7218 -fcaller-saves @gol
7219 -fcrossjumping @gol
7220 -fcse-follow-jumps  -fcse-skip-blocks @gol
7221 -fdelete-null-pointer-checks @gol
7222 -fdevirtualize -fdevirtualize-speculatively @gol
7223 -fexpensive-optimizations @gol
7224 -fgcse  -fgcse-lm  @gol
7225 -fhoist-adjacent-loads @gol
7226 -finline-small-functions @gol
7227 -findirect-inlining @gol
7228 -fipa-cp @gol
7229 -fipa-sra @gol
7230 -fipa-icf @gol
7231 -fisolate-erroneous-paths-dereference @gol
7232 -flra-remat @gol
7233 -foptimize-sibling-calls @gol
7234 -foptimize-strlen @gol
7235 -fpartial-inlining @gol
7236 -fpeephole2 @gol
7237 -freorder-blocks -freorder-blocks-and-partition -freorder-functions @gol
7238 -frerun-cse-after-loop  @gol
7239 -fsched-interblock  -fsched-spec @gol
7240 -fschedule-insns  -fschedule-insns2 @gol
7241 -fstrict-aliasing -fstrict-overflow @gol
7242 -ftree-builtin-call-dce @gol
7243 -ftree-switch-conversion -ftree-tail-merge @gol
7244 -ftree-pre @gol
7245 -ftree-vrp @gol
7246 -fipa-ra}
7248 Please note the warning under @option{-fgcse} about
7249 invoking @option{-O2} on programs that use computed gotos.
7251 @item -O3
7252 @opindex O3
7253 Optimize yet more.  @option{-O3} turns on all optimizations specified
7254 by @option{-O2} and also turns on the @option{-finline-functions},
7255 @option{-funswitch-loops}, @option{-fpredictive-commoning},
7256 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
7257 @option{-ftree-loop-distribute-patterns},
7258 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
7259 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
7261 @item -O0
7262 @opindex O0
7263 Reduce compilation time and make debugging produce the expected
7264 results.  This is the default.
7266 @item -Os
7267 @opindex Os
7268 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
7269 do not typically increase code size.  It also performs further
7270 optimizations designed to reduce code size.
7272 @option{-Os} disables the following optimization flags:
7273 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
7274 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
7275 -fprefetch-loop-arrays}
7277 @item -Ofast
7278 @opindex Ofast
7279 Disregard strict standards compliance.  @option{-Ofast} enables all
7280 @option{-O3} optimizations.  It also enables optimizations that are not
7281 valid for all standard-compliant programs.
7282 It turns on @option{-ffast-math} and the Fortran-specific
7283 @option{-fno-protect-parens} and @option{-fstack-arrays}.
7285 @item -Og
7286 @opindex Og
7287 Optimize debugging experience.  @option{-Og} enables optimizations
7288 that do not interfere with debugging. It should be the optimization
7289 level of choice for the standard edit-compile-debug cycle, offering
7290 a reasonable level of optimization while maintaining fast compilation
7291 and a good debugging experience.
7293 If you use multiple @option{-O} options, with or without level numbers,
7294 the last such option is the one that is effective.
7295 @end table
7297 Options of the form @option{-f@var{flag}} specify machine-independent
7298 flags.  Most flags have both positive and negative forms; the negative
7299 form of @option{-ffoo} is @option{-fno-foo}.  In the table
7300 below, only one of the forms is listed---the one you typically 
7301 use.  You can figure out the other form by either removing @samp{no-}
7302 or adding it.
7304 The following options control specific optimizations.  They are either
7305 activated by @option{-O} options or are related to ones that are.  You
7306 can use the following flags in the rare cases when ``fine-tuning'' of
7307 optimizations to be performed is desired.
7309 @table @gcctabopt
7310 @item -fno-defer-pop
7311 @opindex fno-defer-pop
7312 Always pop the arguments to each function call as soon as that function
7313 returns.  For machines that must pop arguments after a function call,
7314 the compiler normally lets arguments accumulate on the stack for several
7315 function calls and pops them all at once.
7317 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7319 @item -fforward-propagate
7320 @opindex fforward-propagate
7321 Perform a forward propagation pass on RTL@.  The pass tries to combine two
7322 instructions and checks if the result can be simplified.  If loop unrolling
7323 is active, two passes are performed and the second is scheduled after
7324 loop unrolling.
7326 This option is enabled by default at optimization levels @option{-O},
7327 @option{-O2}, @option{-O3}, @option{-Os}.
7329 @item -ffp-contract=@var{style}
7330 @opindex ffp-contract
7331 @option{-ffp-contract=off} disables floating-point expression contraction.
7332 @option{-ffp-contract=fast} enables floating-point expression contraction
7333 such as forming of fused multiply-add operations if the target has
7334 native support for them.
7335 @option{-ffp-contract=on} enables floating-point expression contraction
7336 if allowed by the language standard.  This is currently not implemented
7337 and treated equal to @option{-ffp-contract=off}.
7339 The default is @option{-ffp-contract=fast}.
7341 @item -fomit-frame-pointer
7342 @opindex fomit-frame-pointer
7343 Don't keep the frame pointer in a register for functions that
7344 don't need one.  This avoids the instructions to save, set up and
7345 restore frame pointers; it also makes an extra register available
7346 in many functions.  @strong{It also makes debugging impossible on
7347 some machines.}
7349 On some machines, such as the VAX, this flag has no effect, because
7350 the standard calling sequence automatically handles the frame pointer
7351 and nothing is saved by pretending it doesn't exist.  The
7352 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7353 whether a target machine supports this flag.  @xref{Registers,,Register
7354 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7356 Starting with GCC version 4.6, the default setting (when not optimizing for
7357 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7358 @option{-fomit-frame-pointer}.  The default can be reverted to
7359 @option{-fno-omit-frame-pointer} by configuring GCC with the
7360 @option{--enable-frame-pointer} configure option.
7362 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7364 @item -foptimize-sibling-calls
7365 @opindex foptimize-sibling-calls
7366 Optimize sibling and tail recursive calls.
7368 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7370 @item -foptimize-strlen
7371 @opindex foptimize-strlen
7372 Optimize various standard C string functions (e.g. @code{strlen},
7373 @code{strchr} or @code{strcpy}) and
7374 their @code{_FORTIFY_SOURCE} counterparts into faster alternatives.
7376 Enabled at levels @option{-O2}, @option{-O3}.
7378 @item -fno-inline
7379 @opindex fno-inline
7380 Do not expand any functions inline apart from those marked with
7381 the @code{always_inline} attribute.  This is the default when not
7382 optimizing.
7384 Single functions can be exempted from inlining by marking them
7385 with the @code{noinline} attribute.
7387 @item -finline-small-functions
7388 @opindex finline-small-functions
7389 Integrate functions into their callers when their body is smaller than expected
7390 function call code (so overall size of program gets smaller).  The compiler
7391 heuristically decides which functions are simple enough to be worth integrating
7392 in this way.  This inlining applies to all functions, even those not declared
7393 inline.
7395 Enabled at level @option{-O2}.
7397 @item -findirect-inlining
7398 @opindex findirect-inlining
7399 Inline also indirect calls that are discovered to be known at compile
7400 time thanks to previous inlining.  This option has any effect only
7401 when inlining itself is turned on by the @option{-finline-functions}
7402 or @option{-finline-small-functions} options.
7404 Enabled at level @option{-O2}.
7406 @item -finline-functions
7407 @opindex finline-functions
7408 Consider all functions for inlining, even if they are not declared inline.
7409 The compiler heuristically decides which functions are worth integrating
7410 in this way.
7412 If all calls to a given function are integrated, and the function is
7413 declared @code{static}, then the function is normally not output as
7414 assembler code in its own right.
7416 Enabled at level @option{-O3}.
7418 @item -finline-functions-called-once
7419 @opindex finline-functions-called-once
7420 Consider all @code{static} functions called once for inlining into their
7421 caller even if they are not marked @code{inline}.  If a call to a given
7422 function is integrated, then the function is not output as assembler code
7423 in its own right.
7425 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7427 @item -fearly-inlining
7428 @opindex fearly-inlining
7429 Inline functions marked by @code{always_inline} and functions whose body seems
7430 smaller than the function call overhead early before doing
7431 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7432 makes profiling significantly cheaper and usually inlining faster on programs
7433 having large chains of nested wrapper functions.
7435 Enabled by default.
7437 @item -fipa-sra
7438 @opindex fipa-sra
7439 Perform interprocedural scalar replacement of aggregates, removal of
7440 unused parameters and replacement of parameters passed by reference
7441 by parameters passed by value.
7443 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7445 @item -finline-limit=@var{n}
7446 @opindex finline-limit
7447 By default, GCC limits the size of functions that can be inlined.  This flag
7448 allows coarse control of this limit.  @var{n} is the size of functions that
7449 can be inlined in number of pseudo instructions.
7451 Inlining is actually controlled by a number of parameters, which may be
7452 specified individually by using @option{--param @var{name}=@var{value}}.
7453 The @option{-finline-limit=@var{n}} option sets some of these parameters
7454 as follows:
7456 @table @gcctabopt
7457 @item max-inline-insns-single
7458 is set to @var{n}/2.
7459 @item max-inline-insns-auto
7460 is set to @var{n}/2.
7461 @end table
7463 See below for a documentation of the individual
7464 parameters controlling inlining and for the defaults of these parameters.
7466 @emph{Note:} there may be no value to @option{-finline-limit} that results
7467 in default behavior.
7469 @emph{Note:} pseudo instruction represents, in this particular context, an
7470 abstract measurement of function's size.  In no way does it represent a count
7471 of assembly instructions and as such its exact meaning might change from one
7472 release to an another.
7474 @item -fno-keep-inline-dllexport
7475 @opindex -fno-keep-inline-dllexport
7476 This is a more fine-grained version of @option{-fkeep-inline-functions},
7477 which applies only to functions that are declared using the @code{dllexport}
7478 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7479 Functions}.)
7481 @item -fkeep-inline-functions
7482 @opindex fkeep-inline-functions
7483 In C, emit @code{static} functions that are declared @code{inline}
7484 into the object file, even if the function has been inlined into all
7485 of its callers.  This switch does not affect functions using the
7486 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7487 inline functions into the object file.
7489 @item -fkeep-static-consts
7490 @opindex fkeep-static-consts
7491 Emit variables declared @code{static const} when optimization isn't turned
7492 on, even if the variables aren't referenced.
7494 GCC enables this option by default.  If you want to force the compiler to
7495 check if a variable is referenced, regardless of whether or not
7496 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7498 @item -fmerge-constants
7499 @opindex fmerge-constants
7500 Attempt to merge identical constants (string constants and floating-point
7501 constants) across compilation units.
7503 This option is the default for optimized compilation if the assembler and
7504 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7505 behavior.
7507 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7509 @item -fmerge-all-constants
7510 @opindex fmerge-all-constants
7511 Attempt to merge identical constants and identical variables.
7513 This option implies @option{-fmerge-constants}.  In addition to
7514 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7515 arrays or initialized constant variables with integral or floating-point
7516 types.  Languages like C or C++ require each variable, including multiple
7517 instances of the same variable in recursive calls, to have distinct locations,
7518 so using this option results in non-conforming
7519 behavior.
7521 @item -fmodulo-sched
7522 @opindex fmodulo-sched
7523 Perform swing modulo scheduling immediately before the first scheduling
7524 pass.  This pass looks at innermost loops and reorders their
7525 instructions by overlapping different iterations.
7527 @item -fmodulo-sched-allow-regmoves
7528 @opindex fmodulo-sched-allow-regmoves
7529 Perform more aggressive SMS-based modulo scheduling with register moves
7530 allowed.  By setting this flag certain anti-dependences edges are
7531 deleted, which triggers the generation of reg-moves based on the
7532 life-range analysis.  This option is effective only with
7533 @option{-fmodulo-sched} enabled.
7535 @item -fno-branch-count-reg
7536 @opindex fno-branch-count-reg
7537 Do not use ``decrement and branch'' instructions on a count register,
7538 but instead generate a sequence of instructions that decrement a
7539 register, compare it against zero, then branch based upon the result.
7540 This option is only meaningful on architectures that support such
7541 instructions, which include x86, PowerPC, IA-64 and S/390.
7543 Enabled by default at @option{-O1} and higher.
7545 The default is @option{-fbranch-count-reg}.
7547 @item -fno-function-cse
7548 @opindex fno-function-cse
7549 Do not put function addresses in registers; make each instruction that
7550 calls a constant function contain the function's address explicitly.
7552 This option results in less efficient code, but some strange hacks
7553 that alter the assembler output may be confused by the optimizations
7554 performed when this option is not used.
7556 The default is @option{-ffunction-cse}
7558 @item -fno-zero-initialized-in-bss
7559 @opindex fno-zero-initialized-in-bss
7560 If the target supports a BSS section, GCC by default puts variables that
7561 are initialized to zero into BSS@.  This can save space in the resulting
7562 code.
7564 This option turns off this behavior because some programs explicitly
7565 rely on variables going to the data section---e.g., so that the
7566 resulting executable can find the beginning of that section and/or make
7567 assumptions based on that.
7569 The default is @option{-fzero-initialized-in-bss}.
7571 @item -fthread-jumps
7572 @opindex fthread-jumps
7573 Perform optimizations that check to see if a jump branches to a
7574 location where another comparison subsumed by the first is found.  If
7575 so, the first branch is redirected to either the destination of the
7576 second branch or a point immediately following it, depending on whether
7577 the condition is known to be true or false.
7579 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7581 @item -fsplit-wide-types
7582 @opindex fsplit-wide-types
7583 When using a type that occupies multiple registers, such as @code{long
7584 long} on a 32-bit system, split the registers apart and allocate them
7585 independently.  This normally generates better code for those types,
7586 but may make debugging more difficult.
7588 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7589 @option{-Os}.
7591 @item -fcse-follow-jumps
7592 @opindex fcse-follow-jumps
7593 In common subexpression elimination (CSE), scan through jump instructions
7594 when the target of the jump is not reached by any other path.  For
7595 example, when CSE encounters an @code{if} statement with an
7596 @code{else} clause, CSE follows the jump when the condition
7597 tested is false.
7599 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7601 @item -fcse-skip-blocks
7602 @opindex fcse-skip-blocks
7603 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7604 follow jumps that conditionally skip over blocks.  When CSE
7605 encounters a simple @code{if} statement with no else clause,
7606 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7607 body of the @code{if}.
7609 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7611 @item -frerun-cse-after-loop
7612 @opindex frerun-cse-after-loop
7613 Re-run common subexpression elimination after loop optimizations are
7614 performed.
7616 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7618 @item -fgcse
7619 @opindex fgcse
7620 Perform a global common subexpression elimination pass.
7621 This pass also performs global constant and copy propagation.
7623 @emph{Note:} When compiling a program using computed gotos, a GCC
7624 extension, you may get better run-time performance if you disable
7625 the global common subexpression elimination pass by adding
7626 @option{-fno-gcse} to the command line.
7628 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7630 @item -fgcse-lm
7631 @opindex fgcse-lm
7632 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7633 attempts to move loads that are only killed by stores into themselves.  This
7634 allows a loop containing a load/store sequence to be changed to a load outside
7635 the loop, and a copy/store within the loop.
7637 Enabled by default when @option{-fgcse} is enabled.
7639 @item -fgcse-sm
7640 @opindex fgcse-sm
7641 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7642 global common subexpression elimination.  This pass attempts to move
7643 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7644 loops containing a load/store sequence can be changed to a load before
7645 the loop and a store after the loop.
7647 Not enabled at any optimization level.
7649 @item -fgcse-las
7650 @opindex fgcse-las
7651 When @option{-fgcse-las} is enabled, the global common subexpression
7652 elimination pass eliminates redundant loads that come after stores to the
7653 same memory location (both partial and full redundancies).
7655 Not enabled at any optimization level.
7657 @item -fgcse-after-reload
7658 @opindex fgcse-after-reload
7659 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7660 pass is performed after reload.  The purpose of this pass is to clean up
7661 redundant spilling.
7663 @item -faggressive-loop-optimizations
7664 @opindex faggressive-loop-optimizations
7665 This option tells the loop optimizer to use language constraints to
7666 derive bounds for the number of iterations of a loop.  This assumes that
7667 loop code does not invoke undefined behavior by for example causing signed
7668 integer overflows or out-of-bound array accesses.  The bounds for the
7669 number of iterations of a loop are used to guide loop unrolling and peeling
7670 and loop exit test optimizations.
7671 This option is enabled by default.
7673 @item -funsafe-loop-optimizations
7674 @opindex funsafe-loop-optimizations
7675 This option tells the loop optimizer to assume that loop indices do not
7676 overflow, and that loops with nontrivial exit condition are not
7677 infinite.  This enables a wider range of loop optimizations even if
7678 the loop optimizer itself cannot prove that these assumptions are valid.
7679 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7680 if it finds this kind of loop.
7682 @item -fcrossjumping
7683 @opindex fcrossjumping
7684 Perform cross-jumping transformation.
7685 This transformation unifies equivalent code and saves code size.  The
7686 resulting code may or may not perform better than without cross-jumping.
7688 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7690 @item -fauto-inc-dec
7691 @opindex fauto-inc-dec
7692 Combine increments or decrements of addresses with memory accesses.
7693 This pass is always skipped on architectures that do not have
7694 instructions to support this.  Enabled by default at @option{-O} and
7695 higher on architectures that support this.
7697 @item -fdce
7698 @opindex fdce
7699 Perform dead code elimination (DCE) on RTL@.
7700 Enabled by default at @option{-O} and higher.
7702 @item -fdse
7703 @opindex fdse
7704 Perform dead store elimination (DSE) on RTL@.
7705 Enabled by default at @option{-O} and higher.
7707 @item -fif-conversion
7708 @opindex fif-conversion
7709 Attempt to transform conditional jumps into branch-less equivalents.  This
7710 includes use of conditional moves, min, max, set flags and abs instructions, and
7711 some tricks doable by standard arithmetics.  The use of conditional execution
7712 on chips where it is available is controlled by @code{if-conversion2}.
7714 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7716 @item -fif-conversion2
7717 @opindex fif-conversion2
7718 Use conditional execution (where available) to transform conditional jumps into
7719 branch-less equivalents.
7721 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7723 @item -fdeclone-ctor-dtor
7724 @opindex fdeclone-ctor-dtor
7725 The C++ ABI requires multiple entry points for constructors and
7726 destructors: one for a base subobject, one for a complete object, and
7727 one for a virtual destructor that calls operator delete afterwards.
7728 For a hierarchy with virtual bases, the base and complete variants are
7729 clones, which means two copies of the function.  With this option, the
7730 base and complete variants are changed to be thunks that call a common
7731 implementation.
7733 Enabled by @option{-Os}.
7735 @item -fdelete-null-pointer-checks
7736 @opindex fdelete-null-pointer-checks
7737 Assume that programs cannot safely dereference null pointers, and that
7738 no code or data element resides there.  This enables simple constant
7739 folding optimizations at all optimization levels.  In addition, other
7740 optimization passes in GCC use this flag to control global dataflow
7741 analyses that eliminate useless checks for null pointers; these assume
7742 that if a pointer is checked after it has already been dereferenced,
7743 it cannot be null.
7745 Note however that in some environments this assumption is not true.
7746 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7747 for programs that depend on that behavior.
7749 Some targets, especially embedded ones, disable this option at all levels.
7750 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7751 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7752 are enabled independently at different optimization levels.
7754 @item -fdevirtualize
7755 @opindex fdevirtualize
7756 Attempt to convert calls to virtual functions to direct calls.  This
7757 is done both within a procedure and interprocedurally as part of
7758 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7759 propagation (@option{-fipa-cp}).
7760 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7762 @item -fdevirtualize-speculatively
7763 @opindex fdevirtualize-speculatively
7764 Attempt to convert calls to virtual functions to speculative direct calls.
7765 Based on the analysis of the type inheritance graph, determine for a given call
7766 the set of likely targets. If the set is small, preferably of size 1, change
7767 the call into an conditional deciding on direct and indirect call.  The
7768 speculative calls enable more optimizations, such as inlining.  When they seem
7769 useless after further optimization, they are converted back into original form.
7771 @item -fdevirtualize-at-ltrans
7772 @opindex fdevirtualize-at-ltrans
7773 Perform extra streaming needed for agressive devirtualization during LTO local
7774 transformation stage. This option enables more devirtualization but
7775 significantly increases the size of streamed data. For this reason it is
7776 disabled by default.
7778 @item -fexpensive-optimizations
7779 @opindex fexpensive-optimizations
7780 Perform a number of minor optimizations that are relatively expensive.
7782 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7784 @item -free
7785 @opindex free
7786 Attempt to remove redundant extension instructions.  This is especially
7787 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7788 registers after writing to their lower 32-bit half.
7790 Enabled for Alpha, AArch64 and x86 at levels @option{-O2},
7791 @option{-O3}, @option{-Os}.
7793 @item -flive-range-shrinkage
7794 @opindex flive-range-shrinkage
7795 Attempt to decrease register pressure through register live range
7796 shrinkage.  This is helpful for fast processors with small or moderate
7797 size register sets.
7799 @item -fira-algorithm=@var{algorithm}
7800 Use the specified coloring algorithm for the integrated register
7801 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7802 specifies Chow's priority coloring, or @samp{CB}, which specifies
7803 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7804 for all architectures, but for those targets that do support it, it is
7805 the default because it generates better code.
7807 @item -fira-region=@var{region}
7808 Use specified regions for the integrated register allocator.  The
7809 @var{region} argument should be one of the following:
7811 @table @samp
7813 @item all
7814 Use all loops as register allocation regions.
7815 This can give the best results for machines with a small and/or
7816 irregular register set.
7818 @item mixed
7819 Use all loops except for loops with small register pressure 
7820 as the regions.  This value usually gives
7821 the best results in most cases and for most architectures,
7822 and is enabled by default when compiling with optimization for speed
7823 (@option{-O}, @option{-O2}, @dots{}).
7825 @item one
7826 Use all functions as a single region.  
7827 This typically results in the smallest code size, and is enabled by default for
7828 @option{-Os} or @option{-O0}.
7830 @end table
7832 @item -fira-hoist-pressure
7833 @opindex fira-hoist-pressure
7834 Use IRA to evaluate register pressure in the code hoisting pass for
7835 decisions to hoist expressions.  This option usually results in smaller
7836 code, but it can slow the compiler down.
7838 This option is enabled at level @option{-Os} for all targets.
7840 @item -fira-loop-pressure
7841 @opindex fira-loop-pressure
7842 Use IRA to evaluate register pressure in loops for decisions to move
7843 loop invariants.  This option usually results in generation
7844 of faster and smaller code on machines with large register files (>= 32
7845 registers), but it can slow the compiler down.
7847 This option is enabled at level @option{-O3} for some targets.
7849 @item -fno-ira-share-save-slots
7850 @opindex fno-ira-share-save-slots
7851 Disable sharing of stack slots used for saving call-used hard
7852 registers living through a call.  Each hard register gets a
7853 separate stack slot, and as a result function stack frames are
7854 larger.
7856 @item -fno-ira-share-spill-slots
7857 @opindex fno-ira-share-spill-slots
7858 Disable sharing of stack slots allocated for pseudo-registers.  Each
7859 pseudo-register that does not get a hard register gets a separate
7860 stack slot, and as a result function stack frames are larger.
7862 @item -fira-verbose=@var{n}
7863 @opindex fira-verbose
7864 Control the verbosity of the dump file for the integrated register allocator.
7865 The default value is 5.  If the value @var{n} is greater or equal to 10,
7866 the dump output is sent to stderr using the same format as @var{n} minus 10.
7868 @item -flra-remat
7869 @opindex fcaller-saves
7870 Enable CFG-sensitive rematerialization in LRA.  Instead of loading
7871 values of spilled pseudos, LRA tries to rematerialize (recalculate)
7872 values if it is profitable.
7874 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7876 @item -fdelayed-branch
7877 @opindex fdelayed-branch
7878 If supported for the target machine, attempt to reorder instructions
7879 to exploit instruction slots available after delayed branch
7880 instructions.
7882 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7884 @item -fschedule-insns
7885 @opindex fschedule-insns
7886 If supported for the target machine, attempt to reorder instructions to
7887 eliminate execution stalls due to required data being unavailable.  This
7888 helps machines that have slow floating point or memory load instructions
7889 by allowing other instructions to be issued until the result of the load
7890 or floating-point instruction is required.
7892 Enabled at levels @option{-O2}, @option{-O3}.
7894 @item -fschedule-insns2
7895 @opindex fschedule-insns2
7896 Similar to @option{-fschedule-insns}, but requests an additional pass of
7897 instruction scheduling after register allocation has been done.  This is
7898 especially useful on machines with a relatively small number of
7899 registers and where memory load instructions take more than one cycle.
7901 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7903 @item -fno-sched-interblock
7904 @opindex fno-sched-interblock
7905 Don't schedule instructions across basic blocks.  This is normally
7906 enabled by default when scheduling before register allocation, i.e.@:
7907 with @option{-fschedule-insns} or at @option{-O2} or higher.
7909 @item -fno-sched-spec
7910 @opindex fno-sched-spec
7911 Don't allow speculative motion of non-load instructions.  This is normally
7912 enabled by default when scheduling before register allocation, i.e.@:
7913 with @option{-fschedule-insns} or at @option{-O2} or higher.
7915 @item -fsched-pressure
7916 @opindex fsched-pressure
7917 Enable register pressure sensitive insn scheduling before register
7918 allocation.  This only makes sense when scheduling before register
7919 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7920 @option{-O2} or higher.  Usage of this option can improve the
7921 generated code and decrease its size by preventing register pressure
7922 increase above the number of available hard registers and subsequent
7923 spills in register allocation.
7925 @item -fsched-spec-load
7926 @opindex fsched-spec-load
7927 Allow speculative motion of some load instructions.  This only makes
7928 sense when scheduling before register allocation, i.e.@: with
7929 @option{-fschedule-insns} or at @option{-O2} or higher.
7931 @item -fsched-spec-load-dangerous
7932 @opindex fsched-spec-load-dangerous
7933 Allow speculative motion of more load instructions.  This only makes
7934 sense when scheduling before register allocation, i.e.@: with
7935 @option{-fschedule-insns} or at @option{-O2} or higher.
7937 @item -fsched-stalled-insns
7938 @itemx -fsched-stalled-insns=@var{n}
7939 @opindex fsched-stalled-insns
7940 Define how many insns (if any) can be moved prematurely from the queue
7941 of stalled insns into the ready list during the second scheduling pass.
7942 @option{-fno-sched-stalled-insns} means that no insns are moved
7943 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7944 on how many queued insns can be moved prematurely.
7945 @option{-fsched-stalled-insns} without a value is equivalent to
7946 @option{-fsched-stalled-insns=1}.
7948 @item -fsched-stalled-insns-dep
7949 @itemx -fsched-stalled-insns-dep=@var{n}
7950 @opindex fsched-stalled-insns-dep
7951 Define how many insn groups (cycles) are examined for a dependency
7952 on a stalled insn that is a candidate for premature removal from the queue
7953 of stalled insns.  This has an effect only during the second scheduling pass,
7954 and only if @option{-fsched-stalled-insns} is used.
7955 @option{-fno-sched-stalled-insns-dep} is equivalent to
7956 @option{-fsched-stalled-insns-dep=0}.
7957 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7958 @option{-fsched-stalled-insns-dep=1}.
7960 @item -fsched2-use-superblocks
7961 @opindex fsched2-use-superblocks
7962 When scheduling after register allocation, use superblock scheduling.
7963 This allows motion across basic block boundaries,
7964 resulting in faster schedules.  This option is experimental, as not all machine
7965 descriptions used by GCC model the CPU closely enough to avoid unreliable
7966 results from the algorithm.
7968 This only makes sense when scheduling after register allocation, i.e.@: with
7969 @option{-fschedule-insns2} or at @option{-O2} or higher.
7971 @item -fsched-group-heuristic
7972 @opindex fsched-group-heuristic
7973 Enable the group heuristic in the scheduler.  This heuristic favors
7974 the instruction that belongs to a schedule group.  This is enabled
7975 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7976 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7978 @item -fsched-critical-path-heuristic
7979 @opindex fsched-critical-path-heuristic
7980 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7981 instructions on the critical path.  This is enabled by default when
7982 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7983 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7985 @item -fsched-spec-insn-heuristic
7986 @opindex fsched-spec-insn-heuristic
7987 Enable the speculative instruction heuristic in the scheduler.  This
7988 heuristic favors speculative instructions with greater dependency weakness.
7989 This is enabled by default when scheduling is enabled, i.e.@:
7990 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7991 or at @option{-O2} or higher.
7993 @item -fsched-rank-heuristic
7994 @opindex fsched-rank-heuristic
7995 Enable the rank heuristic in the scheduler.  This heuristic favors
7996 the instruction belonging to a basic block with greater size or frequency.
7997 This is enabled by default when scheduling is enabled, i.e.@:
7998 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7999 at @option{-O2} or higher.
8001 @item -fsched-last-insn-heuristic
8002 @opindex fsched-last-insn-heuristic
8003 Enable the last-instruction heuristic in the scheduler.  This heuristic
8004 favors the instruction that is less dependent on the last instruction
8005 scheduled.  This is enabled by default when scheduling is enabled,
8006 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8007 at @option{-O2} or higher.
8009 @item -fsched-dep-count-heuristic
8010 @opindex fsched-dep-count-heuristic
8011 Enable the dependent-count heuristic in the scheduler.  This heuristic
8012 favors the instruction that has more instructions depending on it.
8013 This is enabled by default when scheduling is enabled, i.e.@:
8014 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
8015 at @option{-O2} or higher.
8017 @item -freschedule-modulo-scheduled-loops
8018 @opindex freschedule-modulo-scheduled-loops
8019 Modulo scheduling is performed before traditional scheduling.  If a loop
8020 is modulo scheduled, later scheduling passes may change its schedule.  
8021 Use this option to control that behavior.
8023 @item -fselective-scheduling
8024 @opindex fselective-scheduling
8025 Schedule instructions using selective scheduling algorithm.  Selective
8026 scheduling runs instead of the first scheduler pass.
8028 @item -fselective-scheduling2
8029 @opindex fselective-scheduling2
8030 Schedule instructions using selective scheduling algorithm.  Selective
8031 scheduling runs instead of the second scheduler pass.
8033 @item -fsel-sched-pipelining
8034 @opindex fsel-sched-pipelining
8035 Enable software pipelining of innermost loops during selective scheduling.
8036 This option has no effect unless one of @option{-fselective-scheduling} or
8037 @option{-fselective-scheduling2} is turned on.
8039 @item -fsel-sched-pipelining-outer-loops
8040 @opindex fsel-sched-pipelining-outer-loops
8041 When pipelining loops during selective scheduling, also pipeline outer loops.
8042 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
8044 @item -fsemantic-interposition
8045 @opindex fsemantic-interposition
8046 Some object formats, like ELF, allow interposing of symbols by dynamic linker.
8047 This means that for symbols exported from the DSO compiler can not perform
8048 inter-procedural propagation, inlining and other optimizations in anticipation
8049 that the function or variable in question may change. While this feature is
8050 useful, for example, to rewrite memory allocation functions by a debugging
8051 implementation, it is expensive in the terms of code quality.
8052 With @option{-fno-semantic-inteposition} compiler assumest that if interposition
8053 happens for functions the overwritting function will have
8054 precisely same semantics (and side effects). Similarly if interposition happens
8055 for variables, the constructor of the variable will be the same. The flag
8056 has no effect for functions explicitly declared inline, where
8057 interposition changing semantic is never allowed and for symbols explicitly
8058 declared weak.
8060 @item -fshrink-wrap
8061 @opindex fshrink-wrap
8062 Emit function prologues only before parts of the function that need it,
8063 rather than at the top of the function.  This flag is enabled by default at
8064 @option{-O} and higher.
8066 @item -fcaller-saves
8067 @opindex fcaller-saves
8068 Enable allocation of values to registers that are clobbered by
8069 function calls, by emitting extra instructions to save and restore the
8070 registers around such calls.  Such allocation is done only when it
8071 seems to result in better code.
8073 This option is always enabled by default on certain machines, usually
8074 those which have no call-preserved registers to use instead.
8076 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8078 @item -fcombine-stack-adjustments
8079 @opindex fcombine-stack-adjustments
8080 Tracks stack adjustments (pushes and pops) and stack memory references
8081 and then tries to find ways to combine them.
8083 Enabled by default at @option{-O1} and higher.
8085 @item -fipa-ra
8086 Use caller save registers for allocation if those registers are not used by
8087 any called function.  In that case it is not necessary to save and restore
8088 them around calls.  This is only possible if called functions are part of
8089 same compilation unit as current function and they are compiled before it.
8091 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8093 @item -fconserve-stack
8094 @opindex fconserve-stack
8095 Attempt to minimize stack usage.  The compiler attempts to use less
8096 stack space, even if that makes the program slower.  This option
8097 implies setting the @option{large-stack-frame} parameter to 100
8098 and the @option{large-stack-frame-growth} parameter to 400.
8100 @item -ftree-reassoc
8101 @opindex ftree-reassoc
8102 Perform reassociation on trees.  This flag is enabled by default
8103 at @option{-O} and higher.
8105 @item -ftree-pre
8106 @opindex ftree-pre
8107 Perform partial redundancy elimination (PRE) on trees.  This flag is
8108 enabled by default at @option{-O2} and @option{-O3}.
8110 @item -ftree-partial-pre
8111 @opindex ftree-partial-pre
8112 Make partial redundancy elimination (PRE) more aggressive.  This flag is
8113 enabled by default at @option{-O3}.
8115 @item -ftree-forwprop
8116 @opindex ftree-forwprop
8117 Perform forward propagation on trees.  This flag is enabled by default
8118 at @option{-O} and higher.
8120 @item -ftree-fre
8121 @opindex ftree-fre
8122 Perform full redundancy elimination (FRE) on trees.  The difference
8123 between FRE and PRE is that FRE only considers expressions
8124 that are computed on all paths leading to the redundant computation.
8125 This analysis is faster than PRE, though it exposes fewer redundancies.
8126 This flag is enabled by default at @option{-O} and higher.
8128 @item -ftree-phiprop
8129 @opindex ftree-phiprop
8130 Perform hoisting of loads from conditional pointers on trees.  This
8131 pass is enabled by default at @option{-O} and higher.
8133 @item -fhoist-adjacent-loads
8134 @opindex hoist-adjacent-loads
8135 Speculatively hoist loads from both branches of an if-then-else if the
8136 loads are from adjacent locations in the same structure and the target
8137 architecture has a conditional move instruction.  This flag is enabled
8138 by default at @option{-O2} and higher.
8140 @item -ftree-copy-prop
8141 @opindex ftree-copy-prop
8142 Perform copy propagation on trees.  This pass eliminates unnecessary
8143 copy operations.  This flag is enabled by default at @option{-O} and
8144 higher.
8146 @item -fipa-pure-const
8147 @opindex fipa-pure-const
8148 Discover which functions are pure or constant.
8149 Enabled by default at @option{-O} and higher.
8151 @item -fipa-reference
8152 @opindex fipa-reference
8153 Discover which static variables do not escape the
8154 compilation unit.
8155 Enabled by default at @option{-O} and higher.
8157 @item -fipa-pta
8158 @opindex fipa-pta
8159 Perform interprocedural pointer analysis and interprocedural modification
8160 and reference analysis.  This option can cause excessive memory and
8161 compile-time usage on large compilation units.  It is not enabled by
8162 default at any optimization level.
8164 @item -fipa-profile
8165 @opindex fipa-profile
8166 Perform interprocedural profile propagation.  The functions called only from
8167 cold functions are marked as cold. Also functions executed once (such as
8168 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
8169 functions and loop less parts of functions executed once are then optimized for
8170 size.
8171 Enabled by default at @option{-O} and higher.
8173 @item -fipa-cp
8174 @opindex fipa-cp
8175 Perform interprocedural constant propagation.
8176 This optimization analyzes the program to determine when values passed
8177 to functions are constants and then optimizes accordingly.
8178 This optimization can substantially increase performance
8179 if the application has constants passed to functions.
8180 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
8182 @item -fipa-cp-clone
8183 @opindex fipa-cp-clone
8184 Perform function cloning to make interprocedural constant propagation stronger.
8185 When enabled, interprocedural constant propagation performs function cloning
8186 when externally visible function can be called with constant arguments.
8187 Because this optimization can create multiple copies of functions,
8188 it may significantly increase code size
8189 (see @option{--param ipcp-unit-growth=@var{value}}).
8190 This flag is enabled by default at @option{-O3}.
8192 @item -fipa-icf
8193 @opindex fipa-icf
8194 Perform Identical Code Folding for functions and read-only variables.
8195 The optimization reduces code size and may disturb unwind stacks by replacing
8196 a function by equivalent one with a different name. The optimization works
8197 more effectively with link time optimization enabled.
8199 Nevertheless the behavior is similar to Gold Linker ICF optimization, GCC ICF
8200 works on different levels and thus the optimizations are not same - there are
8201 equivalences that are found only by GCC and equivalences found only by Gold.
8203 This flag is enabled by default at @option{-O2} and @option{-Os}.
8205 @item -fisolate-erroneous-paths-dereference
8206 Detect paths which trigger erroneous or undefined behaviour due to
8207 dereferencing a NULL pointer.  Isolate those paths from the main control
8208 flow and turn the statement with erroneous or undefined behaviour into a trap.
8210 @item -fisolate-erroneous-paths-attribute
8211 Detect paths which trigger erroneous or undefined behaviour due a NULL value
8212 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
8213 attribute.  Isolate those paths from the main control flow and turn the
8214 statement with erroneous or undefined behaviour into a trap.  This is not
8215 currently enabled, but may be enabled by @code{-O2} in the future.
8217 @item -ftree-sink
8218 @opindex ftree-sink
8219 Perform forward store motion  on trees.  This flag is
8220 enabled by default at @option{-O} and higher.
8222 @item -ftree-bit-ccp
8223 @opindex ftree-bit-ccp
8224 Perform sparse conditional bit constant propagation on trees and propagate
8225 pointer alignment information.
8226 This pass only operates on local scalar variables and is enabled by default
8227 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
8229 @item -ftree-ccp
8230 @opindex ftree-ccp
8231 Perform sparse conditional constant propagation (CCP) on trees.  This
8232 pass only operates on local scalar variables and is enabled by default
8233 at @option{-O} and higher.
8235 @item -fssa-phiopt
8236 @opindex fssa-phiopt
8237 Perform pattern matching on SSA PHI nodes to optimize conditional
8238 code.  This pass is enabled by default at @option{-O} and higher.
8240 @item -ftree-switch-conversion
8241 Perform conversion of simple initializations in a switch to
8242 initializations from a scalar array.  This flag is enabled by default
8243 at @option{-O2} and higher.
8245 @item -ftree-tail-merge
8246 Look for identical code sequences.  When found, replace one with a jump to the
8247 other.  This optimization is known as tail merging or cross jumping.  This flag
8248 is enabled by default at @option{-O2} and higher.  The compilation time
8249 in this pass can
8250 be limited using @option{max-tail-merge-comparisons} parameter and
8251 @option{max-tail-merge-iterations} parameter.
8253 @item -ftree-dce
8254 @opindex ftree-dce
8255 Perform dead code elimination (DCE) on trees.  This flag is enabled by
8256 default at @option{-O} and higher.
8258 @item -ftree-builtin-call-dce
8259 @opindex ftree-builtin-call-dce
8260 Perform conditional dead code elimination (DCE) for calls to built-in functions
8261 that may set @code{errno} but are otherwise side-effect free.  This flag is
8262 enabled by default at @option{-O2} and higher if @option{-Os} is not also
8263 specified.
8265 @item -ftree-dominator-opts
8266 @opindex ftree-dominator-opts
8267 Perform a variety of simple scalar cleanups (constant/copy
8268 propagation, redundancy elimination, range propagation and expression
8269 simplification) based on a dominator tree traversal.  This also
8270 performs jump threading (to reduce jumps to jumps). This flag is
8271 enabled by default at @option{-O} and higher.
8273 @item -ftree-dse
8274 @opindex ftree-dse
8275 Perform dead store elimination (DSE) on trees.  A dead store is a store into
8276 a memory location that is later overwritten by another store without
8277 any intervening loads.  In this case the earlier store can be deleted.  This
8278 flag is enabled by default at @option{-O} and higher.
8280 @item -ftree-ch
8281 @opindex ftree-ch
8282 Perform loop header copying on trees.  This is beneficial since it increases
8283 effectiveness of code motion optimizations.  It also saves one jump.  This flag
8284 is enabled by default at @option{-O} and higher.  It is not enabled
8285 for @option{-Os}, since it usually increases code size.
8287 @item -ftree-loop-optimize
8288 @opindex ftree-loop-optimize
8289 Perform loop optimizations on trees.  This flag is enabled by default
8290 at @option{-O} and higher.
8292 @item -ftree-loop-linear
8293 @opindex ftree-loop-linear
8294 Perform loop interchange transformations on tree.  Same as
8295 @option{-floop-interchange}.  To use this code transformation, GCC has
8296 to be configured with @option{--with-isl} to enable the Graphite loop
8297 transformation infrastructure.
8299 @item -floop-interchange
8300 @opindex floop-interchange
8301 Perform loop interchange transformations on loops.  Interchanging two
8302 nested loops switches the inner and outer loops.  For example, given a
8303 loop like:
8304 @smallexample
8305 DO J = 1, M
8306   DO I = 1, N
8307     A(J, I) = A(J, I) * C
8308   ENDDO
8309 ENDDO
8310 @end smallexample
8311 loop interchange transforms the loop as if it were written:
8312 @smallexample
8313 DO I = 1, N
8314   DO J = 1, M
8315     A(J, I) = A(J, I) * C
8316   ENDDO
8317 ENDDO
8318 @end smallexample
8319 which can be beneficial when @code{N} is larger than the caches,
8320 because in Fortran, the elements of an array are stored in memory
8321 contiguously by column, and the original loop iterates over rows,
8322 potentially creating at each access a cache miss.  This optimization
8323 applies to all the languages supported by GCC and is not limited to
8324 Fortran.  To use this code transformation, GCC has to be configured
8325 with @option{--with-isl} to enable the Graphite loop transformation
8326 infrastructure.
8328 @item -floop-strip-mine
8329 @opindex floop-strip-mine
8330 Perform loop strip mining transformations on loops.  Strip mining
8331 splits a loop into two nested loops.  The outer loop has strides
8332 equal to the strip size and the inner loop has strides of the
8333 original loop within a strip.  The strip length can be changed
8334 using the @option{loop-block-tile-size} parameter.  For example,
8335 given a loop like:
8336 @smallexample
8337 DO I = 1, N
8338   A(I) = A(I) + C
8339 ENDDO
8340 @end smallexample
8341 loop strip mining transforms the loop as if it were written:
8342 @smallexample
8343 DO II = 1, N, 51
8344   DO I = II, min (II + 50, N)
8345     A(I) = A(I) + C
8346   ENDDO
8347 ENDDO
8348 @end smallexample
8349 This optimization applies to all the languages supported by GCC and is
8350 not limited to Fortran.  To use this code transformation, GCC has to
8351 be configured with @option{--with-isl} to enable the Graphite loop
8352 transformation infrastructure.
8354 @item -floop-block
8355 @opindex floop-block
8356 Perform loop blocking transformations on loops.  Blocking strip mines
8357 each loop in the loop nest such that the memory accesses of the
8358 element loops fit inside caches.  The strip length can be changed
8359 using the @option{loop-block-tile-size} parameter.  For example, given
8360 a loop like:
8361 @smallexample
8362 DO I = 1, N
8363   DO J = 1, M
8364     A(J, I) = B(I) + C(J)
8365   ENDDO
8366 ENDDO
8367 @end smallexample
8368 loop blocking transforms the loop as if it were written:
8369 @smallexample
8370 DO II = 1, N, 51
8371   DO JJ = 1, M, 51
8372     DO I = II, min (II + 50, N)
8373       DO J = JJ, min (JJ + 50, M)
8374         A(J, I) = B(I) + C(J)
8375       ENDDO
8376     ENDDO
8377   ENDDO
8378 ENDDO
8379 @end smallexample
8380 which can be beneficial when @code{M} is larger than the caches,
8381 because the innermost loop iterates over a smaller amount of data
8382 which can be kept in the caches.  This optimization applies to all the
8383 languages supported by GCC and is not limited to Fortran.  To use this
8384 code transformation, GCC has to be configured with @option{--with-isl}
8385 to enable the Graphite loop transformation infrastructure.
8387 @item -fgraphite-identity
8388 @opindex fgraphite-identity
8389 Enable the identity transformation for graphite.  For every SCoP we generate
8390 the polyhedral representation and transform it back to gimple.  Using
8391 @option{-fgraphite-identity} we can check the costs or benefits of the
8392 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
8393 are also performed by the code generator ISL, like index splitting and
8394 dead code elimination in loops.
8396 @item -floop-nest-optimize
8397 @opindex floop-nest-optimize
8398 Enable the ISL based loop nest optimizer.  This is a generic loop nest
8399 optimizer based on the Pluto optimization algorithms.  It calculates a loop
8400 structure optimized for data-locality and parallelism.  This option
8401 is experimental.
8403 @item -floop-unroll-and-jam
8404 @opindex floop-unroll-and-jam
8405 Enable unroll and jam for the ISL based loop nest optimizer.  The unroll 
8406 factor can be changed using the @option{loop-unroll-jam-size} parameter.
8407 The unrolled dimension (counting from the most inner one) can be changed 
8408 using the @option{loop-unroll-jam-depth} parameter.                 .
8410 @item -floop-parallelize-all
8411 @opindex floop-parallelize-all
8412 Use the Graphite data dependence analysis to identify loops that can
8413 be parallelized.  Parallelize all the loops that can be analyzed to
8414 not contain loop carried dependences without checking that it is
8415 profitable to parallelize the loops.
8417 @item -fcheck-data-deps
8418 @opindex fcheck-data-deps
8419 Compare the results of several data dependence analyzers.  This option
8420 is used for debugging the data dependence analyzers.
8422 @item -ftree-loop-if-convert
8423 Attempt to transform conditional jumps in the innermost loops to
8424 branch-less equivalents.  The intent is to remove control-flow from
8425 the innermost loops in order to improve the ability of the
8426 vectorization pass to handle these loops.  This is enabled by default
8427 if vectorization is enabled.
8429 @item -ftree-loop-if-convert-stores
8430 Attempt to also if-convert conditional jumps containing memory writes.
8431 This transformation can be unsafe for multi-threaded programs as it
8432 transforms conditional memory writes into unconditional memory writes.
8433 For example,
8434 @smallexample
8435 for (i = 0; i < N; i++)
8436   if (cond)
8437     A[i] = expr;
8438 @end smallexample
8439 is transformed to
8440 @smallexample
8441 for (i = 0; i < N; i++)
8442   A[i] = cond ? expr : A[i];
8443 @end smallexample
8444 potentially producing data races.
8446 @item -ftree-loop-distribution
8447 Perform loop distribution.  This flag can improve cache performance on
8448 big loop bodies and allow further loop optimizations, like
8449 parallelization or vectorization, to take place.  For example, the loop
8450 @smallexample
8451 DO I = 1, N
8452   A(I) = B(I) + C
8453   D(I) = E(I) * F
8454 ENDDO
8455 @end smallexample
8456 is transformed to
8457 @smallexample
8458 DO I = 1, N
8459    A(I) = B(I) + C
8460 ENDDO
8461 DO I = 1, N
8462    D(I) = E(I) * F
8463 ENDDO
8464 @end smallexample
8466 @item -ftree-loop-distribute-patterns
8467 Perform loop distribution of patterns that can be code generated with
8468 calls to a library.  This flag is enabled by default at @option{-O3}.
8470 This pass distributes the initialization loops and generates a call to
8471 memset zero.  For example, the loop
8472 @smallexample
8473 DO I = 1, N
8474   A(I) = 0
8475   B(I) = A(I) + I
8476 ENDDO
8477 @end smallexample
8478 is transformed to
8479 @smallexample
8480 DO I = 1, N
8481    A(I) = 0
8482 ENDDO
8483 DO I = 1, N
8484    B(I) = A(I) + I
8485 ENDDO
8486 @end smallexample
8487 and the initialization loop is transformed into a call to memset zero.
8489 @item -ftree-loop-im
8490 @opindex ftree-loop-im
8491 Perform loop invariant motion on trees.  This pass moves only invariants that
8492 are hard to handle at RTL level (function calls, operations that expand to
8493 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8494 operands of conditions that are invariant out of the loop, so that we can use
8495 just trivial invariantness analysis in loop unswitching.  The pass also includes
8496 store motion.
8498 @item -ftree-loop-ivcanon
8499 @opindex ftree-loop-ivcanon
8500 Create a canonical counter for number of iterations in loops for which
8501 determining number of iterations requires complicated analysis.  Later
8502 optimizations then may determine the number easily.  Useful especially
8503 in connection with unrolling.
8505 @item -fivopts
8506 @opindex fivopts
8507 Perform induction variable optimizations (strength reduction, induction
8508 variable merging and induction variable elimination) on trees.
8510 @item -ftree-parallelize-loops=n
8511 @opindex ftree-parallelize-loops
8512 Parallelize loops, i.e., split their iteration space to run in n threads.
8513 This is only possible for loops whose iterations are independent
8514 and can be arbitrarily reordered.  The optimization is only
8515 profitable on multiprocessor machines, for loops that are CPU-intensive,
8516 rather than constrained e.g.@: by memory bandwidth.  This option
8517 implies @option{-pthread}, and thus is only supported on targets
8518 that have support for @option{-pthread}.
8520 @item -ftree-pta
8521 @opindex ftree-pta
8522 Perform function-local points-to analysis on trees.  This flag is
8523 enabled by default at @option{-O} and higher.
8525 @item -ftree-sra
8526 @opindex ftree-sra
8527 Perform scalar replacement of aggregates.  This pass replaces structure
8528 references with scalars to prevent committing structures to memory too
8529 early.  This flag is enabled by default at @option{-O} and higher.
8531 @item -ftree-copyrename
8532 @opindex ftree-copyrename
8533 Perform copy renaming on trees.  This pass attempts to rename compiler
8534 temporaries to other variables at copy locations, usually resulting in
8535 variable names which more closely resemble the original variables.  This flag
8536 is enabled by default at @option{-O} and higher.
8538 @item -ftree-coalesce-inlined-vars
8539 @opindex ftree-coalesce-inlined-vars
8540 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8541 combine small user-defined variables too, but only if they were inlined
8542 from other functions.  It is a more limited form of
8543 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8544 inlined variables, but it will keep variables of the inlined-into
8545 function apart from each other, such that they are more likely to
8546 contain the expected values in a debugging session.  This was the
8547 default in GCC versions older than 4.7.
8549 @item -ftree-coalesce-vars
8550 @opindex ftree-coalesce-vars
8551 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8552 combine small user-defined variables too, instead of just compiler
8553 temporaries.  This may severely limit the ability to debug an optimized
8554 program compiled with @option{-fno-var-tracking-assignments}.  In the
8555 negated form, this flag prevents SSA coalescing of user variables,
8556 including inlined ones.  This option is enabled by default.
8558 @item -ftree-ter
8559 @opindex ftree-ter
8560 Perform temporary expression replacement during the SSA->normal phase.  Single
8561 use/single def temporaries are replaced at their use location with their
8562 defining expression.  This results in non-GIMPLE code, but gives the expanders
8563 much more complex trees to work on resulting in better RTL generation.  This is
8564 enabled by default at @option{-O} and higher.
8566 @item -ftree-slsr
8567 @opindex ftree-slsr
8568 Perform straight-line strength reduction on trees.  This recognizes related
8569 expressions involving multiplications and replaces them by less expensive
8570 calculations when possible.  This is enabled by default at @option{-O} and
8571 higher.
8573 @item -ftree-vectorize
8574 @opindex ftree-vectorize
8575 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8576 and @option{-ftree-slp-vectorize} if not explicitly specified.
8578 @item -ftree-loop-vectorize
8579 @opindex ftree-loop-vectorize
8580 Perform loop vectorization on trees. This flag is enabled by default at
8581 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8583 @item -ftree-slp-vectorize
8584 @opindex ftree-slp-vectorize
8585 Perform basic block vectorization on trees. This flag is enabled by default at
8586 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8588 @item -fvect-cost-model=@var{model}
8589 @opindex fvect-cost-model
8590 Alter the cost model used for vectorization.  The @var{model} argument
8591 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8592 With the @code{unlimited} model the vectorized code-path is assumed
8593 to be profitable while with the @code{dynamic} model a runtime check
8594 will guard the vectorized code-path to enable it only for iteration
8595 counts that will likely execute faster than when executing the original
8596 scalar loop.  The @code{cheap} model will disable vectorization of
8597 loops where doing so would be cost prohibitive for example due to
8598 required runtime checks for data dependence or alignment but otherwise
8599 is equal to the @code{dynamic} model.
8600 The default cost model depends on other optimization flags and is
8601 either @code{dynamic} or @code{cheap}.
8603 @item -fsimd-cost-model=@var{model}
8604 @opindex fsimd-cost-model
8605 Alter the cost model used for vectorization of loops marked with the OpenMP
8606 or Cilk Plus simd directive.  The @var{model} argument should be one of
8607 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8608 have the same meaning as described in @option{-fvect-cost-model} and by
8609 default a cost model defined with @option{-fvect-cost-model} is used.
8611 @item -ftree-vrp
8612 @opindex ftree-vrp
8613 Perform Value Range Propagation on trees.  This is similar to the
8614 constant propagation pass, but instead of values, ranges of values are
8615 propagated.  This allows the optimizers to remove unnecessary range
8616 checks like array bound checks and null pointer checks.  This is
8617 enabled by default at @option{-O2} and higher.  Null pointer check
8618 elimination is only done if @option{-fdelete-null-pointer-checks} is
8619 enabled.
8621 @item -ftracer
8622 @opindex ftracer
8623 Perform tail duplication to enlarge superblock size.  This transformation
8624 simplifies the control flow of the function allowing other optimizations to do
8625 a better job.
8627 @item -funroll-loops
8628 @opindex funroll-loops
8629 Unroll loops whose number of iterations can be determined at compile
8630 time or upon entry to the loop.  @option{-funroll-loops} implies
8631 @option{-frerun-cse-after-loop}.  This option makes code larger,
8632 and may or may not make it run faster.
8634 @item -funroll-all-loops
8635 @opindex funroll-all-loops
8636 Unroll all loops, even if their number of iterations is uncertain when
8637 the loop is entered.  This usually makes programs run more slowly.
8638 @option{-funroll-all-loops} implies the same options as
8639 @option{-funroll-loops},
8641 @item -fsplit-ivs-in-unroller
8642 @opindex fsplit-ivs-in-unroller
8643 Enables expression of values of induction variables in later iterations
8644 of the unrolled loop using the value in the first iteration.  This breaks
8645 long dependency chains, thus improving efficiency of the scheduling passes.
8647 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8648 same effect.  However, that is not reliable in cases where the loop body
8649 is more complicated than a single basic block.  It also does not work at all
8650 on some architectures due to restrictions in the CSE pass.
8652 This optimization is enabled by default.
8654 @item -fvariable-expansion-in-unroller
8655 @opindex fvariable-expansion-in-unroller
8656 With this option, the compiler creates multiple copies of some
8657 local variables when unrolling a loop, which can result in superior code.
8659 @item -fpartial-inlining
8660 @opindex fpartial-inlining
8661 Inline parts of functions.  This option has any effect only
8662 when inlining itself is turned on by the @option{-finline-functions}
8663 or @option{-finline-small-functions} options.
8665 Enabled at level @option{-O2}.
8667 @item -fpredictive-commoning
8668 @opindex fpredictive-commoning
8669 Perform predictive commoning optimization, i.e., reusing computations
8670 (especially memory loads and stores) performed in previous
8671 iterations of loops.
8673 This option is enabled at level @option{-O3}.
8675 @item -fprefetch-loop-arrays
8676 @opindex fprefetch-loop-arrays
8677 If supported by the target machine, generate instructions to prefetch
8678 memory to improve the performance of loops that access large arrays.
8680 This option may generate better or worse code; results are highly
8681 dependent on the structure of loops within the source code.
8683 Disabled at level @option{-Os}.
8685 @item -fno-peephole
8686 @itemx -fno-peephole2
8687 @opindex fno-peephole
8688 @opindex fno-peephole2
8689 Disable any machine-specific peephole optimizations.  The difference
8690 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8691 are implemented in the compiler; some targets use one, some use the
8692 other, a few use both.
8694 @option{-fpeephole} is enabled by default.
8695 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8697 @item -fno-guess-branch-probability
8698 @opindex fno-guess-branch-probability
8699 Do not guess branch probabilities using heuristics.
8701 GCC uses heuristics to guess branch probabilities if they are
8702 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8703 heuristics are based on the control flow graph.  If some branch probabilities
8704 are specified by @samp{__builtin_expect}, then the heuristics are
8705 used to guess branch probabilities for the rest of the control flow graph,
8706 taking the @samp{__builtin_expect} info into account.  The interactions
8707 between the heuristics and @samp{__builtin_expect} can be complex, and in
8708 some cases, it may be useful to disable the heuristics so that the effects
8709 of @samp{__builtin_expect} are easier to understand.
8711 The default is @option{-fguess-branch-probability} at levels
8712 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8714 @item -freorder-blocks
8715 @opindex freorder-blocks
8716 Reorder basic blocks in the compiled function in order to reduce number of
8717 taken branches and improve code locality.
8719 Enabled at levels @option{-O2}, @option{-O3}.
8721 @item -freorder-blocks-and-partition
8722 @opindex freorder-blocks-and-partition
8723 In addition to reordering basic blocks in the compiled function, in order
8724 to reduce number of taken branches, partitions hot and cold basic blocks
8725 into separate sections of the assembly and .o files, to improve
8726 paging and cache locality performance.
8728 This optimization is automatically turned off in the presence of
8729 exception handling, for linkonce sections, for functions with a user-defined
8730 section attribute and on any architecture that does not support named
8731 sections.
8733 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8735 @item -freorder-functions
8736 @opindex freorder-functions
8737 Reorder functions in the object file in order to
8738 improve code locality.  This is implemented by using special
8739 subsections @code{.text.hot} for most frequently executed functions and
8740 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8741 the linker so object file format must support named sections and linker must
8742 place them in a reasonable way.
8744 Also profile feedback must be available to make this option effective.  See
8745 @option{-fprofile-arcs} for details.
8747 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8749 @item -fstrict-aliasing
8750 @opindex fstrict-aliasing
8751 Allow the compiler to assume the strictest aliasing rules applicable to
8752 the language being compiled.  For C (and C++), this activates
8753 optimizations based on the type of expressions.  In particular, an
8754 object of one type is assumed never to reside at the same address as an
8755 object of a different type, unless the types are almost the same.  For
8756 example, an @code{unsigned int} can alias an @code{int}, but not a
8757 @code{void*} or a @code{double}.  A character type may alias any other
8758 type.
8760 @anchor{Type-punning}Pay special attention to code like this:
8761 @smallexample
8762 union a_union @{
8763   int i;
8764   double d;
8767 int f() @{
8768   union a_union t;
8769   t.d = 3.0;
8770   return t.i;
8772 @end smallexample
8773 The practice of reading from a different union member than the one most
8774 recently written to (called ``type-punning'') is common.  Even with
8775 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8776 is accessed through the union type.  So, the code above works as
8777 expected.  @xref{Structures unions enumerations and bit-fields
8778 implementation}.  However, this code might not:
8779 @smallexample
8780 int f() @{
8781   union a_union t;
8782   int* ip;
8783   t.d = 3.0;
8784   ip = &t.i;
8785   return *ip;
8787 @end smallexample
8789 Similarly, access by taking the address, casting the resulting pointer
8790 and dereferencing the result has undefined behavior, even if the cast
8791 uses a union type, e.g.:
8792 @smallexample
8793 int f() @{
8794   double d = 3.0;
8795   return ((union a_union *) &d)->i;
8797 @end smallexample
8799 The @option{-fstrict-aliasing} option is enabled at levels
8800 @option{-O2}, @option{-O3}, @option{-Os}.
8802 @item -fstrict-overflow
8803 @opindex fstrict-overflow
8804 Allow the compiler to assume strict signed overflow rules, depending
8805 on the language being compiled.  For C (and C++) this means that
8806 overflow when doing arithmetic with signed numbers is undefined, which
8807 means that the compiler may assume that it does not happen.  This
8808 permits various optimizations.  For example, the compiler assumes
8809 that an expression like @code{i + 10 > i} is always true for
8810 signed @code{i}.  This assumption is only valid if signed overflow is
8811 undefined, as the expression is false if @code{i + 10} overflows when
8812 using twos complement arithmetic.  When this option is in effect any
8813 attempt to determine whether an operation on signed numbers 
8814 overflows must be written carefully to not actually involve overflow.
8816 This option also allows the compiler to assume strict pointer
8817 semantics: given a pointer to an object, if adding an offset to that
8818 pointer does not produce a pointer to the same object, the addition is
8819 undefined.  This permits the compiler to conclude that @code{p + u >
8820 p} is always true for a pointer @code{p} and unsigned integer
8821 @code{u}.  This assumption is only valid because pointer wraparound is
8822 undefined, as the expression is false if @code{p + u} overflows using
8823 twos complement arithmetic.
8825 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8826 that integer signed overflow is fully defined: it wraps.  When
8827 @option{-fwrapv} is used, there is no difference between
8828 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8829 integers.  With @option{-fwrapv} certain types of overflow are
8830 permitted.  For example, if the compiler gets an overflow when doing
8831 arithmetic on constants, the overflowed value can still be used with
8832 @option{-fwrapv}, but not otherwise.
8834 The @option{-fstrict-overflow} option is enabled at levels
8835 @option{-O2}, @option{-O3}, @option{-Os}.
8837 @item -falign-functions
8838 @itemx -falign-functions=@var{n}
8839 @opindex falign-functions
8840 Align the start of functions to the next power-of-two greater than
8841 @var{n}, skipping up to @var{n} bytes.  For instance,
8842 @option{-falign-functions=32} aligns functions to the next 32-byte
8843 boundary, but @option{-falign-functions=24} aligns to the next
8844 32-byte boundary only if this can be done by skipping 23 bytes or less.
8846 @option{-fno-align-functions} and @option{-falign-functions=1} are
8847 equivalent and mean that functions are not aligned.
8849 Some assemblers only support this flag when @var{n} is a power of two;
8850 in that case, it is rounded up.
8852 If @var{n} is not specified or is zero, use a machine-dependent default.
8854 Enabled at levels @option{-O2}, @option{-O3}.
8856 @item -falign-labels
8857 @itemx -falign-labels=@var{n}
8858 @opindex falign-labels
8859 Align all branch targets to a power-of-two boundary, skipping up to
8860 @var{n} bytes like @option{-falign-functions}.  This option can easily
8861 make code slower, because it must insert dummy operations for when the
8862 branch target is reached in the usual flow of the code.
8864 @option{-fno-align-labels} and @option{-falign-labels=1} are
8865 equivalent and mean that labels are not aligned.
8867 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8868 are greater than this value, then their values are used instead.
8870 If @var{n} is not specified or is zero, use a machine-dependent default
8871 which is very likely to be @samp{1}, meaning no alignment.
8873 Enabled at levels @option{-O2}, @option{-O3}.
8875 @item -falign-loops
8876 @itemx -falign-loops=@var{n}
8877 @opindex falign-loops
8878 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8879 like @option{-falign-functions}.  If the loops are
8880 executed many times, this makes up for any execution of the dummy
8881 operations.
8883 @option{-fno-align-loops} and @option{-falign-loops=1} are
8884 equivalent and mean that loops are not aligned.
8886 If @var{n} is not specified or is zero, use a machine-dependent default.
8888 Enabled at levels @option{-O2}, @option{-O3}.
8890 @item -falign-jumps
8891 @itemx -falign-jumps=@var{n}
8892 @opindex falign-jumps
8893 Align branch targets to a power-of-two boundary, for branch targets
8894 where the targets can only be reached by jumping, skipping up to @var{n}
8895 bytes like @option{-falign-functions}.  In this case, no dummy operations
8896 need be executed.
8898 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8899 equivalent and mean that loops are not aligned.
8901 If @var{n} is not specified or is zero, use a machine-dependent default.
8903 Enabled at levels @option{-O2}, @option{-O3}.
8905 @item -funit-at-a-time
8906 @opindex funit-at-a-time
8907 This option is left for compatibility reasons. @option{-funit-at-a-time}
8908 has no effect, while @option{-fno-unit-at-a-time} implies
8909 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8911 Enabled by default.
8913 @item -fno-toplevel-reorder
8914 @opindex fno-toplevel-reorder
8915 Do not reorder top-level functions, variables, and @code{asm}
8916 statements.  Output them in the same order that they appear in the
8917 input file.  When this option is used, unreferenced static variables
8918 are not removed.  This option is intended to support existing code
8919 that relies on a particular ordering.  For new code, it is better to
8920 use attributes when possible.
8922 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8923 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8924 targets.
8926 @item -fweb
8927 @opindex fweb
8928 Constructs webs as commonly used for register allocation purposes and assign
8929 each web individual pseudo register.  This allows the register allocation pass
8930 to operate on pseudos directly, but also strengthens several other optimization
8931 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8932 however, make debugging impossible, since variables no longer stay in a
8933 ``home register''.
8935 Enabled by default with @option{-funroll-loops}.
8937 @item -fwhole-program
8938 @opindex fwhole-program
8939 Assume that the current compilation unit represents the whole program being
8940 compiled.  All public functions and variables with the exception of @code{main}
8941 and those merged by attribute @code{externally_visible} become static functions
8942 and in effect are optimized more aggressively by interprocedural optimizers.
8944 This option should not be used in combination with @code{-flto}.
8945 Instead relying on a linker plugin should provide safer and more precise
8946 information.
8948 @item -flto[=@var{n}]
8949 @opindex flto
8950 This option runs the standard link-time optimizer.  When invoked
8951 with source code, it generates GIMPLE (one of GCC's internal
8952 representations) and writes it to special ELF sections in the object
8953 file.  When the object files are linked together, all the function
8954 bodies are read from these ELF sections and instantiated as if they
8955 had been part of the same translation unit.
8957 To use the link-time optimizer, @option{-flto} and optimization
8958 options should be specified at compile time and during the final link.
8959 For example:
8961 @smallexample
8962 gcc -c -O2 -flto foo.c
8963 gcc -c -O2 -flto bar.c
8964 gcc -o myprog -flto -O2 foo.o bar.o
8965 @end smallexample
8967 The first two invocations to GCC save a bytecode representation
8968 of GIMPLE into special ELF sections inside @file{foo.o} and
8969 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8970 @file{foo.o} and @file{bar.o}, merges the two files into a single
8971 internal image, and compiles the result as usual.  Since both
8972 @file{foo.o} and @file{bar.o} are merged into a single image, this
8973 causes all the interprocedural analyses and optimizations in GCC to
8974 work across the two files as if they were a single one.  This means,
8975 for example, that the inliner is able to inline functions in
8976 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8978 Another (simpler) way to enable link-time optimization is:
8980 @smallexample
8981 gcc -o myprog -flto -O2 foo.c bar.c
8982 @end smallexample
8984 The above generates bytecode for @file{foo.c} and @file{bar.c},
8985 merges them together into a single GIMPLE representation and optimizes
8986 them as usual to produce @file{myprog}.
8988 The only important thing to keep in mind is that to enable link-time
8989 optimizations you need to use the GCC driver to perform the link-step.
8990 GCC then automatically performs link-time optimization if any of the
8991 objects involved were compiled with the @option{-flto}.  You generally
8992 should specify the optimization options to be used for link-time
8993 optimization though GCC will try to be clever at guessing an
8994 optimization level to use from the options used at compile-time
8995 if you fail to specify one at link-time.  You can always override
8996 the automatic decision to do link-time optimization at link-time
8997 by passing @option{-fno-lto} to the link command.
8999 To make whole program optimization effective, it is necessary to make
9000 certain whole program assumptions.  The compiler needs to know
9001 what functions and variables can be accessed by libraries and runtime
9002 outside of the link-time optimized unit.  When supported by the linker,
9003 the linker plugin (see @option{-fuse-linker-plugin}) passes information
9004 to the compiler about used and externally visible symbols.  When
9005 the linker plugin is not available, @option{-fwhole-program} should be
9006 used to allow the compiler to make these assumptions, which leads
9007 to more aggressive optimization decisions.
9009 When @option{-fuse-linker-plugin} is not enabled then, when a file is
9010 compiled with @option{-flto}, the generated object file is larger than
9011 a regular object file because it contains GIMPLE bytecodes and the usual
9012 final code (see @option{-ffat-lto-objects}.  This means that
9013 object files with LTO information can be linked as normal object
9014 files; if @option{-fno-lto} is passed to the linker, no
9015 interprocedural optimizations are applied.  Note that when
9016 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
9017 but you cannot perform a regular, non-LTO link on them.
9019 Additionally, the optimization flags used to compile individual files
9020 are not necessarily related to those used at link time.  For instance,
9022 @smallexample
9023 gcc -c -O0 -ffat-lto-objects -flto foo.c
9024 gcc -c -O0 -ffat-lto-objects -flto bar.c
9025 gcc -o myprog -O3 foo.o bar.o
9026 @end smallexample
9028 This produces individual object files with unoptimized assembler
9029 code, but the resulting binary @file{myprog} is optimized at
9030 @option{-O3}.  If, instead, the final binary is generated with
9031 @option{-fno-lto}, then @file{myprog} is not optimized.
9033 When producing the final binary, GCC only
9034 applies link-time optimizations to those files that contain bytecode.
9035 Therefore, you can mix and match object files and libraries with
9036 GIMPLE bytecodes and final object code.  GCC automatically selects
9037 which files to optimize in LTO mode and which files to link without
9038 further processing.
9040 There are some code generation flags preserved by GCC when
9041 generating bytecodes, as they need to be used during the final link
9042 stage.  Generally options specified at link-time override those
9043 specified at compile-time.
9045 If you do not specify an optimization level option @option{-O} at
9046 link-time then GCC will compute one based on the optimization levels
9047 used when compiling the object files.  The highest optimization
9048 level will win here.
9050 Currently, the following options and their setting are take from
9051 the first object file that explicitely specified it: 
9052 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
9053 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
9054 and all the @option{-m} target flags.
9056 Certain ABI changing flags are required to match in all compilation-units
9057 and trying to override this at link-time with a conflicting value
9058 is ignored.  This includes options such as @option{-freg-struct-return}
9059 and @option{-fpcc-struct-return}. 
9061 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
9062 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
9063 are passed through to the link stage and merged conservatively for
9064 conflicting translation units.  Specifically
9065 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
9066 precedence and for example @option{-ffp-contract=off} takes precedence
9067 over @option{-ffp-contract=fast}.  You can override them at linke-time.
9069 It is recommended that you compile all the files participating in the
9070 same link with the same options and also specify those options at
9071 link time.
9073 If LTO encounters objects with C linkage declared with incompatible
9074 types in separate translation units to be linked together (undefined
9075 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
9076 issued.  The behavior is still undefined at run time.  Similar
9077 diagnostics may be raised for other languages.
9079 Another feature of LTO is that it is possible to apply interprocedural
9080 optimizations on files written in different languages:
9082 @smallexample
9083 gcc -c -flto foo.c
9084 g++ -c -flto bar.cc
9085 gfortran -c -flto baz.f90
9086 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
9087 @end smallexample
9089 Notice that the final link is done with @command{g++} to get the C++
9090 runtime libraries and @option{-lgfortran} is added to get the Fortran
9091 runtime libraries.  In general, when mixing languages in LTO mode, you
9092 should use the same link command options as when mixing languages in a
9093 regular (non-LTO) compilation.
9095 If object files containing GIMPLE bytecode are stored in a library archive, say
9096 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
9097 are using a linker with plugin support.  To create static libraries suitable
9098 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
9099 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
9100 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
9101 and @command{nm} have been compiled with plugin support.  At link time, use the the
9102 flag @option{-fuse-linker-plugin} to ensure that the library participates in
9103 the LTO optimization process:
9105 @smallexample
9106 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
9107 @end smallexample
9109 With the linker plugin enabled, the linker extracts the needed
9110 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
9111 to make them part of the aggregated GIMPLE image to be optimized.
9113 If you are not using a linker with plugin support and/or do not
9114 enable the linker plugin, then the objects inside @file{libfoo.a}
9115 are extracted and linked as usual, but they do not participate
9116 in the LTO optimization process.  In order to make a static library suitable
9117 for both LTO optimization and usual linkage, compile its object files with
9118 @option{-flto} @code{-ffat-lto-objects}.
9120 Link-time optimizations do not require the presence of the whole program to
9121 operate.  If the program does not require any symbols to be exported, it is
9122 possible to combine @option{-flto} and @option{-fwhole-program} to allow
9123 the interprocedural optimizers to use more aggressive assumptions which may
9124 lead to improved optimization opportunities.
9125 Use of @option{-fwhole-program} is not needed when linker plugin is
9126 active (see @option{-fuse-linker-plugin}).
9128 The current implementation of LTO makes no
9129 attempt to generate bytecode that is portable between different
9130 types of hosts.  The bytecode files are versioned and there is a
9131 strict version check, so bytecode files generated in one version of
9132 GCC will not work with an older or newer version of GCC.
9134 Link-time optimization does not work well with generation of debugging
9135 information.  Combining @option{-flto} with
9136 @option{-g} is currently experimental and expected to produce unexpected
9137 results.
9139 If you specify the optional @var{n}, the optimization and code
9140 generation done at link time is executed in parallel using @var{n}
9141 parallel jobs by utilizing an installed @command{make} program.  The
9142 environment variable @env{MAKE} may be used to override the program
9143 used.  The default value for @var{n} is 1.
9145 You can also specify @option{-flto=jobserver} to use GNU make's
9146 job server mode to determine the number of parallel jobs. This
9147 is useful when the Makefile calling GCC is already executing in parallel.
9148 You must prepend a @samp{+} to the command recipe in the parent Makefile
9149 for this to work.  This option likely only works if @env{MAKE} is
9150 GNU make.
9152 @item -flto-partition=@var{alg}
9153 @opindex flto-partition
9154 Specify the partitioning algorithm used by the link-time optimizer.
9155 The value is either @code{1to1} to specify a partitioning mirroring
9156 the original source files or @code{balanced} to specify partitioning
9157 into equally sized chunks (whenever possible) or @code{max} to create
9158 new partition for every symbol where possible.  Specifying @code{none}
9159 as an algorithm disables partitioning and streaming completely. 
9160 The default value is @code{balanced}. While @code{1to1} can be used
9161 as an workaround for various code ordering issues, the @code{max}
9162 partitioning is intended for internal testing only.
9163 The value @code{one} specifies that exactly one partition should be
9164 used while the value @code{none} bypasses partitioning and executes
9165 the link-time optimization step directly from the WPA phase.
9167 @item -flto-odr-type-merging
9168 @opindex flto-odr-type-merging
9169 Enable streaming of mangled types names of C++ types and their unification
9170 at linktime.  This increases size of LTO object files, but enable
9171 diagnostics about One Definition Rule violations.
9173 @item -flto-compression-level=@var{n}
9174 This option specifies the level of compression used for intermediate
9175 language written to LTO object files, and is only meaningful in
9176 conjunction with LTO mode (@option{-flto}).  Valid
9177 values are 0 (no compression) to 9 (maximum compression).  Values
9178 outside this range are clamped to either 0 or 9.  If the option is not
9179 given, a default balanced compression setting is used.
9181 @item -flto-report
9182 Prints a report with internal details on the workings of the link-time
9183 optimizer.  The contents of this report vary from version to version.
9184 It is meant to be useful to GCC developers when processing object
9185 files in LTO mode (via @option{-flto}).
9187 Disabled by default.
9189 @item -flto-report-wpa
9190 Like @option{-flto-report}, but only print for the WPA phase of Link
9191 Time Optimization.
9193 @item -fuse-linker-plugin
9194 Enables the use of a linker plugin during link-time optimization.  This
9195 option relies on plugin support in the linker, which is available in gold
9196 or in GNU ld 2.21 or newer.
9198 This option enables the extraction of object files with GIMPLE bytecode out
9199 of library archives. This improves the quality of optimization by exposing
9200 more code to the link-time optimizer.  This information specifies what
9201 symbols can be accessed externally (by non-LTO object or during dynamic
9202 linking).  Resulting code quality improvements on binaries (and shared
9203 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
9204 See @option{-flto} for a description of the effect of this flag and how to
9205 use it.
9207 This option is enabled by default when LTO support in GCC is enabled
9208 and GCC was configured for use with
9209 a linker supporting plugins (GNU ld 2.21 or newer or gold).
9211 @item -ffat-lto-objects
9212 @opindex ffat-lto-objects
9213 Fat LTO objects are object files that contain both the intermediate language
9214 and the object code. This makes them usable for both LTO linking and normal
9215 linking. This option is effective only when compiling with @option{-flto}
9216 and is ignored at link time.
9218 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
9219 requires the complete toolchain to be aware of LTO. It requires a linker with
9220 linker plugin support for basic functionality.  Additionally,
9221 @command{nm}, @command{ar} and @command{ranlib}
9222 need to support linker plugins to allow a full-featured build environment
9223 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
9224 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
9225 to these tools. With non fat LTO makefiles need to be modified to use them.
9227 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
9228 support.
9230 @item -fcompare-elim
9231 @opindex fcompare-elim
9232 After register allocation and post-register allocation instruction splitting,
9233 identify arithmetic instructions that compute processor flags similar to a
9234 comparison operation based on that arithmetic.  If possible, eliminate the
9235 explicit comparison operation.
9237 This pass only applies to certain targets that cannot explicitly represent
9238 the comparison operation before register allocation is complete.
9240 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9242 @item -fuse-ld=bfd
9243 @opindex fuse-ld=bfd
9244 Use the @command{bfd} linker instead of the default linker.
9246 @item -fuse-ld=gold
9247 @opindex fuse-ld=gold
9248 Use the @command{gold} linker instead of the default linker.
9250 @item -fcprop-registers
9251 @opindex fcprop-registers
9252 After register allocation and post-register allocation instruction splitting,
9253 perform a copy-propagation pass to try to reduce scheduling dependencies
9254 and occasionally eliminate the copy.
9256 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
9258 @item -fprofile-correction
9259 @opindex fprofile-correction
9260 Profiles collected using an instrumented binary for multi-threaded programs may
9261 be inconsistent due to missed counter updates. When this option is specified,
9262 GCC uses heuristics to correct or smooth out such inconsistencies. By
9263 default, GCC emits an error message when an inconsistent profile is detected.
9265 @item -fprofile-dir=@var{path}
9266 @opindex fprofile-dir
9268 Set the directory to search for the profile data files in to @var{path}.
9269 This option affects only the profile data generated by
9270 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
9271 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
9272 and its related options.  Both absolute and relative paths can be used.
9273 By default, GCC uses the current directory as @var{path}, thus the
9274 profile data file appears in the same directory as the object file.
9276 @item -fprofile-generate
9277 @itemx -fprofile-generate=@var{path}
9278 @opindex fprofile-generate
9280 Enable options usually used for instrumenting application to produce
9281 profile useful for later recompilation with profile feedback based
9282 optimization.  You must use @option{-fprofile-generate} both when
9283 compiling and when linking your program.
9285 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
9287 If @var{path} is specified, GCC looks at the @var{path} to find
9288 the profile feedback data files. See @option{-fprofile-dir}.
9290 @item -fprofile-use
9291 @itemx -fprofile-use=@var{path}
9292 @opindex fprofile-use
9293 Enable profile feedback directed optimizations, and optimizations
9294 generally profitable only with profile feedback available.
9296 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9297 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9298 @code{ftree-loop-distribute-patterns}
9300 By default, GCC emits an error message if the feedback profiles do not
9301 match the source code.  This error can be turned into a warning by using
9302 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
9303 code.
9305 If @var{path} is specified, GCC looks at the @var{path} to find
9306 the profile feedback data files. See @option{-fprofile-dir}.
9308 @item -fauto-profile
9309 @itemx -fauto-profile=@var{path}
9310 @opindex fauto-profile
9311 Enable sampling based feedback directed optimizations, and optimizations
9312 generally profitable only with profile feedback available.
9314 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
9315 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
9316 @code{-finline-functions}, @code{-fipa-cp}, @code{-fipa-cp-clone},
9317 @code{-fpredictive-commoning}, @code{-funswitch-loops},
9318 @code{-fgcse-after-reload}, @code{-ftree-loop-distribute-patterns},
9320 If @var{path} is specified, GCC looks at the @var{path} to find
9321 the profile feedback data files.
9323 In order to collect AutoFDO profile, you need to have:
9325 1. A linux system with linux perf support
9326 2. (optional) An Intel processor with last branch record (LBR) support. This is
9327    to guarantee accurate instruction level profile, which is important for
9328    AutoFDO performance.
9330 To collect the profile, first use linux perf to collect raw profile
9331 (see @uref{https://perf.wiki.kernel.org/}).
9333 E.g.
9334 @code{perf record -e br_inst_retired:near_taken -b -o perf.data -- your_program}
9336 Then use create_gcov tool, which takes raw profile and unstripped binary to
9337 generate AutoFDO profile that can be used by GCC.
9338 (see @uref{https://github.com/google/autofdo}).
9340 E.g.
9341 @code{create_gcov --binary=your_program.unstripped --profile=perf.data --gcov=profile.afdo}
9342 @end table
9344 The following options control compiler behavior regarding floating-point 
9345 arithmetic.  These options trade off between speed and
9346 correctness.  All must be specifically enabled.
9348 @table @gcctabopt
9349 @item -ffloat-store
9350 @opindex ffloat-store
9351 Do not store floating-point variables in registers, and inhibit other
9352 options that might change whether a floating-point value is taken from a
9353 register or memory.
9355 @cindex floating-point precision
9356 This option prevents undesirable excess precision on machines such as
9357 the 68000 where the floating registers (of the 68881) keep more
9358 precision than a @code{double} is supposed to have.  Similarly for the
9359 x86 architecture.  For most programs, the excess precision does only
9360 good, but a few programs rely on the precise definition of IEEE floating
9361 point.  Use @option{-ffloat-store} for such programs, after modifying
9362 them to store all pertinent intermediate computations into variables.
9364 @item -fexcess-precision=@var{style}
9365 @opindex fexcess-precision
9366 This option allows further control over excess precision on machines
9367 where floating-point registers have more precision than the IEEE
9368 @code{float} and @code{double} types and the processor does not
9369 support operations rounding to those types.  By default,
9370 @option{-fexcess-precision=fast} is in effect; this means that
9371 operations are carried out in the precision of the registers and that
9372 it is unpredictable when rounding to the types specified in the source
9373 code takes place.  When compiling C, if
9374 @option{-fexcess-precision=standard} is specified then excess
9375 precision follows the rules specified in ISO C99; in particular,
9376 both casts and assignments cause values to be rounded to their
9377 semantic types (whereas @option{-ffloat-store} only affects
9378 assignments).  This option is enabled by default for C if a strict
9379 conformance option such as @option{-std=c99} is used.
9381 @opindex mfpmath
9382 @option{-fexcess-precision=standard} is not implemented for languages
9383 other than C, and has no effect if
9384 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
9385 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
9386 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
9387 semantics apply without excess precision, and in the latter, rounding
9388 is unpredictable.
9390 @item -ffast-math
9391 @opindex ffast-math
9392 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
9393 @option{-ffinite-math-only}, @option{-fno-rounding-math},
9394 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
9396 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
9398 This option is not turned on by any @option{-O} option besides
9399 @option{-Ofast} since it can result in incorrect output for programs
9400 that depend on an exact implementation of IEEE or ISO rules/specifications
9401 for math functions. It may, however, yield faster code for programs
9402 that do not require the guarantees of these specifications.
9404 @item -fno-math-errno
9405 @opindex fno-math-errno
9406 Do not set @code{errno} after calling math functions that are executed
9407 with a single instruction, e.g., @code{sqrt}.  A program that relies on
9408 IEEE exceptions for math error handling may want to use this flag
9409 for speed while maintaining IEEE arithmetic compatibility.
9411 This option is not turned on by any @option{-O} option since
9412 it can result in incorrect output for programs that depend on
9413 an exact implementation of IEEE or ISO rules/specifications for
9414 math functions. It may, however, yield faster code for programs
9415 that do not require the guarantees of these specifications.
9417 The default is @option{-fmath-errno}.
9419 On Darwin systems, the math library never sets @code{errno}.  There is
9420 therefore no reason for the compiler to consider the possibility that
9421 it might, and @option{-fno-math-errno} is the default.
9423 @item -funsafe-math-optimizations
9424 @opindex funsafe-math-optimizations
9426 Allow optimizations for floating-point arithmetic that (a) assume
9427 that arguments and results are valid and (b) may violate IEEE or
9428 ANSI standards.  When used at link-time, it may include libraries
9429 or startup files that change the default FPU control word or other
9430 similar optimizations.
9432 This option is not turned on by any @option{-O} option since
9433 it can result in incorrect output for programs that depend on
9434 an exact implementation of IEEE or ISO rules/specifications for
9435 math functions. It may, however, yield faster code for programs
9436 that do not require the guarantees of these specifications.
9437 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
9438 @option{-fassociative-math} and @option{-freciprocal-math}.
9440 The default is @option{-fno-unsafe-math-optimizations}.
9442 @item -fassociative-math
9443 @opindex fassociative-math
9445 Allow re-association of operands in series of floating-point operations.
9446 This violates the ISO C and C++ language standard by possibly changing
9447 computation result.  NOTE: re-ordering may change the sign of zero as
9448 well as ignore NaNs and inhibit or create underflow or overflow (and
9449 thus cannot be used on code that relies on rounding behavior like
9450 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
9451 and thus may not be used when ordered comparisons are required.
9452 This option requires that both @option{-fno-signed-zeros} and
9453 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
9454 much sense with @option{-frounding-math}. For Fortran the option
9455 is automatically enabled when both @option{-fno-signed-zeros} and
9456 @option{-fno-trapping-math} are in effect.
9458 The default is @option{-fno-associative-math}.
9460 @item -freciprocal-math
9461 @opindex freciprocal-math
9463 Allow the reciprocal of a value to be used instead of dividing by
9464 the value if this enables optimizations.  For example @code{x / y}
9465 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
9466 is subject to common subexpression elimination.  Note that this loses
9467 precision and increases the number of flops operating on the value.
9469 The default is @option{-fno-reciprocal-math}.
9471 @item -ffinite-math-only
9472 @opindex ffinite-math-only
9473 Allow optimizations for floating-point arithmetic that assume
9474 that arguments and results are not NaNs or +-Infs.
9476 This option is not turned on by any @option{-O} option since
9477 it can result in incorrect output for programs that depend on
9478 an exact implementation of IEEE or ISO rules/specifications for
9479 math functions. It may, however, yield faster code for programs
9480 that do not require the guarantees of these specifications.
9482 The default is @option{-fno-finite-math-only}.
9484 @item -fno-signed-zeros
9485 @opindex fno-signed-zeros
9486 Allow optimizations for floating-point arithmetic that ignore the
9487 signedness of zero.  IEEE arithmetic specifies the behavior of
9488 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9489 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9490 This option implies that the sign of a zero result isn't significant.
9492 The default is @option{-fsigned-zeros}.
9494 @item -fno-trapping-math
9495 @opindex fno-trapping-math
9496 Compile code assuming that floating-point operations cannot generate
9497 user-visible traps.  These traps include division by zero, overflow,
9498 underflow, inexact result and invalid operation.  This option requires
9499 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9500 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9502 This option should never be turned on by any @option{-O} option since
9503 it can result in incorrect output for programs that depend on
9504 an exact implementation of IEEE or ISO rules/specifications for
9505 math functions.
9507 The default is @option{-ftrapping-math}.
9509 @item -frounding-math
9510 @opindex frounding-math
9511 Disable transformations and optimizations that assume default floating-point
9512 rounding behavior.  This is round-to-zero for all floating point
9513 to integer conversions, and round-to-nearest for all other arithmetic
9514 truncations.  This option should be specified for programs that change
9515 the FP rounding mode dynamically, or that may be executed with a
9516 non-default rounding mode.  This option disables constant folding of
9517 floating-point expressions at compile time (which may be affected by
9518 rounding mode) and arithmetic transformations that are unsafe in the
9519 presence of sign-dependent rounding modes.
9521 The default is @option{-fno-rounding-math}.
9523 This option is experimental and does not currently guarantee to
9524 disable all GCC optimizations that are affected by rounding mode.
9525 Future versions of GCC may provide finer control of this setting
9526 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9527 will be used to specify the default state for @code{FENV_ACCESS}.
9529 @item -fsignaling-nans
9530 @opindex fsignaling-nans
9531 Compile code assuming that IEEE signaling NaNs may generate user-visible
9532 traps during floating-point operations.  Setting this option disables
9533 optimizations that may change the number of exceptions visible with
9534 signaling NaNs.  This option implies @option{-ftrapping-math}.
9536 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9537 be defined.
9539 The default is @option{-fno-signaling-nans}.
9541 This option is experimental and does not currently guarantee to
9542 disable all GCC optimizations that affect signaling NaN behavior.
9544 @item -fsingle-precision-constant
9545 @opindex fsingle-precision-constant
9546 Treat floating-point constants as single precision instead of
9547 implicitly converting them to double-precision constants.
9549 @item -fcx-limited-range
9550 @opindex fcx-limited-range
9551 When enabled, this option states that a range reduction step is not
9552 needed when performing complex division.  Also, there is no checking
9553 whether the result of a complex multiplication or division is @code{NaN
9554 + I*NaN}, with an attempt to rescue the situation in that case.  The
9555 default is @option{-fno-cx-limited-range}, but is enabled by
9556 @option{-ffast-math}.
9558 This option controls the default setting of the ISO C99
9559 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9560 all languages.
9562 @item -fcx-fortran-rules
9563 @opindex fcx-fortran-rules
9564 Complex multiplication and division follow Fortran rules.  Range
9565 reduction is done as part of complex division, but there is no checking
9566 whether the result of a complex multiplication or division is @code{NaN
9567 + I*NaN}, with an attempt to rescue the situation in that case.
9569 The default is @option{-fno-cx-fortran-rules}.
9571 @end table
9573 The following options control optimizations that may improve
9574 performance, but are not enabled by any @option{-O} options.  This
9575 section includes experimental options that may produce broken code.
9577 @table @gcctabopt
9578 @item -fbranch-probabilities
9579 @opindex fbranch-probabilities
9580 After running a program compiled with @option{-fprofile-arcs}
9581 (@pxref{Debugging Options,, Options for Debugging Your Program or
9582 @command{gcc}}), you can compile it a second time using
9583 @option{-fbranch-probabilities}, to improve optimizations based on
9584 the number of times each branch was taken.  When a program
9585 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9586 counts to a file called @file{@var{sourcename}.gcda} for each source
9587 file.  The information in this data file is very dependent on the
9588 structure of the generated code, so you must use the same source code
9589 and the same optimization options for both compilations.
9591 With @option{-fbranch-probabilities}, GCC puts a
9592 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9593 These can be used to improve optimization.  Currently, they are only
9594 used in one place: in @file{reorg.c}, instead of guessing which path a
9595 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9596 exactly determine which path is taken more often.
9598 @item -fprofile-values
9599 @opindex fprofile-values
9600 If combined with @option{-fprofile-arcs}, it adds code so that some
9601 data about values of expressions in the program is gathered.
9603 With @option{-fbranch-probabilities}, it reads back the data gathered
9604 from profiling values of expressions for usage in optimizations.
9606 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9608 @item -fprofile-reorder-functions
9609 @opindex fprofile-reorder-functions
9610 Function reordering based on profile instrumentation collects
9611 first time of execution of a function and orders these functions
9612 in ascending order.
9614 Enabled with @option{-fprofile-use}.
9616 @item -fvpt
9617 @opindex fvpt
9618 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9619 to add code to gather information about values of expressions.
9621 With @option{-fbranch-probabilities}, it reads back the data gathered
9622 and actually performs the optimizations based on them.
9623 Currently the optimizations include specialization of division operations
9624 using the knowledge about the value of the denominator.
9626 @item -frename-registers
9627 @opindex frename-registers
9628 Attempt to avoid false dependencies in scheduled code by making use
9629 of registers left over after register allocation.  This optimization
9630 most benefits processors with lots of registers.  Depending on the
9631 debug information format adopted by the target, however, it can
9632 make debugging impossible, since variables no longer stay in
9633 a ``home register''.
9635 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9637 @item -fschedule-fusion
9638 @opindex fschedule-fusion
9639 Performs a target dependent pass over the instruction stream to schedule
9640 instructions of same type together because target machine can execute them
9641 more efficiently if they are adjacent to each other in the instruction flow.
9643 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
9645 @item -ftracer
9646 @opindex ftracer
9647 Perform tail duplication to enlarge superblock size.  This transformation
9648 simplifies the control flow of the function allowing other optimizations to do
9649 a better job.
9651 Enabled with @option{-fprofile-use}.
9653 @item -funroll-loops
9654 @opindex funroll-loops
9655 Unroll loops whose number of iterations can be determined at compile time or
9656 upon entry to the loop.  @option{-funroll-loops} implies
9657 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9658 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9659 a small constant number of iterations).  This option makes code larger, and may
9660 or may not make it run faster.
9662 Enabled with @option{-fprofile-use}.
9664 @item -funroll-all-loops
9665 @opindex funroll-all-loops
9666 Unroll all loops, even if their number of iterations is uncertain when
9667 the loop is entered.  This usually makes programs run more slowly.
9668 @option{-funroll-all-loops} implies the same options as
9669 @option{-funroll-loops}.
9671 @item -fpeel-loops
9672 @opindex fpeel-loops
9673 Peels loops for which there is enough information that they do not
9674 roll much (from profile feedback).  It also turns on complete loop peeling
9675 (i.e.@: complete removal of loops with small constant number of iterations).
9677 Enabled with @option{-fprofile-use}.
9679 @item -fmove-loop-invariants
9680 @opindex fmove-loop-invariants
9681 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9682 at level @option{-O1}
9684 @item -funswitch-loops
9685 @opindex funswitch-loops
9686 Move branches with loop invariant conditions out of the loop, with duplicates
9687 of the loop on both branches (modified according to result of the condition).
9689 @item -ffunction-sections
9690 @itemx -fdata-sections
9691 @opindex ffunction-sections
9692 @opindex fdata-sections
9693 Place each function or data item into its own section in the output
9694 file if the target supports arbitrary sections.  The name of the
9695 function or the name of the data item determines the section's name
9696 in the output file.
9698 Use these options on systems where the linker can perform optimizations
9699 to improve locality of reference in the instruction space.  Most systems
9700 using the ELF object format and SPARC processors running Solaris 2 have
9701 linkers with such optimizations.  AIX may have these optimizations in
9702 the future.
9704 Only use these options when there are significant benefits from doing
9705 so.  When you specify these options, the assembler and linker
9706 create larger object and executable files and are also slower.
9707 You cannot use @code{gprof} on all systems if you
9708 specify this option, and you may have problems with debugging if
9709 you specify both this option and @option{-g}.
9711 @item -fbranch-target-load-optimize
9712 @opindex fbranch-target-load-optimize
9713 Perform branch target register load optimization before prologue / epilogue
9714 threading.
9715 The use of target registers can typically be exposed only during reload,
9716 thus hoisting loads out of loops and doing inter-block scheduling needs
9717 a separate optimization pass.
9719 @item -fbranch-target-load-optimize2
9720 @opindex fbranch-target-load-optimize2
9721 Perform branch target register load optimization after prologue / epilogue
9722 threading.
9724 @item -fbtr-bb-exclusive
9725 @opindex fbtr-bb-exclusive
9726 When performing branch target register load optimization, don't reuse
9727 branch target registers within any basic block.
9729 @item -fstack-protector
9730 @opindex fstack-protector
9731 Emit extra code to check for buffer overflows, such as stack smashing
9732 attacks.  This is done by adding a guard variable to functions with
9733 vulnerable objects.  This includes functions that call @code{alloca}, and
9734 functions with buffers larger than 8 bytes.  The guards are initialized
9735 when a function is entered and then checked when the function exits.
9736 If a guard check fails, an error message is printed and the program exits.
9738 @item -fstack-protector-all
9739 @opindex fstack-protector-all
9740 Like @option{-fstack-protector} except that all functions are protected.
9742 @item -fstack-protector-strong
9743 @opindex fstack-protector-strong
9744 Like @option{-fstack-protector} but includes additional functions to
9745 be protected --- those that have local array definitions, or have
9746 references to local frame addresses.
9748 @item -fsection-anchors
9749 @opindex fsection-anchors
9750 Try to reduce the number of symbolic address calculations by using
9751 shared ``anchor'' symbols to address nearby objects.  This transformation
9752 can help to reduce the number of GOT entries and GOT accesses on some
9753 targets.
9755 For example, the implementation of the following function @code{foo}:
9757 @smallexample
9758 static int a, b, c;
9759 int foo (void) @{ return a + b + c; @}
9760 @end smallexample
9762 @noindent
9763 usually calculates the addresses of all three variables, but if you
9764 compile it with @option{-fsection-anchors}, it accesses the variables
9765 from a common anchor point instead.  The effect is similar to the
9766 following pseudocode (which isn't valid C):
9768 @smallexample
9769 int foo (void)
9771   register int *xr = &x;
9772   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9774 @end smallexample
9776 Not all targets support this option.
9778 @item --param @var{name}=@var{value}
9779 @opindex param
9780 In some places, GCC uses various constants to control the amount of
9781 optimization that is done.  For example, GCC does not inline functions
9782 that contain more than a certain number of instructions.  You can
9783 control some of these constants on the command line using the
9784 @option{--param} option.
9786 The names of specific parameters, and the meaning of the values, are
9787 tied to the internals of the compiler, and are subject to change
9788 without notice in future releases.
9790 In each case, the @var{value} is an integer.  The allowable choices for
9791 @var{name} are:
9793 @table @gcctabopt
9794 @item predictable-branch-outcome
9795 When branch is predicted to be taken with probability lower than this threshold
9796 (in percent), then it is considered well predictable. The default is 10.
9798 @item max-crossjump-edges
9799 The maximum number of incoming edges to consider for cross-jumping.
9800 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9801 the number of edges incoming to each block.  Increasing values mean
9802 more aggressive optimization, making the compilation time increase with
9803 probably small improvement in executable size.
9805 @item min-crossjump-insns
9806 The minimum number of instructions that must be matched at the end
9807 of two blocks before cross-jumping is performed on them.  This
9808 value is ignored in the case where all instructions in the block being
9809 cross-jumped from are matched.  The default value is 5.
9811 @item max-grow-copy-bb-insns
9812 The maximum code size expansion factor when copying basic blocks
9813 instead of jumping.  The expansion is relative to a jump instruction.
9814 The default value is 8.
9816 @item max-goto-duplication-insns
9817 The maximum number of instructions to duplicate to a block that jumps
9818 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9819 passes, GCC factors computed gotos early in the compilation process,
9820 and unfactors them as late as possible.  Only computed jumps at the
9821 end of a basic blocks with no more than max-goto-duplication-insns are
9822 unfactored.  The default value is 8.
9824 @item max-delay-slot-insn-search
9825 The maximum number of instructions to consider when looking for an
9826 instruction to fill a delay slot.  If more than this arbitrary number of
9827 instructions are searched, the time savings from filling the delay slot
9828 are minimal, so stop searching.  Increasing values mean more
9829 aggressive optimization, making the compilation time increase with probably
9830 small improvement in execution time.
9832 @item max-delay-slot-live-search
9833 When trying to fill delay slots, the maximum number of instructions to
9834 consider when searching for a block with valid live register
9835 information.  Increasing this arbitrarily chosen value means more
9836 aggressive optimization, increasing the compilation time.  This parameter
9837 should be removed when the delay slot code is rewritten to maintain the
9838 control-flow graph.
9840 @item max-gcse-memory
9841 The approximate maximum amount of memory that can be allocated in
9842 order to perform the global common subexpression elimination
9843 optimization.  If more memory than specified is required, the
9844 optimization is not done.
9846 @item max-gcse-insertion-ratio
9847 If the ratio of expression insertions to deletions is larger than this value
9848 for any expression, then RTL PRE inserts or removes the expression and thus
9849 leaves partially redundant computations in the instruction stream.  The default value is 20.
9851 @item max-pending-list-length
9852 The maximum number of pending dependencies scheduling allows
9853 before flushing the current state and starting over.  Large functions
9854 with few branches or calls can create excessively large lists which
9855 needlessly consume memory and resources.
9857 @item max-modulo-backtrack-attempts
9858 The maximum number of backtrack attempts the scheduler should make
9859 when modulo scheduling a loop.  Larger values can exponentially increase
9860 compilation time.
9862 @item max-inline-insns-single
9863 Several parameters control the tree inliner used in GCC@.
9864 This number sets the maximum number of instructions (counted in GCC's
9865 internal representation) in a single function that the tree inliner
9866 considers for inlining.  This only affects functions declared
9867 inline and methods implemented in a class declaration (C++).
9868 The default value is 400.
9870 @item max-inline-insns-auto
9871 When you use @option{-finline-functions} (included in @option{-O3}),
9872 a lot of functions that would otherwise not be considered for inlining
9873 by the compiler are investigated.  To those functions, a different
9874 (more restrictive) limit compared to functions declared inline can
9875 be applied.
9876 The default value is 40.
9878 @item inline-min-speedup
9879 When estimated performance improvement of caller + callee runtime exceeds this
9880 threshold (in precent), the function can be inlined regardless the limit on
9881 @option{--param max-inline-insns-single} and @option{--param
9882 max-inline-insns-auto}.
9884 @item large-function-insns
9885 The limit specifying really large functions.  For functions larger than this
9886 limit after inlining, inlining is constrained by
9887 @option{--param large-function-growth}.  This parameter is useful primarily
9888 to avoid extreme compilation time caused by non-linear algorithms used by the
9889 back end.
9890 The default value is 2700.
9892 @item large-function-growth
9893 Specifies maximal growth of large function caused by inlining in percents.
9894 The default value is 100 which limits large function growth to 2.0 times
9895 the original size.
9897 @item large-unit-insns
9898 The limit specifying large translation unit.  Growth caused by inlining of
9899 units larger than this limit is limited by @option{--param inline-unit-growth}.
9900 For small units this might be too tight.
9901 For example, consider a unit consisting of function A
9902 that is inline and B that just calls A three times.  If B is small relative to
9903 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9904 large units consisting of small inlineable functions, however, the overall unit
9905 growth limit is needed to avoid exponential explosion of code size.  Thus for
9906 smaller units, the size is increased to @option{--param large-unit-insns}
9907 before applying @option{--param inline-unit-growth}.  The default is 10000.
9909 @item inline-unit-growth
9910 Specifies maximal overall growth of the compilation unit caused by inlining.
9911 The default value is 30 which limits unit growth to 1.3 times the original
9912 size. Cold functions (either marked cold via an attribute or by profile
9913 feedback) are not accounted into the unit size.
9915 @item ipcp-unit-growth
9916 Specifies maximal overall growth of the compilation unit caused by
9917 interprocedural constant propagation.  The default value is 10 which limits
9918 unit growth to 1.1 times the original size.
9920 @item large-stack-frame
9921 The limit specifying large stack frames.  While inlining the algorithm is trying
9922 to not grow past this limit too much.  The default value is 256 bytes.
9924 @item large-stack-frame-growth
9925 Specifies maximal growth of large stack frames caused by inlining in percents.
9926 The default value is 1000 which limits large stack frame growth to 11 times
9927 the original size.
9929 @item max-inline-insns-recursive
9930 @itemx max-inline-insns-recursive-auto
9931 Specifies the maximum number of instructions an out-of-line copy of a
9932 self-recursive inline
9933 function can grow into by performing recursive inlining.
9935 For functions declared inline, @option{--param max-inline-insns-recursive} is
9936 taken into account.  For functions not declared inline, recursive inlining
9937 happens only when @option{-finline-functions} (included in @option{-O3}) is
9938 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9939 default value is 450.
9941 @item max-inline-recursive-depth
9942 @itemx max-inline-recursive-depth-auto
9943 Specifies the maximum recursion depth used for recursive inlining.
9945 For functions declared inline, @option{--param max-inline-recursive-depth} is
9946 taken into account.  For functions not declared inline, recursive inlining
9947 happens only when @option{-finline-functions} (included in @option{-O3}) is
9948 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9949 default value is 8.
9951 @item min-inline-recursive-probability
9952 Recursive inlining is profitable only for function having deep recursion
9953 in average and can hurt for function having little recursion depth by
9954 increasing the prologue size or complexity of function body to other
9955 optimizers.
9957 When profile feedback is available (see @option{-fprofile-generate}) the actual
9958 recursion depth can be guessed from probability that function recurses via a
9959 given call expression.  This parameter limits inlining only to call expressions
9960 whose probability exceeds the given threshold (in percents).
9961 The default value is 10.
9963 @item early-inlining-insns
9964 Specify growth that the early inliner can make.  In effect it increases
9965 the amount of inlining for code having a large abstraction penalty.
9966 The default value is 10.
9968 @item max-early-inliner-iterations
9969 @itemx max-early-inliner-iterations
9970 Limit of iterations of the early inliner.  This basically bounds
9971 the number of nested indirect calls the early inliner can resolve.
9972 Deeper chains are still handled by late inlining.
9974 @item comdat-sharing-probability
9975 @itemx comdat-sharing-probability
9976 Probability (in percent) that C++ inline function with comdat visibility
9977 are shared across multiple compilation units.  The default value is 20.
9979 @item profile-func-internal-id
9980 @itemx profile-func-internal-id
9981 A parameter to control whether to use function internal id in profile
9982 database lookup. If the value is 0, the compiler will use id that
9983 is based on function assembler name and filename, which makes old profile
9984 data more tolerant to source changes such as function reordering etc.
9985 The default value is 0.
9987 @item min-vect-loop-bound
9988 The minimum number of iterations under which loops are not vectorized
9989 when @option{-ftree-vectorize} is used.  The number of iterations after
9990 vectorization needs to be greater than the value specified by this option
9991 to allow vectorization.  The default value is 0.
9993 @item gcse-cost-distance-ratio
9994 Scaling factor in calculation of maximum distance an expression
9995 can be moved by GCSE optimizations.  This is currently supported only in the
9996 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9997 is with simple expressions, i.e., the expressions that have cost
9998 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9999 hoisting of simple expressions.  The default value is 10.
10001 @item gcse-unrestricted-cost
10002 Cost, roughly measured as the cost of a single typical machine
10003 instruction, at which GCSE optimizations do not constrain
10004 the distance an expression can travel.  This is currently
10005 supported only in the code hoisting pass.  The lesser the cost,
10006 the more aggressive code hoisting is.  Specifying 0 
10007 allows all expressions to travel unrestricted distances.
10008 The default value is 3.
10010 @item max-hoist-depth
10011 The depth of search in the dominator tree for expressions to hoist.
10012 This is used to avoid quadratic behavior in hoisting algorithm.
10013 The value of 0 does not limit on the search, but may slow down compilation
10014 of huge functions.  The default value is 30.
10016 @item max-tail-merge-comparisons
10017 The maximum amount of similar bbs to compare a bb with.  This is used to
10018 avoid quadratic behavior in tree tail merging.  The default value is 10.
10020 @item max-tail-merge-iterations
10021 The maximum amount of iterations of the pass over the function.  This is used to
10022 limit compilation time in tree tail merging.  The default value is 2.
10024 @item max-unrolled-insns
10025 The maximum number of instructions that a loop may have to be unrolled.
10026 If a loop is unrolled, this parameter also determines how many times
10027 the loop code is unrolled.
10029 @item max-average-unrolled-insns
10030 The maximum number of instructions biased by probabilities of their execution
10031 that a loop may have to be unrolled.  If a loop is unrolled,
10032 this parameter also determines how many times the loop code is unrolled.
10034 @item max-unroll-times
10035 The maximum number of unrollings of a single loop.
10037 @item max-peeled-insns
10038 The maximum number of instructions that a loop may have to be peeled.
10039 If a loop is peeled, this parameter also determines how many times
10040 the loop code is peeled.
10042 @item max-peel-times
10043 The maximum number of peelings of a single loop.
10045 @item max-peel-branches
10046 The maximum number of branches on the hot path through the peeled sequence.
10048 @item max-completely-peeled-insns
10049 The maximum number of insns of a completely peeled loop.
10051 @item max-completely-peel-times
10052 The maximum number of iterations of a loop to be suitable for complete peeling.
10054 @item max-completely-peel-loop-nest-depth
10055 The maximum depth of a loop nest suitable for complete peeling.
10057 @item max-unswitch-insns
10058 The maximum number of insns of an unswitched loop.
10060 @item max-unswitch-level
10061 The maximum number of branches unswitched in a single loop.
10063 @item lim-expensive
10064 The minimum cost of an expensive expression in the loop invariant motion.
10066 @item iv-consider-all-candidates-bound
10067 Bound on number of candidates for induction variables, below which
10068 all candidates are considered for each use in induction variable
10069 optimizations.  If there are more candidates than this,
10070 only the most relevant ones are considered to avoid quadratic time complexity.
10072 @item iv-max-considered-uses
10073 The induction variable optimizations give up on loops that contain more
10074 induction variable uses.
10076 @item iv-always-prune-cand-set-bound
10077 If the number of candidates in the set is smaller than this value,
10078 always try to remove unnecessary ivs from the set
10079 when adding a new one.
10081 @item scev-max-expr-size
10082 Bound on size of expressions used in the scalar evolutions analyzer.
10083 Large expressions slow the analyzer.
10085 @item scev-max-expr-complexity
10086 Bound on the complexity of the expressions in the scalar evolutions analyzer.
10087 Complex expressions slow the analyzer.
10089 @item omega-max-vars
10090 The maximum number of variables in an Omega constraint system.
10091 The default value is 128.
10093 @item omega-max-geqs
10094 The maximum number of inequalities in an Omega constraint system.
10095 The default value is 256.
10097 @item omega-max-eqs
10098 The maximum number of equalities in an Omega constraint system.
10099 The default value is 128.
10101 @item omega-max-wild-cards
10102 The maximum number of wildcard variables that the Omega solver is
10103 able to insert.  The default value is 18.
10105 @item omega-hash-table-size
10106 The size of the hash table in the Omega solver.  The default value is
10107 550.
10109 @item omega-max-keys
10110 The maximal number of keys used by the Omega solver.  The default
10111 value is 500.
10113 @item omega-eliminate-redundant-constraints
10114 When set to 1, use expensive methods to eliminate all redundant
10115 constraints.  The default value is 0.
10117 @item vect-max-version-for-alignment-checks
10118 The maximum number of run-time checks that can be performed when
10119 doing loop versioning for alignment in the vectorizer.
10121 @item vect-max-version-for-alias-checks
10122 The maximum number of run-time checks that can be performed when
10123 doing loop versioning for alias in the vectorizer.
10125 @item vect-max-peeling-for-alignment
10126 The maximum number of loop peels to enhance access alignment
10127 for vectorizer. Value -1 means 'no limit'.
10129 @item max-iterations-to-track
10130 The maximum number of iterations of a loop the brute-force algorithm
10131 for analysis of the number of iterations of the loop tries to evaluate.
10133 @item hot-bb-count-ws-permille
10134 A basic block profile count is considered hot if it contributes to 
10135 the given permillage (i.e. 0...1000) of the entire profiled execution.
10137 @item hot-bb-frequency-fraction
10138 Select fraction of the entry block frequency of executions of basic block in
10139 function given basic block needs to have to be considered hot.
10141 @item max-predicted-iterations
10142 The maximum number of loop iterations we predict statically.  This is useful
10143 in cases where a function contains a single loop with known bound and
10144 another loop with unknown bound.
10145 The known number of iterations is predicted correctly, while
10146 the unknown number of iterations average to roughly 10.  This means that the
10147 loop without bounds appears artificially cold relative to the other one.
10149 @item builtin-expect-probability
10150 Control the probability of the expression having the specified value. This
10151 parameter takes a percentage (i.e. 0 ... 100) as input.
10152 The default probability of 90 is obtained empirically.
10154 @item align-threshold
10156 Select fraction of the maximal frequency of executions of a basic block in
10157 a function to align the basic block.
10159 @item align-loop-iterations
10161 A loop expected to iterate at least the selected number of iterations is
10162 aligned.
10164 @item tracer-dynamic-coverage
10165 @itemx tracer-dynamic-coverage-feedback
10167 This value is used to limit superblock formation once the given percentage of
10168 executed instructions is covered.  This limits unnecessary code size
10169 expansion.
10171 The @option{tracer-dynamic-coverage-feedback} is used only when profile
10172 feedback is available.  The real profiles (as opposed to statically estimated
10173 ones) are much less balanced allowing the threshold to be larger value.
10175 @item tracer-max-code-growth
10176 Stop tail duplication once code growth has reached given percentage.  This is
10177 a rather artificial limit, as most of the duplicates are eliminated later in
10178 cross jumping, so it may be set to much higher values than is the desired code
10179 growth.
10181 @item tracer-min-branch-ratio
10183 Stop reverse growth when the reverse probability of best edge is less than this
10184 threshold (in percent).
10186 @item tracer-min-branch-ratio
10187 @itemx tracer-min-branch-ratio-feedback
10189 Stop forward growth if the best edge has probability lower than this
10190 threshold.
10192 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
10193 compilation for profile feedback and one for compilation without.  The value
10194 for compilation with profile feedback needs to be more conservative (higher) in
10195 order to make tracer effective.
10197 @item max-cse-path-length
10199 The maximum number of basic blocks on path that CSE considers.
10200 The default is 10.
10202 @item max-cse-insns
10203 The maximum number of instructions CSE processes before flushing.
10204 The default is 1000.
10206 @item ggc-min-expand
10208 GCC uses a garbage collector to manage its own memory allocation.  This
10209 parameter specifies the minimum percentage by which the garbage
10210 collector's heap should be allowed to expand between collections.
10211 Tuning this may improve compilation speed; it has no effect on code
10212 generation.
10214 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
10215 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
10216 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
10217 GCC is not able to calculate RAM on a particular platform, the lower
10218 bound of 30% is used.  Setting this parameter and
10219 @option{ggc-min-heapsize} to zero causes a full collection to occur at
10220 every opportunity.  This is extremely slow, but can be useful for
10221 debugging.
10223 @item ggc-min-heapsize
10225 Minimum size of the garbage collector's heap before it begins bothering
10226 to collect garbage.  The first collection occurs after the heap expands
10227 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
10228 tuning this may improve compilation speed, and has no effect on code
10229 generation.
10231 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
10232 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
10233 with a lower bound of 4096 (four megabytes) and an upper bound of
10234 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
10235 particular platform, the lower bound is used.  Setting this parameter
10236 very large effectively disables garbage collection.  Setting this
10237 parameter and @option{ggc-min-expand} to zero causes a full collection
10238 to occur at every opportunity.
10240 @item max-reload-search-insns
10241 The maximum number of instruction reload should look backward for equivalent
10242 register.  Increasing values mean more aggressive optimization, making the
10243 compilation time increase with probably slightly better performance.
10244 The default value is 100.
10246 @item max-cselib-memory-locations
10247 The maximum number of memory locations cselib should take into account.
10248 Increasing values mean more aggressive optimization, making the compilation time
10249 increase with probably slightly better performance.  The default value is 500.
10251 @item reorder-blocks-duplicate
10252 @itemx reorder-blocks-duplicate-feedback
10254 Used by the basic block reordering pass to decide whether to use unconditional
10255 branch or duplicate the code on its destination.  Code is duplicated when its
10256 estimated size is smaller than this value multiplied by the estimated size of
10257 unconditional jump in the hot spots of the program.
10259 The @option{reorder-block-duplicate-feedback} is used only when profile
10260 feedback is available.  It may be set to higher values than
10261 @option{reorder-block-duplicate} since information about the hot spots is more
10262 accurate.
10264 @item max-sched-ready-insns
10265 The maximum number of instructions ready to be issued the scheduler should
10266 consider at any given time during the first scheduling pass.  Increasing
10267 values mean more thorough searches, making the compilation time increase
10268 with probably little benefit.  The default value is 100.
10270 @item max-sched-region-blocks
10271 The maximum number of blocks in a region to be considered for
10272 interblock scheduling.  The default value is 10.
10274 @item max-pipeline-region-blocks
10275 The maximum number of blocks in a region to be considered for
10276 pipelining in the selective scheduler.  The default value is 15.
10278 @item max-sched-region-insns
10279 The maximum number of insns in a region to be considered for
10280 interblock scheduling.  The default value is 100.
10282 @item max-pipeline-region-insns
10283 The maximum number of insns in a region to be considered for
10284 pipelining in the selective scheduler.  The default value is 200.
10286 @item min-spec-prob
10287 The minimum probability (in percents) of reaching a source block
10288 for interblock speculative scheduling.  The default value is 40.
10290 @item max-sched-extend-regions-iters
10291 The maximum number of iterations through CFG to extend regions.
10292 A value of 0 (the default) disables region extensions.
10294 @item max-sched-insn-conflict-delay
10295 The maximum conflict delay for an insn to be considered for speculative motion.
10296 The default value is 3.
10298 @item sched-spec-prob-cutoff
10299 The minimal probability of speculation success (in percents), so that
10300 speculative insns are scheduled.
10301 The default value is 40.
10303 @item sched-spec-state-edge-prob-cutoff
10304 The minimum probability an edge must have for the scheduler to save its
10305 state across it.
10306 The default value is 10.
10308 @item sched-mem-true-dep-cost
10309 Minimal distance (in CPU cycles) between store and load targeting same
10310 memory locations.  The default value is 1.
10312 @item selsched-max-lookahead
10313 The maximum size of the lookahead window of selective scheduling.  It is a
10314 depth of search for available instructions.
10315 The default value is 50.
10317 @item selsched-max-sched-times
10318 The maximum number of times that an instruction is scheduled during
10319 selective scheduling.  This is the limit on the number of iterations
10320 through which the instruction may be pipelined.  The default value is 2.
10322 @item selsched-max-insns-to-rename
10323 The maximum number of best instructions in the ready list that are considered
10324 for renaming in the selective scheduler.  The default value is 2.
10326 @item sms-min-sc
10327 The minimum value of stage count that swing modulo scheduler
10328 generates.  The default value is 2.
10330 @item max-last-value-rtl
10331 The maximum size measured as number of RTLs that can be recorded in an expression
10332 in combiner for a pseudo register as last known value of that register.  The default
10333 is 10000.
10335 @item max-combine-insns
10336 The maximum number of instructions the RTL combiner tries to combine.
10337 The default value is 2 at @option{-Og} and 4 otherwise.
10339 @item integer-share-limit
10340 Small integer constants can use a shared data structure, reducing the
10341 compiler's memory usage and increasing its speed.  This sets the maximum
10342 value of a shared integer constant.  The default value is 256.
10344 @item ssp-buffer-size
10345 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
10346 protection when @option{-fstack-protection} is used.
10348 @item min-size-for-stack-sharing
10349 The minimum size of variables taking part in stack slot sharing when not
10350 optimizing. The default value is 32.
10352 @item max-jump-thread-duplication-stmts
10353 Maximum number of statements allowed in a block that needs to be
10354 duplicated when threading jumps.
10356 @item max-fields-for-field-sensitive
10357 Maximum number of fields in a structure treated in
10358 a field sensitive manner during pointer analysis.  The default is zero
10359 for @option{-O0} and @option{-O1},
10360 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
10362 @item prefetch-latency
10363 Estimate on average number of instructions that are executed before
10364 prefetch finishes.  The distance prefetched ahead is proportional
10365 to this constant.  Increasing this number may also lead to less
10366 streams being prefetched (see @option{simultaneous-prefetches}).
10368 @item simultaneous-prefetches
10369 Maximum number of prefetches that can run at the same time.
10371 @item l1-cache-line-size
10372 The size of cache line in L1 cache, in bytes.
10374 @item l1-cache-size
10375 The size of L1 cache, in kilobytes.
10377 @item l2-cache-size
10378 The size of L2 cache, in kilobytes.
10380 @item min-insn-to-prefetch-ratio
10381 The minimum ratio between the number of instructions and the
10382 number of prefetches to enable prefetching in a loop.
10384 @item prefetch-min-insn-to-mem-ratio
10385 The minimum ratio between the number of instructions and the
10386 number of memory references to enable prefetching in a loop.
10388 @item use-canonical-types
10389 Whether the compiler should use the ``canonical'' type system.  By
10390 default, this should always be 1, which uses a more efficient internal
10391 mechanism for comparing types in C++ and Objective-C++.  However, if
10392 bugs in the canonical type system are causing compilation failures,
10393 set this value to 0 to disable canonical types.
10395 @item switch-conversion-max-branch-ratio
10396 Switch initialization conversion refuses to create arrays that are
10397 bigger than @option{switch-conversion-max-branch-ratio} times the number of
10398 branches in the switch.
10400 @item max-partial-antic-length
10401 Maximum length of the partial antic set computed during the tree
10402 partial redundancy elimination optimization (@option{-ftree-pre}) when
10403 optimizing at @option{-O3} and above.  For some sorts of source code
10404 the enhanced partial redundancy elimination optimization can run away,
10405 consuming all of the memory available on the host machine.  This
10406 parameter sets a limit on the length of the sets that are computed,
10407 which prevents the runaway behavior.  Setting a value of 0 for
10408 this parameter allows an unlimited set length.
10410 @item sccvn-max-scc-size
10411 Maximum size of a strongly connected component (SCC) during SCCVN
10412 processing.  If this limit is hit, SCCVN processing for the whole
10413 function is not done and optimizations depending on it are
10414 disabled.  The default maximum SCC size is 10000.
10416 @item sccvn-max-alias-queries-per-access
10417 Maximum number of alias-oracle queries we perform when looking for
10418 redundancies for loads and stores.  If this limit is hit the search
10419 is aborted and the load or store is not considered redundant.  The
10420 number of queries is algorithmically limited to the number of
10421 stores on all paths from the load to the function entry.
10422 The default maxmimum number of queries is 1000.
10424 @item ira-max-loops-num
10425 IRA uses regional register allocation by default.  If a function
10426 contains more loops than the number given by this parameter, only at most
10427 the given number of the most frequently-executed loops form regions
10428 for regional register allocation.  The default value of the
10429 parameter is 100.
10431 @item ira-max-conflict-table-size 
10432 Although IRA uses a sophisticated algorithm to compress the conflict
10433 table, the table can still require excessive amounts of memory for
10434 huge functions.  If the conflict table for a function could be more
10435 than the size in MB given by this parameter, the register allocator
10436 instead uses a faster, simpler, and lower-quality
10437 algorithm that does not require building a pseudo-register conflict table.  
10438 The default value of the parameter is 2000.
10440 @item ira-loop-reserved-regs
10441 IRA can be used to evaluate more accurate register pressure in loops
10442 for decisions to move loop invariants (see @option{-O3}).  The number
10443 of available registers reserved for some other purposes is given
10444 by this parameter.  The default value of the parameter is 2, which is
10445 the minimal number of registers needed by typical instructions.
10446 This value is the best found from numerous experiments.
10448 @item loop-invariant-max-bbs-in-loop
10449 Loop invariant motion can be very expensive, both in compilation time and
10450 in amount of needed compile-time memory, with very large loops.  Loops
10451 with more basic blocks than this parameter won't have loop invariant
10452 motion optimization performed on them.  The default value of the
10453 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
10455 @item loop-max-datarefs-for-datadeps
10456 Building data dapendencies is expensive for very large loops.  This
10457 parameter limits the number of data references in loops that are
10458 considered for data dependence analysis.  These large loops are no
10459 handled by the optimizations using loop data dependencies.
10460 The default value is 1000.
10462 @item max-vartrack-size
10463 Sets a maximum number of hash table slots to use during variable
10464 tracking dataflow analysis of any function.  If this limit is exceeded
10465 with variable tracking at assignments enabled, analysis for that
10466 function is retried without it, after removing all debug insns from
10467 the function.  If the limit is exceeded even without debug insns, var
10468 tracking analysis is completely disabled for the function.  Setting
10469 the parameter to zero makes it unlimited.
10471 @item max-vartrack-expr-depth
10472 Sets a maximum number of recursion levels when attempting to map
10473 variable names or debug temporaries to value expressions.  This trades
10474 compilation time for more complete debug information.  If this is set too
10475 low, value expressions that are available and could be represented in
10476 debug information may end up not being used; setting this higher may
10477 enable the compiler to find more complex debug expressions, but compile
10478 time and memory use may grow.  The default is 12.
10480 @item min-nondebug-insn-uid
10481 Use uids starting at this parameter for nondebug insns.  The range below
10482 the parameter is reserved exclusively for debug insns created by
10483 @option{-fvar-tracking-assignments}, but debug insns may get
10484 (non-overlapping) uids above it if the reserved range is exhausted.
10486 @item ipa-sra-ptr-growth-factor
10487 IPA-SRA replaces a pointer to an aggregate with one or more new
10488 parameters only when their cumulative size is less or equal to
10489 @option{ipa-sra-ptr-growth-factor} times the size of the original
10490 pointer parameter.
10492 @item sra-max-scalarization-size-Ospeed
10493 @item sra-max-scalarization-size-Osize
10494 The two Scalar Reduction of Aggregates passes (SRA and IPA-SRA) aim to
10495 replace scalar parts of aggregates with uses of independent scalar
10496 variables.  These parameters control the maximum size, in storage units,
10497 of aggregate which will be considered for replacement when compiling for
10498 speed
10499 (@option{sra-max-scalarization-size-Ospeed}) or size
10500 (@option{sra-max-scalarization-size-Osize}) respectively.
10502 @item tm-max-aggregate-size
10503 When making copies of thread-local variables in a transaction, this
10504 parameter specifies the size in bytes after which variables are
10505 saved with the logging functions as opposed to save/restore code
10506 sequence pairs.  This option only applies when using
10507 @option{-fgnu-tm}.
10509 @item graphite-max-nb-scop-params
10510 To avoid exponential effects in the Graphite loop transforms, the
10511 number of parameters in a Static Control Part (SCoP) is bounded.  The
10512 default value is 10 parameters.  A variable whose value is unknown at
10513 compilation time and defined outside a SCoP is a parameter of the SCoP.
10515 @item graphite-max-bbs-per-function
10516 To avoid exponential effects in the detection of SCoPs, the size of
10517 the functions analyzed by Graphite is bounded.  The default value is
10518 100 basic blocks.
10520 @item loop-block-tile-size
10521 Loop blocking or strip mining transforms, enabled with
10522 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10523 loop in the loop nest by a given number of iterations.  The strip
10524 length can be changed using the @option{loop-block-tile-size}
10525 parameter.  The default value is 51 iterations.
10527 @item loop-unroll-jam-size
10528 Specify the unroll factor for the @option{-floop-unroll-and-jam}.  The 
10529 default value is 4.
10531 @item loop-unroll-jam-depth
10532 Specify the dimension to be unrolled (counting from the most inner loop)
10533 for the  @option{-floop-unroll-and-jam}.  The default value is 2.
10535 @item ipa-cp-value-list-size
10536 IPA-CP attempts to track all possible values and types passed to a function's
10537 parameter in order to propagate them and perform devirtualization.
10538 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10539 stores per one formal parameter of a function.
10541 @item ipa-cp-eval-threshold
10542 IPA-CP calculates its own score of cloning profitability heuristics
10543 and performs those cloning opportunities with scores that exceed
10544 @option{ipa-cp-eval-threshold}.
10546 @item ipa-max-agg-items
10547 IPA-CP is also capable to propagate a number of scalar values passed
10548 in an aggregate. @option{ipa-max-agg-items} controls the maximum
10549 number of such values per one parameter.
10551 @item ipa-cp-loop-hint-bonus
10552 When IPA-CP determines that a cloning candidate would make the number
10553 of iterations of a loop known, it adds a bonus of
10554 @option{ipa-cp-loop-hint-bonus} to the profitability score of
10555 the candidate.
10557 @item ipa-cp-array-index-hint-bonus
10558 When IPA-CP determines that a cloning candidate would make the index of
10559 an array access known, it adds a bonus of
10560 @option{ipa-cp-array-index-hint-bonus} to the profitability
10561 score of the candidate.
10563 @item ipa-max-aa-steps
10564 During its analysis of function bodies, IPA-CP employs alias analysis
10565 in order to track values pointed to by function parameters.  In order
10566 not spend too much time analyzing huge functions, it will give up and
10567 consider all memory clobbered after examining
10568 @option{ipa-max-aa-steps} statements modifying memory.
10570 @item lto-partitions
10571 Specify desired number of partitions produced during WHOPR compilation.
10572 The number of partitions should exceed the number of CPUs used for compilation.
10573 The default value is 32.
10575 @item lto-minpartition
10576 Size of minimal partition for WHOPR (in estimated instructions).
10577 This prevents expenses of splitting very small programs into too many
10578 partitions.
10580 @item cxx-max-namespaces-for-diagnostic-help
10581 The maximum number of namespaces to consult for suggestions when C++
10582 name lookup fails for an identifier.  The default is 1000.
10584 @item sink-frequency-threshold
10585 The maximum relative execution frequency (in percents) of the target block
10586 relative to a statement's original block to allow statement sinking of a
10587 statement.  Larger numbers result in more aggressive statement sinking.
10588 The default value is 75.  A small positive adjustment is applied for
10589 statements with memory operands as those are even more profitable so sink.
10591 @item max-stores-to-sink
10592 The maximum number of conditional stores paires that can be sunk.  Set to 0
10593 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10594 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10596 @item allow-store-data-races
10597 Allow optimizers to introduce new data races on stores.
10598 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10599 at optimization level @option{-Ofast}.
10601 @item case-values-threshold
10602 The smallest number of different values for which it is best to use a
10603 jump-table instead of a tree of conditional branches.  If the value is
10604 0, use the default for the machine.  The default is 0.
10606 @item tree-reassoc-width
10607 Set the maximum number of instructions executed in parallel in
10608 reassociated tree. This parameter overrides target dependent
10609 heuristics used by default if has non zero value.
10611 @item sched-pressure-algorithm
10612 Choose between the two available implementations of
10613 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10614 and is the more likely to prevent instructions from being reordered.
10615 Algorithm 2 was designed to be a compromise between the relatively
10616 conservative approach taken by algorithm 1 and the rather aggressive
10617 approach taken by the default scheduler.  It relies more heavily on
10618 having a regular register file and accurate register pressure classes.
10619 See @file{haifa-sched.c} in the GCC sources for more details.
10621 The default choice depends on the target.
10623 @item max-slsr-cand-scan
10624 Set the maximum number of existing candidates that will be considered when
10625 seeking a basis for a new straight-line strength reduction candidate.
10627 @item asan-globals
10628 Enable buffer overflow detection for global objects.  This kind
10629 of protection is enabled by default if you are using
10630 @option{-fsanitize=address} option.
10631 To disable global objects protection use @option{--param asan-globals=0}.
10633 @item asan-stack
10634 Enable buffer overflow detection for stack objects.  This kind of
10635 protection is enabled by default when using@option{-fsanitize=address}.
10636 To disable stack protection use @option{--param asan-stack=0} option.
10638 @item asan-instrument-reads
10639 Enable buffer overflow detection for memory reads.  This kind of
10640 protection is enabled by default when using @option{-fsanitize=address}.
10641 To disable memory reads protection use
10642 @option{--param asan-instrument-reads=0}.
10644 @item asan-instrument-writes
10645 Enable buffer overflow detection for memory writes.  This kind of
10646 protection is enabled by default when using @option{-fsanitize=address}.
10647 To disable memory writes protection use
10648 @option{--param asan-instrument-writes=0} option.
10650 @item asan-memintrin
10651 Enable detection for built-in functions.  This kind of protection
10652 is enabled by default when using @option{-fsanitize=address}.
10653 To disable built-in functions protection use
10654 @option{--param asan-memintrin=0}.
10656 @item asan-use-after-return
10657 Enable detection of use-after-return.  This kind of protection
10658 is enabled by default when using @option{-fsanitize=address} option.
10659 To disable use-after-return detection use 
10660 @option{--param asan-use-after-return=0}.
10662 @item asan-instrumentation-with-call-threshold
10663 If number of memory accesses in function being instrumented
10664 is greater or equal to this number, use callbacks instead of inline checks.
10665 E.g. to disable inline code use
10666 @option{--param asan-instrumentation-with-call-threshold=0}.
10668 @item chkp-max-ctor-size
10669 Static constructors generated by Pointer Bounds Checker may become very
10670 large and significantly increase compile time at optimization level
10671 @option{-O1} and higher.  This parameter is a maximum nubmer of statements
10672 in a single generated constructor.  Default value is 5000.
10674 @item max-fsm-thread-path-insns
10675 Maximum number of instructions to copy when duplicating blocks on a
10676 finite state automaton jump thread path.  The default is 100.
10678 @item max-fsm-thread-length
10679 Maximum number of basic blocks on a finite state automaton jump thread
10680 path.  The default is 10.
10682 @item max-fsm-thread-paths
10683 Maximum number of new jump thread paths to create for a finite state
10684 automaton.  The default is 50.
10686 @end table
10687 @end table
10689 @node Preprocessor Options
10690 @section Options Controlling the Preprocessor
10691 @cindex preprocessor options
10692 @cindex options, preprocessor
10694 These options control the C preprocessor, which is run on each C source
10695 file before actual compilation.
10697 If you use the @option{-E} option, nothing is done except preprocessing.
10698 Some of these options make sense only together with @option{-E} because
10699 they cause the preprocessor output to be unsuitable for actual
10700 compilation.
10702 @table @gcctabopt
10703 @item -Wp,@var{option}
10704 @opindex Wp
10705 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10706 and pass @var{option} directly through to the preprocessor.  If
10707 @var{option} contains commas, it is split into multiple options at the
10708 commas.  However, many options are modified, translated or interpreted
10709 by the compiler driver before being passed to the preprocessor, and
10710 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10711 interface is undocumented and subject to change, so whenever possible
10712 you should avoid using @option{-Wp} and let the driver handle the
10713 options instead.
10715 @item -Xpreprocessor @var{option}
10716 @opindex Xpreprocessor
10717 Pass @var{option} as an option to the preprocessor.  You can use this to
10718 supply system-specific preprocessor options that GCC does not 
10719 recognize.
10721 If you want to pass an option that takes an argument, you must use
10722 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10724 @item -no-integrated-cpp
10725 @opindex no-integrated-cpp
10726 Perform preprocessing as a separate pass before compilation.
10727 By default, GCC performs preprocessing as an integrated part of
10728 input tokenization and parsing.
10729 If this option is provided, the appropriate language front end
10730 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10731 and Objective-C, respectively) is instead invoked twice,
10732 once for preprocessing only and once for actual compilation
10733 of the preprocessed input.
10734 This option may be useful in conjunction with the @option{-B} or
10735 @option{-wrapper} options to specify an alternate preprocessor or
10736 perform additional processing of the program source between
10737 normal preprocessing and compilation.
10738 @end table
10740 @include cppopts.texi
10742 @node Assembler Options
10743 @section Passing Options to the Assembler
10745 @c prevent bad page break with this line
10746 You can pass options to the assembler.
10748 @table @gcctabopt
10749 @item -Wa,@var{option}
10750 @opindex Wa
10751 Pass @var{option} as an option to the assembler.  If @var{option}
10752 contains commas, it is split into multiple options at the commas.
10754 @item -Xassembler @var{option}
10755 @opindex Xassembler
10756 Pass @var{option} as an option to the assembler.  You can use this to
10757 supply system-specific assembler options that GCC does not
10758 recognize.
10760 If you want to pass an option that takes an argument, you must use
10761 @option{-Xassembler} twice, once for the option and once for the argument.
10763 @end table
10765 @node Link Options
10766 @section Options for Linking
10767 @cindex link options
10768 @cindex options, linking
10770 These options come into play when the compiler links object files into
10771 an executable output file.  They are meaningless if the compiler is
10772 not doing a link step.
10774 @table @gcctabopt
10775 @cindex file names
10776 @item @var{object-file-name}
10777 A file name that does not end in a special recognized suffix is
10778 considered to name an object file or library.  (Object files are
10779 distinguished from libraries by the linker according to the file
10780 contents.)  If linking is done, these object files are used as input
10781 to the linker.
10783 @item -c
10784 @itemx -S
10785 @itemx -E
10786 @opindex c
10787 @opindex S
10788 @opindex E
10789 If any of these options is used, then the linker is not run, and
10790 object file names should not be used as arguments.  @xref{Overall
10791 Options}.
10793 @cindex Libraries
10794 @item -l@var{library}
10795 @itemx -l @var{library}
10796 @opindex l
10797 Search the library named @var{library} when linking.  (The second
10798 alternative with the library as a separate argument is only for
10799 POSIX compliance and is not recommended.)
10801 It makes a difference where in the command you write this option; the
10802 linker searches and processes libraries and object files in the order they
10803 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10804 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10805 to functions in @samp{z}, those functions may not be loaded.
10807 The linker searches a standard list of directories for the library,
10808 which is actually a file named @file{lib@var{library}.a}.  The linker
10809 then uses this file as if it had been specified precisely by name.
10811 The directories searched include several standard system directories
10812 plus any that you specify with @option{-L}.
10814 Normally the files found this way are library files---archive files
10815 whose members are object files.  The linker handles an archive file by
10816 scanning through it for members which define symbols that have so far
10817 been referenced but not defined.  But if the file that is found is an
10818 ordinary object file, it is linked in the usual fashion.  The only
10819 difference between using an @option{-l} option and specifying a file name
10820 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10821 and searches several directories.
10823 @item -lobjc
10824 @opindex lobjc
10825 You need this special case of the @option{-l} option in order to
10826 link an Objective-C or Objective-C++ program.
10828 @item -nostartfiles
10829 @opindex nostartfiles
10830 Do not use the standard system startup files when linking.
10831 The standard system libraries are used normally, unless @option{-nostdlib}
10832 or @option{-nodefaultlibs} is used.
10834 @item -nodefaultlibs
10835 @opindex nodefaultlibs
10836 Do not use the standard system libraries when linking.
10837 Only the libraries you specify are passed to the linker, and options
10838 specifying linkage of the system libraries, such as @code{-static-libgcc}
10839 or @code{-shared-libgcc}, are ignored.  
10840 The standard startup files are used normally, unless @option{-nostartfiles}
10841 is used.  
10843 The compiler may generate calls to @code{memcmp},
10844 @code{memset}, @code{memcpy} and @code{memmove}.
10845 These entries are usually resolved by entries in
10846 libc.  These entry points should be supplied through some other
10847 mechanism when this option is specified.
10849 @item -nostdlib
10850 @opindex nostdlib
10851 Do not use the standard system startup files or libraries when linking.
10852 No startup files and only the libraries you specify are passed to
10853 the linker, and options specifying linkage of the system libraries, such as
10854 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10856 The compiler may generate calls to @code{memcmp}, @code{memset},
10857 @code{memcpy} and @code{memmove}.
10858 These entries are usually resolved by entries in
10859 libc.  These entry points should be supplied through some other
10860 mechanism when this option is specified.
10862 @cindex @option{-lgcc}, use with @option{-nostdlib}
10863 @cindex @option{-nostdlib} and unresolved references
10864 @cindex unresolved references and @option{-nostdlib}
10865 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10866 @cindex @option{-nodefaultlibs} and unresolved references
10867 @cindex unresolved references and @option{-nodefaultlibs}
10868 One of the standard libraries bypassed by @option{-nostdlib} and
10869 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10870 which GCC uses to overcome shortcomings of particular machines, or special
10871 needs for some languages.
10872 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10873 Collection (GCC) Internals},
10874 for more discussion of @file{libgcc.a}.)
10875 In most cases, you need @file{libgcc.a} even when you want to avoid
10876 other standard libraries.  In other words, when you specify @option{-nostdlib}
10877 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10878 This ensures that you have no unresolved references to internal GCC
10879 library subroutines.
10880 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10881 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10882 GNU Compiler Collection (GCC) Internals}.)
10884 @item -pie
10885 @opindex pie
10886 Produce a position independent executable on targets that support it.
10887 For predictable results, you must also specify the same set of options
10888 used for compilation (@option{-fpie}, @option{-fPIE},
10889 or model suboptions) when you specify this linker option.
10891 @item -rdynamic
10892 @opindex rdynamic
10893 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10894 that support it. This instructs the linker to add all symbols, not
10895 only used ones, to the dynamic symbol table. This option is needed
10896 for some uses of @code{dlopen} or to allow obtaining backtraces
10897 from within a program.
10899 @item -s
10900 @opindex s
10901 Remove all symbol table and relocation information from the executable.
10903 @item -static
10904 @opindex static
10905 On systems that support dynamic linking, this prevents linking with the shared
10906 libraries.  On other systems, this option has no effect.
10908 @item -shared
10909 @opindex shared
10910 Produce a shared object which can then be linked with other objects to
10911 form an executable.  Not all systems support this option.  For predictable
10912 results, you must also specify the same set of options used for compilation
10913 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10914 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10915 needs to build supplementary stub code for constructors to work.  On
10916 multi-libbed systems, @samp{gcc -shared} must select the correct support
10917 libraries to link against.  Failing to supply the correct flags may lead
10918 to subtle defects.  Supplying them in cases where they are not necessary
10919 is innocuous.}
10921 @item -shared-libgcc
10922 @itemx -static-libgcc
10923 @opindex shared-libgcc
10924 @opindex static-libgcc
10925 On systems that provide @file{libgcc} as a shared library, these options
10926 force the use of either the shared or static version, respectively.
10927 If no shared version of @file{libgcc} was built when the compiler was
10928 configured, these options have no effect.
10930 There are several situations in which an application should use the
10931 shared @file{libgcc} instead of the static version.  The most common
10932 of these is when the application wishes to throw and catch exceptions
10933 across different shared libraries.  In that case, each of the libraries
10934 as well as the application itself should use the shared @file{libgcc}.
10936 Therefore, the G++ and GCJ drivers automatically add
10937 @option{-shared-libgcc} whenever you build a shared library or a main
10938 executable, because C++ and Java programs typically use exceptions, so
10939 this is the right thing to do.
10941 If, instead, you use the GCC driver to create shared libraries, you may
10942 find that they are not always linked with the shared @file{libgcc}.
10943 If GCC finds, at its configuration time, that you have a non-GNU linker
10944 or a GNU linker that does not support option @option{--eh-frame-hdr},
10945 it links the shared version of @file{libgcc} into shared libraries
10946 by default.  Otherwise, it takes advantage of the linker and optimizes
10947 away the linking with the shared version of @file{libgcc}, linking with
10948 the static version of libgcc by default.  This allows exceptions to
10949 propagate through such shared libraries, without incurring relocation
10950 costs at library load time.
10952 However, if a library or main executable is supposed to throw or catch
10953 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10954 for the languages used in the program, or using the option
10955 @option{-shared-libgcc}, such that it is linked with the shared
10956 @file{libgcc}.
10958 @item -static-libasan
10959 @opindex static-libasan
10960 When the @option{-fsanitize=address} option is used to link a program,
10961 the GCC driver automatically links against @option{libasan}.  If
10962 @file{libasan} is available as a shared library, and the @option{-static}
10963 option is not used, then this links against the shared version of
10964 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10965 driver to link @file{libasan} statically, without necessarily linking
10966 other libraries statically.
10968 @item -static-libtsan
10969 @opindex static-libtsan
10970 When the @option{-fsanitize=thread} option is used to link a program,
10971 the GCC driver automatically links against @option{libtsan}.  If
10972 @file{libtsan} is available as a shared library, and the @option{-static}
10973 option is not used, then this links against the shared version of
10974 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10975 driver to link @file{libtsan} statically, without necessarily linking
10976 other libraries statically.
10978 @item -static-liblsan
10979 @opindex static-liblsan
10980 When the @option{-fsanitize=leak} option is used to link a program,
10981 the GCC driver automatically links against @option{liblsan}.  If
10982 @file{liblsan} is available as a shared library, and the @option{-static}
10983 option is not used, then this links against the shared version of
10984 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10985 driver to link @file{liblsan} statically, without necessarily linking
10986 other libraries statically.
10988 @item -static-libubsan
10989 @opindex static-libubsan
10990 When the @option{-fsanitize=undefined} option is used to link a program,
10991 the GCC driver automatically links against @option{libubsan}.  If
10992 @file{libubsan} is available as a shared library, and the @option{-static}
10993 option is not used, then this links against the shared version of
10994 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10995 driver to link @file{libubsan} statically, without necessarily linking
10996 other libraries statically.
10998 @item -static-libstdc++
10999 @opindex static-libstdc++
11000 When the @command{g++} program is used to link a C++ program, it
11001 normally automatically links against @option{libstdc++}.  If
11002 @file{libstdc++} is available as a shared library, and the
11003 @option{-static} option is not used, then this links against the
11004 shared version of @file{libstdc++}.  That is normally fine.  However, it
11005 is sometimes useful to freeze the version of @file{libstdc++} used by
11006 the program without going all the way to a fully static link.  The
11007 @option{-static-libstdc++} option directs the @command{g++} driver to
11008 link @file{libstdc++} statically, without necessarily linking other
11009 libraries statically.
11011 @item -symbolic
11012 @opindex symbolic
11013 Bind references to global symbols when building a shared object.  Warn
11014 about any unresolved references (unless overridden by the link editor
11015 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
11016 this option.
11018 @item -T @var{script}
11019 @opindex T
11020 @cindex linker script
11021 Use @var{script} as the linker script.  This option is supported by most
11022 systems using the GNU linker.  On some targets, such as bare-board
11023 targets without an operating system, the @option{-T} option may be required
11024 when linking to avoid references to undefined symbols.
11026 @item -Xlinker @var{option}
11027 @opindex Xlinker
11028 Pass @var{option} as an option to the linker.  You can use this to
11029 supply system-specific linker options that GCC does not recognize.
11031 If you want to pass an option that takes a separate argument, you must use
11032 @option{-Xlinker} twice, once for the option and once for the argument.
11033 For example, to pass @option{-assert definitions}, you must write
11034 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
11035 @option{-Xlinker "-assert definitions"}, because this passes the entire
11036 string as a single argument, which is not what the linker expects.
11038 When using the GNU linker, it is usually more convenient to pass
11039 arguments to linker options using the @option{@var{option}=@var{value}}
11040 syntax than as separate arguments.  For example, you can specify
11041 @option{-Xlinker -Map=output.map} rather than
11042 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
11043 this syntax for command-line options.
11045 @item -Wl,@var{option}
11046 @opindex Wl
11047 Pass @var{option} as an option to the linker.  If @var{option} contains
11048 commas, it is split into multiple options at the commas.  You can use this
11049 syntax to pass an argument to the option.
11050 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
11051 linker.  When using the GNU linker, you can also get the same effect with
11052 @option{-Wl,-Map=output.map}.
11054 @item -u @var{symbol}
11055 @opindex u
11056 Pretend the symbol @var{symbol} is undefined, to force linking of
11057 library modules to define it.  You can use @option{-u} multiple times with
11058 different symbols to force loading of additional library modules.
11060 @item -z @var{keyword}
11061 @opindex z
11062 @option{-z} is passed directly on to the linker along with the keyword
11063 @var{keyword}. See the section in the documentation of your linker for
11064 permitted values and their meanings.
11065 @end table
11067 @node Directory Options
11068 @section Options for Directory Search
11069 @cindex directory options
11070 @cindex options, directory search
11071 @cindex search path
11073 These options specify directories to search for header files, for
11074 libraries and for parts of the compiler:
11076 @table @gcctabopt
11077 @item -I@var{dir}
11078 @opindex I
11079 Add the directory @var{dir} to the head of the list of directories to be
11080 searched for header files.  This can be used to override a system header
11081 file, substituting your own version, since these directories are
11082 searched before the system header file directories.  However, you should
11083 not use this option to add directories that contain vendor-supplied
11084 system header files (use @option{-isystem} for that).  If you use more than
11085 one @option{-I} option, the directories are scanned in left-to-right
11086 order; the standard system directories come after.
11088 If a standard system include directory, or a directory specified with
11089 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
11090 option is ignored.  The directory is still searched but as a
11091 system directory at its normal position in the system include chain.
11092 This is to ensure that GCC's procedure to fix buggy system headers and
11093 the ordering for the @code{include_next} directive are not inadvertently changed.
11094 If you really need to change the search order for system directories,
11095 use the @option{-nostdinc} and/or @option{-isystem} options.
11097 @item -iplugindir=@var{dir}
11098 @opindex iplugindir=
11099 Set the directory to search for plugins that are passed
11100 by @option{-fplugin=@var{name}} instead of
11101 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
11102 to be used by the user, but only passed by the driver.
11104 @item -iquote@var{dir}
11105 @opindex iquote
11106 Add the directory @var{dir} to the head of the list of directories to
11107 be searched for header files only for the case of @samp{#include
11108 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
11109 otherwise just like @option{-I}.
11111 @item -L@var{dir}
11112 @opindex L
11113 Add directory @var{dir} to the list of directories to be searched
11114 for @option{-l}.
11116 @item -B@var{prefix}
11117 @opindex B
11118 This option specifies where to find the executables, libraries,
11119 include files, and data files of the compiler itself.
11121 The compiler driver program runs one or more of the subprograms
11122 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
11123 @var{prefix} as a prefix for each program it tries to run, both with and
11124 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
11126 For each subprogram to be run, the compiler driver first tries the
11127 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
11128 is not specified, the driver tries two standard prefixes, 
11129 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
11130 those results in a file name that is found, the unmodified program
11131 name is searched for using the directories specified in your
11132 @env{PATH} environment variable.
11134 The compiler checks to see if the path provided by the @option{-B}
11135 refers to a directory, and if necessary it adds a directory
11136 separator character at the end of the path.
11138 @option{-B} prefixes that effectively specify directory names also apply
11139 to libraries in the linker, because the compiler translates these
11140 options into @option{-L} options for the linker.  They also apply to
11141 include files in the preprocessor, because the compiler translates these
11142 options into @option{-isystem} options for the preprocessor.  In this case,
11143 the compiler appends @samp{include} to the prefix.
11145 The runtime support file @file{libgcc.a} can also be searched for using
11146 the @option{-B} prefix, if needed.  If it is not found there, the two
11147 standard prefixes above are tried, and that is all.  The file is left
11148 out of the link if it is not found by those means.
11150 Another way to specify a prefix much like the @option{-B} prefix is to use
11151 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
11152 Variables}.
11154 As a special kludge, if the path provided by @option{-B} is
11155 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
11156 9, then it is replaced by @file{[dir/]include}.  This is to help
11157 with boot-strapping the compiler.
11159 @item -specs=@var{file}
11160 @opindex specs
11161 Process @var{file} after the compiler reads in the standard @file{specs}
11162 file, in order to override the defaults which the @command{gcc} driver
11163 program uses when determining what switches to pass to @command{cc1},
11164 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
11165 @option{-specs=@var{file}} can be specified on the command line, and they
11166 are processed in order, from left to right.
11168 @item --sysroot=@var{dir}
11169 @opindex sysroot
11170 Use @var{dir} as the logical root directory for headers and libraries.
11171 For example, if the compiler normally searches for headers in
11172 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
11173 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
11175 If you use both this option and the @option{-isysroot} option, then
11176 the @option{--sysroot} option applies to libraries, but the
11177 @option{-isysroot} option applies to header files.
11179 The GNU linker (beginning with version 2.16) has the necessary support
11180 for this option.  If your linker does not support this option, the
11181 header file aspect of @option{--sysroot} still works, but the
11182 library aspect does not.
11184 @item --no-sysroot-suffix
11185 @opindex no-sysroot-suffix
11186 For some targets, a suffix is added to the root directory specified
11187 with @option{--sysroot}, depending on the other options used, so that
11188 headers may for example be found in
11189 @file{@var{dir}/@var{suffix}/usr/include} instead of
11190 @file{@var{dir}/usr/include}.  This option disables the addition of
11191 such a suffix.
11193 @item -I-
11194 @opindex I-
11195 This option has been deprecated.  Please use @option{-iquote} instead for
11196 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
11197 Any directories you specify with @option{-I} options before the @option{-I-}
11198 option are searched only for the case of @samp{#include "@var{file}"};
11199 they are not searched for @samp{#include <@var{file}>}.
11201 If additional directories are specified with @option{-I} options after
11202 the @option{-I-}, these directories are searched for all @samp{#include}
11203 directives.  (Ordinarily @emph{all} @option{-I} directories are used
11204 this way.)
11206 In addition, the @option{-I-} option inhibits the use of the current
11207 directory (where the current input file came from) as the first search
11208 directory for @samp{#include "@var{file}"}.  There is no way to
11209 override this effect of @option{-I-}.  With @option{-I.} you can specify
11210 searching the directory that is current when the compiler is
11211 invoked.  That is not exactly the same as what the preprocessor does
11212 by default, but it is often satisfactory.
11214 @option{-I-} does not inhibit the use of the standard system directories
11215 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
11216 independent.
11217 @end table
11219 @c man end
11221 @node Spec Files
11222 @section Specifying subprocesses and the switches to pass to them
11223 @cindex Spec Files
11225 @command{gcc} is a driver program.  It performs its job by invoking a
11226 sequence of other programs to do the work of compiling, assembling and
11227 linking.  GCC interprets its command-line parameters and uses these to
11228 deduce which programs it should invoke, and which command-line options
11229 it ought to place on their command lines.  This behavior is controlled
11230 by @dfn{spec strings}.  In most cases there is one spec string for each
11231 program that GCC can invoke, but a few programs have multiple spec
11232 strings to control their behavior.  The spec strings built into GCC can
11233 be overridden by using the @option{-specs=} command-line switch to specify
11234 a spec file.
11236 @dfn{Spec files} are plaintext files that are used to construct spec
11237 strings.  They consist of a sequence of directives separated by blank
11238 lines.  The type of directive is determined by the first non-whitespace
11239 character on the line, which can be one of the following:
11241 @table @code
11242 @item %@var{command}
11243 Issues a @var{command} to the spec file processor.  The commands that can
11244 appear here are:
11246 @table @code
11247 @item %include <@var{file}>
11248 @cindex @code{%include}
11249 Search for @var{file} and insert its text at the current point in the
11250 specs file.
11252 @item %include_noerr <@var{file}>
11253 @cindex @code{%include_noerr}
11254 Just like @samp{%include}, but do not generate an error message if the include
11255 file cannot be found.
11257 @item %rename @var{old_name} @var{new_name}
11258 @cindex @code{%rename}
11259 Rename the spec string @var{old_name} to @var{new_name}.
11261 @end table
11263 @item *[@var{spec_name}]:
11264 This tells the compiler to create, override or delete the named spec
11265 string.  All lines after this directive up to the next directive or
11266 blank line are considered to be the text for the spec string.  If this
11267 results in an empty string then the spec is deleted.  (Or, if the
11268 spec did not exist, then nothing happens.)  Otherwise, if the spec
11269 does not currently exist a new spec is created.  If the spec does
11270 exist then its contents are overridden by the text of this
11271 directive, unless the first character of that text is the @samp{+}
11272 character, in which case the text is appended to the spec.
11274 @item [@var{suffix}]:
11275 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
11276 and up to the next directive or blank line are considered to make up the
11277 spec string for the indicated suffix.  When the compiler encounters an
11278 input file with the named suffix, it processes the spec string in
11279 order to work out how to compile that file.  For example:
11281 @smallexample
11282 .ZZ:
11283 z-compile -input %i
11284 @end smallexample
11286 This says that any input file whose name ends in @samp{.ZZ} should be
11287 passed to the program @samp{z-compile}, which should be invoked with the
11288 command-line switch @option{-input} and with the result of performing the
11289 @samp{%i} substitution.  (See below.)
11291 As an alternative to providing a spec string, the text following a
11292 suffix directive can be one of the following:
11294 @table @code
11295 @item @@@var{language}
11296 This says that the suffix is an alias for a known @var{language}.  This is
11297 similar to using the @option{-x} command-line switch to GCC to specify a
11298 language explicitly.  For example:
11300 @smallexample
11301 .ZZ:
11302 @@c++
11303 @end smallexample
11305 Says that .ZZ files are, in fact, C++ source files.
11307 @item #@var{name}
11308 This causes an error messages saying:
11310 @smallexample
11311 @var{name} compiler not installed on this system.
11312 @end smallexample
11313 @end table
11315 GCC already has an extensive list of suffixes built into it.
11316 This directive adds an entry to the end of the list of suffixes, but
11317 since the list is searched from the end backwards, it is effectively
11318 possible to override earlier entries using this technique.
11320 @end table
11322 GCC has the following spec strings built into it.  Spec files can
11323 override these strings or create their own.  Note that individual
11324 targets can also add their own spec strings to this list.
11326 @smallexample
11327 asm          Options to pass to the assembler
11328 asm_final    Options to pass to the assembler post-processor
11329 cpp          Options to pass to the C preprocessor
11330 cc1          Options to pass to the C compiler
11331 cc1plus      Options to pass to the C++ compiler
11332 endfile      Object files to include at the end of the link
11333 link         Options to pass to the linker
11334 lib          Libraries to include on the command line to the linker
11335 libgcc       Decides which GCC support library to pass to the linker
11336 linker       Sets the name of the linker
11337 predefines   Defines to be passed to the C preprocessor
11338 signed_char  Defines to pass to CPP to say whether @code{char} is signed
11339              by default
11340 startfile    Object files to include at the start of the link
11341 @end smallexample
11343 Here is a small example of a spec file:
11345 @smallexample
11346 %rename lib                 old_lib
11348 *lib:
11349 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
11350 @end smallexample
11352 This example renames the spec called @samp{lib} to @samp{old_lib} and
11353 then overrides the previous definition of @samp{lib} with a new one.
11354 The new definition adds in some extra command-line options before
11355 including the text of the old definition.
11357 @dfn{Spec strings} are a list of command-line options to be passed to their
11358 corresponding program.  In addition, the spec strings can contain
11359 @samp{%}-prefixed sequences to substitute variable text or to
11360 conditionally insert text into the command line.  Using these constructs
11361 it is possible to generate quite complex command lines.
11363 Here is a table of all defined @samp{%}-sequences for spec
11364 strings.  Note that spaces are not generated automatically around the
11365 results of expanding these sequences.  Therefore you can concatenate them
11366 together or combine them with constant text in a single argument.
11368 @table @code
11369 @item %%
11370 Substitute one @samp{%} into the program name or argument.
11372 @item %i
11373 Substitute the name of the input file being processed.
11375 @item %b
11376 Substitute the basename of the input file being processed.
11377 This is the substring up to (and not including) the last period
11378 and not including the directory.
11380 @item %B
11381 This is the same as @samp{%b}, but include the file suffix (text after
11382 the last period).
11384 @item %d
11385 Marks the argument containing or following the @samp{%d} as a
11386 temporary file name, so that that file is deleted if GCC exits
11387 successfully.  Unlike @samp{%g}, this contributes no text to the
11388 argument.
11390 @item %g@var{suffix}
11391 Substitute a file name that has suffix @var{suffix} and is chosen
11392 once per compilation, and mark the argument in the same way as
11393 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
11394 name is now chosen in a way that is hard to predict even when previously
11395 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
11396 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
11397 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
11398 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
11399 was simply substituted with a file name chosen once per compilation,
11400 without regard to any appended suffix (which was therefore treated
11401 just like ordinary text), making such attacks more likely to succeed.
11403 @item %u@var{suffix}
11404 Like @samp{%g}, but generates a new temporary file name
11405 each time it appears instead of once per compilation.
11407 @item %U@var{suffix}
11408 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
11409 new one if there is no such last file name.  In the absence of any
11410 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
11411 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
11412 involves the generation of two distinct file names, one
11413 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
11414 simply substituted with a file name chosen for the previous @samp{%u},
11415 without regard to any appended suffix.
11417 @item %j@var{suffix}
11418 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
11419 writable, and if @option{-save-temps} is not used; 
11420 otherwise, substitute the name
11421 of a temporary file, just like @samp{%u}.  This temporary file is not
11422 meant for communication between processes, but rather as a junk
11423 disposal mechanism.
11425 @item %|@var{suffix}
11426 @itemx %m@var{suffix}
11427 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
11428 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
11429 all.  These are the two most common ways to instruct a program that it
11430 should read from standard input or write to standard output.  If you
11431 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
11432 construct: see for example @file{f/lang-specs.h}.
11434 @item %.@var{SUFFIX}
11435 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
11436 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
11437 terminated by the next space or %.
11439 @item %w
11440 Marks the argument containing or following the @samp{%w} as the
11441 designated output file of this compilation.  This puts the argument
11442 into the sequence of arguments that @samp{%o} substitutes.
11444 @item %o
11445 Substitutes the names of all the output files, with spaces
11446 automatically placed around them.  You should write spaces
11447 around the @samp{%o} as well or the results are undefined.
11448 @samp{%o} is for use in the specs for running the linker.
11449 Input files whose names have no recognized suffix are not compiled
11450 at all, but they are included among the output files, so they are
11451 linked.
11453 @item %O
11454 Substitutes the suffix for object files.  Note that this is
11455 handled specially when it immediately follows @samp{%g, %u, or %U},
11456 because of the need for those to form complete file names.  The
11457 handling is such that @samp{%O} is treated exactly as if it had already
11458 been substituted, except that @samp{%g, %u, and %U} do not currently
11459 support additional @var{suffix} characters following @samp{%O} as they do
11460 following, for example, @samp{.o}.
11462 @item %p
11463 Substitutes the standard macro predefinitions for the
11464 current target machine.  Use this when running @code{cpp}.
11466 @item %P
11467 Like @samp{%p}, but puts @samp{__} before and after the name of each
11468 predefined macro, except for macros that start with @samp{__} or with
11469 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
11472 @item %I
11473 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
11474 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
11475 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
11476 and @option{-imultilib} as necessary.
11478 @item %s
11479 Current argument is the name of a library or startup file of some sort.
11480 Search for that file in a standard list of directories and substitute
11481 the full name found.  The current working directory is included in the
11482 list of directories scanned.
11484 @item %T
11485 Current argument is the name of a linker script.  Search for that file
11486 in the current list of directories to scan for libraries. If the file
11487 is located insert a @option{--script} option into the command line
11488 followed by the full path name found.  If the file is not found then
11489 generate an error message.  Note: the current working directory is not
11490 searched.
11492 @item %e@var{str}
11493 Print @var{str} as an error message.  @var{str} is terminated by a newline.
11494 Use this when inconsistent options are detected.
11496 @item %(@var{name})
11497 Substitute the contents of spec string @var{name} at this point.
11499 @item %x@{@var{option}@}
11500 Accumulate an option for @samp{%X}.
11502 @item %X
11503 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
11504 spec string.
11506 @item %Y
11507 Output the accumulated assembler options specified by @option{-Wa}.
11509 @item %Z
11510 Output the accumulated preprocessor options specified by @option{-Wp}.
11512 @item %a
11513 Process the @code{asm} spec.  This is used to compute the
11514 switches to be passed to the assembler.
11516 @item %A
11517 Process the @code{asm_final} spec.  This is a spec string for
11518 passing switches to an assembler post-processor, if such a program is
11519 needed.
11521 @item %l
11522 Process the @code{link} spec.  This is the spec for computing the
11523 command line passed to the linker.  Typically it makes use of the
11524 @samp{%L %G %S %D and %E} sequences.
11526 @item %D
11527 Dump out a @option{-L} option for each directory that GCC believes might
11528 contain startup files.  If the target supports multilibs then the
11529 current multilib directory is prepended to each of these paths.
11531 @item %L
11532 Process the @code{lib} spec.  This is a spec string for deciding which
11533 libraries are included on the command line to the linker.
11535 @item %G
11536 Process the @code{libgcc} spec.  This is a spec string for deciding
11537 which GCC support library is included on the command line to the linker.
11539 @item %S
11540 Process the @code{startfile} spec.  This is a spec for deciding which
11541 object files are the first ones passed to the linker.  Typically
11542 this might be a file named @file{crt0.o}.
11544 @item %E
11545 Process the @code{endfile} spec.  This is a spec string that specifies
11546 the last object files that are passed to the linker.
11548 @item %C
11549 Process the @code{cpp} spec.  This is used to construct the arguments
11550 to be passed to the C preprocessor.
11552 @item %1
11553 Process the @code{cc1} spec.  This is used to construct the options to be
11554 passed to the actual C compiler (@samp{cc1}).
11556 @item %2
11557 Process the @code{cc1plus} spec.  This is used to construct the options to be
11558 passed to the actual C++ compiler (@samp{cc1plus}).
11560 @item %*
11561 Substitute the variable part of a matched option.  See below.
11562 Note that each comma in the substituted string is replaced by
11563 a single space.
11565 @item %<@code{S}
11566 Remove all occurrences of @code{-S} from the command line.  Note---this
11567 command is position dependent.  @samp{%} commands in the spec string
11568 before this one see @code{-S}, @samp{%} commands in the spec string
11569 after this one do not.
11571 @item %:@var{function}(@var{args})
11572 Call the named function @var{function}, passing it @var{args}.
11573 @var{args} is first processed as a nested spec string, then split
11574 into an argument vector in the usual fashion.  The function returns
11575 a string which is processed as if it had appeared literally as part
11576 of the current spec.
11578 The following built-in spec functions are provided:
11580 @table @code
11581 @item @code{getenv}
11582 The @code{getenv} spec function takes two arguments: an environment
11583 variable name and a string.  If the environment variable is not
11584 defined, a fatal error is issued.  Otherwise, the return value is the
11585 value of the environment variable concatenated with the string.  For
11586 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11588 @smallexample
11589 %:getenv(TOPDIR /include)
11590 @end smallexample
11592 expands to @file{/path/to/top/include}.
11594 @item @code{if-exists}
11595 The @code{if-exists} spec function takes one argument, an absolute
11596 pathname to a file.  If the file exists, @code{if-exists} returns the
11597 pathname.  Here is a small example of its usage:
11599 @smallexample
11600 *startfile:
11601 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11602 @end smallexample
11604 @item @code{if-exists-else}
11605 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11606 spec function, except that it takes two arguments.  The first argument is
11607 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11608 returns the pathname.  If it does not exist, it returns the second argument.
11609 This way, @code{if-exists-else} can be used to select one file or another,
11610 based on the existence of the first.  Here is a small example of its usage:
11612 @smallexample
11613 *startfile:
11614 crt0%O%s %:if-exists(crti%O%s) \
11615 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11616 @end smallexample
11618 @item @code{replace-outfile}
11619 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11620 first argument in the outfiles array and replaces it with the second argument.  Here
11621 is a small example of its usage:
11623 @smallexample
11624 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11625 @end smallexample
11627 @item @code{remove-outfile}
11628 The @code{remove-outfile} spec function takes one argument.  It looks for the
11629 first argument in the outfiles array and removes it.  Here is a small example
11630 its usage:
11632 @smallexample
11633 %:remove-outfile(-lm)
11634 @end smallexample
11636 @item @code{pass-through-libs}
11637 The @code{pass-through-libs} spec function takes any number of arguments.  It
11638 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11639 assumes are the names of linker input library archive files) and returns a
11640 result containing all the found arguments each prepended by
11641 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11642 intended to be passed to the LTO linker plugin.
11644 @smallexample
11645 %:pass-through-libs(%G %L %G)
11646 @end smallexample
11648 @item @code{print-asm-header}
11649 The @code{print-asm-header} function takes no arguments and simply
11650 prints a banner like:
11652 @smallexample
11653 Assembler options
11654 =================
11656 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11657 @end smallexample
11659 It is used to separate compiler options from assembler options
11660 in the @option{--target-help} output.
11661 @end table
11663 @item %@{@code{S}@}
11664 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11665 If that switch is not specified, this substitutes nothing.  Note that
11666 the leading dash is omitted when specifying this option, and it is
11667 automatically inserted if the substitution is performed.  Thus the spec
11668 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11669 and outputs the command-line option @option{-foo}.
11671 @item %W@{@code{S}@}
11672 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11673 deleted on failure.
11675 @item %@{@code{S}*@}
11676 Substitutes all the switches specified to GCC whose names start
11677 with @code{-S}, but which also take an argument.  This is used for
11678 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11679 GCC considers @option{-o foo} as being
11680 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11681 text, including the space.  Thus two arguments are generated.
11683 @item %@{@code{S}*&@code{T}*@}
11684 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11685 (the order of @code{S} and @code{T} in the spec is not significant).
11686 There can be any number of ampersand-separated variables; for each the
11687 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11689 @item %@{@code{S}:@code{X}@}
11690 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11692 @item %@{!@code{S}:@code{X}@}
11693 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11695 @item %@{@code{S}*:@code{X}@}
11696 Substitutes @code{X} if one or more switches whose names start with
11697 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11698 once, no matter how many such switches appeared.  However, if @code{%*}
11699 appears somewhere in @code{X}, then @code{X} is substituted once
11700 for each matching switch, with the @code{%*} replaced by the part of
11701 that switch matching the @code{*}.
11703 If @code{%*} appears as the last part of a spec sequence then a space
11704 will be added after the end of the last substitution.  If there is more
11705 text in the sequence however then a space will not be generated.  This
11706 allows the @code{%*} substitution to be used as part of a larger
11707 string.  For example, a spec string like this:
11709 @smallexample
11710 %@{mcu=*:--script=%*/memory.ld@}
11711 @end smallexample
11713 when matching an option like @code{-mcu=newchip} will produce:
11715 @smallexample
11716 --script=newchip/memory.ld
11717 @end smallexample
11719 @item %@{.@code{S}:@code{X}@}
11720 Substitutes @code{X}, if processing a file with suffix @code{S}.
11722 @item %@{!.@code{S}:@code{X}@}
11723 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11725 @item %@{,@code{S}:@code{X}@}
11726 Substitutes @code{X}, if processing a file for language @code{S}.
11728 @item %@{!,@code{S}:@code{X}@}
11729 Substitutes @code{X}, if not processing a file for language @code{S}.
11731 @item %@{@code{S}|@code{P}:@code{X}@}
11732 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11733 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11734 @code{*} sequences as well, although they have a stronger binding than
11735 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11736 alternatives must be starred, and only the first matching alternative
11737 is substituted.
11739 For example, a spec string like this:
11741 @smallexample
11742 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11743 @end smallexample
11745 @noindent
11746 outputs the following command-line options from the following input
11747 command-line options:
11749 @smallexample
11750 fred.c        -foo -baz
11751 jim.d         -bar -boggle
11752 -d fred.c     -foo -baz -boggle
11753 -d jim.d      -bar -baz -boggle
11754 @end smallexample
11756 @item %@{S:X; T:Y; :D@}
11758 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11759 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11760 be as many clauses as you need.  This may be combined with @code{.},
11761 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11764 @end table
11766 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11767 construct may contain other nested @samp{%} constructs or spaces, or
11768 even newlines.  They are processed as usual, as described above.
11769 Trailing white space in @code{X} is ignored.  White space may also
11770 appear anywhere on the left side of the colon in these constructs,
11771 except between @code{.} or @code{*} and the corresponding word.
11773 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11774 handled specifically in these constructs.  If another value of
11775 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11776 @option{-W} switch is found later in the command line, the earlier
11777 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11778 just one letter, which passes all matching options.
11780 The character @samp{|} at the beginning of the predicate text is used to
11781 indicate that a command should be piped to the following command, but
11782 only if @option{-pipe} is specified.
11784 It is built into GCC which switches take arguments and which do not.
11785 (You might think it would be useful to generalize this to allow each
11786 compiler's spec to say which switches take arguments.  But this cannot
11787 be done in a consistent fashion.  GCC cannot even decide which input
11788 files have been specified without knowing which switches take arguments,
11789 and it must know which input files to compile in order to tell which
11790 compilers to run).
11792 GCC also knows implicitly that arguments starting in @option{-l} are to be
11793 treated as compiler output files, and passed to the linker in their
11794 proper position among the other output files.
11796 @c man begin OPTIONS
11798 @node Target Options
11799 @section Specifying Target Machine and Compiler Version
11800 @cindex target options
11801 @cindex cross compiling
11802 @cindex specifying machine version
11803 @cindex specifying compiler version and target machine
11804 @cindex compiler version, specifying
11805 @cindex target machine, specifying
11807 The usual way to run GCC is to run the executable called @command{gcc}, or
11808 @command{@var{machine}-gcc} when cross-compiling, or
11809 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11810 one that was installed last.
11812 @node Submodel Options
11813 @section Hardware Models and Configurations
11814 @cindex submodel options
11815 @cindex specifying hardware config
11816 @cindex hardware models and configurations, specifying
11817 @cindex machine dependent options
11819 Each target machine types can have its own
11820 special options, starting with @samp{-m}, to choose among various
11821 hardware models or configurations---for example, 68010 vs 68020,
11822 floating coprocessor or none.  A single installed version of the
11823 compiler can compile for any model or configuration, according to the
11824 options specified.
11826 Some configurations of the compiler also support additional special
11827 options, usually for compatibility with other compilers on the same
11828 platform.
11830 @c This list is ordered alphanumerically by subsection name.
11831 @c It should be the same order and spelling as these options are listed
11832 @c in Machine Dependent Options
11834 @menu
11835 * AArch64 Options::
11836 * Adapteva Epiphany Options::
11837 * ARC Options::
11838 * ARM Options::
11839 * AVR Options::
11840 * Blackfin Options::
11841 * C6X Options::
11842 * CRIS Options::
11843 * CR16 Options::
11844 * Darwin Options::
11845 * DEC Alpha Options::
11846 * FR30 Options::
11847 * FRV Options::
11848 * GNU/Linux Options::
11849 * H8/300 Options::
11850 * HPPA Options::
11851 * i386 and x86-64 Options::
11852 * i386 and x86-64 Windows Options::
11853 * IA-64 Options::
11854 * LM32 Options::
11855 * M32C Options::
11856 * M32R/D Options::
11857 * M680x0 Options::
11858 * MCore Options::
11859 * MeP Options::
11860 * MicroBlaze Options::
11861 * MIPS Options::
11862 * MMIX Options::
11863 * MN10300 Options::
11864 * Moxie Options::
11865 * MSP430 Options::
11866 * NDS32 Options::
11867 * Nios II Options::
11868 * PDP-11 Options::
11869 * picoChip Options::
11870 * PowerPC Options::
11871 * RL78 Options::
11872 * RS/6000 and PowerPC Options::
11873 * RX Options::
11874 * S/390 and zSeries Options::
11875 * Score Options::
11876 * SH Options::
11877 * Solaris 2 Options::
11878 * SPARC Options::
11879 * SPU Options::
11880 * System V Options::
11881 * TILE-Gx Options::
11882 * TILEPro Options::
11883 * V850 Options::
11884 * VAX Options::
11885 * VMS Options::
11886 * VxWorks Options::
11887 * x86-64 Options::
11888 * Xstormy16 Options::
11889 * Xtensa Options::
11890 * zSeries Options::
11891 @end menu
11893 @node AArch64 Options
11894 @subsection AArch64 Options
11895 @cindex AArch64 Options
11897 These options are defined for AArch64 implementations:
11899 @table @gcctabopt
11901 @item -mabi=@var{name}
11902 @opindex mabi
11903 Generate code for the specified data model.  Permissible values
11904 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11905 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11906 but long int and pointer are 64-bit.
11908 The default depends on the specific target configuration.  Note that
11909 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11910 entire program with the same ABI, and link with a compatible set of libraries.
11912 @item -mbig-endian
11913 @opindex mbig-endian
11914 Generate big-endian code.  This is the default when GCC is configured for an
11915 @samp{aarch64_be-*-*} target.
11917 @item -mgeneral-regs-only
11918 @opindex mgeneral-regs-only
11919 Generate code which uses only the general registers.
11921 @item -mlittle-endian
11922 @opindex mlittle-endian
11923 Generate little-endian code.  This is the default when GCC is configured for an
11924 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11926 @item -mcmodel=tiny
11927 @opindex mcmodel=tiny
11928 Generate code for the tiny code model.  The program and its statically defined
11929 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11930 be statically or dynamically linked.  This model is not fully implemented and
11931 mostly treated as @samp{small}.
11933 @item -mcmodel=small
11934 @opindex mcmodel=small
11935 Generate code for the small code model.  The program and its statically defined
11936 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11937 be statically or dynamically linked.  This is the default code model.
11939 @item -mcmodel=large
11940 @opindex mcmodel=large
11941 Generate code for the large code model.  This makes no assumptions about
11942 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11943 statically linked only.
11945 @item -mstrict-align
11946 @opindex mstrict-align
11947 Do not assume that unaligned memory references will be handled by the system.
11949 @item -momit-leaf-frame-pointer
11950 @itemx -mno-omit-leaf-frame-pointer
11951 @opindex momit-leaf-frame-pointer
11952 @opindex mno-omit-leaf-frame-pointer
11953 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11954 default.
11956 @item -mtls-dialect=desc
11957 @opindex mtls-dialect=desc
11958 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11959 of TLS variables.  This is the default.
11961 @item -mtls-dialect=traditional
11962 @opindex mtls-dialect=traditional
11963 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11964 of TLS variables.
11966 @item -mfix-cortex-a53-835769
11967 @itemx -mno-fix-cortex-a53-835769
11968 @opindex -mfix-cortex-a53-835769
11969 @opindex -mno-fix-cortex-a53-835769
11970 Enable or disable the workaround for the ARM Cortex-A53 erratum number 835769.
11971 This will involve inserting a NOP instruction between memory instructions and
11972 64-bit integer multiply-accumulate instructions.
11974 @item -march=@var{name}
11975 @opindex march
11976 Specify the name of the target architecture, optionally suffixed by one or
11977 more feature modifiers.  This option has the form
11978 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11979 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11980 values for @var{feature} are documented in the sub-section below.
11982 Where conflicting feature modifiers are specified, the right-most feature is
11983 used.
11985 GCC uses this name to determine what kind of instructions it can emit when
11986 generating assembly code.
11988 Where @option{-march} is specified without either of @option{-mtune}
11989 or @option{-mcpu} also being specified, the code will be tuned to perform
11990 well across a range of target processors implementing the target
11991 architecture.
11993 @item -mtune=@var{name}
11994 @opindex mtune
11995 Specify the name of the target processor for which GCC should tune the
11996 performance of the code.  Permissible values for this option are:
11997 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}, @samp{thunderx}.
11999 Additionally, this option can specify that GCC should tune the performance
12000 of the code for a big.LITTLE system.  The only permissible value is
12001 @samp{cortex-a57.cortex-a53}.
12003 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
12004 are specified, the code will be tuned to perform well across a range
12005 of target processors.
12007 This option cannot be suffixed by feature modifiers.
12009 @item -mcpu=@var{name}
12010 @opindex mcpu
12011 Specify the name of the target processor, optionally suffixed by one or more
12012 feature modifiers.  This option has the form
12013 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
12014 permissible values for @var{cpu} are the same as those available for
12015 @option{-mtune}.
12017 The permissible values for @var{feature} are documented in the sub-section
12018 below.
12020 Where conflicting feature modifiers are specified, the right-most feature is
12021 used.
12023 GCC uses this name to determine what kind of instructions it can emit when
12024 generating assembly code (as if by @option{-march}) and to determine
12025 the target processor for which to tune for performance (as if
12026 by @option{-mtune}).  Where this option is used in conjunction
12027 with @option{-march} or @option{-mtune}, those options take precedence
12028 over the appropriate part of this option.
12029 @end table
12031 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
12032 @cindex @option{-march} feature modifiers
12033 @cindex @option{-mcpu} feature modifiers
12034 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
12035 the following:
12037 @table @samp
12038 @item crc
12039 Enable CRC extension.
12040 @item crypto
12041 Enable Crypto extension.  This implies Advanced SIMD is enabled.
12042 @item fp
12043 Enable floating-point instructions.
12044 @item simd
12045 Enable Advanced SIMD instructions.  This implies floating-point instructions
12046 are enabled.  This is the default for all current possible values for options
12047 @option{-march} and @option{-mcpu=}.
12048 @end table
12050 @node Adapteva Epiphany Options
12051 @subsection Adapteva Epiphany Options
12053 These @samp{-m} options are defined for Adapteva Epiphany:
12055 @table @gcctabopt
12056 @item -mhalf-reg-file
12057 @opindex mhalf-reg-file
12058 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
12059 That allows code to run on hardware variants that lack these registers.
12061 @item -mprefer-short-insn-regs
12062 @opindex mprefer-short-insn-regs
12063 Preferrentially allocate registers that allow short instruction generation.
12064 This can result in increased instruction count, so this may either reduce or
12065 increase overall code size.
12067 @item -mbranch-cost=@var{num}
12068 @opindex mbranch-cost
12069 Set the cost of branches to roughly @var{num} ``simple'' instructions.
12070 This cost is only a heuristic and is not guaranteed to produce
12071 consistent results across releases.
12073 @item -mcmove
12074 @opindex mcmove
12075 Enable the generation of conditional moves.
12077 @item -mnops=@var{num}
12078 @opindex mnops
12079 Emit @var{num} NOPs before every other generated instruction.
12081 @item -mno-soft-cmpsf
12082 @opindex mno-soft-cmpsf
12083 For single-precision floating-point comparisons, emit an @code{fsub} instruction
12084 and test the flags.  This is faster than a software comparison, but can
12085 get incorrect results in the presence of NaNs, or when two different small
12086 numbers are compared such that their difference is calculated as zero.
12087 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
12088 software comparisons.
12090 @item -mstack-offset=@var{num}
12091 @opindex mstack-offset
12092 Set the offset between the top of the stack and the stack pointer.
12093 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
12094 can be used by leaf functions without stack allocation.
12095 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
12096 Note also that this option changes the ABI; compiling a program with a
12097 different stack offset than the libraries have been compiled with
12098 generally does not work.
12099 This option can be useful if you want to evaluate if a different stack
12100 offset would give you better code, but to actually use a different stack
12101 offset to build working programs, it is recommended to configure the
12102 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
12104 @item -mno-round-nearest
12105 @opindex mno-round-nearest
12106 Make the scheduler assume that the rounding mode has been set to
12107 truncating.  The default is @option{-mround-nearest}.
12109 @item -mlong-calls
12110 @opindex mlong-calls
12111 If not otherwise specified by an attribute, assume all calls might be beyond
12112 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
12113 function address into a register before performing a (otherwise direct) call.
12114 This is the default.
12116 @item -mshort-calls
12117 @opindex short-calls
12118 If not otherwise specified by an attribute, assume all direct calls are
12119 in the range of the @code{b} / @code{bl} instructions, so use these instructions
12120 for direct calls.  The default is @option{-mlong-calls}.
12122 @item -msmall16
12123 @opindex msmall16
12124 Assume addresses can be loaded as 16-bit unsigned values.  This does not
12125 apply to function addresses for which @option{-mlong-calls} semantics
12126 are in effect.
12128 @item -mfp-mode=@var{mode}
12129 @opindex mfp-mode
12130 Set the prevailing mode of the floating-point unit.
12131 This determines the floating-point mode that is provided and expected
12132 at function call and return time.  Making this mode match the mode you
12133 predominantly need at function start can make your programs smaller and
12134 faster by avoiding unnecessary mode switches.
12136 @var{mode} can be set to one the following values:
12138 @table @samp
12139 @item caller
12140 Any mode at function entry is valid, and retained or restored when
12141 the function returns, and when it calls other functions.
12142 This mode is useful for compiling libraries or other compilation units
12143 you might want to incorporate into different programs with different
12144 prevailing FPU modes, and the convenience of being able to use a single
12145 object file outweighs the size and speed overhead for any extra
12146 mode switching that might be needed, compared with what would be needed
12147 with a more specific choice of prevailing FPU mode.
12149 @item truncate
12150 This is the mode used for floating-point calculations with
12151 truncating (i.e.@: round towards zero) rounding mode.  That includes
12152 conversion from floating point to integer.
12154 @item round-nearest
12155 This is the mode used for floating-point calculations with
12156 round-to-nearest-or-even rounding mode.
12158 @item int
12159 This is the mode used to perform integer calculations in the FPU, e.g.@:
12160 integer multiply, or integer multiply-and-accumulate.
12161 @end table
12163 The default is @option{-mfp-mode=caller}
12165 @item -mnosplit-lohi
12166 @itemx -mno-postinc
12167 @itemx -mno-postmodify
12168 @opindex mnosplit-lohi
12169 @opindex mno-postinc
12170 @opindex mno-postmodify
12171 Code generation tweaks that disable, respectively, splitting of 32-bit
12172 loads, generation of post-increment addresses, and generation of
12173 post-modify addresses.  The defaults are @option{msplit-lohi},
12174 @option{-mpost-inc}, and @option{-mpost-modify}.
12176 @item -mnovect-double
12177 @opindex mno-vect-double
12178 Change the preferred SIMD mode to SImode.  The default is
12179 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
12181 @item -max-vect-align=@var{num}
12182 @opindex max-vect-align
12183 The maximum alignment for SIMD vector mode types.
12184 @var{num} may be 4 or 8.  The default is 8.
12185 Note that this is an ABI change, even though many library function
12186 interfaces are unaffected if they don't use SIMD vector modes
12187 in places that affect size and/or alignment of relevant types.
12189 @item -msplit-vecmove-early
12190 @opindex msplit-vecmove-early
12191 Split vector moves into single word moves before reload.  In theory this
12192 can give better register allocation, but so far the reverse seems to be
12193 generally the case.
12195 @item -m1reg-@var{reg}
12196 @opindex m1reg-
12197 Specify a register to hold the constant @minus{}1, which makes loading small negative
12198 constants and certain bitmasks faster.
12199 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
12200 which specify use of that register as a fixed register,
12201 and @samp{none}, which means that no register is used for this
12202 purpose.  The default is @option{-m1reg-none}.
12204 @end table
12206 @node ARC Options
12207 @subsection ARC Options
12208 @cindex ARC options
12210 The following options control the architecture variant for which code
12211 is being compiled:
12213 @c architecture variants
12214 @table @gcctabopt
12216 @item -mbarrel-shifter
12217 @opindex mbarrel-shifter
12218 Generate instructions supported by barrel shifter.  This is the default
12219 unless @samp{-mcpu=ARC601} is in effect.
12221 @item -mcpu=@var{cpu}
12222 @opindex mcpu
12223 Set architecture type, register usage, and instruction scheduling
12224 parameters for @var{cpu}.  There are also shortcut alias options
12225 available for backward compatibility and convenience.  Supported
12226 values for @var{cpu} are
12228 @table @samp
12229 @opindex mA6
12230 @opindex mARC600
12231 @item ARC600
12232 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
12234 @item ARC601
12235 @opindex mARC601
12236 Compile for ARC601.  Alias: @option{-mARC601}.
12238 @item ARC700
12239 @opindex mA7
12240 @opindex mARC700
12241 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
12242 This is the default when configured with @samp{--with-cpu=arc700}@.
12243 @end table
12245 @item -mdpfp
12246 @opindex mdpfp
12247 @itemx -mdpfp-compact
12248 @opindex mdpfp-compact
12249 FPX: Generate Double Precision FPX instructions, tuned for the compact
12250 implementation.
12252 @item -mdpfp-fast
12253 @opindex mdpfp-fast
12254 FPX: Generate Double Precision FPX instructions, tuned for the fast
12255 implementation.
12257 @item -mno-dpfp-lrsr
12258 @opindex mno-dpfp-lrsr
12259 Disable LR and SR instructions from using FPX extension aux registers.
12261 @item -mea
12262 @opindex mea
12263 Generate Extended arithmetic instructions.  Currently only
12264 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
12265 supported.  This is always enabled for @samp{-mcpu=ARC700}.
12267 @item -mno-mpy
12268 @opindex mno-mpy
12269 Do not generate mpy instructions for ARC700.
12271 @item -mmul32x16
12272 @opindex mmul32x16
12273 Generate 32x16 bit multiply and mac instructions.
12275 @item -mmul64
12276 @opindex mmul64
12277 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
12279 @item -mnorm
12280 @opindex mnorm
12281 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
12282 is in effect.
12284 @item -mspfp
12285 @opindex mspfp
12286 @itemx -mspfp-compact
12287 @opindex mspfp-compact
12288 FPX: Generate Single Precision FPX instructions, tuned for the compact
12289 implementation.
12291 @item -mspfp-fast
12292 @opindex mspfp-fast
12293 FPX: Generate Single Precision FPX instructions, tuned for the fast
12294 implementation.
12296 @item -msimd
12297 @opindex msimd
12298 Enable generation of ARC SIMD instructions via target-specific
12299 builtins.  Only valid for @samp{-mcpu=ARC700}.
12301 @item -msoft-float
12302 @opindex msoft-float
12303 This option ignored; it is provided for compatibility purposes only.
12304 Software floating point code is emitted by default, and this default
12305 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
12306 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
12307 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
12309 @item -mswap
12310 @opindex mswap
12311 Generate swap instructions.
12313 @end table
12315 The following options are passed through to the assembler, and also
12316 define preprocessor macro symbols.
12318 @c Flags used by the assembler, but for which we define preprocessor
12319 @c macro symbols as well.
12320 @table @gcctabopt
12321 @item -mdsp-packa
12322 @opindex mdsp-packa
12323 Passed down to the assembler to enable the DSP Pack A extensions.
12324 Also sets the preprocessor symbol @code{__Xdsp_packa}.
12326 @item -mdvbf
12327 @opindex mdvbf
12328 Passed down to the assembler to enable the dual viterbi butterfly
12329 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
12331 @c ARC700 4.10 extension instruction
12332 @item -mlock
12333 @opindex mlock
12334 Passed down to the assembler to enable the Locked Load/Store
12335 Conditional extension.  Also sets the preprocessor symbol
12336 @code{__Xlock}.
12338 @item -mmac-d16
12339 @opindex mmac-d16
12340 Passed down to the assembler.  Also sets the preprocessor symbol
12341 @code{__Xxmac_d16}.
12343 @item -mmac-24
12344 @opindex mmac-24
12345 Passed down to the assembler.  Also sets the preprocessor symbol
12346 @code{__Xxmac_24}.
12348 @c ARC700 4.10 extension instruction
12349 @item -mrtsc
12350 @opindex mrtsc
12351 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
12352 extension instruction.  Also sets the preprocessor symbol
12353 @code{__Xrtsc}.
12355 @c ARC700 4.10 extension instruction
12356 @item -mswape
12357 @opindex mswape
12358 Passed down to the assembler to enable the swap byte ordering
12359 extension instruction.  Also sets the preprocessor symbol
12360 @code{__Xswape}.
12362 @item -mtelephony
12363 @opindex mtelephony
12364 Passed down to the assembler to enable dual and single operand
12365 instructions for telephony.  Also sets the preprocessor symbol
12366 @code{__Xtelephony}.
12368 @item -mxy
12369 @opindex mxy
12370 Passed down to the assembler to enable the XY Memory extension.  Also
12371 sets the preprocessor symbol @code{__Xxy}.
12373 @end table
12375 The following options control how the assembly code is annotated:
12377 @c Assembly annotation options
12378 @table @gcctabopt
12379 @item -misize
12380 @opindex misize
12381 Annotate assembler instructions with estimated addresses.
12383 @item -mannotate-align
12384 @opindex mannotate-align
12385 Explain what alignment considerations lead to the decision to make an
12386 instruction short or long.
12388 @end table
12390 The following options are passed through to the linker:
12392 @c options passed through to the linker
12393 @table @gcctabopt
12394 @item -marclinux
12395 @opindex marclinux
12396 Passed through to the linker, to specify use of the @code{arclinux} emulation.
12397 This option is enabled by default in tool chains built for
12398 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
12399 when profiling is not requested.
12401 @item -marclinux_prof
12402 @opindex marclinux_prof
12403 Passed through to the linker, to specify use of the
12404 @code{arclinux_prof} emulation.  This option is enabled by default in
12405 tool chains built for @w{@code{arc-linux-uclibc}} and
12406 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
12408 @end table
12410 The following options control the semantics of generated code:
12412 @c semantically relevant code generation options
12413 @table @gcctabopt
12414 @item -mepilogue-cfi
12415 @opindex mepilogue-cfi
12416 Enable generation of call frame information for epilogues.
12418 @item -mno-epilogue-cfi
12419 @opindex mno-epilogue-cfi
12420 Disable generation of call frame information for epilogues.
12422 @item -mlong-calls
12423 @opindex mlong-calls
12424 Generate call insns as register indirect calls, thus providing access
12425 to the full 32-bit address range.
12427 @item -mmedium-calls
12428 @opindex mmedium-calls
12429 Don't use less than 25 bit addressing range for calls, which is the
12430 offset available for an unconditional branch-and-link
12431 instruction.  Conditional execution of function calls is suppressed, to
12432 allow use of the 25-bit range, rather than the 21-bit range with
12433 conditional branch-and-link.  This is the default for tool chains built
12434 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
12436 @item -mno-sdata
12437 @opindex mno-sdata
12438 Do not generate sdata references.  This is the default for tool chains
12439 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
12440 targets.
12442 @item -mucb-mcount
12443 @opindex mucb-mcount
12444 Instrument with mcount calls as used in UCB code.  I.e. do the
12445 counting in the callee, not the caller.  By default ARC instrumentation
12446 counts in the caller.
12448 @item -mvolatile-cache
12449 @opindex mvolatile-cache
12450 Use ordinarily cached memory accesses for volatile references.  This is the
12451 default.
12453 @item -mno-volatile-cache
12454 @opindex mno-volatile-cache
12455 Enable cache bypass for volatile references.
12457 @end table
12459 The following options fine tune code generation:
12460 @c code generation tuning options
12461 @table @gcctabopt
12462 @item -malign-call
12463 @opindex malign-call
12464 Do alignment optimizations for call instructions.
12466 @item -mauto-modify-reg
12467 @opindex mauto-modify-reg
12468 Enable the use of pre/post modify with register displacement.
12470 @item -mbbit-peephole
12471 @opindex mbbit-peephole
12472 Enable bbit peephole2.
12474 @item -mno-brcc
12475 @opindex mno-brcc
12476 This option disables a target-specific pass in @file{arc_reorg} to
12477 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
12478 generation driven by the combiner pass.
12480 @item -mcase-vector-pcrel
12481 @opindex mcase-vector-pcrel
12482 Use pc-relative switch case tables - this enables case table shortening.
12483 This is the default for @option{-Os}.
12485 @item -mcompact-casesi
12486 @opindex mcompact-casesi
12487 Enable compact casesi pattern.
12488 This is the default for @option{-Os}.
12490 @item -mno-cond-exec
12491 @opindex mno-cond-exec
12492 Disable ARCompact specific pass to generate conditional execution instructions.
12493 Due to delay slot scheduling and interactions between operand numbers,
12494 literal sizes, instruction lengths, and the support for conditional execution,
12495 the target-independent pass to generate conditional execution is often lacking,
12496 so the ARC port has kept a special pass around that tries to find more
12497 conditional execution generating opportunities after register allocation,
12498 branch shortening, and delay slot scheduling have been done.  This pass
12499 generally, but not always, improves performance and code size, at the cost of
12500 extra compilation time, which is why there is an option to switch it off.
12501 If you have a problem with call instructions exceeding their allowable
12502 offset range because they are conditionalized, you should consider using
12503 @option{-mmedium-calls} instead.
12505 @item -mearly-cbranchsi
12506 @opindex mearly-cbranchsi
12507 Enable pre-reload use of the cbranchsi pattern.
12509 @item -mexpand-adddi
12510 @opindex mexpand-adddi
12511 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
12512 @code{add.f}, @code{adc} etc.
12514 @item -mindexed-loads
12515 @opindex mindexed-loads
12516 Enable the use of indexed loads.  This can be problematic because some
12517 optimizers will then assume the that indexed stores exist, which is not
12518 the case.
12520 @item -mlra
12521 @opindex mlra
12522 Enable Local Register Allocation.  This is still experimental for ARC,
12523 so by default the compiler uses standard reload
12524 (i.e. @samp{-mno-lra}).
12526 @item -mlra-priority-none
12527 @opindex mlra-priority-none
12528 Don't indicate any priority for target registers.
12530 @item -mlra-priority-compact
12531 @opindex mlra-priority-compact
12532 Indicate target register priority for r0..r3 / r12..r15.
12534 @item -mlra-priority-noncompact
12535 @opindex mlra-priority-noncompact
12536 Reduce target regsiter priority for r0..r3 / r12..r15.
12538 @item -mno-millicode
12539 @opindex mno-millicode
12540 When optimizing for size (using @option{-Os}), prologues and epilogues
12541 that have to save or restore a large number of registers are often
12542 shortened by using call to a special function in libgcc; this is
12543 referred to as a @emph{millicode} call.  As these calls can pose
12544 performance issues, and/or cause linking issues when linking in a
12545 nonstandard way, this option is provided to turn off millicode call
12546 generation.
12548 @item -mmixed-code
12549 @opindex mmixed-code
12550 Tweak register allocation to help 16-bit instruction generation.
12551 This generally has the effect of decreasing the average instruction size
12552 while increasing the instruction count.
12554 @item -mq-class
12555 @opindex mq-class
12556 Enable 'q' instruction alternatives.
12557 This is the default for @option{-Os}.
12559 @item -mRcq
12560 @opindex mRcq
12561 Enable Rcq constraint handling - most short code generation depends on this.
12562 This is the default.
12564 @item -mRcw
12565 @opindex mRcw
12566 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12567 This is the default.
12569 @item -msize-level=@var{level}
12570 @opindex msize-level
12571 Fine-tune size optimization with regards to instruction lengths and alignment.
12572 The recognized values for @var{level} are:
12573 @table @samp
12574 @item 0
12575 No size optimization.  This level is deprecated and treated like @samp{1}.
12577 @item 1
12578 Short instructions are used opportunistically.
12580 @item 2
12581 In addition, alignment of loops and of code after barriers are dropped.
12583 @item 3
12584 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12586 @end table
12588 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12589 the behavior when this is not set is equivalent to level @samp{1}.
12591 @item -mtune=@var{cpu}
12592 @opindex mtune
12593 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12594 by @option{-mcpu=}.
12596 Supported values for @var{cpu} are
12598 @table @samp
12599 @item ARC600
12600 Tune for ARC600 cpu.
12602 @item ARC601
12603 Tune for ARC601 cpu.
12605 @item ARC700
12606 Tune for ARC700 cpu with standard multiplier block.
12608 @item ARC700-xmac
12609 Tune for ARC700 cpu with XMAC block.
12611 @item ARC725D
12612 Tune for ARC725D cpu.
12614 @item ARC750D
12615 Tune for ARC750D cpu.
12617 @end table
12619 @item -mmultcost=@var{num}
12620 @opindex mmultcost
12621 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12622 normal instruction.
12624 @item -munalign-prob-threshold=@var{probability}
12625 @opindex munalign-prob-threshold
12626 Set probability threshold for unaligning branches.
12627 When tuning for @samp{ARC700} and optimizing for speed, branches without
12628 filled delay slot are preferably emitted unaligned and long, unless
12629 profiling indicates that the probability for the branch to be taken
12630 is below @var{probability}.  @xref{Cross-profiling}.
12631 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12633 @end table
12635 The following options are maintained for backward compatibility, but
12636 are now deprecated and will be removed in a future release:
12638 @c Deprecated options
12639 @table @gcctabopt
12641 @item -margonaut
12642 @opindex margonaut
12643 Obsolete FPX.
12645 @item -mbig-endian
12646 @opindex mbig-endian
12647 @itemx -EB
12648 @opindex EB
12649 Compile code for big endian targets.  Use of these options is now
12650 deprecated.  Users wanting big-endian code, should use the
12651 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12652 building the tool chain, for which big-endian is the default.
12654 @item -mlittle-endian
12655 @opindex mlittle-endian
12656 @itemx -EL
12657 @opindex EL
12658 Compile code for little endian targets.  Use of these options is now
12659 deprecated.  Users wanting little-endian code should use the
12660 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12661 building the tool chain, for which little-endian is the default.
12663 @item -mbarrel_shifter
12664 @opindex mbarrel_shifter
12665 Replaced by @samp{-mbarrel-shifter}
12667 @item -mdpfp_compact
12668 @opindex mdpfp_compact
12669 Replaced by @samp{-mdpfp-compact}
12671 @item -mdpfp_fast
12672 @opindex mdpfp_fast
12673 Replaced by @samp{-mdpfp-fast}
12675 @item -mdsp_packa
12676 @opindex mdsp_packa
12677 Replaced by @samp{-mdsp-packa}
12679 @item -mEA
12680 @opindex mEA
12681 Replaced by @samp{-mea}
12683 @item -mmac_24
12684 @opindex mmac_24
12685 Replaced by @samp{-mmac-24}
12687 @item -mmac_d16
12688 @opindex mmac_d16
12689 Replaced by @samp{-mmac-d16}
12691 @item -mspfp_compact
12692 @opindex mspfp_compact
12693 Replaced by @samp{-mspfp-compact}
12695 @item -mspfp_fast
12696 @opindex mspfp_fast
12697 Replaced by @samp{-mspfp-fast}
12699 @item -mtune=@var{cpu}
12700 @opindex mtune
12701 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12702 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12703 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12705 @item -multcost=@var{num}
12706 @opindex multcost
12707 Replaced by @samp{-mmultcost}.
12709 @end table
12711 @node ARM Options
12712 @subsection ARM Options
12713 @cindex ARM options
12715 These @samp{-m} options are defined for the ARM port:
12717 @table @gcctabopt
12718 @item -mabi=@var{name}
12719 @opindex mabi
12720 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12721 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12723 @item -mapcs-frame
12724 @opindex mapcs-frame
12725 Generate a stack frame that is compliant with the ARM Procedure Call
12726 Standard for all functions, even if this is not strictly necessary for
12727 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12728 with this option causes the stack frames not to be generated for
12729 leaf functions.  The default is @option{-mno-apcs-frame}.
12731 @item -mapcs
12732 @opindex mapcs
12733 This is a synonym for @option{-mapcs-frame}.
12735 @ignore
12736 @c not currently implemented
12737 @item -mapcs-stack-check
12738 @opindex mapcs-stack-check
12739 Generate code to check the amount of stack space available upon entry to
12740 every function (that actually uses some stack space).  If there is
12741 insufficient space available then either the function
12742 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12743 called, depending upon the amount of stack space required.  The runtime
12744 system is required to provide these functions.  The default is
12745 @option{-mno-apcs-stack-check}, since this produces smaller code.
12747 @c not currently implemented
12748 @item -mapcs-float
12749 @opindex mapcs-float
12750 Pass floating-point arguments using the floating-point registers.  This is
12751 one of the variants of the APCS@.  This option is recommended if the
12752 target hardware has a floating-point unit or if a lot of floating-point
12753 arithmetic is going to be performed by the code.  The default is
12754 @option{-mno-apcs-float}, since the size of integer-only code is 
12755 slightly increased if @option{-mapcs-float} is used.
12757 @c not currently implemented
12758 @item -mapcs-reentrant
12759 @opindex mapcs-reentrant
12760 Generate reentrant, position-independent code.  The default is
12761 @option{-mno-apcs-reentrant}.
12762 @end ignore
12764 @item -mthumb-interwork
12765 @opindex mthumb-interwork
12766 Generate code that supports calling between the ARM and Thumb
12767 instruction sets.  Without this option, on pre-v5 architectures, the
12768 two instruction sets cannot be reliably used inside one program.  The
12769 default is @option{-mno-thumb-interwork}, since slightly larger code
12770 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12771 configurations this option is meaningless.
12773 @item -mno-sched-prolog
12774 @opindex mno-sched-prolog
12775 Prevent the reordering of instructions in the function prologue, or the
12776 merging of those instruction with the instructions in the function's
12777 body.  This means that all functions start with a recognizable set
12778 of instructions (or in fact one of a choice from a small set of
12779 different function prologues), and this information can be used to
12780 locate the start of functions inside an executable piece of code.  The
12781 default is @option{-msched-prolog}.
12783 @item -mfloat-abi=@var{name}
12784 @opindex mfloat-abi
12785 Specifies which floating-point ABI to use.  Permissible values
12786 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12788 Specifying @samp{soft} causes GCC to generate output containing
12789 library calls for floating-point operations.
12790 @samp{softfp} allows the generation of code using hardware floating-point
12791 instructions, but still uses the soft-float calling conventions.
12792 @samp{hard} allows generation of floating-point instructions
12793 and uses FPU-specific calling conventions.
12795 The default depends on the specific target configuration.  Note that
12796 the hard-float and soft-float ABIs are not link-compatible; you must
12797 compile your entire program with the same ABI, and link with a
12798 compatible set of libraries.
12800 @item -mlittle-endian
12801 @opindex mlittle-endian
12802 Generate code for a processor running in little-endian mode.  This is
12803 the default for all standard configurations.
12805 @item -mbig-endian
12806 @opindex mbig-endian
12807 Generate code for a processor running in big-endian mode; the default is
12808 to compile code for a little-endian processor.
12810 @item -march=@var{name}
12811 @opindex march
12812 This specifies the name of the target ARM architecture.  GCC uses this
12813 name to determine what kind of instructions it can emit when generating
12814 assembly code.  This option can be used in conjunction with or instead
12815 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12816 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12817 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12818 @samp{armv6}, @samp{armv6j},
12819 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12820 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12821 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12822 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12824 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12825 extensions.
12827 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12828 architecture together with the optional CRC32 extensions.
12830 @option{-march=native} causes the compiler to auto-detect the architecture
12831 of the build computer.  At present, this feature is only supported on
12832 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12833 is unsuccessful the option has no effect.
12835 @item -mtune=@var{name}
12836 @opindex mtune
12837 This option specifies the name of the target ARM processor for
12838 which GCC should tune the performance of the code.
12839 For some ARM implementations better performance can be obtained by using
12840 this option.
12841 Permissible names are: @samp{arm2}, @samp{arm250},
12842 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12843 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12844 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12845 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12846 @samp{arm720},
12847 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12848 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12849 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12850 @samp{strongarm1110},
12851 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12852 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12853 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12854 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12855 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12856 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12857 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12858 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12859 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12860 @samp{cortex-r4},
12861 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m7},
12862 @samp{cortex-m4},
12863 @samp{cortex-m3},
12864 @samp{cortex-m1},
12865 @samp{cortex-m0},
12866 @samp{cortex-m0plus},
12867 @samp{cortex-m1.small-multiply},
12868 @samp{cortex-m0.small-multiply},
12869 @samp{cortex-m0plus.small-multiply},
12870 @samp{marvell-pj4},
12871 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12872 @samp{fa526}, @samp{fa626},
12873 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12875 Additionally, this option can specify that GCC should tune the performance
12876 of the code for a big.LITTLE system.  Permissible names are:
12877 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12879 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12880 performance for a blend of processors within architecture @var{arch}.
12881 The aim is to generate code that run well on the current most popular
12882 processors, balancing between optimizations that benefit some CPUs in the
12883 range, and avoiding performance pitfalls of other CPUs.  The effects of
12884 this option may change in future GCC versions as CPU models come and go.
12886 @option{-mtune=native} causes the compiler to auto-detect the CPU
12887 of the build computer.  At present, this feature is only supported on
12888 GNU/Linux, and not all architectures are recognized.  If the auto-detect is
12889 unsuccessful the option has no effect.
12891 @item -mcpu=@var{name}
12892 @opindex mcpu
12893 This specifies the name of the target ARM processor.  GCC uses this name
12894 to derive the name of the target ARM architecture (as if specified
12895 by @option{-march}) and the ARM processor type for which to tune for
12896 performance (as if specified by @option{-mtune}).  Where this option
12897 is used in conjunction with @option{-march} or @option{-mtune},
12898 those options take precedence over the appropriate part of this option.
12900 Permissible names for this option are the same as those for
12901 @option{-mtune}.
12903 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12904 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12905 See @option{-mtune} for more information.
12907 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12908 of the build computer.  At present, this feature is only supported on
12909 GNU/Linux, and not all architectures are recognized.  If the auto-detect
12910 is unsuccessful the option has no effect.
12912 @item -mfpu=@var{name}
12913 @opindex mfpu
12914 This specifies what floating-point hardware (or hardware emulation) is
12915 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12916 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12917 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12918 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12919 @samp{fpv5-d16}, @samp{fpv5-sp-d16},
12920 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12922 If @option{-msoft-float} is specified this specifies the format of
12923 floating-point values.
12925 If the selected floating-point hardware includes the NEON extension
12926 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12927 operations are not generated by GCC's auto-vectorization pass unless
12928 @option{-funsafe-math-optimizations} is also specified.  This is
12929 because NEON hardware does not fully implement the IEEE 754 standard for
12930 floating-point arithmetic (in particular denormal values are treated as
12931 zero), so the use of NEON instructions may lead to a loss of precision.
12933 @item -mfp16-format=@var{name}
12934 @opindex mfp16-format
12935 Specify the format of the @code{__fp16} half-precision floating-point type.
12936 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12937 the default is @samp{none}, in which case the @code{__fp16} type is not
12938 defined.  @xref{Half-Precision}, for more information.
12940 @item -mstructure-size-boundary=@var{n}
12941 @opindex mstructure-size-boundary
12942 The sizes of all structures and unions are rounded up to a multiple
12943 of the number of bits set by this option.  Permissible values are 8, 32
12944 and 64.  The default value varies for different toolchains.  For the COFF
12945 targeted toolchain the default value is 8.  A value of 64 is only allowed
12946 if the underlying ABI supports it.
12948 Specifying a larger number can produce faster, more efficient code, but
12949 can also increase the size of the program.  Different values are potentially
12950 incompatible.  Code compiled with one value cannot necessarily expect to
12951 work with code or libraries compiled with another value, if they exchange
12952 information using structures or unions.
12954 @item -mabort-on-noreturn
12955 @opindex mabort-on-noreturn
12956 Generate a call to the function @code{abort} at the end of a
12957 @code{noreturn} function.  It is executed if the function tries to
12958 return.
12960 @item -mlong-calls
12961 @itemx -mno-long-calls
12962 @opindex mlong-calls
12963 @opindex mno-long-calls
12964 Tells the compiler to perform function calls by first loading the
12965 address of the function into a register and then performing a subroutine
12966 call on this register.  This switch is needed if the target function
12967 lies outside of the 64-megabyte addressing range of the offset-based
12968 version of subroutine call instruction.
12970 Even if this switch is enabled, not all function calls are turned
12971 into long calls.  The heuristic is that static functions, functions
12972 that have the @samp{short-call} attribute, functions that are inside
12973 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12974 definitions have already been compiled within the current compilation
12975 unit are not turned into long calls.  The exceptions to this rule are
12976 that weak function definitions, functions with the @samp{long-call}
12977 attribute or the @samp{section} attribute, and functions that are within
12978 the scope of a @samp{#pragma long_calls} directive are always
12979 turned into long calls.
12981 This feature is not enabled by default.  Specifying
12982 @option{-mno-long-calls} restores the default behavior, as does
12983 placing the function calls within the scope of a @samp{#pragma
12984 long_calls_off} directive.  Note these switches have no effect on how
12985 the compiler generates code to handle function calls via function
12986 pointers.
12988 @item -msingle-pic-base
12989 @opindex msingle-pic-base
12990 Treat the register used for PIC addressing as read-only, rather than
12991 loading it in the prologue for each function.  The runtime system is
12992 responsible for initializing this register with an appropriate value
12993 before execution begins.
12995 @item -mpic-register=@var{reg}
12996 @opindex mpic-register
12997 Specify the register to be used for PIC addressing.
12998 For standard PIC base case, the default will be any suitable register
12999 determined by compiler.  For single PIC base case, the default is
13000 @samp{R9} if target is EABI based or stack-checking is enabled,
13001 otherwise the default is @samp{R10}.
13003 @item -mpic-data-is-text-relative
13004 @opindex mpic-data-is-text-relative
13005 Assume that each data segments are relative to text segment at load time.
13006 Therefore, it permits addressing data using PC-relative operations.
13007 This option is on by default for targets other than VxWorks RTP.
13009 @item -mpoke-function-name
13010 @opindex mpoke-function-name
13011 Write the name of each function into the text section, directly
13012 preceding the function prologue.  The generated code is similar to this:
13014 @smallexample
13015      t0
13016          .ascii "arm_poke_function_name", 0
13017          .align
13018      t1
13019          .word 0xff000000 + (t1 - t0)
13020      arm_poke_function_name
13021          mov     ip, sp
13022          stmfd   sp!, @{fp, ip, lr, pc@}
13023          sub     fp, ip, #4
13024 @end smallexample
13026 When performing a stack backtrace, code can inspect the value of
13027 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
13028 location @code{pc - 12} and the top 8 bits are set, then we know that
13029 there is a function name embedded immediately preceding this location
13030 and has length @code{((pc[-3]) & 0xff000000)}.
13032 @item -mthumb
13033 @itemx -marm
13034 @opindex marm
13035 @opindex mthumb
13037 Select between generating code that executes in ARM and Thumb
13038 states.  The default for most configurations is to generate code
13039 that executes in ARM state, but the default can be changed by
13040 configuring GCC with the @option{--with-mode=}@var{state}
13041 configure option.
13043 @item -mtpcs-frame
13044 @opindex mtpcs-frame
13045 Generate a stack frame that is compliant with the Thumb Procedure Call
13046 Standard for all non-leaf functions.  (A leaf function is one that does
13047 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
13049 @item -mtpcs-leaf-frame
13050 @opindex mtpcs-leaf-frame
13051 Generate a stack frame that is compliant with the Thumb Procedure Call
13052 Standard for all leaf functions.  (A leaf function is one that does
13053 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
13055 @item -mcallee-super-interworking
13056 @opindex mcallee-super-interworking
13057 Gives all externally visible functions in the file being compiled an ARM
13058 instruction set header which switches to Thumb mode before executing the
13059 rest of the function.  This allows these functions to be called from
13060 non-interworking code.  This option is not valid in AAPCS configurations
13061 because interworking is enabled by default.
13063 @item -mcaller-super-interworking
13064 @opindex mcaller-super-interworking
13065 Allows calls via function pointers (including virtual functions) to
13066 execute correctly regardless of whether the target code has been
13067 compiled for interworking or not.  There is a small overhead in the cost
13068 of executing a function pointer if this option is enabled.  This option
13069 is not valid in AAPCS configurations because interworking is enabled
13070 by default.
13072 @item -mtp=@var{name}
13073 @opindex mtp
13074 Specify the access model for the thread local storage pointer.  The valid
13075 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
13076 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
13077 (supported in the arm6k architecture), and @option{auto}, which uses the
13078 best available method for the selected processor.  The default setting is
13079 @option{auto}.
13081 @item -mtls-dialect=@var{dialect}
13082 @opindex mtls-dialect
13083 Specify the dialect to use for accessing thread local storage.  Two
13084 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
13085 @samp{gnu} dialect selects the original GNU scheme for supporting
13086 local and global dynamic TLS models.  The @samp{gnu2} dialect
13087 selects the GNU descriptor scheme, which provides better performance
13088 for shared libraries.  The GNU descriptor scheme is compatible with
13089 the original scheme, but does require new assembler, linker and
13090 library support.  Initial and local exec TLS models are unaffected by
13091 this option and always use the original scheme.
13093 @item -mword-relocations
13094 @opindex mword-relocations
13095 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
13096 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
13097 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
13098 is specified.
13100 @item -mfix-cortex-m3-ldrd
13101 @opindex mfix-cortex-m3-ldrd
13102 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
13103 with overlapping destination and base registers are used.  This option avoids
13104 generating these instructions.  This option is enabled by default when
13105 @option{-mcpu=cortex-m3} is specified.
13107 @item -munaligned-access
13108 @itemx -mno-unaligned-access
13109 @opindex munaligned-access
13110 @opindex mno-unaligned-access
13111 Enables (or disables) reading and writing of 16- and 32- bit values
13112 from addresses that are not 16- or 32- bit aligned.  By default
13113 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
13114 architectures, and enabled for all other architectures.  If unaligned
13115 access is not enabled then words in packed data structures will be
13116 accessed a byte at a time.
13118 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
13119 generated object file to either true or false, depending upon the
13120 setting of this option.  If unaligned access is enabled then the
13121 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
13122 defined.
13124 @item -mneon-for-64bits
13125 @opindex mneon-for-64bits
13126 Enables using Neon to handle scalar 64-bits operations. This is
13127 disabled by default since the cost of moving data from core registers
13128 to Neon is high.
13130 @item -mslow-flash-data
13131 @opindex mslow-flash-data
13132 Assume loading data from flash is slower than fetching instruction.
13133 Therefore literal load is minimized for better performance.
13134 This option is only supported when compiling for ARMv7 M-profile and
13135 off by default.
13137 @item -masm-syntax-unified
13138 @opindex masm-syntax-unified
13139 Assume inline assembler is using unified asm syntax.  The default is
13140 currently off which implies divided syntax.  Currently this option is
13141 available only for Thumb1 and has no effect on ARM state and Thumb2.
13142 However, this may change in future releases of GCC.  Divided syntax
13143 should be considered deprecated.
13145 @item -mrestrict-it
13146 @opindex mrestrict-it
13147 Restricts generation of IT blocks to conform to the rules of ARMv8.
13148 IT blocks can only contain a single 16-bit instruction from a select
13149 set of instructions. This option is on by default for ARMv8 Thumb mode.
13150 @end table
13152 @node AVR Options
13153 @subsection AVR Options
13154 @cindex AVR Options
13156 These options are defined for AVR implementations:
13158 @table @gcctabopt
13159 @item -mmcu=@var{mcu}
13160 @opindex mmcu
13161 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
13163 The default for this option is@tie{}@code{avr2}.
13165 GCC supports the following AVR devices and ISAs:
13167 @include avr-mmcu.texi
13169 @item -maccumulate-args
13170 @opindex maccumulate-args
13171 Accumulate outgoing function arguments and acquire/release the needed
13172 stack space for outgoing function arguments once in function
13173 prologue/epilogue.  Without this option, outgoing arguments are pushed
13174 before calling a function and popped afterwards.
13176 Popping the arguments after the function call can be expensive on
13177 AVR so that accumulating the stack space might lead to smaller
13178 executables because arguments need not to be removed from the
13179 stack after such a function call.
13181 This option can lead to reduced code size for functions that perform
13182 several calls to functions that get their arguments on the stack like
13183 calls to printf-like functions.
13185 @item -mbranch-cost=@var{cost}
13186 @opindex mbranch-cost
13187 Set the branch costs for conditional branch instructions to
13188 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
13189 integers. The default branch cost is 0.
13191 @item -mcall-prologues
13192 @opindex mcall-prologues
13193 Functions prologues/epilogues are expanded as calls to appropriate
13194 subroutines.  Code size is smaller.
13196 @item -mint8
13197 @opindex mint8
13198 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
13199 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
13200 and @code{long long} is 4 bytes.  Please note that this option does not
13201 conform to the C standards, but it results in smaller code
13202 size.
13204 @item -mno-interrupts
13205 @opindex mno-interrupts
13206 Generated code is not compatible with hardware interrupts.
13207 Code size is smaller.
13209 @item -mrelax
13210 @opindex mrelax
13211 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
13212 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
13213 Setting @code{-mrelax} just adds the @code{--relax} option to the
13214 linker command line when the linker is called.
13216 Jump relaxing is performed by the linker because jump offsets are not
13217 known before code is located. Therefore, the assembler code generated by the
13218 compiler is the same, but the instructions in the executable may
13219 differ from instructions in the assembler code.
13221 Relaxing must be turned on if linker stubs are needed, see the
13222 section on @code{EIND} and linker stubs below.
13224 @item -msp8
13225 @opindex msp8
13226 Treat the stack pointer register as an 8-bit register,
13227 i.e.@: assume the high byte of the stack pointer is zero.
13228 In general, you don't need to set this option by hand.
13230 This option is used internally by the compiler to select and
13231 build multilibs for architectures @code{avr2} and @code{avr25}.
13232 These architectures mix devices with and without @code{SPH}.
13233 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
13234 the compiler driver will add or remove this option from the compiler
13235 proper's command line, because the compiler then knows if the device
13236 or architecture has an 8-bit stack pointer and thus no @code{SPH}
13237 register or not.
13239 @item -mstrict-X
13240 @opindex mstrict-X
13241 Use address register @code{X} in a way proposed by the hardware.  This means
13242 that @code{X} is only used in indirect, post-increment or
13243 pre-decrement addressing.
13245 Without this option, the @code{X} register may be used in the same way
13246 as @code{Y} or @code{Z} which then is emulated by additional
13247 instructions.  
13248 For example, loading a value with @code{X+const} addressing with a
13249 small non-negative @code{const < 64} to a register @var{Rn} is
13250 performed as
13252 @example
13253 adiw r26, const   ; X += const
13254 ld   @var{Rn}, X        ; @var{Rn} = *X
13255 sbiw r26, const   ; X -= const
13256 @end example
13258 @item -mtiny-stack
13259 @opindex mtiny-stack
13260 Only change the lower 8@tie{}bits of the stack pointer.
13262 @item -Waddr-space-convert
13263 @opindex Waddr-space-convert
13264 Warn about conversions between address spaces in the case where the
13265 resulting address space is not contained in the incoming address space.
13266 @end table
13268 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
13269 @cindex @code{EIND}
13270 Pointers in the implementation are 16@tie{}bits wide.
13271 The address of a function or label is represented as word address so
13272 that indirect jumps and calls can target any code address in the
13273 range of 64@tie{}Ki words.
13275 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
13276 bytes of program memory space, there is a special function register called
13277 @code{EIND} that serves as most significant part of the target address
13278 when @code{EICALL} or @code{EIJMP} instructions are used.
13280 Indirect jumps and calls on these devices are handled as follows by
13281 the compiler and are subject to some limitations:
13283 @itemize @bullet
13285 @item
13286 The compiler never sets @code{EIND}.
13288 @item
13289 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
13290 instructions or might read @code{EIND} directly in order to emulate an
13291 indirect call/jump by means of a @code{RET} instruction.
13293 @item
13294 The compiler assumes that @code{EIND} never changes during the startup
13295 code or during the application. In particular, @code{EIND} is not
13296 saved/restored in function or interrupt service routine
13297 prologue/epilogue.
13299 @item
13300 For indirect calls to functions and computed goto, the linker
13301 generates @emph{stubs}. Stubs are jump pads sometimes also called
13302 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
13303 The stub contains a direct jump to the desired address.
13305 @item
13306 Linker relaxation must be turned on so that the linker will generate
13307 the stubs correctly an all situaltion. See the compiler option
13308 @code{-mrelax} and the linler option @code{--relax}.
13309 There are corner cases where the linker is supposed to generate stubs
13310 but aborts without relaxation and without a helpful error message.
13312 @item
13313 The default linker script is arranged for code with @code{EIND = 0}.
13314 If code is supposed to work for a setup with @code{EIND != 0}, a custom
13315 linker script has to be used in order to place the sections whose
13316 name start with @code{.trampolines} into the segment where @code{EIND}
13317 points to.
13319 @item
13320 The startup code from libgcc never sets @code{EIND}.
13321 Notice that startup code is a blend of code from libgcc and AVR-LibC.
13322 For the impact of AVR-LibC on @code{EIND}, see the
13323 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
13325 @item
13326 It is legitimate for user-specific startup code to set up @code{EIND}
13327 early, for example by means of initialization code located in
13328 section @code{.init3}. Such code runs prior to general startup code
13329 that initializes RAM and calls constructors, but after the bit
13330 of startup code from AVR-LibC that sets @code{EIND} to the segment
13331 where the vector table is located.
13332 @example
13333 #include <avr/io.h>
13335 static void
13336 __attribute__((section(".init3"),naked,used,no_instrument_function))
13337 init3_set_eind (void)
13339   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
13340                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
13342 @end example
13344 @noindent
13345 The @code{__trampolines_start} symbol is defined in the linker script.
13347 @item
13348 Stubs are generated automatically by the linker if
13349 the following two conditions are met:
13350 @itemize @minus
13352 @item The address of a label is taken by means of the @code{gs} modifier
13353 (short for @emph{generate stubs}) like so:
13354 @example
13355 LDI r24, lo8(gs(@var{func}))
13356 LDI r25, hi8(gs(@var{func}))
13357 @end example
13358 @item The final location of that label is in a code segment
13359 @emph{outside} the segment where the stubs are located.
13360 @end itemize
13362 @item
13363 The compiler emits such @code{gs} modifiers for code labels in the
13364 following situations:
13365 @itemize @minus
13366 @item Taking address of a function or code label.
13367 @item Computed goto.
13368 @item If prologue-save function is used, see @option{-mcall-prologues}
13369 command-line option.
13370 @item Switch/case dispatch tables. If you do not want such dispatch
13371 tables you can specify the @option{-fno-jump-tables} command-line option.
13372 @item C and C++ constructors/destructors called during startup/shutdown.
13373 @item If the tools hit a @code{gs()} modifier explained above.
13374 @end itemize
13376 @item
13377 Jumping to non-symbolic addresses like so is @emph{not} supported:
13379 @example
13380 int main (void)
13382     /* Call function at word address 0x2 */
13383     return ((int(*)(void)) 0x2)();
13385 @end example
13387 Instead, a stub has to be set up, i.e.@: the function has to be called
13388 through a symbol (@code{func_4} in the example):
13390 @example
13391 int main (void)
13393     extern int func_4 (void);
13395     /* Call function at byte address 0x4 */
13396     return func_4();
13398 @end example
13400 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
13401 Alternatively, @code{func_4} can be defined in the linker script.
13402 @end itemize
13404 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
13405 @cindex @code{RAMPD}
13406 @cindex @code{RAMPX}
13407 @cindex @code{RAMPY}
13408 @cindex @code{RAMPZ}
13409 Some AVR devices support memories larger than the 64@tie{}KiB range
13410 that can be accessed with 16-bit pointers.  To access memory locations
13411 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
13412 register is used as high part of the address:
13413 The @code{X}, @code{Y}, @code{Z} address register is concatenated
13414 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
13415 register, respectively, to get a wide address. Similarly,
13416 @code{RAMPD} is used together with direct addressing.
13418 @itemize
13419 @item
13420 The startup code initializes the @code{RAMP} special function
13421 registers with zero.
13423 @item
13424 If a @ref{AVR Named Address Spaces,named address space} other than
13425 generic or @code{__flash} is used, then @code{RAMPZ} is set
13426 as needed before the operation.
13428 @item
13429 If the device supports RAM larger than 64@tie{}KiB and the compiler
13430 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
13431 is reset to zero after the operation.
13433 @item
13434 If the device comes with a specific @code{RAMP} register, the ISR
13435 prologue/epilogue saves/restores that SFR and initializes it with
13436 zero in case the ISR code might (implicitly) use it.
13438 @item
13439 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
13440 If you use inline assembler to read from locations outside the
13441 16-bit address range and change one of the @code{RAMP} registers,
13442 you must reset it to zero after the access.
13444 @end itemize
13446 @subsubsection AVR Built-in Macros
13448 GCC defines several built-in macros so that the user code can test
13449 for the presence or absence of features.  Almost any of the following
13450 built-in macros are deduced from device capabilities and thus
13451 triggered by the @code{-mmcu=} command-line option.
13453 For even more AVR-specific built-in macros see
13454 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
13456 @table @code
13458 @item __AVR_ARCH__
13459 Build-in macro that resolves to a decimal number that identifies the
13460 architecture and depends on the @code{-mmcu=@var{mcu}} option.
13461 Possible values are:
13463 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
13464 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
13465 @code{105}, @code{106}, @code{107}
13467 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
13468 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
13469 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
13470 @code{avrxmega6}, @code{avrxmega7}, respectively.
13471 If @var{mcu} specifies a device, this built-in macro is set
13472 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
13473 defined to @code{4}.
13475 @item __AVR_@var{Device}__
13476 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
13477 the device's name. For example, @code{-mmcu=atmega8} defines the
13478 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
13479 @code{__AVR_ATtiny261A__}, etc.
13481 The built-in macros' names follow
13482 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
13483 the device name as from the AVR user manual. The difference between
13484 @var{Device} in the built-in macro and @var{device} in
13485 @code{-mmcu=@var{device}} is that the latter is always lowercase.
13487 If @var{device} is not a device but only a core architecture like
13488 @code{avr51}, this macro will not be defined.
13490 @item   __AVR_DEVICE_NAME__
13491 Setting @code{-mmcu=@var{device}} defines this built-in macro to
13492 the device's name. For example, with @code{-mmcu=atmega8} the macro
13493 will be defined to @code{atmega8}.
13495 If @var{device} is not a device but only a core architecture like
13496 @code{avr51}, this macro will not be defined.
13498 @item __AVR_XMEGA__
13499 The device / architecture belongs to the XMEGA family of devices.
13501 @item __AVR_HAVE_ELPM__
13502 The device has the the @code{ELPM} instruction.
13504 @item __AVR_HAVE_ELPMX__
13505 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
13506 R@var{n},Z+} instructions.
13508 @item __AVR_HAVE_MOVW__
13509 The device has the @code{MOVW} instruction to perform 16-bit
13510 register-register moves.
13512 @item __AVR_HAVE_LPMX__
13513 The device has the @code{LPM R@var{n},Z} and
13514 @code{LPM R@var{n},Z+} instructions.
13516 @item __AVR_HAVE_MUL__
13517 The device has a hardware multiplier. 
13519 @item __AVR_HAVE_JMP_CALL__
13520 The device has the @code{JMP} and @code{CALL} instructions.
13521 This is the case for devices with at least 16@tie{}KiB of program
13522 memory.
13524 @item __AVR_HAVE_EIJMP_EICALL__
13525 @itemx __AVR_3_BYTE_PC__
13526 The device has the @code{EIJMP} and @code{EICALL} instructions.
13527 This is the case for devices with more than 128@tie{}KiB of program memory.
13528 This also means that the program counter
13529 (PC) is 3@tie{}bytes wide.
13531 @item __AVR_2_BYTE_PC__
13532 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
13533 with up to 128@tie{}KiB of program memory.
13535 @item __AVR_HAVE_8BIT_SP__
13536 @itemx __AVR_HAVE_16BIT_SP__
13537 The stack pointer (SP) register is treated as 8-bit respectively
13538 16-bit register by the compiler.
13539 The definition of these macros is affected by @code{-mtiny-stack}.
13541 @item __AVR_HAVE_SPH__
13542 @itemx __AVR_SP8__
13543 The device has the SPH (high part of stack pointer) special function
13544 register or has an 8-bit stack pointer, respectively.
13545 The definition of these macros is affected by @code{-mmcu=} and
13546 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
13547 by @code{-msp8}.
13549 @item __AVR_HAVE_RAMPD__
13550 @itemx __AVR_HAVE_RAMPX__
13551 @itemx __AVR_HAVE_RAMPY__
13552 @itemx __AVR_HAVE_RAMPZ__
13553 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
13554 @code{RAMPZ} special function register, respectively.
13556 @item __NO_INTERRUPTS__
13557 This macro reflects the @code{-mno-interrupts} command line option.
13559 @item __AVR_ERRATA_SKIP__
13560 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
13561 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
13562 instructions because of a hardware erratum.  Skip instructions are
13563 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
13564 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
13565 set.
13567 @item __AVR_ISA_RMW__
13568 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13570 @item __AVR_SFR_OFFSET__=@var{offset}
13571 Instructions that can address I/O special function registers directly
13572 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13573 address as if addressed by an instruction to access RAM like @code{LD}
13574 or @code{STS}. This offset depends on the device architecture and has
13575 to be subtracted from the RAM address in order to get the
13576 respective I/O@tie{}address.
13578 @item __WITH_AVRLIBC__
13579 The compiler is configured to be used together with AVR-Libc.
13580 See the @code{--with-avrlibc} configure option.
13582 @end table
13584 @node Blackfin Options
13585 @subsection Blackfin Options
13586 @cindex Blackfin Options
13588 @table @gcctabopt
13589 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13590 @opindex mcpu=
13591 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13592 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13593 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13594 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13595 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13596 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13597 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13598 @samp{bf561}, @samp{bf592}.
13600 The optional @var{sirevision} specifies the silicon revision of the target
13601 Blackfin processor.  Any workarounds available for the targeted silicon revision
13602 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13603 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13604 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13605 hexadecimal digits representing the major and minor numbers in the silicon
13606 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13607 is not defined.  If @var{sirevision} is @samp{any}, the
13608 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13609 If this optional @var{sirevision} is not used, GCC assumes the latest known
13610 silicon revision of the targeted Blackfin processor.
13612 GCC defines a preprocessor macro for the specified @var{cpu}.
13613 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13614 provided by libgloss to be linked in if @option{-msim} is not given.
13616 Without this option, @samp{bf532} is used as the processor by default.
13618 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13619 only the preprocessor macro is defined.
13621 @item -msim
13622 @opindex msim
13623 Specifies that the program will be run on the simulator.  This causes
13624 the simulator BSP provided by libgloss to be linked in.  This option
13625 has effect only for @samp{bfin-elf} toolchain.
13626 Certain other options, such as @option{-mid-shared-library} and
13627 @option{-mfdpic}, imply @option{-msim}.
13629 @item -momit-leaf-frame-pointer
13630 @opindex momit-leaf-frame-pointer
13631 Don't keep the frame pointer in a register for leaf functions.  This
13632 avoids the instructions to save, set up and restore frame pointers and
13633 makes an extra register available in leaf functions.  The option
13634 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13635 which might make debugging harder.
13637 @item -mspecld-anomaly
13638 @opindex mspecld-anomaly
13639 When enabled, the compiler ensures that the generated code does not
13640 contain speculative loads after jump instructions. If this option is used,
13641 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13643 @item -mno-specld-anomaly
13644 @opindex mno-specld-anomaly
13645 Don't generate extra code to prevent speculative loads from occurring.
13647 @item -mcsync-anomaly
13648 @opindex mcsync-anomaly
13649 When enabled, the compiler ensures that the generated code does not
13650 contain CSYNC or SSYNC instructions too soon after conditional branches.
13651 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13653 @item -mno-csync-anomaly
13654 @opindex mno-csync-anomaly
13655 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13656 occurring too soon after a conditional branch.
13658 @item -mlow-64k
13659 @opindex mlow-64k
13660 When enabled, the compiler is free to take advantage of the knowledge that
13661 the entire program fits into the low 64k of memory.
13663 @item -mno-low-64k
13664 @opindex mno-low-64k
13665 Assume that the program is arbitrarily large.  This is the default.
13667 @item -mstack-check-l1
13668 @opindex mstack-check-l1
13669 Do stack checking using information placed into L1 scratchpad memory by the
13670 uClinux kernel.
13672 @item -mid-shared-library
13673 @opindex mid-shared-library
13674 Generate code that supports shared libraries via the library ID method.
13675 This allows for execute in place and shared libraries in an environment
13676 without virtual memory management.  This option implies @option{-fPIC}.
13677 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13679 @item -mno-id-shared-library
13680 @opindex mno-id-shared-library
13681 Generate code that doesn't assume ID-based shared libraries are being used.
13682 This is the default.
13684 @item -mleaf-id-shared-library
13685 @opindex mleaf-id-shared-library
13686 Generate code that supports shared libraries via the library ID method,
13687 but assumes that this library or executable won't link against any other
13688 ID shared libraries.  That allows the compiler to use faster code for jumps
13689 and calls.
13691 @item -mno-leaf-id-shared-library
13692 @opindex mno-leaf-id-shared-library
13693 Do not assume that the code being compiled won't link against any ID shared
13694 libraries.  Slower code is generated for jump and call insns.
13696 @item -mshared-library-id=n
13697 @opindex mshared-library-id
13698 Specifies the identification number of the ID-based shared library being
13699 compiled.  Specifying a value of 0 generates more compact code; specifying
13700 other values forces the allocation of that number to the current
13701 library but is no more space- or time-efficient than omitting this option.
13703 @item -msep-data
13704 @opindex msep-data
13705 Generate code that allows the data segment to be located in a different
13706 area of memory from the text segment.  This allows for execute in place in
13707 an environment without virtual memory management by eliminating relocations
13708 against the text section.
13710 @item -mno-sep-data
13711 @opindex mno-sep-data
13712 Generate code that assumes that the data segment follows the text segment.
13713 This is the default.
13715 @item -mlong-calls
13716 @itemx -mno-long-calls
13717 @opindex mlong-calls
13718 @opindex mno-long-calls
13719 Tells the compiler to perform function calls by first loading the
13720 address of the function into a register and then performing a subroutine
13721 call on this register.  This switch is needed if the target function
13722 lies outside of the 24-bit addressing range of the offset-based
13723 version of subroutine call instruction.
13725 This feature is not enabled by default.  Specifying
13726 @option{-mno-long-calls} restores the default behavior.  Note these
13727 switches have no effect on how the compiler generates code to handle
13728 function calls via function pointers.
13730 @item -mfast-fp
13731 @opindex mfast-fp
13732 Link with the fast floating-point library. This library relaxes some of
13733 the IEEE floating-point standard's rules for checking inputs against
13734 Not-a-Number (NAN), in the interest of performance.
13736 @item -minline-plt
13737 @opindex minline-plt
13738 Enable inlining of PLT entries in function calls to functions that are
13739 not known to bind locally.  It has no effect without @option{-mfdpic}.
13741 @item -mmulticore
13742 @opindex mmulticore
13743 Build a standalone application for multicore Blackfin processors. 
13744 This option causes proper start files and link scripts supporting 
13745 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13746 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13748 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13749 selects the one-application-per-core programming model.  Without
13750 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13751 programming model is used. In this model, the main function of Core B
13752 should be named as @code{coreb_main}.
13754 If this option is not used, the single-core application programming
13755 model is used.
13757 @item -mcorea
13758 @opindex mcorea
13759 Build a standalone application for Core A of BF561 when using
13760 the one-application-per-core programming model. Proper start files
13761 and link scripts are used to support Core A, and the macro
13762 @code{__BFIN_COREA} is defined.
13763 This option can only be used in conjunction with @option{-mmulticore}.
13765 @item -mcoreb
13766 @opindex mcoreb
13767 Build a standalone application for Core B of BF561 when using
13768 the one-application-per-core programming model. Proper start files
13769 and link scripts are used to support Core B, and the macro
13770 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13771 should be used instead of @code{main}. 
13772 This option can only be used in conjunction with @option{-mmulticore}.
13774 @item -msdram
13775 @opindex msdram
13776 Build a standalone application for SDRAM. Proper start files and
13777 link scripts are used to put the application into SDRAM, and the macro
13778 @code{__BFIN_SDRAM} is defined.
13779 The loader should initialize SDRAM before loading the application.
13781 @item -micplb
13782 @opindex micplb
13783 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13784 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13785 are enabled; for standalone applications the default is off.
13786 @end table
13788 @node C6X Options
13789 @subsection C6X Options
13790 @cindex C6X Options
13792 @table @gcctabopt
13793 @item -march=@var{name}
13794 @opindex march
13795 This specifies the name of the target architecture.  GCC uses this
13796 name to determine what kind of instructions it can emit when generating
13797 assembly code.  Permissible names are: @samp{c62x},
13798 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13800 @item -mbig-endian
13801 @opindex mbig-endian
13802 Generate code for a big-endian target.
13804 @item -mlittle-endian
13805 @opindex mlittle-endian
13806 Generate code for a little-endian target.  This is the default.
13808 @item -msim
13809 @opindex msim
13810 Choose startup files and linker script suitable for the simulator.
13812 @item -msdata=default
13813 @opindex msdata=default
13814 Put small global and static data in the @samp{.neardata} section,
13815 which is pointed to by register @code{B14}.  Put small uninitialized
13816 global and static data in the @samp{.bss} section, which is adjacent
13817 to the @samp{.neardata} section.  Put small read-only data into the
13818 @samp{.rodata} section.  The corresponding sections used for large
13819 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13821 @item -msdata=all
13822 @opindex msdata=all
13823 Put all data, not just small objects, into the sections reserved for
13824 small data, and use addressing relative to the @code{B14} register to
13825 access them.
13827 @item -msdata=none
13828 @opindex msdata=none
13829 Make no use of the sections reserved for small data, and use absolute
13830 addresses to access all data.  Put all initialized global and static
13831 data in the @samp{.fardata} section, and all uninitialized data in the
13832 @samp{.far} section.  Put all constant data into the @samp{.const}
13833 section.
13834 @end table
13836 @node CRIS Options
13837 @subsection CRIS Options
13838 @cindex CRIS Options
13840 These options are defined specifically for the CRIS ports.
13842 @table @gcctabopt
13843 @item -march=@var{architecture-type}
13844 @itemx -mcpu=@var{architecture-type}
13845 @opindex march
13846 @opindex mcpu
13847 Generate code for the specified architecture.  The choices for
13848 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13849 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13850 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13851 @samp{v10}.
13853 @item -mtune=@var{architecture-type}
13854 @opindex mtune
13855 Tune to @var{architecture-type} everything applicable about the generated
13856 code, except for the ABI and the set of available instructions.  The
13857 choices for @var{architecture-type} are the same as for
13858 @option{-march=@var{architecture-type}}.
13860 @item -mmax-stack-frame=@var{n}
13861 @opindex mmax-stack-frame
13862 Warn when the stack frame of a function exceeds @var{n} bytes.
13864 @item -metrax4
13865 @itemx -metrax100
13866 @opindex metrax4
13867 @opindex metrax100
13868 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13869 @option{-march=v3} and @option{-march=v8} respectively.
13871 @item -mmul-bug-workaround
13872 @itemx -mno-mul-bug-workaround
13873 @opindex mmul-bug-workaround
13874 @opindex mno-mul-bug-workaround
13875 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13876 models where it applies.  This option is active by default.
13878 @item -mpdebug
13879 @opindex mpdebug
13880 Enable CRIS-specific verbose debug-related information in the assembly
13881 code.  This option also has the effect of turning off the @samp{#NO_APP}
13882 formatted-code indicator to the assembler at the beginning of the
13883 assembly file.
13885 @item -mcc-init
13886 @opindex mcc-init
13887 Do not use condition-code results from previous instruction; always emit
13888 compare and test instructions before use of condition codes.
13890 @item -mno-side-effects
13891 @opindex mno-side-effects
13892 Do not emit instructions with side effects in addressing modes other than
13893 post-increment.
13895 @item -mstack-align
13896 @itemx -mno-stack-align
13897 @itemx -mdata-align
13898 @itemx -mno-data-align
13899 @itemx -mconst-align
13900 @itemx -mno-const-align
13901 @opindex mstack-align
13902 @opindex mno-stack-align
13903 @opindex mdata-align
13904 @opindex mno-data-align
13905 @opindex mconst-align
13906 @opindex mno-const-align
13907 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13908 stack frame, individual data and constants to be aligned for the maximum
13909 single data access size for the chosen CPU model.  The default is to
13910 arrange for 32-bit alignment.  ABI details such as structure layout are
13911 not affected by these options.
13913 @item -m32-bit
13914 @itemx -m16-bit
13915 @itemx -m8-bit
13916 @opindex m32-bit
13917 @opindex m16-bit
13918 @opindex m8-bit
13919 Similar to the stack- data- and const-align options above, these options
13920 arrange for stack frame, writable data and constants to all be 32-bit,
13921 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13923 @item -mno-prologue-epilogue
13924 @itemx -mprologue-epilogue
13925 @opindex mno-prologue-epilogue
13926 @opindex mprologue-epilogue
13927 With @option{-mno-prologue-epilogue}, the normal function prologue and
13928 epilogue which set up the stack frame are omitted and no return
13929 instructions or return sequences are generated in the code.  Use this
13930 option only together with visual inspection of the compiled code: no
13931 warnings or errors are generated when call-saved registers must be saved,
13932 or storage for local variables needs to be allocated.
13934 @item -mno-gotplt
13935 @itemx -mgotplt
13936 @opindex mno-gotplt
13937 @opindex mgotplt
13938 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13939 instruction sequences that load addresses for functions from the PLT part
13940 of the GOT rather than (traditional on other architectures) calls to the
13941 PLT@.  The default is @option{-mgotplt}.
13943 @item -melf
13944 @opindex melf
13945 Legacy no-op option only recognized with the cris-axis-elf and
13946 cris-axis-linux-gnu targets.
13948 @item -mlinux
13949 @opindex mlinux
13950 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13952 @item -sim
13953 @opindex sim
13954 This option, recognized for the cris-axis-elf, arranges
13955 to link with input-output functions from a simulator library.  Code,
13956 initialized data and zero-initialized data are allocated consecutively.
13958 @item -sim2
13959 @opindex sim2
13960 Like @option{-sim}, but pass linker options to locate initialized data at
13961 0x40000000 and zero-initialized data at 0x80000000.
13962 @end table
13964 @node CR16 Options
13965 @subsection CR16 Options
13966 @cindex CR16 Options
13968 These options are defined specifically for the CR16 ports.
13970 @table @gcctabopt
13972 @item -mmac
13973 @opindex mmac
13974 Enable the use of multiply-accumulate instructions. Disabled by default.
13976 @item -mcr16cplus
13977 @itemx -mcr16c
13978 @opindex mcr16cplus
13979 @opindex mcr16c
13980 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13981 is default.
13983 @item -msim
13984 @opindex msim
13985 Links the library libsim.a which is in compatible with simulator. Applicable
13986 to ELF compiler only.
13988 @item -mint32
13989 @opindex mint32
13990 Choose integer type as 32-bit wide.
13992 @item -mbit-ops
13993 @opindex mbit-ops
13994 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13996 @item -mdata-model=@var{model}
13997 @opindex mdata-model
13998 Choose a data model. The choices for @var{model} are @samp{near},
13999 @samp{far} or @samp{medium}. @samp{medium} is default.
14000 However, @samp{far} is not valid with @option{-mcr16c}, as the
14001 CR16C architecture does not support the far data model.
14002 @end table
14004 @node Darwin Options
14005 @subsection Darwin Options
14006 @cindex Darwin options
14008 These options are defined for all architectures running the Darwin operating
14009 system.
14011 FSF GCC on Darwin does not create ``fat'' object files; it creates
14012 an object file for the single architecture that GCC was built to
14013 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
14014 @option{-arch} options are used; it does so by running the compiler or
14015 linker multiple times and joining the results together with
14016 @file{lipo}.
14018 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
14019 @samp{i686}) is determined by the flags that specify the ISA
14020 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
14021 @option{-force_cpusubtype_ALL} option can be used to override this.
14023 The Darwin tools vary in their behavior when presented with an ISA
14024 mismatch.  The assembler, @file{as}, only permits instructions to
14025 be used that are valid for the subtype of the file it is generating,
14026 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
14027 The linker for shared libraries, @file{/usr/bin/libtool}, fails
14028 and prints an error if asked to create a shared library with a less
14029 restrictive subtype than its input files (for instance, trying to put
14030 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
14031 for executables, @command{ld}, quietly gives the executable the most
14032 restrictive subtype of any of its input files.
14034 @table @gcctabopt
14035 @item -F@var{dir}
14036 @opindex F
14037 Add the framework directory @var{dir} to the head of the list of
14038 directories to be searched for header files.  These directories are
14039 interleaved with those specified by @option{-I} options and are
14040 scanned in a left-to-right order.
14042 A framework directory is a directory with frameworks in it.  A
14043 framework is a directory with a @file{Headers} and/or
14044 @file{PrivateHeaders} directory contained directly in it that ends
14045 in @file{.framework}.  The name of a framework is the name of this
14046 directory excluding the @file{.framework}.  Headers associated with
14047 the framework are found in one of those two directories, with
14048 @file{Headers} being searched first.  A subframework is a framework
14049 directory that is in a framework's @file{Frameworks} directory.
14050 Includes of subframework headers can only appear in a header of a
14051 framework that contains the subframework, or in a sibling subframework
14052 header.  Two subframeworks are siblings if they occur in the same
14053 framework.  A subframework should not have the same name as a
14054 framework; a warning is issued if this is violated.  Currently a
14055 subframework cannot have subframeworks; in the future, the mechanism
14056 may be extended to support this.  The standard frameworks can be found
14057 in @file{/System/Library/Frameworks} and
14058 @file{/Library/Frameworks}.  An example include looks like
14059 @code{#include <Framework/header.h>}, where @file{Framework} denotes
14060 the name of the framework and @file{header.h} is found in the
14061 @file{PrivateHeaders} or @file{Headers} directory.
14063 @item -iframework@var{dir}
14064 @opindex iframework
14065 Like @option{-F} except the directory is a treated as a system
14066 directory.  The main difference between this @option{-iframework} and
14067 @option{-F} is that with @option{-iframework} the compiler does not
14068 warn about constructs contained within header files found via
14069 @var{dir}.  This option is valid only for the C family of languages.
14071 @item -gused
14072 @opindex gused
14073 Emit debugging information for symbols that are used.  For stabs
14074 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
14075 This is by default ON@.
14077 @item -gfull
14078 @opindex gfull
14079 Emit debugging information for all symbols and types.
14081 @item -mmacosx-version-min=@var{version}
14082 The earliest version of MacOS X that this executable will run on
14083 is @var{version}.  Typical values of @var{version} include @code{10.1},
14084 @code{10.2}, and @code{10.3.9}.
14086 If the compiler was built to use the system's headers by default,
14087 then the default for this option is the system version on which the
14088 compiler is running, otherwise the default is to make choices that
14089 are compatible with as many systems and code bases as possible.
14091 @item -mkernel
14092 @opindex mkernel
14093 Enable kernel development mode.  The @option{-mkernel} option sets
14094 @option{-static}, @option{-fno-common}, @option{-fno-use-cxa-atexit},
14095 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
14096 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
14097 applicable.  This mode also sets @option{-mno-altivec},
14098 @option{-msoft-float}, @option{-fno-builtin} and
14099 @option{-mlong-branch} for PowerPC targets.
14101 @item -mone-byte-bool
14102 @opindex mone-byte-bool
14103 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
14104 By default @samp{sizeof(bool)} is @samp{4} when compiling for
14105 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
14106 option has no effect on x86.
14108 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
14109 to generate code that is not binary compatible with code generated
14110 without that switch.  Using this switch may require recompiling all
14111 other modules in a program, including system libraries.  Use this
14112 switch to conform to a non-default data model.
14114 @item -mfix-and-continue
14115 @itemx -ffix-and-continue
14116 @itemx -findirect-data
14117 @opindex mfix-and-continue
14118 @opindex ffix-and-continue
14119 @opindex findirect-data
14120 Generate code suitable for fast turnaround development, such as to
14121 allow GDB to dynamically load @code{.o} files into already-running
14122 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
14123 are provided for backwards compatibility.
14125 @item -all_load
14126 @opindex all_load
14127 Loads all members of static archive libraries.
14128 See man ld(1) for more information.
14130 @item -arch_errors_fatal
14131 @opindex arch_errors_fatal
14132 Cause the errors having to do with files that have the wrong architecture
14133 to be fatal.
14135 @item -bind_at_load
14136 @opindex bind_at_load
14137 Causes the output file to be marked such that the dynamic linker will
14138 bind all undefined references when the file is loaded or launched.
14140 @item -bundle
14141 @opindex bundle
14142 Produce a Mach-o bundle format file.
14143 See man ld(1) for more information.
14145 @item -bundle_loader @var{executable}
14146 @opindex bundle_loader
14147 This option specifies the @var{executable} that will load the build
14148 output file being linked.  See man ld(1) for more information.
14150 @item -dynamiclib
14151 @opindex dynamiclib
14152 When passed this option, GCC produces a dynamic library instead of
14153 an executable when linking, using the Darwin @file{libtool} command.
14155 @item -force_cpusubtype_ALL
14156 @opindex force_cpusubtype_ALL
14157 This causes GCC's output file to have the @var{ALL} subtype, instead of
14158 one controlled by the @option{-mcpu} or @option{-march} option.
14160 @item -allowable_client  @var{client_name}
14161 @itemx -client_name
14162 @itemx -compatibility_version
14163 @itemx -current_version
14164 @itemx -dead_strip
14165 @itemx -dependency-file
14166 @itemx -dylib_file
14167 @itemx -dylinker_install_name
14168 @itemx -dynamic
14169 @itemx -exported_symbols_list
14170 @itemx -filelist
14171 @need 800
14172 @itemx -flat_namespace
14173 @itemx -force_flat_namespace
14174 @itemx -headerpad_max_install_names
14175 @itemx -image_base
14176 @itemx -init
14177 @itemx -install_name
14178 @itemx -keep_private_externs
14179 @itemx -multi_module
14180 @itemx -multiply_defined
14181 @itemx -multiply_defined_unused
14182 @need 800
14183 @itemx -noall_load
14184 @itemx -no_dead_strip_inits_and_terms
14185 @itemx -nofixprebinding
14186 @itemx -nomultidefs
14187 @itemx -noprebind
14188 @itemx -noseglinkedit
14189 @itemx -pagezero_size
14190 @itemx -prebind
14191 @itemx -prebind_all_twolevel_modules
14192 @itemx -private_bundle
14193 @need 800
14194 @itemx -read_only_relocs
14195 @itemx -sectalign
14196 @itemx -sectobjectsymbols
14197 @itemx -whyload
14198 @itemx -seg1addr
14199 @itemx -sectcreate
14200 @itemx -sectobjectsymbols
14201 @itemx -sectorder
14202 @itemx -segaddr
14203 @itemx -segs_read_only_addr
14204 @need 800
14205 @itemx -segs_read_write_addr
14206 @itemx -seg_addr_table
14207 @itemx -seg_addr_table_filename
14208 @itemx -seglinkedit
14209 @itemx -segprot
14210 @itemx -segs_read_only_addr
14211 @itemx -segs_read_write_addr
14212 @itemx -single_module
14213 @itemx -static
14214 @itemx -sub_library
14215 @need 800
14216 @itemx -sub_umbrella
14217 @itemx -twolevel_namespace
14218 @itemx -umbrella
14219 @itemx -undefined
14220 @itemx -unexported_symbols_list
14221 @itemx -weak_reference_mismatches
14222 @itemx -whatsloaded
14223 @opindex allowable_client
14224 @opindex client_name
14225 @opindex compatibility_version
14226 @opindex current_version
14227 @opindex dead_strip
14228 @opindex dependency-file
14229 @opindex dylib_file
14230 @opindex dylinker_install_name
14231 @opindex dynamic
14232 @opindex exported_symbols_list
14233 @opindex filelist
14234 @opindex flat_namespace
14235 @opindex force_flat_namespace
14236 @opindex headerpad_max_install_names
14237 @opindex image_base
14238 @opindex init
14239 @opindex install_name
14240 @opindex keep_private_externs
14241 @opindex multi_module
14242 @opindex multiply_defined
14243 @opindex multiply_defined_unused
14244 @opindex noall_load
14245 @opindex no_dead_strip_inits_and_terms
14246 @opindex nofixprebinding
14247 @opindex nomultidefs
14248 @opindex noprebind
14249 @opindex noseglinkedit
14250 @opindex pagezero_size
14251 @opindex prebind
14252 @opindex prebind_all_twolevel_modules
14253 @opindex private_bundle
14254 @opindex read_only_relocs
14255 @opindex sectalign
14256 @opindex sectobjectsymbols
14257 @opindex whyload
14258 @opindex seg1addr
14259 @opindex sectcreate
14260 @opindex sectobjectsymbols
14261 @opindex sectorder
14262 @opindex segaddr
14263 @opindex segs_read_only_addr
14264 @opindex segs_read_write_addr
14265 @opindex seg_addr_table
14266 @opindex seg_addr_table_filename
14267 @opindex seglinkedit
14268 @opindex segprot
14269 @opindex segs_read_only_addr
14270 @opindex segs_read_write_addr
14271 @opindex single_module
14272 @opindex static
14273 @opindex sub_library
14274 @opindex sub_umbrella
14275 @opindex twolevel_namespace
14276 @opindex umbrella
14277 @opindex undefined
14278 @opindex unexported_symbols_list
14279 @opindex weak_reference_mismatches
14280 @opindex whatsloaded
14281 These options are passed to the Darwin linker.  The Darwin linker man page
14282 describes them in detail.
14283 @end table
14285 @node DEC Alpha Options
14286 @subsection DEC Alpha Options
14288 These @samp{-m} options are defined for the DEC Alpha implementations:
14290 @table @gcctabopt
14291 @item -mno-soft-float
14292 @itemx -msoft-float
14293 @opindex mno-soft-float
14294 @opindex msoft-float
14295 Use (do not use) the hardware floating-point instructions for
14296 floating-point operations.  When @option{-msoft-float} is specified,
14297 functions in @file{libgcc.a} are used to perform floating-point
14298 operations.  Unless they are replaced by routines that emulate the
14299 floating-point operations, or compiled in such a way as to call such
14300 emulations routines, these routines issue floating-point
14301 operations.   If you are compiling for an Alpha without floating-point
14302 operations, you must ensure that the library is built so as not to call
14303 them.
14305 Note that Alpha implementations without floating-point operations are
14306 required to have floating-point registers.
14308 @item -mfp-reg
14309 @itemx -mno-fp-regs
14310 @opindex mfp-reg
14311 @opindex mno-fp-regs
14312 Generate code that uses (does not use) the floating-point register set.
14313 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
14314 register set is not used, floating-point operands are passed in integer
14315 registers as if they were integers and floating-point results are passed
14316 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
14317 so any function with a floating-point argument or return value called by code
14318 compiled with @option{-mno-fp-regs} must also be compiled with that
14319 option.
14321 A typical use of this option is building a kernel that does not use,
14322 and hence need not save and restore, any floating-point registers.
14324 @item -mieee
14325 @opindex mieee
14326 The Alpha architecture implements floating-point hardware optimized for
14327 maximum performance.  It is mostly compliant with the IEEE floating-point
14328 standard.  However, for full compliance, software assistance is
14329 required.  This option generates code fully IEEE-compliant code
14330 @emph{except} that the @var{inexact-flag} is not maintained (see below).
14331 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
14332 defined during compilation.  The resulting code is less efficient but is
14333 able to correctly support denormalized numbers and exceptional IEEE
14334 values such as not-a-number and plus/minus infinity.  Other Alpha
14335 compilers call this option @option{-ieee_with_no_inexact}.
14337 @item -mieee-with-inexact
14338 @opindex mieee-with-inexact
14339 This is like @option{-mieee} except the generated code also maintains
14340 the IEEE @var{inexact-flag}.  Turning on this option causes the
14341 generated code to implement fully-compliant IEEE math.  In addition to
14342 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
14343 macro.  On some Alpha implementations the resulting code may execute
14344 significantly slower than the code generated by default.  Since there is
14345 very little code that depends on the @var{inexact-flag}, you should
14346 normally not specify this option.  Other Alpha compilers call this
14347 option @option{-ieee_with_inexact}.
14349 @item -mfp-trap-mode=@var{trap-mode}
14350 @opindex mfp-trap-mode
14351 This option controls what floating-point related traps are enabled.
14352 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
14353 The trap mode can be set to one of four values:
14355 @table @samp
14356 @item n
14357 This is the default (normal) setting.  The only traps that are enabled
14358 are the ones that cannot be disabled in software (e.g., division by zero
14359 trap).
14361 @item u
14362 In addition to the traps enabled by @samp{n}, underflow traps are enabled
14363 as well.
14365 @item su
14366 Like @samp{u}, but the instructions are marked to be safe for software
14367 completion (see Alpha architecture manual for details).
14369 @item sui
14370 Like @samp{su}, but inexact traps are enabled as well.
14371 @end table
14373 @item -mfp-rounding-mode=@var{rounding-mode}
14374 @opindex mfp-rounding-mode
14375 Selects the IEEE rounding mode.  Other Alpha compilers call this option
14376 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
14379 @table @samp
14380 @item n
14381 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
14382 the nearest machine number or towards the even machine number in case
14383 of a tie.
14385 @item m
14386 Round towards minus infinity.
14388 @item c
14389 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
14391 @item d
14392 Dynamic rounding mode.  A field in the floating-point control register
14393 (@var{fpcr}, see Alpha architecture reference manual) controls the
14394 rounding mode in effect.  The C library initializes this register for
14395 rounding towards plus infinity.  Thus, unless your program modifies the
14396 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
14397 @end table
14399 @item -mtrap-precision=@var{trap-precision}
14400 @opindex mtrap-precision
14401 In the Alpha architecture, floating-point traps are imprecise.  This
14402 means without software assistance it is impossible to recover from a
14403 floating trap and program execution normally needs to be terminated.
14404 GCC can generate code that can assist operating system trap handlers
14405 in determining the exact location that caused a floating-point trap.
14406 Depending on the requirements of an application, different levels of
14407 precisions can be selected:
14409 @table @samp
14410 @item p
14411 Program precision.  This option is the default and means a trap handler
14412 can only identify which program caused a floating-point exception.
14414 @item f
14415 Function precision.  The trap handler can determine the function that
14416 caused a floating-point exception.
14418 @item i
14419 Instruction precision.  The trap handler can determine the exact
14420 instruction that caused a floating-point exception.
14421 @end table
14423 Other Alpha compilers provide the equivalent options called
14424 @option{-scope_safe} and @option{-resumption_safe}.
14426 @item -mieee-conformant
14427 @opindex mieee-conformant
14428 This option marks the generated code as IEEE conformant.  You must not
14429 use this option unless you also specify @option{-mtrap-precision=i} and either
14430 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
14431 is to emit the line @samp{.eflag 48} in the function prologue of the
14432 generated assembly file.
14434 @item -mbuild-constants
14435 @opindex mbuild-constants
14436 Normally GCC examines a 32- or 64-bit integer constant to
14437 see if it can construct it from smaller constants in two or three
14438 instructions.  If it cannot, it outputs the constant as a literal and
14439 generates code to load it from the data segment at run time.
14441 Use this option to require GCC to construct @emph{all} integer constants
14442 using code, even if it takes more instructions (the maximum is six).
14444 You typically use this option to build a shared library dynamic
14445 loader.  Itself a shared library, it must relocate itself in memory
14446 before it can find the variables and constants in its own data segment.
14448 @item -mbwx
14449 @itemx -mno-bwx
14450 @itemx -mcix
14451 @itemx -mno-cix
14452 @itemx -mfix
14453 @itemx -mno-fix
14454 @itemx -mmax
14455 @itemx -mno-max
14456 @opindex mbwx
14457 @opindex mno-bwx
14458 @opindex mcix
14459 @opindex mno-cix
14460 @opindex mfix
14461 @opindex mno-fix
14462 @opindex mmax
14463 @opindex mno-max
14464 Indicate whether GCC should generate code to use the optional BWX,
14465 CIX, FIX and MAX instruction sets.  The default is to use the instruction
14466 sets supported by the CPU type specified via @option{-mcpu=} option or that
14467 of the CPU on which GCC was built if none is specified.
14469 @item -mfloat-vax
14470 @itemx -mfloat-ieee
14471 @opindex mfloat-vax
14472 @opindex mfloat-ieee
14473 Generate code that uses (does not use) VAX F and G floating-point
14474 arithmetic instead of IEEE single and double precision.
14476 @item -mexplicit-relocs
14477 @itemx -mno-explicit-relocs
14478 @opindex mexplicit-relocs
14479 @opindex mno-explicit-relocs
14480 Older Alpha assemblers provided no way to generate symbol relocations
14481 except via assembler macros.  Use of these macros does not allow
14482 optimal instruction scheduling.  GNU binutils as of version 2.12
14483 supports a new syntax that allows the compiler to explicitly mark
14484 which relocations should apply to which instructions.  This option
14485 is mostly useful for debugging, as GCC detects the capabilities of
14486 the assembler when it is built and sets the default accordingly.
14488 @item -msmall-data
14489 @itemx -mlarge-data
14490 @opindex msmall-data
14491 @opindex mlarge-data
14492 When @option{-mexplicit-relocs} is in effect, static data is
14493 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
14494 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
14495 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
14496 16-bit relocations off of the @code{$gp} register.  This limits the
14497 size of the small data area to 64KB, but allows the variables to be
14498 directly accessed via a single instruction.
14500 The default is @option{-mlarge-data}.  With this option the data area
14501 is limited to just below 2GB@.  Programs that require more than 2GB of
14502 data must use @code{malloc} or @code{mmap} to allocate the data in the
14503 heap instead of in the program's data segment.
14505 When generating code for shared libraries, @option{-fpic} implies
14506 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
14508 @item -msmall-text
14509 @itemx -mlarge-text
14510 @opindex msmall-text
14511 @opindex mlarge-text
14512 When @option{-msmall-text} is used, the compiler assumes that the
14513 code of the entire program (or shared library) fits in 4MB, and is
14514 thus reachable with a branch instruction.  When @option{-msmall-data}
14515 is used, the compiler can assume that all local symbols share the
14516 same @code{$gp} value, and thus reduce the number of instructions
14517 required for a function call from 4 to 1.
14519 The default is @option{-mlarge-text}.
14521 @item -mcpu=@var{cpu_type}
14522 @opindex mcpu
14523 Set the instruction set and instruction scheduling parameters for
14524 machine type @var{cpu_type}.  You can specify either the @samp{EV}
14525 style name or the corresponding chip number.  GCC supports scheduling
14526 parameters for the EV4, EV5 and EV6 family of processors and
14527 chooses the default values for the instruction set from the processor
14528 you specify.  If you do not specify a processor type, GCC defaults
14529 to the processor on which the compiler was built.
14531 Supported values for @var{cpu_type} are
14533 @table @samp
14534 @item ev4
14535 @itemx ev45
14536 @itemx 21064
14537 Schedules as an EV4 and has no instruction set extensions.
14539 @item ev5
14540 @itemx 21164
14541 Schedules as an EV5 and has no instruction set extensions.
14543 @item ev56
14544 @itemx 21164a
14545 Schedules as an EV5 and supports the BWX extension.
14547 @item pca56
14548 @itemx 21164pc
14549 @itemx 21164PC
14550 Schedules as an EV5 and supports the BWX and MAX extensions.
14552 @item ev6
14553 @itemx 21264
14554 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
14556 @item ev67
14557 @itemx 21264a
14558 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
14559 @end table
14561 Native toolchains also support the value @samp{native},
14562 which selects the best architecture option for the host processor.
14563 @option{-mcpu=native} has no effect if GCC does not recognize
14564 the processor.
14566 @item -mtune=@var{cpu_type}
14567 @opindex mtune
14568 Set only the instruction scheduling parameters for machine type
14569 @var{cpu_type}.  The instruction set is not changed.
14571 Native toolchains also support the value @samp{native},
14572 which selects the best architecture option for the host processor.
14573 @option{-mtune=native} has no effect if GCC does not recognize
14574 the processor.
14576 @item -mmemory-latency=@var{time}
14577 @opindex mmemory-latency
14578 Sets the latency the scheduler should assume for typical memory
14579 references as seen by the application.  This number is highly
14580 dependent on the memory access patterns used by the application
14581 and the size of the external cache on the machine.
14583 Valid options for @var{time} are
14585 @table @samp
14586 @item @var{number}
14587 A decimal number representing clock cycles.
14589 @item L1
14590 @itemx L2
14591 @itemx L3
14592 @itemx main
14593 The compiler contains estimates of the number of clock cycles for
14594 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14595 (also called Dcache, Scache, and Bcache), as well as to main memory.
14596 Note that L3 is only valid for EV5.
14598 @end table
14599 @end table
14601 @node FR30 Options
14602 @subsection FR30 Options
14603 @cindex FR30 Options
14605 These options are defined specifically for the FR30 port.
14607 @table @gcctabopt
14609 @item -msmall-model
14610 @opindex msmall-model
14611 Use the small address space model.  This can produce smaller code, but
14612 it does assume that all symbolic values and addresses fit into a
14613 20-bit range.
14615 @item -mno-lsim
14616 @opindex mno-lsim
14617 Assume that runtime support has been provided and so there is no need
14618 to include the simulator library (@file{libsim.a}) on the linker
14619 command line.
14621 @end table
14623 @node FRV Options
14624 @subsection FRV Options
14625 @cindex FRV Options
14627 @table @gcctabopt
14628 @item -mgpr-32
14629 @opindex mgpr-32
14631 Only use the first 32 general-purpose registers.
14633 @item -mgpr-64
14634 @opindex mgpr-64
14636 Use all 64 general-purpose registers.
14638 @item -mfpr-32
14639 @opindex mfpr-32
14641 Use only the first 32 floating-point registers.
14643 @item -mfpr-64
14644 @opindex mfpr-64
14646 Use all 64 floating-point registers.
14648 @item -mhard-float
14649 @opindex mhard-float
14651 Use hardware instructions for floating-point operations.
14653 @item -msoft-float
14654 @opindex msoft-float
14656 Use library routines for floating-point operations.
14658 @item -malloc-cc
14659 @opindex malloc-cc
14661 Dynamically allocate condition code registers.
14663 @item -mfixed-cc
14664 @opindex mfixed-cc
14666 Do not try to dynamically allocate condition code registers, only
14667 use @code{icc0} and @code{fcc0}.
14669 @item -mdword
14670 @opindex mdword
14672 Change ABI to use double word insns.
14674 @item -mno-dword
14675 @opindex mno-dword
14677 Do not use double word instructions.
14679 @item -mdouble
14680 @opindex mdouble
14682 Use floating-point double instructions.
14684 @item -mno-double
14685 @opindex mno-double
14687 Do not use floating-point double instructions.
14689 @item -mmedia
14690 @opindex mmedia
14692 Use media instructions.
14694 @item -mno-media
14695 @opindex mno-media
14697 Do not use media instructions.
14699 @item -mmuladd
14700 @opindex mmuladd
14702 Use multiply and add/subtract instructions.
14704 @item -mno-muladd
14705 @opindex mno-muladd
14707 Do not use multiply and add/subtract instructions.
14709 @item -mfdpic
14710 @opindex mfdpic
14712 Select the FDPIC ABI, which uses function descriptors to represent
14713 pointers to functions.  Without any PIC/PIE-related options, it
14714 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14715 assumes GOT entries and small data are within a 12-bit range from the
14716 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14717 are computed with 32 bits.
14718 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14720 @item -minline-plt
14721 @opindex minline-plt
14723 Enable inlining of PLT entries in function calls to functions that are
14724 not known to bind locally.  It has no effect without @option{-mfdpic}.
14725 It's enabled by default if optimizing for speed and compiling for
14726 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14727 optimization option such as @option{-O3} or above is present in the
14728 command line.
14730 @item -mTLS
14731 @opindex mTLS
14733 Assume a large TLS segment when generating thread-local code.
14735 @item -mtls
14736 @opindex mtls
14738 Do not assume a large TLS segment when generating thread-local code.
14740 @item -mgprel-ro
14741 @opindex mgprel-ro
14743 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14744 that is known to be in read-only sections.  It's enabled by default,
14745 except for @option{-fpic} or @option{-fpie}: even though it may help
14746 make the global offset table smaller, it trades 1 instruction for 4.
14747 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14748 one of which may be shared by multiple symbols, and it avoids the need
14749 for a GOT entry for the referenced symbol, so it's more likely to be a
14750 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14752 @item -multilib-library-pic
14753 @opindex multilib-library-pic
14755 Link with the (library, not FD) pic libraries.  It's implied by
14756 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14757 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14758 it explicitly.
14760 @item -mlinked-fp
14761 @opindex mlinked-fp
14763 Follow the EABI requirement of always creating a frame pointer whenever
14764 a stack frame is allocated.  This option is enabled by default and can
14765 be disabled with @option{-mno-linked-fp}.
14767 @item -mlong-calls
14768 @opindex mlong-calls
14770 Use indirect addressing to call functions outside the current
14771 compilation unit.  This allows the functions to be placed anywhere
14772 within the 32-bit address space.
14774 @item -malign-labels
14775 @opindex malign-labels
14777 Try to align labels to an 8-byte boundary by inserting NOPs into the
14778 previous packet.  This option only has an effect when VLIW packing
14779 is enabled.  It doesn't create new packets; it merely adds NOPs to
14780 existing ones.
14782 @item -mlibrary-pic
14783 @opindex mlibrary-pic
14785 Generate position-independent EABI code.
14787 @item -macc-4
14788 @opindex macc-4
14790 Use only the first four media accumulator registers.
14792 @item -macc-8
14793 @opindex macc-8
14795 Use all eight media accumulator registers.
14797 @item -mpack
14798 @opindex mpack
14800 Pack VLIW instructions.
14802 @item -mno-pack
14803 @opindex mno-pack
14805 Do not pack VLIW instructions.
14807 @item -mno-eflags
14808 @opindex mno-eflags
14810 Do not mark ABI switches in e_flags.
14812 @item -mcond-move
14813 @opindex mcond-move
14815 Enable the use of conditional-move instructions (default).
14817 This switch is mainly for debugging the compiler and will likely be removed
14818 in a future version.
14820 @item -mno-cond-move
14821 @opindex mno-cond-move
14823 Disable the use of conditional-move instructions.
14825 This switch is mainly for debugging the compiler and will likely be removed
14826 in a future version.
14828 @item -mscc
14829 @opindex mscc
14831 Enable the use of conditional set instructions (default).
14833 This switch is mainly for debugging the compiler and will likely be removed
14834 in a future version.
14836 @item -mno-scc
14837 @opindex mno-scc
14839 Disable the use of conditional set instructions.
14841 This switch is mainly for debugging the compiler and will likely be removed
14842 in a future version.
14844 @item -mcond-exec
14845 @opindex mcond-exec
14847 Enable the use of conditional execution (default).
14849 This switch is mainly for debugging the compiler and will likely be removed
14850 in a future version.
14852 @item -mno-cond-exec
14853 @opindex mno-cond-exec
14855 Disable the use of conditional execution.
14857 This switch is mainly for debugging the compiler and will likely be removed
14858 in a future version.
14860 @item -mvliw-branch
14861 @opindex mvliw-branch
14863 Run a pass to pack branches into VLIW instructions (default).
14865 This switch is mainly for debugging the compiler and will likely be removed
14866 in a future version.
14868 @item -mno-vliw-branch
14869 @opindex mno-vliw-branch
14871 Do not run a pass to pack branches into VLIW instructions.
14873 This switch is mainly for debugging the compiler and will likely be removed
14874 in a future version.
14876 @item -mmulti-cond-exec
14877 @opindex mmulti-cond-exec
14879 Enable optimization of @code{&&} and @code{||} in conditional execution
14880 (default).
14882 This switch is mainly for debugging the compiler and will likely be removed
14883 in a future version.
14885 @item -mno-multi-cond-exec
14886 @opindex mno-multi-cond-exec
14888 Disable optimization of @code{&&} and @code{||} in conditional execution.
14890 This switch is mainly for debugging the compiler and will likely be removed
14891 in a future version.
14893 @item -mnested-cond-exec
14894 @opindex mnested-cond-exec
14896 Enable nested conditional execution optimizations (default).
14898 This switch is mainly for debugging the compiler and will likely be removed
14899 in a future version.
14901 @item -mno-nested-cond-exec
14902 @opindex mno-nested-cond-exec
14904 Disable nested conditional execution optimizations.
14906 This switch is mainly for debugging the compiler and will likely be removed
14907 in a future version.
14909 @item -moptimize-membar
14910 @opindex moptimize-membar
14912 This switch removes redundant @code{membar} instructions from the
14913 compiler-generated code.  It is enabled by default.
14915 @item -mno-optimize-membar
14916 @opindex mno-optimize-membar
14918 This switch disables the automatic removal of redundant @code{membar}
14919 instructions from the generated code.
14921 @item -mtomcat-stats
14922 @opindex mtomcat-stats
14924 Cause gas to print out tomcat statistics.
14926 @item -mcpu=@var{cpu}
14927 @opindex mcpu
14929 Select the processor type for which to generate code.  Possible values are
14930 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14931 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14933 @end table
14935 @node GNU/Linux Options
14936 @subsection GNU/Linux Options
14938 These @samp{-m} options are defined for GNU/Linux targets:
14940 @table @gcctabopt
14941 @item -mglibc
14942 @opindex mglibc
14943 Use the GNU C library.  This is the default except
14944 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14946 @item -muclibc
14947 @opindex muclibc
14948 Use uClibc C library.  This is the default on
14949 @samp{*-*-linux-*uclibc*} targets.
14951 @item -mbionic
14952 @opindex mbionic
14953 Use Bionic C library.  This is the default on
14954 @samp{*-*-linux-*android*} targets.
14956 @item -mandroid
14957 @opindex mandroid
14958 Compile code compatible with Android platform.  This is the default on
14959 @samp{*-*-linux-*android*} targets.
14961 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14962 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14963 this option makes the GCC driver pass Android-specific options to the linker.
14964 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14965 to be defined.
14967 @item -tno-android-cc
14968 @opindex tno-android-cc
14969 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14970 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14971 @option{-fno-rtti} by default.
14973 @item -tno-android-ld
14974 @opindex tno-android-ld
14975 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14976 linking options to the linker.
14978 @end table
14980 @node H8/300 Options
14981 @subsection H8/300 Options
14983 These @samp{-m} options are defined for the H8/300 implementations:
14985 @table @gcctabopt
14986 @item -mrelax
14987 @opindex mrelax
14988 Shorten some address references at link time, when possible; uses the
14989 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14990 ld, Using ld}, for a fuller description.
14992 @item -mh
14993 @opindex mh
14994 Generate code for the H8/300H@.
14996 @item -ms
14997 @opindex ms
14998 Generate code for the H8S@.
15000 @item -mn
15001 @opindex mn
15002 Generate code for the H8S and H8/300H in the normal mode.  This switch
15003 must be used either with @option{-mh} or @option{-ms}.
15005 @item -ms2600
15006 @opindex ms2600
15007 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
15009 @item -mexr
15010 @opindex mexr
15011 Extended registers are stored on stack before execution of function
15012 with monitor attribute. Default option is @option{-mexr}.
15013 This option is valid only for H8S targets.
15015 @item -mno-exr
15016 @opindex mno-exr
15017 Extended registers are not stored on stack before execution of function 
15018 with monitor attribute. Default option is @option{-mno-exr}. 
15019 This option is valid only for H8S targets.
15021 @item -mint32
15022 @opindex mint32
15023 Make @code{int} data 32 bits by default.
15025 @item -malign-300
15026 @opindex malign-300
15027 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
15028 The default for the H8/300H and H8S is to align longs and floats on
15029 4-byte boundaries.
15030 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
15031 This option has no effect on the H8/300.
15032 @end table
15034 @node HPPA Options
15035 @subsection HPPA Options
15036 @cindex HPPA Options
15038 These @samp{-m} options are defined for the HPPA family of computers:
15040 @table @gcctabopt
15041 @item -march=@var{architecture-type}
15042 @opindex march
15043 Generate code for the specified architecture.  The choices for
15044 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
15045 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
15046 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
15047 architecture option for your machine.  Code compiled for lower numbered
15048 architectures runs on higher numbered architectures, but not the
15049 other way around.
15051 @item -mpa-risc-1-0
15052 @itemx -mpa-risc-1-1
15053 @itemx -mpa-risc-2-0
15054 @opindex mpa-risc-1-0
15055 @opindex mpa-risc-1-1
15056 @opindex mpa-risc-2-0
15057 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
15059 @item -mjump-in-delay
15060 @opindex mjump-in-delay
15061 This option is ignored and provided for compatibility purposes only.
15063 @item -mdisable-fpregs
15064 @opindex mdisable-fpregs
15065 Prevent floating-point registers from being used in any manner.  This is
15066 necessary for compiling kernels that perform lazy context switching of
15067 floating-point registers.  If you use this option and attempt to perform
15068 floating-point operations, the compiler aborts.
15070 @item -mdisable-indexing
15071 @opindex mdisable-indexing
15072 Prevent the compiler from using indexing address modes.  This avoids some
15073 rather obscure problems when compiling MIG generated code under MACH@.
15075 @item -mno-space-regs
15076 @opindex mno-space-regs
15077 Generate code that assumes the target has no space registers.  This allows
15078 GCC to generate faster indirect calls and use unscaled index address modes.
15080 Such code is suitable for level 0 PA systems and kernels.
15082 @item -mfast-indirect-calls
15083 @opindex mfast-indirect-calls
15084 Generate code that assumes calls never cross space boundaries.  This
15085 allows GCC to emit code that performs faster indirect calls.
15087 This option does not work in the presence of shared libraries or nested
15088 functions.
15090 @item -mfixed-range=@var{register-range}
15091 @opindex mfixed-range
15092 Generate code treating the given register range as fixed registers.
15093 A fixed register is one that the register allocator cannot use.  This is
15094 useful when compiling kernel code.  A register range is specified as
15095 two registers separated by a dash.  Multiple register ranges can be
15096 specified separated by a comma.
15098 @item -mlong-load-store
15099 @opindex mlong-load-store
15100 Generate 3-instruction load and store sequences as sometimes required by
15101 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
15102 the HP compilers.
15104 @item -mportable-runtime
15105 @opindex mportable-runtime
15106 Use the portable calling conventions proposed by HP for ELF systems.
15108 @item -mgas
15109 @opindex mgas
15110 Enable the use of assembler directives only GAS understands.
15112 @item -mschedule=@var{cpu-type}
15113 @opindex mschedule
15114 Schedule code according to the constraints for the machine type
15115 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
15116 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
15117 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
15118 proper scheduling option for your machine.  The default scheduling is
15119 @samp{8000}.
15121 @item -mlinker-opt
15122 @opindex mlinker-opt
15123 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
15124 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
15125 linkers in which they give bogus error messages when linking some programs.
15127 @item -msoft-float
15128 @opindex msoft-float
15129 Generate output containing library calls for floating point.
15130 @strong{Warning:} the requisite libraries are not available for all HPPA
15131 targets.  Normally the facilities of the machine's usual C compiler are
15132 used, but this cannot be done directly in cross-compilation.  You must make
15133 your own arrangements to provide suitable library functions for
15134 cross-compilation.
15136 @option{-msoft-float} changes the calling convention in the output file;
15137 therefore, it is only useful if you compile @emph{all} of a program with
15138 this option.  In particular, you need to compile @file{libgcc.a}, the
15139 library that comes with GCC, with @option{-msoft-float} in order for
15140 this to work.
15142 @item -msio
15143 @opindex msio
15144 Generate the predefine, @code{_SIO}, for server IO@.  The default is
15145 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
15146 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
15147 options are available under HP-UX and HI-UX@.
15149 @item -mgnu-ld
15150 @opindex mgnu-ld
15151 Use options specific to GNU @command{ld}.
15152 This passes @option{-shared} to @command{ld} when
15153 building a shared library.  It is the default when GCC is configured,
15154 explicitly or implicitly, with the GNU linker.  This option does not
15155 affect which @command{ld} is called; it only changes what parameters
15156 are passed to that @command{ld}.
15157 The @command{ld} that is called is determined by the
15158 @option{--with-ld} configure option, GCC's program search path, and
15159 finally by the user's @env{PATH}.  The linker used by GCC can be printed
15160 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
15161 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15163 @item -mhp-ld
15164 @opindex mhp-ld
15165 Use options specific to HP @command{ld}.
15166 This passes @option{-b} to @command{ld} when building
15167 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
15168 links.  It is the default when GCC is configured, explicitly or
15169 implicitly, with the HP linker.  This option does not affect
15170 which @command{ld} is called; it only changes what parameters are passed to that
15171 @command{ld}.
15172 The @command{ld} that is called is determined by the @option{--with-ld}
15173 configure option, GCC's program search path, and finally by the user's
15174 @env{PATH}.  The linker used by GCC can be printed using @samp{which
15175 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
15176 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
15178 @item -mlong-calls
15179 @opindex mno-long-calls
15180 Generate code that uses long call sequences.  This ensures that a call
15181 is always able to reach linker generated stubs.  The default is to generate
15182 long calls only when the distance from the call site to the beginning
15183 of the function or translation unit, as the case may be, exceeds a
15184 predefined limit set by the branch type being used.  The limits for
15185 normal calls are 7,600,000 and 240,000 bytes, respectively for the
15186 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
15187 240,000 bytes.
15189 Distances are measured from the beginning of functions when using the
15190 @option{-ffunction-sections} option, or when using the @option{-mgas}
15191 and @option{-mno-portable-runtime} options together under HP-UX with
15192 the SOM linker.
15194 It is normally not desirable to use this option as it degrades
15195 performance.  However, it may be useful in large applications,
15196 particularly when partial linking is used to build the application.
15198 The types of long calls used depends on the capabilities of the
15199 assembler and linker, and the type of code being generated.  The
15200 impact on systems that support long absolute calls, and long pic
15201 symbol-difference or pc-relative calls should be relatively small.
15202 However, an indirect call is used on 32-bit ELF systems in pic code
15203 and it is quite long.
15205 @item -munix=@var{unix-std}
15206 @opindex march
15207 Generate compiler predefines and select a startfile for the specified
15208 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
15209 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
15210 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
15211 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
15212 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
15213 and later.
15215 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
15216 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
15217 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
15218 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
15219 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
15220 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
15222 It is @emph{important} to note that this option changes the interfaces
15223 for various library routines.  It also affects the operational behavior
15224 of the C library.  Thus, @emph{extreme} care is needed in using this
15225 option.
15227 Library code that is intended to operate with more than one UNIX
15228 standard must test, set and restore the variable @var{__xpg4_extended_mask}
15229 as appropriate.  Most GNU software doesn't provide this capability.
15231 @item -nolibdld
15232 @opindex nolibdld
15233 Suppress the generation of link options to search libdld.sl when the
15234 @option{-static} option is specified on HP-UX 10 and later.
15236 @item -static
15237 @opindex static
15238 The HP-UX implementation of setlocale in libc has a dependency on
15239 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
15240 when the @option{-static} option is specified, special link options
15241 are needed to resolve this dependency.
15243 On HP-UX 10 and later, the GCC driver adds the necessary options to
15244 link with libdld.sl when the @option{-static} option is specified.
15245 This causes the resulting binary to be dynamic.  On the 64-bit port,
15246 the linkers generate dynamic binaries by default in any case.  The
15247 @option{-nolibdld} option can be used to prevent the GCC driver from
15248 adding these link options.
15250 @item -threads
15251 @opindex threads
15252 Add support for multithreading with the @dfn{dce thread} library
15253 under HP-UX@.  This option sets flags for both the preprocessor and
15254 linker.
15255 @end table
15257 @node i386 and x86-64 Options
15258 @subsection Intel 386 and AMD x86-64 Options
15259 @cindex i386 Options
15260 @cindex x86-64 Options
15261 @cindex Intel 386 Options
15262 @cindex AMD x86-64 Options
15264 These @samp{-m} options are defined for the i386 and x86-64 family of
15265 computers:
15267 @table @gcctabopt
15269 @item -march=@var{cpu-type}
15270 @opindex march
15271 Generate instructions for the machine type @var{cpu-type}.  In contrast to
15272 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
15273 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
15274 to generate code that may not run at all on processors other than the one
15275 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
15276 @option{-mtune=@var{cpu-type}}.
15278 The choices for @var{cpu-type} are:
15280 @table @samp
15281 @item native
15282 This selects the CPU to generate code for at compilation time by determining
15283 the processor type of the compiling machine.  Using @option{-march=native}
15284 enables all instruction subsets supported by the local machine (hence
15285 the result might not run on different machines).  Using @option{-mtune=native}
15286 produces code optimized for the local machine under the constraints
15287 of the selected instruction set.  
15289 @item i386
15290 Original Intel i386 CPU@.
15292 @item i486
15293 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
15295 @item i586
15296 @itemx pentium
15297 Intel Pentium CPU with no MMX support.
15299 @item pentium-mmx
15300 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
15302 @item pentiumpro
15303 Intel Pentium Pro CPU@.
15305 @item i686
15306 When used with @option{-march}, the Pentium Pro
15307 instruction set is used, so the code runs on all i686 family chips.
15308 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
15310 @item pentium2
15311 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
15312 support.
15314 @item pentium3
15315 @itemx pentium3m
15316 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
15317 set support.
15319 @item pentium-m
15320 Intel Pentium M; low-power version of Intel Pentium III CPU
15321 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
15323 @item pentium4
15324 @itemx pentium4m
15325 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
15327 @item prescott
15328 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
15329 set support.
15331 @item nocona
15332 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
15333 SSE2 and SSE3 instruction set support.
15335 @item core2
15336 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
15337 instruction set support.
15339 @item nehalem
15340 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15341 SSE4.1, SSE4.2 and POPCNT instruction set support.
15343 @item westmere
15344 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15345 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
15347 @item sandybridge
15348 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15349 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
15351 @item ivybridge
15352 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
15353 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
15354 instruction set support.
15356 @item haswell
15357 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15358 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15359 BMI, BMI2 and F16C instruction set support.
15361 @item broadwell
15362 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15363 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
15364 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
15366 @item bonnell
15367 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
15368 instruction set support.
15370 @item silvermont
15371 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
15372 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
15374 @item k6
15375 AMD K6 CPU with MMX instruction set support.
15377 @item k6-2
15378 @itemx k6-3
15379 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
15381 @item athlon
15382 @itemx athlon-tbird
15383 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
15384 support.
15386 @item athlon-4
15387 @itemx athlon-xp
15388 @itemx athlon-mp
15389 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
15390 instruction set support.
15392 @item k8
15393 @itemx opteron
15394 @itemx athlon64
15395 @itemx athlon-fx
15396 Processors based on the AMD K8 core with x86-64 instruction set support,
15397 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
15398 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
15399 instruction set extensions.)
15401 @item k8-sse3
15402 @itemx opteron-sse3
15403 @itemx athlon64-sse3
15404 Improved versions of AMD K8 cores with SSE3 instruction set support.
15406 @item amdfam10
15407 @itemx barcelona
15408 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
15409 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
15410 instruction set extensions.)
15412 @item bdver1
15413 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
15414 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
15415 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
15416 @item bdver2
15417 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15418 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
15419 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
15420 extensions.)
15421 @item bdver3
15422 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15423 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
15424 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
15425 64-bit instruction set extensions.
15426 @item bdver4
15427 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
15428 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
15429 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
15430 SSE4.2, ABM and 64-bit instruction set extensions.
15432 @item btver1
15433 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
15434 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
15435 instruction set extensions.)
15437 @item btver2
15438 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
15439 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
15440 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
15442 @item winchip-c6
15443 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
15444 set support.
15446 @item winchip2
15447 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
15448 instruction set support.
15450 @item c3
15451 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
15452 implemented for this chip.)
15454 @item c3-2
15455 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
15456 (No scheduling is
15457 implemented for this chip.)
15459 @item geode
15460 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
15461 @end table
15463 @item -mtune=@var{cpu-type}
15464 @opindex mtune
15465 Tune to @var{cpu-type} everything applicable about the generated code, except
15466 for the ABI and the set of available instructions.  
15467 While picking a specific @var{cpu-type} schedules things appropriately
15468 for that particular chip, the compiler does not generate any code that
15469 cannot run on the default machine type unless you use a
15470 @option{-march=@var{cpu-type}} option.
15471 For example, if GCC is configured for i686-pc-linux-gnu
15472 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
15473 but still runs on i686 machines.
15475 The choices for @var{cpu-type} are the same as for @option{-march}.
15476 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
15478 @table @samp
15479 @item generic
15480 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
15481 If you know the CPU on which your code will run, then you should use
15482 the corresponding @option{-mtune} or @option{-march} option instead of
15483 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
15484 of your application will have, then you should use this option.
15486 As new processors are deployed in the marketplace, the behavior of this
15487 option will change.  Therefore, if you upgrade to a newer version of
15488 GCC, code generation controlled by this option will change to reflect
15489 the processors
15490 that are most common at the time that version of GCC is released.
15492 There is no @option{-march=generic} option because @option{-march}
15493 indicates the instruction set the compiler can use, and there is no
15494 generic instruction set applicable to all processors.  In contrast,
15495 @option{-mtune} indicates the processor (or, in this case, collection of
15496 processors) for which the code is optimized.
15498 @item intel
15499 Produce code optimized for the most current Intel processors, which are
15500 Haswell and Silvermont for this version of GCC.  If you know the CPU
15501 on which your code will run, then you should use the corresponding
15502 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
15503 But, if you want your application performs better on both Haswell and
15504 Silvermont, then you should use this option.
15506 As new Intel processors are deployed in the marketplace, the behavior of
15507 this option will change.  Therefore, if you upgrade to a newer version of
15508 GCC, code generation controlled by this option will change to reflect
15509 the most current Intel processors at the time that version of GCC is
15510 released.
15512 There is no @option{-march=intel} option because @option{-march} indicates
15513 the instruction set the compiler can use, and there is no common
15514 instruction set applicable to all processors.  In contrast,
15515 @option{-mtune} indicates the processor (or, in this case, collection of
15516 processors) for which the code is optimized.
15517 @end table
15519 @item -mcpu=@var{cpu-type}
15520 @opindex mcpu
15521 A deprecated synonym for @option{-mtune}.
15523 @item -mfpmath=@var{unit}
15524 @opindex mfpmath
15525 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
15526 for @var{unit} are:
15528 @table @samp
15529 @item 387
15530 Use the standard 387 floating-point coprocessor present on the majority of chips and
15531 emulated otherwise.  Code compiled with this option runs almost everywhere.
15532 The temporary results are computed in 80-bit precision instead of the precision
15533 specified by the type, resulting in slightly different results compared to most
15534 of other chips.  See @option{-ffloat-store} for more detailed description.
15536 This is the default choice for i386 compiler.
15538 @item sse
15539 Use scalar floating-point instructions present in the SSE instruction set.
15540 This instruction set is supported by Pentium III and newer chips,
15541 and in the AMD line
15542 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
15543 instruction set supports only single-precision arithmetic, thus the double and
15544 extended-precision arithmetic are still done using 387.  A later version, present
15545 only in Pentium 4 and AMD x86-64 chips, supports double-precision
15546 arithmetic too.
15548 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
15549 or @option{-msse2} switches to enable SSE extensions and make this option
15550 effective.  For the x86-64 compiler, these extensions are enabled by default.
15552 The resulting code should be considerably faster in the majority of cases and avoid
15553 the numerical instability problems of 387 code, but may break some existing
15554 code that expects temporaries to be 80 bits.
15556 This is the default choice for the x86-64 compiler.
15558 @item sse,387
15559 @itemx sse+387
15560 @itemx both
15561 Attempt to utilize both instruction sets at once.  This effectively doubles the
15562 amount of available registers, and on chips with separate execution units for
15563 387 and SSE the execution resources too.  Use this option with care, as it is
15564 still experimental, because the GCC register allocator does not model separate
15565 functional units well, resulting in unstable performance.
15566 @end table
15568 @item -masm=@var{dialect}
15569 @opindex masm=@var{dialect}
15570 Output assembly instructions using selected @var{dialect}.  Supported
15571 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15572 not support @samp{intel}.
15574 @item -mieee-fp
15575 @itemx -mno-ieee-fp
15576 @opindex mieee-fp
15577 @opindex mno-ieee-fp
15578 Control whether or not the compiler uses IEEE floating-point
15579 comparisons.  These correctly handle the case where the result of a
15580 comparison is unordered.
15582 @item -msoft-float
15583 @opindex msoft-float
15584 Generate output containing library calls for floating point.
15586 @strong{Warning:} the requisite libraries are not part of GCC@.
15587 Normally the facilities of the machine's usual C compiler are used, but
15588 this can't be done directly in cross-compilation.  You must make your
15589 own arrangements to provide suitable library functions for
15590 cross-compilation.
15592 On machines where a function returns floating-point results in the 80387
15593 register stack, some floating-point opcodes may be emitted even if
15594 @option{-msoft-float} is used.
15596 @item -mno-fp-ret-in-387
15597 @opindex mno-fp-ret-in-387
15598 Do not use the FPU registers for return values of functions.
15600 The usual calling convention has functions return values of types
15601 @code{float} and @code{double} in an FPU register, even if there
15602 is no FPU@.  The idea is that the operating system should emulate
15603 an FPU@.
15605 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15606 in ordinary CPU registers instead.
15608 @item -mno-fancy-math-387
15609 @opindex mno-fancy-math-387
15610 Some 387 emulators do not support the @code{sin}, @code{cos} and
15611 @code{sqrt} instructions for the 387.  Specify this option to avoid
15612 generating those instructions.  This option is the default on FreeBSD,
15613 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15614 indicates that the target CPU always has an FPU and so the
15615 instruction does not need emulation.  These
15616 instructions are not generated unless you also use the
15617 @option{-funsafe-math-optimizations} switch.
15619 @item -malign-double
15620 @itemx -mno-align-double
15621 @opindex malign-double
15622 @opindex mno-align-double
15623 Control whether GCC aligns @code{double}, @code{long double}, and
15624 @code{long long} variables on a two-word boundary or a one-word
15625 boundary.  Aligning @code{double} variables on a two-word boundary
15626 produces code that runs somewhat faster on a Pentium at the
15627 expense of more memory.
15629 On x86-64, @option{-malign-double} is enabled by default.
15631 @strong{Warning:} if you use the @option{-malign-double} switch,
15632 structures containing the above types are aligned differently than
15633 the published application binary interface specifications for the 386
15634 and are not binary compatible with structures in code compiled
15635 without that switch.
15637 @item -m96bit-long-double
15638 @itemx -m128bit-long-double
15639 @opindex m96bit-long-double
15640 @opindex m128bit-long-double
15641 These switches control the size of @code{long double} type.  The i386
15642 application binary interface specifies the size to be 96 bits,
15643 so @option{-m96bit-long-double} is the default in 32-bit mode.
15645 Modern architectures (Pentium and newer) prefer @code{long double}
15646 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15647 conforming to the ABI, this is not possible.  So specifying
15648 @option{-m128bit-long-double} aligns @code{long double}
15649 to a 16-byte boundary by padding the @code{long double} with an additional
15650 32-bit zero.
15652 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15653 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15655 Notice that neither of these options enable any extra precision over the x87
15656 standard of 80 bits for a @code{long double}.
15658 @strong{Warning:} if you override the default value for your target ABI, this
15659 changes the size of 
15660 structures and arrays containing @code{long double} variables,
15661 as well as modifying the function calling convention for functions taking
15662 @code{long double}.  Hence they are not binary-compatible
15663 with code compiled without that switch.
15665 @item -mlong-double-64
15666 @itemx -mlong-double-80
15667 @itemx -mlong-double-128
15668 @opindex mlong-double-64
15669 @opindex mlong-double-80
15670 @opindex mlong-double-128
15671 These switches control the size of @code{long double} type. A size
15672 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15673 type. This is the default for 32-bit Bionic C library.  A size
15674 of 128 bits makes the @code{long double} type equivalent to the
15675 @code{__float128} type. This is the default for 64-bit Bionic C library.
15677 @strong{Warning:} if you override the default value for your target ABI, this
15678 changes the size of
15679 structures and arrays containing @code{long double} variables,
15680 as well as modifying the function calling convention for functions taking
15681 @code{long double}.  Hence they are not binary-compatible
15682 with code compiled without that switch.
15684 @item -malign-data=@var{type}
15685 @opindex malign-data
15686 Control how GCC aligns variables.  Supported values for @var{type} are
15687 @samp{compat} uses increased alignment value compatible uses GCC 4.8
15688 and earlier, @samp{abi} uses alignment value as specified by the
15689 psABI, and @samp{cacheline} uses increased alignment value to match
15690 the cache line size.  @samp{compat} is the default.
15692 @item -mlarge-data-threshold=@var{threshold}
15693 @opindex mlarge-data-threshold
15694 When @option{-mcmodel=medium} is specified, data objects larger than
15695 @var{threshold} are placed in the large data section.  This value must be the
15696 same across all objects linked into the binary, and defaults to 65535.
15698 @item -mrtd
15699 @opindex mrtd
15700 Use a different function-calling convention, in which functions that
15701 take a fixed number of arguments return with the @code{ret @var{num}}
15702 instruction, which pops their arguments while returning.  This saves one
15703 instruction in the caller since there is no need to pop the arguments
15704 there.
15706 You can specify that an individual function is called with this calling
15707 sequence with the function attribute @samp{stdcall}.  You can also
15708 override the @option{-mrtd} option by using the function attribute
15709 @samp{cdecl}.  @xref{Function Attributes}.
15711 @strong{Warning:} this calling convention is incompatible with the one
15712 normally used on Unix, so you cannot use it if you need to call
15713 libraries compiled with the Unix compiler.
15715 Also, you must provide function prototypes for all functions that
15716 take variable numbers of arguments (including @code{printf});
15717 otherwise incorrect code is generated for calls to those
15718 functions.
15720 In addition, seriously incorrect code results if you call a
15721 function with too many arguments.  (Normally, extra arguments are
15722 harmlessly ignored.)
15724 @item -mregparm=@var{num}
15725 @opindex mregparm
15726 Control how many registers are used to pass integer arguments.  By
15727 default, no registers are used to pass arguments, and at most 3
15728 registers can be used.  You can control this behavior for a specific
15729 function by using the function attribute @samp{regparm}.
15730 @xref{Function Attributes}.
15732 @strong{Warning:} if you use this switch, and
15733 @var{num} is nonzero, then you must build all modules with the same
15734 value, including any libraries.  This includes the system libraries and
15735 startup modules.
15737 @item -msseregparm
15738 @opindex msseregparm
15739 Use SSE register passing conventions for float and double arguments
15740 and return values.  You can control this behavior for a specific
15741 function by using the function attribute @samp{sseregparm}.
15742 @xref{Function Attributes}.
15744 @strong{Warning:} if you use this switch then you must build all
15745 modules with the same value, including any libraries.  This includes
15746 the system libraries and startup modules.
15748 @item -mvect8-ret-in-mem
15749 @opindex mvect8-ret-in-mem
15750 Return 8-byte vectors in memory instead of MMX registers.  This is the
15751 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15752 Studio compilers until version 12.  Later compiler versions (starting
15753 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15754 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15755 you need to remain compatible with existing code produced by those
15756 previous compiler versions or older versions of GCC@.
15758 @item -mpc32
15759 @itemx -mpc64
15760 @itemx -mpc80
15761 @opindex mpc32
15762 @opindex mpc64
15763 @opindex mpc80
15765 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15766 is specified, the significands of results of floating-point operations are
15767 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15768 significands of results of floating-point operations to 53 bits (double
15769 precision) and @option{-mpc80} rounds the significands of results of
15770 floating-point operations to 64 bits (extended double precision), which is
15771 the default.  When this option is used, floating-point operations in higher
15772 precisions are not available to the programmer without setting the FPU
15773 control word explicitly.
15775 Setting the rounding of floating-point operations to less than the default
15776 80 bits can speed some programs by 2% or more.  Note that some mathematical
15777 libraries assume that extended-precision (80-bit) floating-point operations
15778 are enabled by default; routines in such libraries could suffer significant
15779 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15780 when this option is used to set the precision to less than extended precision.
15782 @item -mstackrealign
15783 @opindex mstackrealign
15784 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15785 option generates an alternate prologue and epilogue that realigns the
15786 run-time stack if necessary.  This supports mixing legacy codes that keep
15787 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15788 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15789 applicable to individual functions.
15791 @item -mpreferred-stack-boundary=@var{num}
15792 @opindex mpreferred-stack-boundary
15793 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15794 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15795 the default is 4 (16 bytes or 128 bits).
15797 @strong{Warning:} When generating code for the x86-64 architecture with
15798 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15799 used to keep the stack boundary aligned to 8 byte boundary.  Since
15800 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15801 intended to be used in controlled environment where stack space is
15802 important limitation.  This option will lead to wrong code when functions
15803 compiled with 16 byte stack alignment (such as functions from a standard
15804 library) are called with misaligned stack.  In this case, SSE
15805 instructions may lead to misaligned memory access traps.  In addition,
15806 variable arguments will be handled incorrectly for 16 byte aligned
15807 objects (including x87 long double and __int128), leading to wrong
15808 results.  You must build all modules with
15809 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15810 includes the system libraries and startup modules.
15812 @item -mincoming-stack-boundary=@var{num}
15813 @opindex mincoming-stack-boundary
15814 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15815 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15816 the one specified by @option{-mpreferred-stack-boundary} is used.
15818 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15819 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15820 suffer significant run time performance penalties.  On Pentium III, the
15821 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15822 properly if it is not 16-byte aligned.
15824 To ensure proper alignment of this values on the stack, the stack boundary
15825 must be as aligned as that required by any value stored on the stack.
15826 Further, every function must be generated such that it keeps the stack
15827 aligned.  Thus calling a function compiled with a higher preferred
15828 stack boundary from a function compiled with a lower preferred stack
15829 boundary most likely misaligns the stack.  It is recommended that
15830 libraries that use callbacks always use the default setting.
15832 This extra alignment does consume extra stack space, and generally
15833 increases code size.  Code that is sensitive to stack space usage, such
15834 as embedded systems and operating system kernels, may want to reduce the
15835 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15837 @item -mmmx
15838 @itemx -mno-mmx
15839 @itemx -msse
15840 @itemx -mno-sse
15841 @itemx -msse2
15842 @itemx -mno-sse2
15843 @itemx -msse3
15844 @itemx -mno-sse3
15845 @itemx -mssse3
15846 @itemx -mno-ssse3
15847 @itemx -msse4.1
15848 @need 800
15849 @itemx -mno-sse4.1
15850 @itemx -msse4.2
15851 @itemx -mno-sse4.2
15852 @itemx -msse4
15853 @itemx -mno-sse4
15854 @itemx -mavx
15855 @itemx -mno-avx
15856 @itemx -mavx2
15857 @itemx -mno-avx2
15858 @itemx -mavx512f
15859 @itemx -mno-avx512f
15860 @need 800
15861 @itemx -mavx512pf
15862 @itemx -mno-avx512pf
15863 @itemx -mavx512er
15864 @itemx -mno-avx512er
15865 @itemx -mavx512cd
15866 @itemx -mno-avx512cd
15867 @itemx -msha
15868 @itemx -mno-sha
15869 @itemx -maes
15870 @itemx -mno-aes
15871 @itemx -mpclmul
15872 @itemx -mno-pclmul
15873 @itemx -mclfushopt
15874 @itemx -mno-clflsuhopt
15875 @need 800
15876 @itemx -mfsgsbase
15877 @itemx -mno-fsgsbase
15878 @itemx -mrdrnd
15879 @itemx -mno-rdrnd
15880 @itemx -mf16c
15881 @itemx -mno-f16c
15882 @itemx -mfma
15883 @itemx -mno-fma
15884 @itemx -mprefetchwt1
15885 @itemx -mno-prefetchwt1
15886 @itemx -msse4a
15887 @itemx -mno-sse4a
15888 @itemx -mfma4
15889 @itemx -mno-fma4
15890 @need 800
15891 @itemx -mxop
15892 @itemx -mno-xop
15893 @itemx -mlwp
15894 @itemx -mno-lwp
15895 @itemx -m3dnow
15896 @itemx -mno-3dnow
15897 @itemx -mpopcnt
15898 @itemx -mno-popcnt
15899 @itemx -mabm
15900 @itemx -mno-abm
15901 @itemx -mbmi
15902 @itemx -mbmi2
15903 @itemx -mno-bmi
15904 @itemx -mno-bmi2
15905 @itemx -mlzcnt
15906 @itemx -mno-lzcnt
15907 @itemx -mfxsr
15908 @itemx -mxsave
15909 @itemx -mxsaveopt
15910 @itemx -mrtm
15911 @itemx -mtbm
15912 @itemx -mno-tbm
15913 @itemx -mxsavec
15914 @itemx -mno-xsavec
15915 @itemx -mxsaves
15916 @itemx -mno-xsaves
15917 @itemx -mmpx
15918 @itemx -mno-mpx
15919 @opindex mmmx
15920 @opindex mno-mmx
15921 @opindex msse
15922 @opindex mno-sse
15923 @opindex m3dnow
15924 @opindex mno-3dnow
15925 These switches enable or disable the use of instructions in the MMX, SSE,
15926 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15927 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15928 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, MPX or 3DNow!@:
15929 extended instruction sets.
15930 These extensions are also available as built-in functions: see
15931 @ref{X86 Built-in Functions}, for details of the functions enabled and
15932 disabled by these switches.
15934 To generate SSE/SSE2 instructions automatically from floating-point
15935 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15937 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15938 generates new AVX instructions or AVX equivalence for all SSEx instructions
15939 when needed.
15941 These options enable GCC to use these extended instructions in
15942 generated code, even without @option{-mfpmath=sse}.  Applications that
15943 perform run-time CPU detection must compile separate files for each
15944 supported architecture, using the appropriate flags.  In particular,
15945 the file containing the CPU detection code should be compiled without
15946 these options.
15948 @item -mdump-tune-features
15949 @opindex mdump-tune-features
15950 This option instructs GCC to dump the names of the x86 performance 
15951 tuning features and default settings. The names can be used in 
15952 @option{-mtune-ctrl=@var{feature-list}}.
15954 @item -mtune-ctrl=@var{feature-list}
15955 @opindex mtune-ctrl=@var{feature-list}
15956 This option is used to do fine grain control of x86 code generation features.
15957 @var{feature-list} is a comma separated list of @var{feature} names. See also
15958 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15959 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15960 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15961 developers. Using it may lead to code paths not covered by testing and can
15962 potentially result in compiler ICEs or runtime errors.
15964 @item -mno-default
15965 @opindex mno-default
15966 This option instructs GCC to turn off all tunable features. See also 
15967 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15969 @item -mcld
15970 @opindex mcld
15971 This option instructs GCC to emit a @code{cld} instruction in the prologue
15972 of functions that use string instructions.  String instructions depend on
15973 the DF flag to select between autoincrement or autodecrement mode.  While the
15974 ABI specifies the DF flag to be cleared on function entry, some operating
15975 systems violate this specification by not clearing the DF flag in their
15976 exception dispatchers.  The exception handler can be invoked with the DF flag
15977 set, which leads to wrong direction mode when string instructions are used.
15978 This option can be enabled by default on 32-bit x86 targets by configuring
15979 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15980 instructions can be suppressed with the @option{-mno-cld} compiler option
15981 in this case.
15983 @item -mvzeroupper
15984 @opindex mvzeroupper
15985 This option instructs GCC to emit a @code{vzeroupper} instruction
15986 before a transfer of control flow out of the function to minimize
15987 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15988 intrinsics.
15990 @item -mprefer-avx128
15991 @opindex mprefer-avx128
15992 This option instructs GCC to use 128-bit AVX instructions instead of
15993 256-bit AVX instructions in the auto-vectorizer.
15995 @item -mcx16
15996 @opindex mcx16
15997 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15998 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15999 (or oword) data types.  
16000 This is useful for high-resolution counters that can be updated
16001 by multiple processors (or cores).  This instruction is generated as part of
16002 atomic built-in functions: see @ref{__sync Builtins} or
16003 @ref{__atomic Builtins} for details.
16005 @item -msahf
16006 @opindex msahf
16007 This option enables generation of @code{SAHF} instructions in 64-bit code.
16008 Early Intel Pentium 4 CPUs with Intel 64 support,
16009 prior to the introduction of Pentium 4 G1 step in December 2005,
16010 lacked the @code{LAHF} and @code{SAHF} instructions
16011 which were supported by AMD64.
16012 These are load and store instructions, respectively, for certain status flags.
16013 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
16014 @code{drem}, and @code{remainder} built-in functions;
16015 see @ref{Other Builtins} for details.
16017 @item -mmovbe
16018 @opindex mmovbe
16019 This option enables use of the @code{movbe} instruction to implement
16020 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
16022 @item -mcrc32
16023 @opindex mcrc32
16024 This option enables built-in functions @code{__builtin_ia32_crc32qi},
16025 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
16026 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
16028 @item -mrecip
16029 @opindex mrecip
16030 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
16031 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
16032 with an additional Newton-Raphson step
16033 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
16034 (and their vectorized
16035 variants) for single-precision floating-point arguments.  These instructions
16036 are generated only when @option{-funsafe-math-optimizations} is enabled
16037 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
16038 Note that while the throughput of the sequence is higher than the throughput
16039 of the non-reciprocal instruction, the precision of the sequence can be
16040 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
16042 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
16043 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
16044 combination), and doesn't need @option{-mrecip}.
16046 Also note that GCC emits the above sequence with additional Newton-Raphson step
16047 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
16048 already with @option{-ffast-math} (or the above option combination), and
16049 doesn't need @option{-mrecip}.
16051 @item -mrecip=@var{opt}
16052 @opindex mrecip=opt
16053 This option controls which reciprocal estimate instructions
16054 may be used.  @var{opt} is a comma-separated list of options, which may
16055 be preceded by a @samp{!} to invert the option:
16057 @table @samp
16058 @item all
16059 Enable all estimate instructions.
16061 @item default
16062 Enable the default instructions, equivalent to @option{-mrecip}.
16064 @item none
16065 Disable all estimate instructions, equivalent to @option{-mno-recip}.
16067 @item div
16068 Enable the approximation for scalar division.
16070 @item vec-div
16071 Enable the approximation for vectorized division.
16073 @item sqrt
16074 Enable the approximation for scalar square root.
16076 @item vec-sqrt
16077 Enable the approximation for vectorized square root.
16078 @end table
16080 So, for example, @option{-mrecip=all,!sqrt} enables
16081 all of the reciprocal approximations, except for square root.
16083 @item -mveclibabi=@var{type}
16084 @opindex mveclibabi
16085 Specifies the ABI type to use for vectorizing intrinsics using an
16086 external library.  Supported values for @var{type} are @samp{svml} 
16087 for the Intel short
16088 vector math library and @samp{acml} for the AMD math core library.
16089 To use this option, both @option{-ftree-vectorize} and
16090 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
16091 ABI-compatible library must be specified at link time.
16093 GCC currently emits calls to @code{vmldExp2},
16094 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
16095 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
16096 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
16097 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
16098 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
16099 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
16100 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
16101 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
16102 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
16103 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
16104 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
16105 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
16106 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
16107 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
16108 when @option{-mveclibabi=acml} is used.  
16110 @item -mabi=@var{name}
16111 @opindex mabi
16112 Generate code for the specified calling convention.  Permissible values
16113 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
16114 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
16115 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
16116 You can control this behavior for a specific function by
16117 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
16118 @xref{Function Attributes}.
16120 @item -mtls-dialect=@var{type}
16121 @opindex mtls-dialect
16122 Generate code to access thread-local storage using the @samp{gnu} or
16123 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
16124 @samp{gnu2} is more efficient, but it may add compile- and run-time
16125 requirements that cannot be satisfied on all systems.
16127 @item -mpush-args
16128 @itemx -mno-push-args
16129 @opindex mpush-args
16130 @opindex mno-push-args
16131 Use PUSH operations to store outgoing parameters.  This method is shorter
16132 and usually equally fast as method using SUB/MOV operations and is enabled
16133 by default.  In some cases disabling it may improve performance because of
16134 improved scheduling and reduced dependencies.
16136 @item -maccumulate-outgoing-args
16137 @opindex maccumulate-outgoing-args
16138 If enabled, the maximum amount of space required for outgoing arguments is
16139 computed in the function prologue.  This is faster on most modern CPUs
16140 because of reduced dependencies, improved scheduling and reduced stack usage
16141 when the preferred stack boundary is not equal to 2.  The drawback is a notable
16142 increase in code size.  This switch implies @option{-mno-push-args}.
16144 @item -mthreads
16145 @opindex mthreads
16146 Support thread-safe exception handling on MinGW.  Programs that rely
16147 on thread-safe exception handling must compile and link all code with the
16148 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
16149 @code{-D_MT}; when linking, it links in a special thread helper library
16150 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
16152 @item -mno-align-stringops
16153 @opindex mno-align-stringops
16154 Do not align the destination of inlined string operations.  This switch reduces
16155 code size and improves performance in case the destination is already aligned,
16156 but GCC doesn't know about it.
16158 @item -minline-all-stringops
16159 @opindex minline-all-stringops
16160 By default GCC inlines string operations only when the destination is 
16161 known to be aligned to least a 4-byte boundary.  
16162 This enables more inlining and increases code
16163 size, but may improve performance of code that depends on fast
16164 @code{memcpy}, @code{strlen},
16165 and @code{memset} for short lengths.
16167 @item -minline-stringops-dynamically
16168 @opindex minline-stringops-dynamically
16169 For string operations of unknown size, use run-time checks with
16170 inline code for small blocks and a library call for large blocks.
16172 @item -mstringop-strategy=@var{alg}
16173 @opindex mstringop-strategy=@var{alg}
16174 Override the internal decision heuristic for the particular algorithm to use
16175 for inlining string operations.  The allowed values for @var{alg} are:
16177 @table @samp
16178 @item rep_byte
16179 @itemx rep_4byte
16180 @itemx rep_8byte
16181 Expand using i386 @code{rep} prefix of the specified size.
16183 @item byte_loop
16184 @itemx loop
16185 @itemx unrolled_loop
16186 Expand into an inline loop.
16188 @item libcall
16189 Always use a library call.
16190 @end table
16192 @item -mmemcpy-strategy=@var{strategy}
16193 @opindex mmemcpy-strategy=@var{strategy}
16194 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
16195 should be inlined and what inline algorithm to use when the expected size
16196 of the copy operation is known. @var{strategy} 
16197 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
16198 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
16199 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
16200 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
16201 in the list must be specified in increasing order.  The minimal byte size for 
16202 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
16203 preceding range.
16205 @item -mmemset-strategy=@var{strategy}
16206 @opindex mmemset-strategy=@var{strategy}
16207 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
16208 @code{__builtin_memset} expansion.
16210 @item -momit-leaf-frame-pointer
16211 @opindex momit-leaf-frame-pointer
16212 Don't keep the frame pointer in a register for leaf functions.  This
16213 avoids the instructions to save, set up, and restore frame pointers and
16214 makes an extra register available in leaf functions.  The option
16215 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
16216 which might make debugging harder.
16218 @item -mtls-direct-seg-refs
16219 @itemx -mno-tls-direct-seg-refs
16220 @opindex mtls-direct-seg-refs
16221 Controls whether TLS variables may be accessed with offsets from the
16222 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
16223 or whether the thread base pointer must be added.  Whether or not this
16224 is valid depends on the operating system, and whether it maps the
16225 segment to cover the entire TLS area.
16227 For systems that use the GNU C Library, the default is on.
16229 @item -msse2avx
16230 @itemx -mno-sse2avx
16231 @opindex msse2avx
16232 Specify that the assembler should encode SSE instructions with VEX
16233 prefix.  The option @option{-mavx} turns this on by default.
16235 @item -mfentry
16236 @itemx -mno-fentry
16237 @opindex mfentry
16238 If profiling is active (@option{-pg}), put the profiling
16239 counter call before the prologue.
16240 Note: On x86 architectures the attribute @code{ms_hook_prologue}
16241 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
16243 @item -mrecord-mcount
16244 @itemx -mno-record-mcount
16245 @opindex mrecord-mcount
16246 If profiling is active (@option{-pg}), generate a __mcount_loc section
16247 that contains pointers to each profiling call. This is useful for
16248 automatically patching and out calls.
16250 @item -mnop-mcount
16251 @itemx -mno-nop-mcount
16252 @opindex mnop-mcount
16253 If profiling is active (@option{-pg}), generate the calls to
16254 the profiling functions as nops. This is useful when they
16255 should be patched in later dynamically. This is likely only
16256 useful together with @option{-mrecord-mcount}.
16258 @item -mskip-rax-setup
16259 @itemx -mno-skip-rax-setup
16260 @opindex mskip-rax-setup
16261 When generating code for the x86-64 architecture with SSE extensions
16262 disabled, @option{-skip-rax-setup} can be used to skip setting up RAX
16263 register when there are no variable arguments passed in vector registers.
16265 @strong{Warning:} Since RAX register is used to avoid unnecessarily
16266 saving vector registers on stack when passing variable arguments, the
16267 impacts of this option are callees may waste some stack space,
16268 misbehave or jump to a random location.  GCC 4.4 or newer don't have
16269 those issues, regardless the RAX register value.
16271 @item -m8bit-idiv
16272 @itemx -mno-8bit-idiv
16273 @opindex 8bit-idiv
16274 On some processors, like Intel Atom, 8-bit unsigned integer divide is
16275 much faster than 32-bit/64-bit integer divide.  This option generates a
16276 run-time check.  If both dividend and divisor are within range of 0
16277 to 255, 8-bit unsigned integer divide is used instead of
16278 32-bit/64-bit integer divide.
16280 @item -mavx256-split-unaligned-load
16281 @itemx -mavx256-split-unaligned-store
16282 @opindex avx256-split-unaligned-load
16283 @opindex avx256-split-unaligned-store
16284 Split 32-byte AVX unaligned load and store.
16286 @item -mstack-protector-guard=@var{guard}
16287 @opindex mstack-protector-guard=@var{guard}
16288 Generate stack protection code using canary at @var{guard}.  Supported
16289 locations are @samp{global} for global canary or @samp{tls} for per-thread
16290 canary in the TLS block (the default).  This option has effect only when
16291 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
16293 @end table
16295 These @samp{-m} switches are supported in addition to the above
16296 on x86-64 processors in 64-bit environments.
16298 @table @gcctabopt
16299 @item -m32
16300 @itemx -m64
16301 @itemx -mx32
16302 @itemx -m16
16303 @opindex m32
16304 @opindex m64
16305 @opindex mx32
16306 @opindex m16
16307 Generate code for a 16-bit, 32-bit or 64-bit environment.
16308 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
16309 to 32 bits, and
16310 generates code that runs on any i386 system.
16312 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
16313 types to 64 bits, and generates code for the x86-64 architecture.
16314 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
16315 and @option{-mdynamic-no-pic} options.
16317 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
16318 to 32 bits, and
16319 generates code for the x86-64 architecture.
16321 The @option{-m16} option is the same as @option{-m32}, except for that
16322 it outputs the @code{.code16gcc} assembly directive at the beginning of
16323 the assembly output so that the binary can run in 16-bit mode.
16325 @item -mno-red-zone
16326 @opindex mno-red-zone
16327 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
16328 by the x86-64 ABI; it is a 128-byte area beyond the location of the
16329 stack pointer that is not modified by signal or interrupt handlers
16330 and therefore can be used for temporary data without adjusting the stack
16331 pointer.  The flag @option{-mno-red-zone} disables this red zone.
16333 @item -mcmodel=small
16334 @opindex mcmodel=small
16335 Generate code for the small code model: the program and its symbols must
16336 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
16337 Programs can be statically or dynamically linked.  This is the default
16338 code model.
16340 @item -mcmodel=kernel
16341 @opindex mcmodel=kernel
16342 Generate code for the kernel code model.  The kernel runs in the
16343 negative 2 GB of the address space.
16344 This model has to be used for Linux kernel code.
16346 @item -mcmodel=medium
16347 @opindex mcmodel=medium
16348 Generate code for the medium model: the program is linked in the lower 2
16349 GB of the address space.  Small symbols are also placed there.  Symbols
16350 with sizes larger than @option{-mlarge-data-threshold} are put into
16351 large data or BSS sections and can be located above 2GB.  Programs can
16352 be statically or dynamically linked.
16354 @item -mcmodel=large
16355 @opindex mcmodel=large
16356 Generate code for the large model.  This model makes no assumptions
16357 about addresses and sizes of sections.
16359 @item -maddress-mode=long
16360 @opindex maddress-mode=long
16361 Generate code for long address mode.  This is only supported for 64-bit
16362 and x32 environments.  It is the default address mode for 64-bit
16363 environments.
16365 @item -maddress-mode=short
16366 @opindex maddress-mode=short
16367 Generate code for short address mode.  This is only supported for 32-bit
16368 and x32 environments.  It is the default address mode for 32-bit and
16369 x32 environments.
16370 @end table
16372 @node i386 and x86-64 Windows Options
16373 @subsection i386 and x86-64 Windows Options
16374 @cindex i386 and x86-64 Windows Options
16376 These additional options are available for Microsoft Windows targets:
16378 @table @gcctabopt
16379 @item -mconsole
16380 @opindex mconsole
16381 This option
16382 specifies that a console application is to be generated, by
16383 instructing the linker to set the PE header subsystem type
16384 required for console applications.
16385 This option is available for Cygwin and MinGW targets and is
16386 enabled by default on those targets.
16388 @item -mdll
16389 @opindex mdll
16390 This option is available for Cygwin and MinGW targets.  It
16391 specifies that a DLL---a dynamic link library---is to be
16392 generated, enabling the selection of the required runtime
16393 startup object and entry point.
16395 @item -mnop-fun-dllimport
16396 @opindex mnop-fun-dllimport
16397 This option is available for Cygwin and MinGW targets.  It
16398 specifies that the @code{dllimport} attribute should be ignored.
16400 @item -mthread
16401 @opindex mthread
16402 This option is available for MinGW targets. It specifies
16403 that MinGW-specific thread support is to be used.
16405 @item -municode
16406 @opindex municode
16407 This option is available for MinGW-w64 targets.  It causes
16408 the @code{UNICODE} preprocessor macro to be predefined, and
16409 chooses Unicode-capable runtime startup code.
16411 @item -mwin32
16412 @opindex mwin32
16413 This option is available for Cygwin and MinGW targets.  It
16414 specifies that the typical Microsoft Windows predefined macros are to
16415 be set in the pre-processor, but does not influence the choice
16416 of runtime library/startup code.
16418 @item -mwindows
16419 @opindex mwindows
16420 This option is available for Cygwin and MinGW targets.  It
16421 specifies that a GUI application is to be generated by
16422 instructing the linker to set the PE header subsystem type
16423 appropriately.
16425 @item -fno-set-stack-executable
16426 @opindex fno-set-stack-executable
16427 This option is available for MinGW targets. It specifies that
16428 the executable flag for the stack used by nested functions isn't
16429 set. This is necessary for binaries running in kernel mode of
16430 Microsoft Windows, as there the User32 API, which is used to set executable
16431 privileges, isn't available.
16433 @item -fwritable-relocated-rdata
16434 @opindex fno-writable-relocated-rdata
16435 This option is available for MinGW and Cygwin targets.  It specifies
16436 that relocated-data in read-only section is put into .data
16437 section.  This is a necessary for older runtimes not supporting
16438 modification of .rdata sections for pseudo-relocation.
16440 @item -mpe-aligned-commons
16441 @opindex mpe-aligned-commons
16442 This option is available for Cygwin and MinGW targets.  It
16443 specifies that the GNU extension to the PE file format that
16444 permits the correct alignment of COMMON variables should be
16445 used when generating code.  It is enabled by default if
16446 GCC detects that the target assembler found during configuration
16447 supports the feature.
16448 @end table
16450 See also under @ref{i386 and x86-64 Options} for standard options.
16452 @node IA-64 Options
16453 @subsection IA-64 Options
16454 @cindex IA-64 Options
16456 These are the @samp{-m} options defined for the Intel IA-64 architecture.
16458 @table @gcctabopt
16459 @item -mbig-endian
16460 @opindex mbig-endian
16461 Generate code for a big-endian target.  This is the default for HP-UX@.
16463 @item -mlittle-endian
16464 @opindex mlittle-endian
16465 Generate code for a little-endian target.  This is the default for AIX5
16466 and GNU/Linux.
16468 @item -mgnu-as
16469 @itemx -mno-gnu-as
16470 @opindex mgnu-as
16471 @opindex mno-gnu-as
16472 Generate (or don't) code for the GNU assembler.  This is the default.
16473 @c Also, this is the default if the configure option @option{--with-gnu-as}
16474 @c is used.
16476 @item -mgnu-ld
16477 @itemx -mno-gnu-ld
16478 @opindex mgnu-ld
16479 @opindex mno-gnu-ld
16480 Generate (or don't) code for the GNU linker.  This is the default.
16481 @c Also, this is the default if the configure option @option{--with-gnu-ld}
16482 @c is used.
16484 @item -mno-pic
16485 @opindex mno-pic
16486 Generate code that does not use a global pointer register.  The result
16487 is not position independent code, and violates the IA-64 ABI@.
16489 @item -mvolatile-asm-stop
16490 @itemx -mno-volatile-asm-stop
16491 @opindex mvolatile-asm-stop
16492 @opindex mno-volatile-asm-stop
16493 Generate (or don't) a stop bit immediately before and after volatile asm
16494 statements.
16496 @item -mregister-names
16497 @itemx -mno-register-names
16498 @opindex mregister-names
16499 @opindex mno-register-names
16500 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
16501 the stacked registers.  This may make assembler output more readable.
16503 @item -mno-sdata
16504 @itemx -msdata
16505 @opindex mno-sdata
16506 @opindex msdata
16507 Disable (or enable) optimizations that use the small data section.  This may
16508 be useful for working around optimizer bugs.
16510 @item -mconstant-gp
16511 @opindex mconstant-gp
16512 Generate code that uses a single constant global pointer value.  This is
16513 useful when compiling kernel code.
16515 @item -mauto-pic
16516 @opindex mauto-pic
16517 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
16518 This is useful when compiling firmware code.
16520 @item -minline-float-divide-min-latency
16521 @opindex minline-float-divide-min-latency
16522 Generate code for inline divides of floating-point values
16523 using the minimum latency algorithm.
16525 @item -minline-float-divide-max-throughput
16526 @opindex minline-float-divide-max-throughput
16527 Generate code for inline divides of floating-point values
16528 using the maximum throughput algorithm.
16530 @item -mno-inline-float-divide
16531 @opindex mno-inline-float-divide
16532 Do not generate inline code for divides of floating-point values.
16534 @item -minline-int-divide-min-latency
16535 @opindex minline-int-divide-min-latency
16536 Generate code for inline divides of integer values
16537 using the minimum latency algorithm.
16539 @item -minline-int-divide-max-throughput
16540 @opindex minline-int-divide-max-throughput
16541 Generate code for inline divides of integer values
16542 using the maximum throughput algorithm.
16544 @item -mno-inline-int-divide
16545 @opindex mno-inline-int-divide
16546 Do not generate inline code for divides of integer values.
16548 @item -minline-sqrt-min-latency
16549 @opindex minline-sqrt-min-latency
16550 Generate code for inline square roots
16551 using the minimum latency algorithm.
16553 @item -minline-sqrt-max-throughput
16554 @opindex minline-sqrt-max-throughput
16555 Generate code for inline square roots
16556 using the maximum throughput algorithm.
16558 @item -mno-inline-sqrt
16559 @opindex mno-inline-sqrt
16560 Do not generate inline code for @code{sqrt}.
16562 @item -mfused-madd
16563 @itemx -mno-fused-madd
16564 @opindex mfused-madd
16565 @opindex mno-fused-madd
16566 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
16567 instructions.  The default is to use these instructions.
16569 @item -mno-dwarf2-asm
16570 @itemx -mdwarf2-asm
16571 @opindex mno-dwarf2-asm
16572 @opindex mdwarf2-asm
16573 Don't (or do) generate assembler code for the DWARF 2 line number debugging
16574 info.  This may be useful when not using the GNU assembler.
16576 @item -mearly-stop-bits
16577 @itemx -mno-early-stop-bits
16578 @opindex mearly-stop-bits
16579 @opindex mno-early-stop-bits
16580 Allow stop bits to be placed earlier than immediately preceding the
16581 instruction that triggered the stop bit.  This can improve instruction
16582 scheduling, but does not always do so.
16584 @item -mfixed-range=@var{register-range}
16585 @opindex mfixed-range
16586 Generate code treating the given register range as fixed registers.
16587 A fixed register is one that the register allocator cannot use.  This is
16588 useful when compiling kernel code.  A register range is specified as
16589 two registers separated by a dash.  Multiple register ranges can be
16590 specified separated by a comma.
16592 @item -mtls-size=@var{tls-size}
16593 @opindex mtls-size
16594 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
16597 @item -mtune=@var{cpu-type}
16598 @opindex mtune
16599 Tune the instruction scheduling for a particular CPU, Valid values are
16600 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
16601 and @samp{mckinley}.
16603 @item -milp32
16604 @itemx -mlp64
16605 @opindex milp32
16606 @opindex mlp64
16607 Generate code for a 32-bit or 64-bit environment.
16608 The 32-bit environment sets int, long and pointer to 32 bits.
16609 The 64-bit environment sets int to 32 bits and long and pointer
16610 to 64 bits.  These are HP-UX specific flags.
16612 @item -mno-sched-br-data-spec
16613 @itemx -msched-br-data-spec
16614 @opindex mno-sched-br-data-spec
16615 @opindex msched-br-data-spec
16616 (Dis/En)able data speculative scheduling before reload.
16617 This results in generation of @code{ld.a} instructions and
16618 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16619 The default is 'disable'.
16621 @item -msched-ar-data-spec
16622 @itemx -mno-sched-ar-data-spec
16623 @opindex msched-ar-data-spec
16624 @opindex mno-sched-ar-data-spec
16625 (En/Dis)able data speculative scheduling after reload.
16626 This results in generation of @code{ld.a} instructions and
16627 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16628 The default is 'enable'.
16630 @item -mno-sched-control-spec
16631 @itemx -msched-control-spec
16632 @opindex mno-sched-control-spec
16633 @opindex msched-control-spec
16634 (Dis/En)able control speculative scheduling.  This feature is
16635 available only during region scheduling (i.e.@: before reload).
16636 This results in generation of the @code{ld.s} instructions and
16637 the corresponding check instructions @code{chk.s}.
16638 The default is 'disable'.
16640 @item -msched-br-in-data-spec
16641 @itemx -mno-sched-br-in-data-spec
16642 @opindex msched-br-in-data-spec
16643 @opindex mno-sched-br-in-data-spec
16644 (En/Dis)able speculative scheduling of the instructions that
16645 are dependent on the data speculative loads before reload.
16646 This is effective only with @option{-msched-br-data-spec} enabled.
16647 The default is 'enable'.
16649 @item -msched-ar-in-data-spec
16650 @itemx -mno-sched-ar-in-data-spec
16651 @opindex msched-ar-in-data-spec
16652 @opindex mno-sched-ar-in-data-spec
16653 (En/Dis)able speculative scheduling of the instructions that
16654 are dependent on the data speculative loads after reload.
16655 This is effective only with @option{-msched-ar-data-spec} enabled.
16656 The default is 'enable'.
16658 @item -msched-in-control-spec
16659 @itemx -mno-sched-in-control-spec
16660 @opindex msched-in-control-spec
16661 @opindex mno-sched-in-control-spec
16662 (En/Dis)able speculative scheduling of the instructions that
16663 are dependent on the control speculative loads.
16664 This is effective only with @option{-msched-control-spec} enabled.
16665 The default is 'enable'.
16667 @item -mno-sched-prefer-non-data-spec-insns
16668 @itemx -msched-prefer-non-data-spec-insns
16669 @opindex mno-sched-prefer-non-data-spec-insns
16670 @opindex msched-prefer-non-data-spec-insns
16671 If enabled, data-speculative instructions are chosen for schedule
16672 only if there are no other choices at the moment.  This makes
16673 the use of the data speculation much more conservative.
16674 The default is 'disable'.
16676 @item -mno-sched-prefer-non-control-spec-insns
16677 @itemx -msched-prefer-non-control-spec-insns
16678 @opindex mno-sched-prefer-non-control-spec-insns
16679 @opindex msched-prefer-non-control-spec-insns
16680 If enabled, control-speculative instructions are chosen for schedule
16681 only if there are no other choices at the moment.  This makes
16682 the use of the control speculation much more conservative.
16683 The default is 'disable'.
16685 @item -mno-sched-count-spec-in-critical-path
16686 @itemx -msched-count-spec-in-critical-path
16687 @opindex mno-sched-count-spec-in-critical-path
16688 @opindex msched-count-spec-in-critical-path
16689 If enabled, speculative dependencies are considered during
16690 computation of the instructions priorities.  This makes the use of the
16691 speculation a bit more conservative.
16692 The default is 'disable'.
16694 @item -msched-spec-ldc
16695 @opindex msched-spec-ldc
16696 Use a simple data speculation check.  This option is on by default.
16698 @item -msched-control-spec-ldc
16699 @opindex msched-spec-ldc
16700 Use a simple check for control speculation.  This option is on by default.
16702 @item -msched-stop-bits-after-every-cycle
16703 @opindex msched-stop-bits-after-every-cycle
16704 Place a stop bit after every cycle when scheduling.  This option is on
16705 by default.
16707 @item -msched-fp-mem-deps-zero-cost
16708 @opindex msched-fp-mem-deps-zero-cost
16709 Assume that floating-point stores and loads are not likely to cause a conflict
16710 when placed into the same instruction group.  This option is disabled by
16711 default.
16713 @item -msel-sched-dont-check-control-spec
16714 @opindex msel-sched-dont-check-control-spec
16715 Generate checks for control speculation in selective scheduling.
16716 This flag is disabled by default.
16718 @item -msched-max-memory-insns=@var{max-insns}
16719 @opindex msched-max-memory-insns
16720 Limit on the number of memory insns per instruction group, giving lower
16721 priority to subsequent memory insns attempting to schedule in the same
16722 instruction group. Frequently useful to prevent cache bank conflicts.
16723 The default value is 1.
16725 @item -msched-max-memory-insns-hard-limit
16726 @opindex msched-max-memory-insns-hard-limit
16727 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16728 disallowing more than that number in an instruction group.
16729 Otherwise, the limit is ``soft'', meaning that non-memory operations
16730 are preferred when the limit is reached, but memory operations may still
16731 be scheduled.
16733 @end table
16735 @node LM32 Options
16736 @subsection LM32 Options
16737 @cindex LM32 options
16739 These @option{-m} options are defined for the LatticeMico32 architecture:
16741 @table @gcctabopt
16742 @item -mbarrel-shift-enabled
16743 @opindex mbarrel-shift-enabled
16744 Enable barrel-shift instructions.
16746 @item -mdivide-enabled
16747 @opindex mdivide-enabled
16748 Enable divide and modulus instructions.
16750 @item -mmultiply-enabled
16751 @opindex multiply-enabled
16752 Enable multiply instructions.
16754 @item -msign-extend-enabled
16755 @opindex msign-extend-enabled
16756 Enable sign extend instructions.
16758 @item -muser-enabled
16759 @opindex muser-enabled
16760 Enable user-defined instructions.
16762 @end table
16764 @node M32C Options
16765 @subsection M32C Options
16766 @cindex M32C options
16768 @table @gcctabopt
16769 @item -mcpu=@var{name}
16770 @opindex mcpu=
16771 Select the CPU for which code is generated.  @var{name} may be one of
16772 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16773 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16774 the M32C/80 series.
16776 @item -msim
16777 @opindex msim
16778 Specifies that the program will be run on the simulator.  This causes
16779 an alternate runtime library to be linked in which supports, for
16780 example, file I/O@.  You must not use this option when generating
16781 programs that will run on real hardware; you must provide your own
16782 runtime library for whatever I/O functions are needed.
16784 @item -memregs=@var{number}
16785 @opindex memregs=
16786 Specifies the number of memory-based pseudo-registers GCC uses
16787 during code generation.  These pseudo-registers are used like real
16788 registers, so there is a tradeoff between GCC's ability to fit the
16789 code into available registers, and the performance penalty of using
16790 memory instead of registers.  Note that all modules in a program must
16791 be compiled with the same value for this option.  Because of that, you
16792 must not use this option with GCC's default runtime libraries.
16794 @end table
16796 @node M32R/D Options
16797 @subsection M32R/D Options
16798 @cindex M32R/D options
16800 These @option{-m} options are defined for Renesas M32R/D architectures:
16802 @table @gcctabopt
16803 @item -m32r2
16804 @opindex m32r2
16805 Generate code for the M32R/2@.
16807 @item -m32rx
16808 @opindex m32rx
16809 Generate code for the M32R/X@.
16811 @item -m32r
16812 @opindex m32r
16813 Generate code for the M32R@.  This is the default.
16815 @item -mmodel=small
16816 @opindex mmodel=small
16817 Assume all objects live in the lower 16MB of memory (so that their addresses
16818 can be loaded with the @code{ld24} instruction), and assume all subroutines
16819 are reachable with the @code{bl} instruction.
16820 This is the default.
16822 The addressability of a particular object can be set with the
16823 @code{model} attribute.
16825 @item -mmodel=medium
16826 @opindex mmodel=medium
16827 Assume objects may be anywhere in the 32-bit address space (the compiler
16828 generates @code{seth/add3} instructions to load their addresses), and
16829 assume all subroutines are reachable with the @code{bl} instruction.
16831 @item -mmodel=large
16832 @opindex mmodel=large
16833 Assume objects may be anywhere in the 32-bit address space (the compiler
16834 generates @code{seth/add3} instructions to load their addresses), and
16835 assume subroutines may not be reachable with the @code{bl} instruction
16836 (the compiler generates the much slower @code{seth/add3/jl}
16837 instruction sequence).
16839 @item -msdata=none
16840 @opindex msdata=none
16841 Disable use of the small data area.  Variables are put into
16842 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16843 @code{section} attribute has been specified).
16844 This is the default.
16846 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16847 Objects may be explicitly put in the small data area with the
16848 @code{section} attribute using one of these sections.
16850 @item -msdata=sdata
16851 @opindex msdata=sdata
16852 Put small global and static data in the small data area, but do not
16853 generate special code to reference them.
16855 @item -msdata=use
16856 @opindex msdata=use
16857 Put small global and static data in the small data area, and generate
16858 special instructions to reference them.
16860 @item -G @var{num}
16861 @opindex G
16862 @cindex smaller data references
16863 Put global and static objects less than or equal to @var{num} bytes
16864 into the small data or BSS sections instead of the normal data or BSS
16865 sections.  The default value of @var{num} is 8.
16866 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16867 for this option to have any effect.
16869 All modules should be compiled with the same @option{-G @var{num}} value.
16870 Compiling with different values of @var{num} may or may not work; if it
16871 doesn't the linker gives an error message---incorrect code is not
16872 generated.
16874 @item -mdebug
16875 @opindex mdebug
16876 Makes the M32R-specific code in the compiler display some statistics
16877 that might help in debugging programs.
16879 @item -malign-loops
16880 @opindex malign-loops
16881 Align all loops to a 32-byte boundary.
16883 @item -mno-align-loops
16884 @opindex mno-align-loops
16885 Do not enforce a 32-byte alignment for loops.  This is the default.
16887 @item -missue-rate=@var{number}
16888 @opindex missue-rate=@var{number}
16889 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16890 or 2.
16892 @item -mbranch-cost=@var{number}
16893 @opindex mbranch-cost=@var{number}
16894 @var{number} can only be 1 or 2.  If it is 1 then branches are
16895 preferred over conditional code, if it is 2, then the opposite applies.
16897 @item -mflush-trap=@var{number}
16898 @opindex mflush-trap=@var{number}
16899 Specifies the trap number to use to flush the cache.  The default is
16900 12.  Valid numbers are between 0 and 15 inclusive.
16902 @item -mno-flush-trap
16903 @opindex mno-flush-trap
16904 Specifies that the cache cannot be flushed by using a trap.
16906 @item -mflush-func=@var{name}
16907 @opindex mflush-func=@var{name}
16908 Specifies the name of the operating system function to call to flush
16909 the cache.  The default is @emph{_flush_cache}, but a function call
16910 is only used if a trap is not available.
16912 @item -mno-flush-func
16913 @opindex mno-flush-func
16914 Indicates that there is no OS function for flushing the cache.
16916 @end table
16918 @node M680x0 Options
16919 @subsection M680x0 Options
16920 @cindex M680x0 options
16922 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16923 The default settings depend on which architecture was selected when
16924 the compiler was configured; the defaults for the most common choices
16925 are given below.
16927 @table @gcctabopt
16928 @item -march=@var{arch}
16929 @opindex march
16930 Generate code for a specific M680x0 or ColdFire instruction set
16931 architecture.  Permissible values of @var{arch} for M680x0
16932 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16933 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16934 architectures are selected according to Freescale's ISA classification
16935 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16936 @samp{isab} and @samp{isac}.
16938 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16939 code for a ColdFire target.  The @var{arch} in this macro is one of the
16940 @option{-march} arguments given above.
16942 When used together, @option{-march} and @option{-mtune} select code
16943 that runs on a family of similar processors but that is optimized
16944 for a particular microarchitecture.
16946 @item -mcpu=@var{cpu}
16947 @opindex mcpu
16948 Generate code for a specific M680x0 or ColdFire processor.
16949 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16950 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16951 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16952 below, which also classifies the CPUs into families:
16954 @multitable @columnfractions 0.20 0.80
16955 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16956 @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}
16957 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16958 @item @samp{5206e} @tab @samp{5206e}
16959 @item @samp{5208} @tab @samp{5207} @samp{5208}
16960 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16961 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16962 @item @samp{5216} @tab @samp{5214} @samp{5216}
16963 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16964 @item @samp{5225} @tab @samp{5224} @samp{5225}
16965 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16966 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16967 @item @samp{5249} @tab @samp{5249}
16968 @item @samp{5250} @tab @samp{5250}
16969 @item @samp{5271} @tab @samp{5270} @samp{5271}
16970 @item @samp{5272} @tab @samp{5272}
16971 @item @samp{5275} @tab @samp{5274} @samp{5275}
16972 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16973 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16974 @item @samp{5307} @tab @samp{5307}
16975 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16976 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16977 @item @samp{5407} @tab @samp{5407}
16978 @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}
16979 @end multitable
16981 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16982 @var{arch} is compatible with @var{cpu}.  Other combinations of
16983 @option{-mcpu} and @option{-march} are rejected.
16985 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16986 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16987 where the value of @var{family} is given by the table above.
16989 @item -mtune=@var{tune}
16990 @opindex mtune
16991 Tune the code for a particular microarchitecture within the
16992 constraints set by @option{-march} and @option{-mcpu}.
16993 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16994 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16995 and @samp{cpu32}.  The ColdFire microarchitectures
16996 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16998 You can also use @option{-mtune=68020-40} for code that needs
16999 to run relatively well on 68020, 68030 and 68040 targets.
17000 @option{-mtune=68020-60} is similar but includes 68060 targets
17001 as well.  These two options select the same tuning decisions as
17002 @option{-m68020-40} and @option{-m68020-60} respectively.
17004 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
17005 when tuning for 680x0 architecture @var{arch}.  It also defines
17006 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
17007 option is used.  If GCC is tuning for a range of architectures,
17008 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
17009 it defines the macros for every architecture in the range.
17011 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
17012 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
17013 of the arguments given above.
17015 @item -m68000
17016 @itemx -mc68000
17017 @opindex m68000
17018 @opindex mc68000
17019 Generate output for a 68000.  This is the default
17020 when the compiler is configured for 68000-based systems.
17021 It is equivalent to @option{-march=68000}.
17023 Use this option for microcontrollers with a 68000 or EC000 core,
17024 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
17026 @item -m68010
17027 @opindex m68010
17028 Generate output for a 68010.  This is the default
17029 when the compiler is configured for 68010-based systems.
17030 It is equivalent to @option{-march=68010}.
17032 @item -m68020
17033 @itemx -mc68020
17034 @opindex m68020
17035 @opindex mc68020
17036 Generate output for a 68020.  This is the default
17037 when the compiler is configured for 68020-based systems.
17038 It is equivalent to @option{-march=68020}.
17040 @item -m68030
17041 @opindex m68030
17042 Generate output for a 68030.  This is the default when the compiler is
17043 configured for 68030-based systems.  It is equivalent to
17044 @option{-march=68030}.
17046 @item -m68040
17047 @opindex m68040
17048 Generate output for a 68040.  This is the default when the compiler is
17049 configured for 68040-based systems.  It is equivalent to
17050 @option{-march=68040}.
17052 This option inhibits the use of 68881/68882 instructions that have to be
17053 emulated by software on the 68040.  Use this option if your 68040 does not
17054 have code to emulate those instructions.
17056 @item -m68060
17057 @opindex m68060
17058 Generate output for a 68060.  This is the default when the compiler is
17059 configured for 68060-based systems.  It is equivalent to
17060 @option{-march=68060}.
17062 This option inhibits the use of 68020 and 68881/68882 instructions that
17063 have to be emulated by software on the 68060.  Use this option if your 68060
17064 does not have code to emulate those instructions.
17066 @item -mcpu32
17067 @opindex mcpu32
17068 Generate output for a CPU32.  This is the default
17069 when the compiler is configured for CPU32-based systems.
17070 It is equivalent to @option{-march=cpu32}.
17072 Use this option for microcontrollers with a
17073 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
17074 68336, 68340, 68341, 68349 and 68360.
17076 @item -m5200
17077 @opindex m5200
17078 Generate output for a 520X ColdFire CPU@.  This is the default
17079 when the compiler is configured for 520X-based systems.
17080 It is equivalent to @option{-mcpu=5206}, and is now deprecated
17081 in favor of that option.
17083 Use this option for microcontroller with a 5200 core, including
17084 the MCF5202, MCF5203, MCF5204 and MCF5206.
17086 @item -m5206e
17087 @opindex m5206e
17088 Generate output for a 5206e ColdFire CPU@.  The option is now
17089 deprecated in favor of the equivalent @option{-mcpu=5206e}.
17091 @item -m528x
17092 @opindex m528x
17093 Generate output for a member of the ColdFire 528X family.
17094 The option is now deprecated in favor of the equivalent
17095 @option{-mcpu=528x}.
17097 @item -m5307
17098 @opindex m5307
17099 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
17100 in favor of the equivalent @option{-mcpu=5307}.
17102 @item -m5407
17103 @opindex m5407
17104 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
17105 in favor of the equivalent @option{-mcpu=5407}.
17107 @item -mcfv4e
17108 @opindex mcfv4e
17109 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
17110 This includes use of hardware floating-point instructions.
17111 The option is equivalent to @option{-mcpu=547x}, and is now
17112 deprecated in favor of that option.
17114 @item -m68020-40
17115 @opindex m68020-40
17116 Generate output for a 68040, without using any of the new instructions.
17117 This results in code that can run relatively efficiently on either a
17118 68020/68881 or a 68030 or a 68040.  The generated code does use the
17119 68881 instructions that are emulated on the 68040.
17121 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
17123 @item -m68020-60
17124 @opindex m68020-60
17125 Generate output for a 68060, without using any of the new instructions.
17126 This results in code that can run relatively efficiently on either a
17127 68020/68881 or a 68030 or a 68040.  The generated code does use the
17128 68881 instructions that are emulated on the 68060.
17130 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
17132 @item -mhard-float
17133 @itemx -m68881
17134 @opindex mhard-float
17135 @opindex m68881
17136 Generate floating-point instructions.  This is the default for 68020
17137 and above, and for ColdFire devices that have an FPU@.  It defines the
17138 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
17139 on ColdFire targets.
17141 @item -msoft-float
17142 @opindex msoft-float
17143 Do not generate floating-point instructions; use library calls instead.
17144 This is the default for 68000, 68010, and 68832 targets.  It is also
17145 the default for ColdFire devices that have no FPU.
17147 @item -mdiv
17148 @itemx -mno-div
17149 @opindex mdiv
17150 @opindex mno-div
17151 Generate (do not generate) ColdFire hardware divide and remainder
17152 instructions.  If @option{-march} is used without @option{-mcpu},
17153 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
17154 architectures.  Otherwise, the default is taken from the target CPU
17155 (either the default CPU, or the one specified by @option{-mcpu}).  For
17156 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
17157 @option{-mcpu=5206e}.
17159 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
17161 @item -mshort
17162 @opindex mshort
17163 Consider type @code{int} to be 16 bits wide, like @code{short int}.
17164 Additionally, parameters passed on the stack are also aligned to a
17165 16-bit boundary even on targets whose API mandates promotion to 32-bit.
17167 @item -mno-short
17168 @opindex mno-short
17169 Do not consider type @code{int} to be 16 bits wide.  This is the default.
17171 @item -mnobitfield
17172 @itemx -mno-bitfield
17173 @opindex mnobitfield
17174 @opindex mno-bitfield
17175 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
17176 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
17178 @item -mbitfield
17179 @opindex mbitfield
17180 Do use the bit-field instructions.  The @option{-m68020} option implies
17181 @option{-mbitfield}.  This is the default if you use a configuration
17182 designed for a 68020.
17184 @item -mrtd
17185 @opindex mrtd
17186 Use a different function-calling convention, in which functions
17187 that take a fixed number of arguments return with the @code{rtd}
17188 instruction, which pops their arguments while returning.  This
17189 saves one instruction in the caller since there is no need to pop
17190 the arguments there.
17192 This calling convention is incompatible with the one normally
17193 used on Unix, so you cannot use it if you need to call libraries
17194 compiled with the Unix compiler.
17196 Also, you must provide function prototypes for all functions that
17197 take variable numbers of arguments (including @code{printf});
17198 otherwise incorrect code is generated for calls to those
17199 functions.
17201 In addition, seriously incorrect code results if you call a
17202 function with too many arguments.  (Normally, extra arguments are
17203 harmlessly ignored.)
17205 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
17206 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
17208 @item -mno-rtd
17209 @opindex mno-rtd
17210 Do not use the calling conventions selected by @option{-mrtd}.
17211 This is the default.
17213 @item -malign-int
17214 @itemx -mno-align-int
17215 @opindex malign-int
17216 @opindex mno-align-int
17217 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
17218 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
17219 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
17220 Aligning variables on 32-bit boundaries produces code that runs somewhat
17221 faster on processors with 32-bit busses at the expense of more memory.
17223 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
17224 aligns structures containing the above types differently than
17225 most published application binary interface specifications for the m68k.
17227 @item -mpcrel
17228 @opindex mpcrel
17229 Use the pc-relative addressing mode of the 68000 directly, instead of
17230 using a global offset table.  At present, this option implies @option{-fpic},
17231 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
17232 not presently supported with @option{-mpcrel}, though this could be supported for
17233 68020 and higher processors.
17235 @item -mno-strict-align
17236 @itemx -mstrict-align
17237 @opindex mno-strict-align
17238 @opindex mstrict-align
17239 Do not (do) assume that unaligned memory references are handled by
17240 the system.
17242 @item -msep-data
17243 Generate code that allows the data segment to be located in a different
17244 area of memory from the text segment.  This allows for execute-in-place in
17245 an environment without virtual memory management.  This option implies
17246 @option{-fPIC}.
17248 @item -mno-sep-data
17249 Generate code that assumes that the data segment follows the text segment.
17250 This is the default.
17252 @item -mid-shared-library
17253 Generate code that supports shared libraries via the library ID method.
17254 This allows for execute-in-place and shared libraries in an environment
17255 without virtual memory management.  This option implies @option{-fPIC}.
17257 @item -mno-id-shared-library
17258 Generate code that doesn't assume ID-based shared libraries are being used.
17259 This is the default.
17261 @item -mshared-library-id=n
17262 Specifies the identification number of the ID-based shared library being
17263 compiled.  Specifying a value of 0 generates more compact code; specifying
17264 other values forces the allocation of that number to the current
17265 library, but is no more space- or time-efficient than omitting this option.
17267 @item -mxgot
17268 @itemx -mno-xgot
17269 @opindex mxgot
17270 @opindex mno-xgot
17271 When generating position-independent code for ColdFire, generate code
17272 that works if the GOT has more than 8192 entries.  This code is
17273 larger and slower than code generated without this option.  On M680x0
17274 processors, this option is not needed; @option{-fPIC} suffices.
17276 GCC normally uses a single instruction to load values from the GOT@.
17277 While this is relatively efficient, it only works if the GOT
17278 is smaller than about 64k.  Anything larger causes the linker
17279 to report an error such as:
17281 @cindex relocation truncated to fit (ColdFire)
17282 @smallexample
17283 relocation truncated to fit: R_68K_GOT16O foobar
17284 @end smallexample
17286 If this happens, you should recompile your code with @option{-mxgot}.
17287 It should then work with very large GOTs.  However, code generated with
17288 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
17289 the value of a global symbol.
17291 Note that some linkers, including newer versions of the GNU linker,
17292 can create multiple GOTs and sort GOT entries.  If you have such a linker,
17293 you should only need to use @option{-mxgot} when compiling a single
17294 object file that accesses more than 8192 GOT entries.  Very few do.
17296 These options have no effect unless GCC is generating
17297 position-independent code.
17299 @end table
17301 @node MCore Options
17302 @subsection MCore Options
17303 @cindex MCore options
17305 These are the @samp{-m} options defined for the Motorola M*Core
17306 processors.
17308 @table @gcctabopt
17310 @item -mhardlit
17311 @itemx -mno-hardlit
17312 @opindex mhardlit
17313 @opindex mno-hardlit
17314 Inline constants into the code stream if it can be done in two
17315 instructions or less.
17317 @item -mdiv
17318 @itemx -mno-div
17319 @opindex mdiv
17320 @opindex mno-div
17321 Use the divide instruction.  (Enabled by default).
17323 @item -mrelax-immediate
17324 @itemx -mno-relax-immediate
17325 @opindex mrelax-immediate
17326 @opindex mno-relax-immediate
17327 Allow arbitrary-sized immediates in bit operations.
17329 @item -mwide-bitfields
17330 @itemx -mno-wide-bitfields
17331 @opindex mwide-bitfields
17332 @opindex mno-wide-bitfields
17333 Always treat bit-fields as @code{int}-sized.
17335 @item -m4byte-functions
17336 @itemx -mno-4byte-functions
17337 @opindex m4byte-functions
17338 @opindex mno-4byte-functions
17339 Force all functions to be aligned to a 4-byte boundary.
17341 @item -mcallgraph-data
17342 @itemx -mno-callgraph-data
17343 @opindex mcallgraph-data
17344 @opindex mno-callgraph-data
17345 Emit callgraph information.
17347 @item -mslow-bytes
17348 @itemx -mno-slow-bytes
17349 @opindex mslow-bytes
17350 @opindex mno-slow-bytes
17351 Prefer word access when reading byte quantities.
17353 @item -mlittle-endian
17354 @itemx -mbig-endian
17355 @opindex mlittle-endian
17356 @opindex mbig-endian
17357 Generate code for a little-endian target.
17359 @item -m210
17360 @itemx -m340
17361 @opindex m210
17362 @opindex m340
17363 Generate code for the 210 processor.
17365 @item -mno-lsim
17366 @opindex mno-lsim
17367 Assume that runtime support has been provided and so omit the
17368 simulator library (@file{libsim.a)} from the linker command line.
17370 @item -mstack-increment=@var{size}
17371 @opindex mstack-increment
17372 Set the maximum amount for a single stack increment operation.  Large
17373 values can increase the speed of programs that contain functions
17374 that need a large amount of stack space, but they can also trigger a
17375 segmentation fault if the stack is extended too much.  The default
17376 value is 0x1000.
17378 @end table
17380 @node MeP Options
17381 @subsection MeP Options
17382 @cindex MeP options
17384 @table @gcctabopt
17386 @item -mabsdiff
17387 @opindex mabsdiff
17388 Enables the @code{abs} instruction, which is the absolute difference
17389 between two registers.
17391 @item -mall-opts
17392 @opindex mall-opts
17393 Enables all the optional instructions---average, multiply, divide, bit
17394 operations, leading zero, absolute difference, min/max, clip, and
17395 saturation.
17398 @item -maverage
17399 @opindex maverage
17400 Enables the @code{ave} instruction, which computes the average of two
17401 registers.
17403 @item -mbased=@var{n}
17404 @opindex mbased=
17405 Variables of size @var{n} bytes or smaller are placed in the
17406 @code{.based} section by default.  Based variables use the @code{$tp}
17407 register as a base register, and there is a 128-byte limit to the
17408 @code{.based} section.
17410 @item -mbitops
17411 @opindex mbitops
17412 Enables the bit operation instructions---bit test (@code{btstm}), set
17413 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
17414 test-and-set (@code{tas}).
17416 @item -mc=@var{name}
17417 @opindex mc=
17418 Selects which section constant data is placed in.  @var{name} may
17419 be @code{tiny}, @code{near}, or @code{far}.
17421 @item -mclip
17422 @opindex mclip
17423 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
17424 useful unless you also provide @code{-mminmax}.
17426 @item -mconfig=@var{name}
17427 @opindex mconfig=
17428 Selects one of the built-in core configurations.  Each MeP chip has
17429 one or more modules in it; each module has a core CPU and a variety of
17430 coprocessors, optional instructions, and peripherals.  The
17431 @code{MeP-Integrator} tool, not part of GCC, provides these
17432 configurations through this option; using this option is the same as
17433 using all the corresponding command-line options.  The default
17434 configuration is @code{default}.
17436 @item -mcop
17437 @opindex mcop
17438 Enables the coprocessor instructions.  By default, this is a 32-bit
17439 coprocessor.  Note that the coprocessor is normally enabled via the
17440 @code{-mconfig=} option.
17442 @item -mcop32
17443 @opindex mcop32
17444 Enables the 32-bit coprocessor's instructions.
17446 @item -mcop64
17447 @opindex mcop64
17448 Enables the 64-bit coprocessor's instructions.
17450 @item -mivc2
17451 @opindex mivc2
17452 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
17454 @item -mdc
17455 @opindex mdc
17456 Causes constant variables to be placed in the @code{.near} section.
17458 @item -mdiv
17459 @opindex mdiv
17460 Enables the @code{div} and @code{divu} instructions.
17462 @item -meb
17463 @opindex meb
17464 Generate big-endian code.
17466 @item -mel
17467 @opindex mel
17468 Generate little-endian code.
17470 @item -mio-volatile
17471 @opindex mio-volatile
17472 Tells the compiler that any variable marked with the @code{io}
17473 attribute is to be considered volatile.
17475 @item -ml
17476 @opindex ml
17477 Causes variables to be assigned to the @code{.far} section by default.
17479 @item -mleadz
17480 @opindex mleadz
17481 Enables the @code{leadz} (leading zero) instruction.
17483 @item -mm
17484 @opindex mm
17485 Causes variables to be assigned to the @code{.near} section by default.
17487 @item -mminmax
17488 @opindex mminmax
17489 Enables the @code{min} and @code{max} instructions.
17491 @item -mmult
17492 @opindex mmult
17493 Enables the multiplication and multiply-accumulate instructions.
17495 @item -mno-opts
17496 @opindex mno-opts
17497 Disables all the optional instructions enabled by @code{-mall-opts}.
17499 @item -mrepeat
17500 @opindex mrepeat
17501 Enables the @code{repeat} and @code{erepeat} instructions, used for
17502 low-overhead looping.
17504 @item -ms
17505 @opindex ms
17506 Causes all variables to default to the @code{.tiny} section.  Note
17507 that there is a 65536-byte limit to this section.  Accesses to these
17508 variables use the @code{%gp} base register.
17510 @item -msatur
17511 @opindex msatur
17512 Enables the saturation instructions.  Note that the compiler does not
17513 currently generate these itself, but this option is included for
17514 compatibility with other tools, like @code{as}.
17516 @item -msdram
17517 @opindex msdram
17518 Link the SDRAM-based runtime instead of the default ROM-based runtime.
17520 @item -msim
17521 @opindex msim
17522 Link the simulator run-time libraries.
17524 @item -msimnovec
17525 @opindex msimnovec
17526 Link the simulator runtime libraries, excluding built-in support
17527 for reset and exception vectors and tables.
17529 @item -mtf
17530 @opindex mtf
17531 Causes all functions to default to the @code{.far} section.  Without
17532 this option, functions default to the @code{.near} section.
17534 @item -mtiny=@var{n}
17535 @opindex mtiny=
17536 Variables that are @var{n} bytes or smaller are allocated to the
17537 @code{.tiny} section.  These variables use the @code{$gp} base
17538 register.  The default for this option is 4, but note that there's a
17539 65536-byte limit to the @code{.tiny} section.
17541 @end table
17543 @node MicroBlaze Options
17544 @subsection MicroBlaze Options
17545 @cindex MicroBlaze Options
17547 @table @gcctabopt
17549 @item -msoft-float
17550 @opindex msoft-float
17551 Use software emulation for floating point (default).
17553 @item -mhard-float
17554 @opindex mhard-float
17555 Use hardware floating-point instructions.
17557 @item -mmemcpy
17558 @opindex mmemcpy
17559 Do not optimize block moves, use @code{memcpy}.
17561 @item -mno-clearbss
17562 @opindex mno-clearbss
17563 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
17565 @item -mcpu=@var{cpu-type}
17566 @opindex mcpu=
17567 Use features of, and schedule code for, the given CPU.
17568 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
17569 where @var{X} is a major version, @var{YY} is the minor version, and
17570 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
17571 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
17573 @item -mxl-soft-mul
17574 @opindex mxl-soft-mul
17575 Use software multiply emulation (default).
17577 @item -mxl-soft-div
17578 @opindex mxl-soft-div
17579 Use software emulation for divides (default).
17581 @item -mxl-barrel-shift
17582 @opindex mxl-barrel-shift
17583 Use the hardware barrel shifter.
17585 @item -mxl-pattern-compare
17586 @opindex mxl-pattern-compare
17587 Use pattern compare instructions.
17589 @item -msmall-divides
17590 @opindex msmall-divides
17591 Use table lookup optimization for small signed integer divisions.
17593 @item -mxl-stack-check
17594 @opindex mxl-stack-check
17595 This option is deprecated.  Use @option{-fstack-check} instead.
17597 @item -mxl-gp-opt
17598 @opindex mxl-gp-opt
17599 Use GP-relative @code{.sdata}/@code{.sbss} sections.
17601 @item -mxl-multiply-high
17602 @opindex mxl-multiply-high
17603 Use multiply high instructions for high part of 32x32 multiply.
17605 @item -mxl-float-convert
17606 @opindex mxl-float-convert
17607 Use hardware floating-point conversion instructions.
17609 @item -mxl-float-sqrt
17610 @opindex mxl-float-sqrt
17611 Use hardware floating-point square root instruction.
17613 @item -mbig-endian
17614 @opindex mbig-endian
17615 Generate code for a big-endian target.
17617 @item -mlittle-endian
17618 @opindex mlittle-endian
17619 Generate code for a little-endian target.
17621 @item -mxl-reorder
17622 @opindex mxl-reorder
17623 Use reorder instructions (swap and byte reversed load/store).
17625 @item -mxl-mode-@var{app-model}
17626 Select application model @var{app-model}.  Valid models are
17627 @table @samp
17628 @item executable
17629 normal executable (default), uses startup code @file{crt0.o}.
17631 @item xmdstub
17632 for use with Xilinx Microprocessor Debugger (XMD) based
17633 software intrusive debug agent called xmdstub. This uses startup file
17634 @file{crt1.o} and sets the start address of the program to 0x800.
17636 @item bootstrap
17637 for applications that are loaded using a bootloader.
17638 This model uses startup file @file{crt2.o} which does not contain a processor
17639 reset vector handler. This is suitable for transferring control on a
17640 processor reset to the bootloader rather than the application.
17642 @item novectors
17643 for applications that do not require any of the
17644 MicroBlaze vectors. This option may be useful for applications running
17645 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17646 @end table
17648 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17649 @option{-mxl-mode-@var{app-model}}.
17651 @end table
17653 @node MIPS Options
17654 @subsection MIPS Options
17655 @cindex MIPS options
17657 @table @gcctabopt
17659 @item -EB
17660 @opindex EB
17661 Generate big-endian code.
17663 @item -EL
17664 @opindex EL
17665 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17666 configurations.
17668 @item -march=@var{arch}
17669 @opindex march
17670 Generate code that runs on @var{arch}, which can be the name of a
17671 generic MIPS ISA, or the name of a particular processor.
17672 The ISA names are:
17673 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17674 @samp{mips32}, @samp{mips32r2}, @samp{mips32r3}, @samp{mips32r5},
17675 @samp{mips32r6}, @samp{mips64}, @samp{mips64r2}, @samp{mips64r3},
17676 @samp{mips64r5} and @samp{mips64r6}.
17677 The processor names are:
17678 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17679 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17680 @samp{5kc}, @samp{5kf},
17681 @samp{20kc},
17682 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17683 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17684 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17685 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17686 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17687 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17688 @samp{m4k},
17689 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17690 @samp{octeon}, @samp{octeon+}, @samp{octeon2}, @samp{octeon3},
17691 @samp{orion},
17692 @samp{p5600},
17693 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17694 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17695 @samp{rm7000}, @samp{rm9000},
17696 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17697 @samp{sb1},
17698 @samp{sr71000},
17699 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17700 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17701 @samp{xlr} and @samp{xlp}.
17702 The special value @samp{from-abi} selects the
17703 most compatible architecture for the selected ABI (that is,
17704 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17706 The native Linux/GNU toolchain also supports the value @samp{native},
17707 which selects the best architecture option for the host processor.
17708 @option{-march=native} has no effect if GCC does not recognize
17709 the processor.
17711 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17712 (for example, @option{-march=r2k}).  Prefixes are optional, and
17713 @samp{vr} may be written @samp{r}.
17715 Names of the form @samp{@var{n}f2_1} refer to processors with
17716 FPUs clocked at half the rate of the core, names of the form
17717 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17718 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17719 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17720 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17721 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17722 accepted as synonyms for @samp{@var{n}f1_1}.
17724 GCC defines two macros based on the value of this option.  The first
17725 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17726 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17727 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17728 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17729 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17731 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17732 above.  In other words, it has the full prefix and does not
17733 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17734 the macro names the resolved architecture (either @samp{"mips1"} or
17735 @samp{"mips3"}).  It names the default architecture when no
17736 @option{-march} option is given.
17738 @item -mtune=@var{arch}
17739 @opindex mtune
17740 Optimize for @var{arch}.  Among other things, this option controls
17741 the way instructions are scheduled, and the perceived cost of arithmetic
17742 operations.  The list of @var{arch} values is the same as for
17743 @option{-march}.
17745 When this option is not used, GCC optimizes for the processor
17746 specified by @option{-march}.  By using @option{-march} and
17747 @option{-mtune} together, it is possible to generate code that
17748 runs on a family of processors, but optimize the code for one
17749 particular member of that family.
17751 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17752 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17753 @option{-march} ones described above.
17755 @item -mips1
17756 @opindex mips1
17757 Equivalent to @option{-march=mips1}.
17759 @item -mips2
17760 @opindex mips2
17761 Equivalent to @option{-march=mips2}.
17763 @item -mips3
17764 @opindex mips3
17765 Equivalent to @option{-march=mips3}.
17767 @item -mips4
17768 @opindex mips4
17769 Equivalent to @option{-march=mips4}.
17771 @item -mips32
17772 @opindex mips32
17773 Equivalent to @option{-march=mips32}.
17775 @item -mips32r3
17776 @opindex mips32r3
17777 Equivalent to @option{-march=mips32r3}.
17779 @item -mips32r5
17780 @opindex mips32r5
17781 Equivalent to @option{-march=mips32r5}.
17783 @item -mips32r6
17784 @opindex mips32r6
17785 Equivalent to @option{-march=mips32r6}.
17787 @item -mips64
17788 @opindex mips64
17789 Equivalent to @option{-march=mips64}.
17791 @item -mips64r2
17792 @opindex mips64r2
17793 Equivalent to @option{-march=mips64r2}.
17795 @item -mips64r3
17796 @opindex mips64r3
17797 Equivalent to @option{-march=mips64r3}.
17799 @item -mips64r5
17800 @opindex mips64r5
17801 Equivalent to @option{-march=mips64r5}.
17803 @item -mips64r6
17804 @opindex mips64r6
17805 Equivalent to @option{-march=mips64r6}.
17807 @item -mips16
17808 @itemx -mno-mips16
17809 @opindex mips16
17810 @opindex mno-mips16
17811 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17812 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17814 MIPS16 code generation can also be controlled on a per-function basis
17815 by means of @code{mips16} and @code{nomips16} attributes.
17816 @xref{Function Attributes}, for more information.
17818 @item -mflip-mips16
17819 @opindex mflip-mips16
17820 Generate MIPS16 code on alternating functions.  This option is provided
17821 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17822 not intended for ordinary use in compiling user code.
17824 @item -minterlink-compressed
17825 @item -mno-interlink-compressed
17826 @opindex minterlink-compressed
17827 @opindex mno-interlink-compressed
17828 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17829 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17831 For example, code using the standard ISA encoding cannot jump directly
17832 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17833 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17834 knows that the target of the jump is not compressed.
17836 @item -minterlink-mips16
17837 @itemx -mno-interlink-mips16
17838 @opindex minterlink-mips16
17839 @opindex mno-interlink-mips16
17840 Aliases of @option{-minterlink-compressed} and
17841 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17842 and are retained for backwards compatibility.
17844 @item -mabi=32
17845 @itemx -mabi=o64
17846 @itemx -mabi=n32
17847 @itemx -mabi=64
17848 @itemx -mabi=eabi
17849 @opindex mabi=32
17850 @opindex mabi=o64
17851 @opindex mabi=n32
17852 @opindex mabi=64
17853 @opindex mabi=eabi
17854 Generate code for the given ABI@.
17856 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17857 generates 64-bit code when you select a 64-bit architecture, but you
17858 can use @option{-mgp32} to get 32-bit code instead.
17860 For information about the O64 ABI, see
17861 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17863 GCC supports a variant of the o32 ABI in which floating-point registers
17864 are 64 rather than 32 bits wide.  You can select this combination with
17865 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17866 and @code{mfhc1} instructions and is therefore only supported for
17867 MIPS32R2, MIPS32R3 and MIPS32R5 processors.
17869 The register assignments for arguments and return values remain the
17870 same, but each scalar value is passed in a single 64-bit register
17871 rather than a pair of 32-bit registers.  For example, scalar
17872 floating-point values are returned in @samp{$f0} only, not a
17873 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17874 remains the same in that the even-numbered double-precision registers
17875 are saved.
17877 Two additional variants of the o32 ABI are supported to enable
17878 a transition from 32-bit to 64-bit registers.  These are FPXX
17879 (@option{-mfpxx}) and FP64A (@option{-mfp64} @option{-mno-odd-spreg}).
17880 The FPXX extension mandates that all code must execute correctly
17881 when run using 32-bit or 64-bit registers.  The code can be interlinked
17882 with either FP32 or FP64, but not both.
17883 The FP64A extension is similar to the FP64 extension but forbids the
17884 use of odd-numbered single-precision registers.  This can be used
17885 in conjunction with the @code{FRE} mode of FPUs in MIPS32R5
17886 processors and allows both FP32 and FP64A code to interlink and
17887 run in the same process without changing FPU modes.
17889 @item -mabicalls
17890 @itemx -mno-abicalls
17891 @opindex mabicalls
17892 @opindex mno-abicalls
17893 Generate (do not generate) code that is suitable for SVR4-style
17894 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17895 systems.
17897 @item -mshared
17898 @itemx -mno-shared
17899 Generate (do not generate) code that is fully position-independent,
17900 and that can therefore be linked into shared libraries.  This option
17901 only affects @option{-mabicalls}.
17903 All @option{-mabicalls} code has traditionally been position-independent,
17904 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17905 as an extension, the GNU toolchain allows executables to use absolute
17906 accesses for locally-binding symbols.  It can also use shorter GP
17907 initialization sequences and generate direct calls to locally-defined
17908 functions.  This mode is selected by @option{-mno-shared}.
17910 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17911 objects that can only be linked by the GNU linker.  However, the option
17912 does not affect the ABI of the final executable; it only affects the ABI
17913 of relocatable objects.  Using @option{-mno-shared} generally makes
17914 executables both smaller and quicker.
17916 @option{-mshared} is the default.
17918 @item -mplt
17919 @itemx -mno-plt
17920 @opindex mplt
17921 @opindex mno-plt
17922 Assume (do not assume) that the static and dynamic linkers
17923 support PLTs and copy relocations.  This option only affects
17924 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17925 has no effect without @option{-msym32}.
17927 You can make @option{-mplt} the default by configuring
17928 GCC with @option{--with-mips-plt}.  The default is
17929 @option{-mno-plt} otherwise.
17931 @item -mxgot
17932 @itemx -mno-xgot
17933 @opindex mxgot
17934 @opindex mno-xgot
17935 Lift (do not lift) the usual restrictions on the size of the global
17936 offset table.
17938 GCC normally uses a single instruction to load values from the GOT@.
17939 While this is relatively efficient, it only works if the GOT
17940 is smaller than about 64k.  Anything larger causes the linker
17941 to report an error such as:
17943 @cindex relocation truncated to fit (MIPS)
17944 @smallexample
17945 relocation truncated to fit: R_MIPS_GOT16 foobar
17946 @end smallexample
17948 If this happens, you should recompile your code with @option{-mxgot}.
17949 This works with very large GOTs, although the code is also
17950 less efficient, since it takes three instructions to fetch the
17951 value of a global symbol.
17953 Note that some linkers can create multiple GOTs.  If you have such a
17954 linker, you should only need to use @option{-mxgot} when a single object
17955 file accesses more than 64k's worth of GOT entries.  Very few do.
17957 These options have no effect unless GCC is generating position
17958 independent code.
17960 @item -mgp32
17961 @opindex mgp32
17962 Assume that general-purpose registers are 32 bits wide.
17964 @item -mgp64
17965 @opindex mgp64
17966 Assume that general-purpose registers are 64 bits wide.
17968 @item -mfp32
17969 @opindex mfp32
17970 Assume that floating-point registers are 32 bits wide.
17972 @item -mfp64
17973 @opindex mfp64
17974 Assume that floating-point registers are 64 bits wide.
17976 @item -mfpxx
17977 @opindex mfpxx
17978 Do not assume the width of floating-point registers.
17980 @item -mhard-float
17981 @opindex mhard-float
17982 Use floating-point coprocessor instructions.
17984 @item -msoft-float
17985 @opindex msoft-float
17986 Do not use floating-point coprocessor instructions.  Implement
17987 floating-point calculations using library calls instead.
17989 @item -mno-float
17990 @opindex mno-float
17991 Equivalent to @option{-msoft-float}, but additionally asserts that the
17992 program being compiled does not perform any floating-point operations.
17993 This option is presently supported only by some bare-metal MIPS
17994 configurations, where it may select a special set of libraries
17995 that lack all floating-point support (including, for example, the
17996 floating-point @code{printf} formats).  
17997 If code compiled with @code{-mno-float} accidentally contains
17998 floating-point operations, it is likely to suffer a link-time
17999 or run-time failure.
18001 @item -msingle-float
18002 @opindex msingle-float
18003 Assume that the floating-point coprocessor only supports single-precision
18004 operations.
18006 @item -mdouble-float
18007 @opindex mdouble-float
18008 Assume that the floating-point coprocessor supports double-precision
18009 operations.  This is the default.
18011 @item -modd-spreg
18012 @itemx -mno-odd-spreg
18013 @opindex modd-spreg
18014 @opindex mno-odd-spreg
18015 Enable the use of odd-numbered single-precision floating-point registers
18016 for the o32 ABI.  This is the default for processors that are known to
18017 support these registers.  When using the o32 FPXX ABI, @code{-mno-odd-spreg}
18018 is set by default.
18020 @item -mabs=2008
18021 @itemx -mabs=legacy
18022 @opindex mabs=2008
18023 @opindex mabs=legacy
18024 These options control the treatment of the special not-a-number (NaN)
18025 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
18026 @code{neg.@i{fmt}} machine instructions.
18028 By default or when the @option{-mabs=legacy} is used the legacy
18029 treatment is selected.  In this case these instructions are considered
18030 arithmetic and avoided where correct operation is required and the
18031 input operand might be a NaN.  A longer sequence of instructions that
18032 manipulate the sign bit of floating-point datum manually is used
18033 instead unless the @option{-ffinite-math-only} option has also been
18034 specified.
18036 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
18037 this case these instructions are considered non-arithmetic and therefore
18038 operating correctly in all cases, including in particular where the
18039 input operand is a NaN.  These instructions are therefore always used
18040 for the respective operations.
18042 @item -mnan=2008
18043 @itemx -mnan=legacy
18044 @opindex mnan=2008
18045 @opindex mnan=legacy
18046 These options control the encoding of the special not-a-number (NaN)
18047 IEEE 754 floating-point data.
18049 The @option{-mnan=legacy} option selects the legacy encoding.  In this
18050 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
18051 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
18052 by the first bit of their trailing significand field being 1.
18054 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
18055 this case qNaNs are denoted by the first bit of their trailing
18056 significand field being 1, whereas sNaNs are denoted by the first bit of
18057 their trailing significand field being 0.
18059 The default is @option{-mnan=legacy} unless GCC has been configured with
18060 @option{--with-nan=2008}.
18062 @item -mllsc
18063 @itemx -mno-llsc
18064 @opindex mllsc
18065 @opindex mno-llsc
18066 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
18067 implement atomic memory built-in functions.  When neither option is
18068 specified, GCC uses the instructions if the target architecture
18069 supports them.
18071 @option{-mllsc} is useful if the runtime environment can emulate the
18072 instructions and @option{-mno-llsc} can be useful when compiling for
18073 nonstandard ISAs.  You can make either option the default by
18074 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
18075 respectively.  @option{--with-llsc} is the default for some
18076 configurations; see the installation documentation for details.
18078 @item -mdsp
18079 @itemx -mno-dsp
18080 @opindex mdsp
18081 @opindex mno-dsp
18082 Use (do not use) revision 1 of the MIPS DSP ASE@.
18083 @xref{MIPS DSP Built-in Functions}.  This option defines the
18084 preprocessor macro @samp{__mips_dsp}.  It also defines
18085 @samp{__mips_dsp_rev} to 1.
18087 @item -mdspr2
18088 @itemx -mno-dspr2
18089 @opindex mdspr2
18090 @opindex mno-dspr2
18091 Use (do not use) revision 2 of the MIPS DSP ASE@.
18092 @xref{MIPS DSP Built-in Functions}.  This option defines the
18093 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
18094 It also defines @samp{__mips_dsp_rev} to 2.
18096 @item -msmartmips
18097 @itemx -mno-smartmips
18098 @opindex msmartmips
18099 @opindex mno-smartmips
18100 Use (do not use) the MIPS SmartMIPS ASE.
18102 @item -mpaired-single
18103 @itemx -mno-paired-single
18104 @opindex mpaired-single
18105 @opindex mno-paired-single
18106 Use (do not use) paired-single floating-point instructions.
18107 @xref{MIPS Paired-Single Support}.  This option requires
18108 hardware floating-point support to be enabled.
18110 @item -mdmx
18111 @itemx -mno-mdmx
18112 @opindex mdmx
18113 @opindex mno-mdmx
18114 Use (do not use) MIPS Digital Media Extension instructions.
18115 This option can only be used when generating 64-bit code and requires
18116 hardware floating-point support to be enabled.
18118 @item -mips3d
18119 @itemx -mno-mips3d
18120 @opindex mips3d
18121 @opindex mno-mips3d
18122 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
18123 The option @option{-mips3d} implies @option{-mpaired-single}.
18125 @item -mmicromips
18126 @itemx -mno-micromips
18127 @opindex mmicromips
18128 @opindex mno-mmicromips
18129 Generate (do not generate) microMIPS code.
18131 MicroMIPS code generation can also be controlled on a per-function basis
18132 by means of @code{micromips} and @code{nomicromips} attributes.
18133 @xref{Function Attributes}, for more information.
18135 @item -mmt
18136 @itemx -mno-mt
18137 @opindex mmt
18138 @opindex mno-mt
18139 Use (do not use) MT Multithreading instructions.
18141 @item -mmcu
18142 @itemx -mno-mcu
18143 @opindex mmcu
18144 @opindex mno-mcu
18145 Use (do not use) the MIPS MCU ASE instructions.
18147 @item -meva
18148 @itemx -mno-eva
18149 @opindex meva
18150 @opindex mno-eva
18151 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
18153 @item -mvirt
18154 @itemx -mno-virt
18155 @opindex mvirt
18156 @opindex mno-virt
18157 Use (do not use) the MIPS Virtualization Application Specific instructions.
18159 @item -mxpa
18160 @itemx -mno-xpa
18161 @opindex mxpa
18162 @opindex mno-xpa
18163 Use (do not use) the MIPS eXtended Physical Address (XPA) instructions.
18165 @item -mlong64
18166 @opindex mlong64
18167 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
18168 an explanation of the default and the way that the pointer size is
18169 determined.
18171 @item -mlong32
18172 @opindex mlong32
18173 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
18175 The default size of @code{int}s, @code{long}s and pointers depends on
18176 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
18177 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
18178 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
18179 or the same size as integer registers, whichever is smaller.
18181 @item -msym32
18182 @itemx -mno-sym32
18183 @opindex msym32
18184 @opindex mno-sym32
18185 Assume (do not assume) that all symbols have 32-bit values, regardless
18186 of the selected ABI@.  This option is useful in combination with
18187 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
18188 to generate shorter and faster references to symbolic addresses.
18190 @item -G @var{num}
18191 @opindex G
18192 Put definitions of externally-visible data in a small data section
18193 if that data is no bigger than @var{num} bytes.  GCC can then generate
18194 more efficient accesses to the data; see @option{-mgpopt} for details.
18196 The default @option{-G} option depends on the configuration.
18198 @item -mlocal-sdata
18199 @itemx -mno-local-sdata
18200 @opindex mlocal-sdata
18201 @opindex mno-local-sdata
18202 Extend (do not extend) the @option{-G} behavior to local data too,
18203 such as to static variables in C@.  @option{-mlocal-sdata} is the
18204 default for all configurations.
18206 If the linker complains that an application is using too much small data,
18207 you might want to try rebuilding the less performance-critical parts with
18208 @option{-mno-local-sdata}.  You might also want to build large
18209 libraries with @option{-mno-local-sdata}, so that the libraries leave
18210 more room for the main program.
18212 @item -mextern-sdata
18213 @itemx -mno-extern-sdata
18214 @opindex mextern-sdata
18215 @opindex mno-extern-sdata
18216 Assume (do not assume) that externally-defined data is in
18217 a small data section if the size of that data is within the @option{-G} limit.
18218 @option{-mextern-sdata} is the default for all configurations.
18220 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
18221 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
18222 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
18223 is placed in a small data section.  If @var{Var} is defined by another
18224 module, you must either compile that module with a high-enough
18225 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
18226 definition.  If @var{Var} is common, you must link the application
18227 with a high-enough @option{-G} setting.
18229 The easiest way of satisfying these restrictions is to compile
18230 and link every module with the same @option{-G} option.  However,
18231 you may wish to build a library that supports several different
18232 small data limits.  You can do this by compiling the library with
18233 the highest supported @option{-G} setting and additionally using
18234 @option{-mno-extern-sdata} to stop the library from making assumptions
18235 about externally-defined data.
18237 @item -mgpopt
18238 @itemx -mno-gpopt
18239 @opindex mgpopt
18240 @opindex mno-gpopt
18241 Use (do not use) GP-relative accesses for symbols that are known to be
18242 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
18243 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
18244 configurations.
18246 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
18247 might not hold the value of @code{_gp}.  For example, if the code is
18248 part of a library that might be used in a boot monitor, programs that
18249 call boot monitor routines pass an unknown value in @code{$gp}.
18250 (In such situations, the boot monitor itself is usually compiled
18251 with @option{-G0}.)
18253 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
18254 @option{-mno-extern-sdata}.
18256 @item -membedded-data
18257 @itemx -mno-embedded-data
18258 @opindex membedded-data
18259 @opindex mno-embedded-data
18260 Allocate variables to the read-only data section first if possible, then
18261 next in the small data section if possible, otherwise in data.  This gives
18262 slightly slower code than the default, but reduces the amount of RAM required
18263 when executing, and thus may be preferred for some embedded systems.
18265 @item -muninit-const-in-rodata
18266 @itemx -mno-uninit-const-in-rodata
18267 @opindex muninit-const-in-rodata
18268 @opindex mno-uninit-const-in-rodata
18269 Put uninitialized @code{const} variables in the read-only data section.
18270 This option is only meaningful in conjunction with @option{-membedded-data}.
18272 @item -mcode-readable=@var{setting}
18273 @opindex mcode-readable
18274 Specify whether GCC may generate code that reads from executable sections.
18275 There are three possible settings:
18277 @table @gcctabopt
18278 @item -mcode-readable=yes
18279 Instructions may freely access executable sections.  This is the
18280 default setting.
18282 @item -mcode-readable=pcrel
18283 MIPS16 PC-relative load instructions can access executable sections,
18284 but other instructions must not do so.  This option is useful on 4KSc
18285 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
18286 It is also useful on processors that can be configured to have a dual
18287 instruction/data SRAM interface and that, like the M4K, automatically
18288 redirect PC-relative loads to the instruction RAM.
18290 @item -mcode-readable=no
18291 Instructions must not access executable sections.  This option can be
18292 useful on targets that are configured to have a dual instruction/data
18293 SRAM interface but that (unlike the M4K) do not automatically redirect
18294 PC-relative loads to the instruction RAM.
18295 @end table
18297 @item -msplit-addresses
18298 @itemx -mno-split-addresses
18299 @opindex msplit-addresses
18300 @opindex mno-split-addresses
18301 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
18302 relocation operators.  This option has been superseded by
18303 @option{-mexplicit-relocs} but is retained for backwards compatibility.
18305 @item -mexplicit-relocs
18306 @itemx -mno-explicit-relocs
18307 @opindex mexplicit-relocs
18308 @opindex mno-explicit-relocs
18309 Use (do not use) assembler relocation operators when dealing with symbolic
18310 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
18311 is to use assembler macros instead.
18313 @option{-mexplicit-relocs} is the default if GCC was configured
18314 to use an assembler that supports relocation operators.
18316 @item -mcheck-zero-division
18317 @itemx -mno-check-zero-division
18318 @opindex mcheck-zero-division
18319 @opindex mno-check-zero-division
18320 Trap (do not trap) on integer division by zero.
18322 The default is @option{-mcheck-zero-division}.
18324 @item -mdivide-traps
18325 @itemx -mdivide-breaks
18326 @opindex mdivide-traps
18327 @opindex mdivide-breaks
18328 MIPS systems check for division by zero by generating either a
18329 conditional trap or a break instruction.  Using traps results in
18330 smaller code, but is only supported on MIPS II and later.  Also, some
18331 versions of the Linux kernel have a bug that prevents trap from
18332 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
18333 allow conditional traps on architectures that support them and
18334 @option{-mdivide-breaks} to force the use of breaks.
18336 The default is usually @option{-mdivide-traps}, but this can be
18337 overridden at configure time using @option{--with-divide=breaks}.
18338 Divide-by-zero checks can be completely disabled using
18339 @option{-mno-check-zero-division}.
18341 @item -mmemcpy
18342 @itemx -mno-memcpy
18343 @opindex mmemcpy
18344 @opindex mno-memcpy
18345 Force (do not force) the use of @code{memcpy()} for non-trivial block
18346 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
18347 most constant-sized copies.
18349 @item -mlong-calls
18350 @itemx -mno-long-calls
18351 @opindex mlong-calls
18352 @opindex mno-long-calls
18353 Disable (do not disable) use of the @code{jal} instruction.  Calling
18354 functions using @code{jal} is more efficient but requires the caller
18355 and callee to be in the same 256 megabyte segment.
18357 This option has no effect on abicalls code.  The default is
18358 @option{-mno-long-calls}.
18360 @item -mmad
18361 @itemx -mno-mad
18362 @opindex mmad
18363 @opindex mno-mad
18364 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
18365 instructions, as provided by the R4650 ISA@.
18367 @item -mimadd
18368 @itemx -mno-imadd
18369 @opindex mimadd
18370 @opindex mno-imadd
18371 Enable (disable) use of the @code{madd} and @code{msub} integer
18372 instructions.  The default is @option{-mimadd} on architectures
18373 that support @code{madd} and @code{msub} except for the 74k 
18374 architecture where it was found to generate slower code.
18376 @item -mfused-madd
18377 @itemx -mno-fused-madd
18378 @opindex mfused-madd
18379 @opindex mno-fused-madd
18380 Enable (disable) use of the floating-point multiply-accumulate
18381 instructions, when they are available.  The default is
18382 @option{-mfused-madd}.
18384 On the R8000 CPU when multiply-accumulate instructions are used,
18385 the intermediate product is calculated to infinite precision
18386 and is not subject to the FCSR Flush to Zero bit.  This may be
18387 undesirable in some circumstances.  On other processors the result
18388 is numerically identical to the equivalent computation using
18389 separate multiply, add, subtract and negate instructions.
18391 @item -nocpp
18392 @opindex nocpp
18393 Tell the MIPS assembler to not run its preprocessor over user
18394 assembler files (with a @samp{.s} suffix) when assembling them.
18396 @item -mfix-24k
18397 @item -mno-fix-24k
18398 @opindex mfix-24k
18399 @opindex mno-fix-24k
18400 Work around the 24K E48 (lost data on stores during refill) errata.
18401 The workarounds are implemented by the assembler rather than by GCC@.
18403 @item -mfix-r4000
18404 @itemx -mno-fix-r4000
18405 @opindex mfix-r4000
18406 @opindex mno-fix-r4000
18407 Work around certain R4000 CPU errata:
18408 @itemize @minus
18409 @item
18410 A double-word or a variable shift may give an incorrect result if executed
18411 immediately after starting an integer division.
18412 @item
18413 A double-word or a variable shift may give an incorrect result if executed
18414 while an integer multiplication is in progress.
18415 @item
18416 An integer division may give an incorrect result if started in a delay slot
18417 of a taken branch or a jump.
18418 @end itemize
18420 @item -mfix-r4400
18421 @itemx -mno-fix-r4400
18422 @opindex mfix-r4400
18423 @opindex mno-fix-r4400
18424 Work around certain R4400 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 @end itemize
18431 @item -mfix-r10000
18432 @itemx -mno-fix-r10000
18433 @opindex mfix-r10000
18434 @opindex mno-fix-r10000
18435 Work around certain R10000 errata:
18436 @itemize @minus
18437 @item
18438 @code{ll}/@code{sc} sequences may not behave atomically on revisions
18439 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
18440 @end itemize
18442 This option can only be used if the target architecture supports
18443 branch-likely instructions.  @option{-mfix-r10000} is the default when
18444 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
18445 otherwise.
18447 @item -mfix-rm7000
18448 @itemx -mno-fix-rm7000
18449 @opindex mfix-rm7000
18450 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
18451 workarounds are implemented by the assembler rather than by GCC@.
18453 @item -mfix-vr4120
18454 @itemx -mno-fix-vr4120
18455 @opindex mfix-vr4120
18456 Work around certain VR4120 errata:
18457 @itemize @minus
18458 @item
18459 @code{dmultu} does not always produce the correct result.
18460 @item
18461 @code{div} and @code{ddiv} do not always produce the correct result if one
18462 of the operands is negative.
18463 @end itemize
18464 The workarounds for the division errata rely on special functions in
18465 @file{libgcc.a}.  At present, these functions are only provided by
18466 the @code{mips64vr*-elf} configurations.
18468 Other VR4120 errata require a NOP to be inserted between certain pairs of
18469 instructions.  These errata are handled by the assembler, not by GCC itself.
18471 @item -mfix-vr4130
18472 @opindex mfix-vr4130
18473 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
18474 workarounds are implemented by the assembler rather than by GCC,
18475 although GCC avoids using @code{mflo} and @code{mfhi} if the
18476 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
18477 instructions are available instead.
18479 @item -mfix-sb1
18480 @itemx -mno-fix-sb1
18481 @opindex mfix-sb1
18482 Work around certain SB-1 CPU core errata.
18483 (This flag currently works around the SB-1 revision 2
18484 ``F1'' and ``F2'' floating-point errata.)
18486 @item -mr10k-cache-barrier=@var{setting}
18487 @opindex mr10k-cache-barrier
18488 Specify whether GCC should insert cache barriers to avoid the
18489 side-effects of speculation on R10K processors.
18491 In common with many processors, the R10K tries to predict the outcome
18492 of a conditional branch and speculatively executes instructions from
18493 the ``taken'' branch.  It later aborts these instructions if the
18494 predicted outcome is wrong.  However, on the R10K, even aborted
18495 instructions can have side effects.
18497 This problem only affects kernel stores and, depending on the system,
18498 kernel loads.  As an example, a speculatively-executed store may load
18499 the target memory into cache and mark the cache line as dirty, even if
18500 the store itself is later aborted.  If a DMA operation writes to the
18501 same area of memory before the ``dirty'' line is flushed, the cached
18502 data overwrites the DMA-ed data.  See the R10K processor manual
18503 for a full description, including other potential problems.
18505 One workaround is to insert cache barrier instructions before every memory
18506 access that might be speculatively executed and that might have side
18507 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
18508 controls GCC's implementation of this workaround.  It assumes that
18509 aborted accesses to any byte in the following regions does not have
18510 side effects:
18512 @enumerate
18513 @item
18514 the memory occupied by the current function's stack frame;
18516 @item
18517 the memory occupied by an incoming stack argument;
18519 @item
18520 the memory occupied by an object with a link-time-constant address.
18521 @end enumerate
18523 It is the kernel's responsibility to ensure that speculative
18524 accesses to these regions are indeed safe.
18526 If the input program contains a function declaration such as:
18528 @smallexample
18529 void foo (void);
18530 @end smallexample
18532 then the implementation of @code{foo} must allow @code{j foo} and
18533 @code{jal foo} to be executed speculatively.  GCC honors this
18534 restriction for functions it compiles itself.  It expects non-GCC
18535 functions (such as hand-written assembly code) to do the same.
18537 The option has three forms:
18539 @table @gcctabopt
18540 @item -mr10k-cache-barrier=load-store
18541 Insert a cache barrier before a load or store that might be
18542 speculatively executed and that might have side effects even
18543 if aborted.
18545 @item -mr10k-cache-barrier=store
18546 Insert a cache barrier before a store that might be speculatively
18547 executed and that might have side effects even if aborted.
18549 @item -mr10k-cache-barrier=none
18550 Disable the insertion of cache barriers.  This is the default setting.
18551 @end table
18553 @item -mflush-func=@var{func}
18554 @itemx -mno-flush-func
18555 @opindex mflush-func
18556 Specifies the function to call to flush the I and D caches, or to not
18557 call any such function.  If called, the function must take the same
18558 arguments as the common @code{_flush_func()}, that is, the address of the
18559 memory range for which the cache is being flushed, the size of the
18560 memory range, and the number 3 (to flush both caches).  The default
18561 depends on the target GCC was configured for, but commonly is either
18562 @samp{_flush_func} or @samp{__cpu_flush}.
18564 @item mbranch-cost=@var{num}
18565 @opindex mbranch-cost
18566 Set the cost of branches to roughly @var{num} ``simple'' instructions.
18567 This cost is only a heuristic and is not guaranteed to produce
18568 consistent results across releases.  A zero cost redundantly selects
18569 the default, which is based on the @option{-mtune} setting.
18571 @item -mbranch-likely
18572 @itemx -mno-branch-likely
18573 @opindex mbranch-likely
18574 @opindex mno-branch-likely
18575 Enable or disable use of Branch Likely instructions, regardless of the
18576 default for the selected architecture.  By default, Branch Likely
18577 instructions may be generated if they are supported by the selected
18578 architecture.  An exception is for the MIPS32 and MIPS64 architectures
18579 and processors that implement those architectures; for those, Branch
18580 Likely instructions are not be generated by default because the MIPS32
18581 and MIPS64 architectures specifically deprecate their use.
18583 @item -mfp-exceptions
18584 @itemx -mno-fp-exceptions
18585 @opindex mfp-exceptions
18586 Specifies whether FP exceptions are enabled.  This affects how
18587 FP instructions are scheduled for some processors.
18588 The default is that FP exceptions are
18589 enabled.
18591 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
18592 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
18593 FP pipe.
18595 @item -mvr4130-align
18596 @itemx -mno-vr4130-align
18597 @opindex mvr4130-align
18598 The VR4130 pipeline is two-way superscalar, but can only issue two
18599 instructions together if the first one is 8-byte aligned.  When this
18600 option is enabled, GCC aligns pairs of instructions that it
18601 thinks should execute in parallel.
18603 This option only has an effect when optimizing for the VR4130.
18604 It normally makes code faster, but at the expense of making it bigger.
18605 It is enabled by default at optimization level @option{-O3}.
18607 @item -msynci
18608 @itemx -mno-synci
18609 @opindex msynci
18610 Enable (disable) generation of @code{synci} instructions on
18611 architectures that support it.  The @code{synci} instructions (if
18612 enabled) are generated when @code{__builtin___clear_cache()} is
18613 compiled.
18615 This option defaults to @code{-mno-synci}, but the default can be
18616 overridden by configuring with @code{--with-synci}.
18618 When compiling code for single processor systems, it is generally safe
18619 to use @code{synci}.  However, on many multi-core (SMP) systems, it
18620 does not invalidate the instruction caches on all cores and may lead
18621 to undefined behavior.
18623 @item -mrelax-pic-calls
18624 @itemx -mno-relax-pic-calls
18625 @opindex mrelax-pic-calls
18626 Try to turn PIC calls that are normally dispatched via register
18627 @code{$25} into direct calls.  This is only possible if the linker can
18628 resolve the destination at link-time and if the destination is within
18629 range for a direct call.
18631 @option{-mrelax-pic-calls} is the default if GCC was configured to use
18632 an assembler and a linker that support the @code{.reloc} assembly
18633 directive and @code{-mexplicit-relocs} is in effect.  With
18634 @code{-mno-explicit-relocs}, this optimization can be performed by the
18635 assembler and the linker alone without help from the compiler.
18637 @item -mmcount-ra-address
18638 @itemx -mno-mcount-ra-address
18639 @opindex mmcount-ra-address
18640 @opindex mno-mcount-ra-address
18641 Emit (do not emit) code that allows @code{_mcount} to modify the
18642 calling function's return address.  When enabled, this option extends
18643 the usual @code{_mcount} interface with a new @var{ra-address}
18644 parameter, which has type @code{intptr_t *} and is passed in register
18645 @code{$12}.  @code{_mcount} can then modify the return address by
18646 doing both of the following:
18647 @itemize
18648 @item
18649 Returning the new address in register @code{$31}.
18650 @item
18651 Storing the new address in @code{*@var{ra-address}},
18652 if @var{ra-address} is nonnull.
18653 @end itemize
18655 The default is @option{-mno-mcount-ra-address}.
18657 @end table
18659 @node MMIX Options
18660 @subsection MMIX Options
18661 @cindex MMIX Options
18663 These options are defined for the MMIX:
18665 @table @gcctabopt
18666 @item -mlibfuncs
18667 @itemx -mno-libfuncs
18668 @opindex mlibfuncs
18669 @opindex mno-libfuncs
18670 Specify that intrinsic library functions are being compiled, passing all
18671 values in registers, no matter the size.
18673 @item -mepsilon
18674 @itemx -mno-epsilon
18675 @opindex mepsilon
18676 @opindex mno-epsilon
18677 Generate floating-point comparison instructions that compare with respect
18678 to the @code{rE} epsilon register.
18680 @item -mabi=mmixware
18681 @itemx -mabi=gnu
18682 @opindex mabi=mmixware
18683 @opindex mabi=gnu
18684 Generate code that passes function parameters and return values that (in
18685 the called function) are seen as registers @code{$0} and up, as opposed to
18686 the GNU ABI which uses global registers @code{$231} and up.
18688 @item -mzero-extend
18689 @itemx -mno-zero-extend
18690 @opindex mzero-extend
18691 @opindex mno-zero-extend
18692 When reading data from memory in sizes shorter than 64 bits, use (do not
18693 use) zero-extending load instructions by default, rather than
18694 sign-extending ones.
18696 @item -mknuthdiv
18697 @itemx -mno-knuthdiv
18698 @opindex mknuthdiv
18699 @opindex mno-knuthdiv
18700 Make the result of a division yielding a remainder have the same sign as
18701 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18702 remainder follows the sign of the dividend.  Both methods are
18703 arithmetically valid, the latter being almost exclusively used.
18705 @item -mtoplevel-symbols
18706 @itemx -mno-toplevel-symbols
18707 @opindex mtoplevel-symbols
18708 @opindex mno-toplevel-symbols
18709 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18710 code can be used with the @code{PREFIX} assembly directive.
18712 @item -melf
18713 @opindex melf
18714 Generate an executable in the ELF format, rather than the default
18715 @samp{mmo} format used by the @command{mmix} simulator.
18717 @item -mbranch-predict
18718 @itemx -mno-branch-predict
18719 @opindex mbranch-predict
18720 @opindex mno-branch-predict
18721 Use (do not use) the probable-branch instructions, when static branch
18722 prediction indicates a probable branch.
18724 @item -mbase-addresses
18725 @itemx -mno-base-addresses
18726 @opindex mbase-addresses
18727 @opindex mno-base-addresses
18728 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18729 base address automatically generates a request (handled by the assembler
18730 and the linker) for a constant to be set up in a global register.  The
18731 register is used for one or more base address requests within the range 0
18732 to 255 from the value held in the register.  The generally leads to short
18733 and fast code, but the number of different data items that can be
18734 addressed is limited.  This means that a program that uses lots of static
18735 data may require @option{-mno-base-addresses}.
18737 @item -msingle-exit
18738 @itemx -mno-single-exit
18739 @opindex msingle-exit
18740 @opindex mno-single-exit
18741 Force (do not force) generated code to have a single exit point in each
18742 function.
18743 @end table
18745 @node MN10300 Options
18746 @subsection MN10300 Options
18747 @cindex MN10300 options
18749 These @option{-m} options are defined for Matsushita MN10300 architectures:
18751 @table @gcctabopt
18752 @item -mmult-bug
18753 @opindex mmult-bug
18754 Generate code to avoid bugs in the multiply instructions for the MN10300
18755 processors.  This is the default.
18757 @item -mno-mult-bug
18758 @opindex mno-mult-bug
18759 Do not generate code to avoid bugs in the multiply instructions for the
18760 MN10300 processors.
18762 @item -mam33
18763 @opindex mam33
18764 Generate code using features specific to the AM33 processor.
18766 @item -mno-am33
18767 @opindex mno-am33
18768 Do not generate code using features specific to the AM33 processor.  This
18769 is the default.
18771 @item -mam33-2
18772 @opindex mam33-2
18773 Generate code using features specific to the AM33/2.0 processor.
18775 @item -mam34
18776 @opindex mam34
18777 Generate code using features specific to the AM34 processor.
18779 @item -mtune=@var{cpu-type}
18780 @opindex mtune
18781 Use the timing characteristics of the indicated CPU type when
18782 scheduling instructions.  This does not change the targeted processor
18783 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18784 @samp{am33-2} or @samp{am34}.
18786 @item -mreturn-pointer-on-d0
18787 @opindex mreturn-pointer-on-d0
18788 When generating a function that returns a pointer, return the pointer
18789 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18790 only in @code{a0}, and attempts to call such functions without a prototype
18791 result in errors.  Note that this option is on by default; use
18792 @option{-mno-return-pointer-on-d0} to disable it.
18794 @item -mno-crt0
18795 @opindex mno-crt0
18796 Do not link in the C run-time initialization object file.
18798 @item -mrelax
18799 @opindex mrelax
18800 Indicate to the linker that it should perform a relaxation optimization pass
18801 to shorten branches, calls and absolute memory addresses.  This option only
18802 has an effect when used on the command line for the final link step.
18804 This option makes symbolic debugging impossible.
18806 @item -mliw
18807 @opindex mliw
18808 Allow the compiler to generate @emph{Long Instruction Word}
18809 instructions if the target is the @samp{AM33} or later.  This is the
18810 default.  This option defines the preprocessor macro @samp{__LIW__}.
18812 @item -mnoliw
18813 @opindex mnoliw
18814 Do not allow the compiler to generate @emph{Long Instruction Word}
18815 instructions.  This option defines the preprocessor macro
18816 @samp{__NO_LIW__}.
18818 @item -msetlb
18819 @opindex msetlb
18820 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18821 instructions if the target is the @samp{AM33} or later.  This is the
18822 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18824 @item -mnosetlb
18825 @opindex mnosetlb
18826 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18827 instructions.  This option defines the preprocessor macro
18828 @samp{__NO_SETLB__}.
18830 @end table
18832 @node Moxie Options
18833 @subsection Moxie Options
18834 @cindex Moxie Options
18836 @table @gcctabopt
18838 @item -meb
18839 @opindex meb
18840 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18841 configurations.
18843 @item -mel
18844 @opindex mel
18845 Generate little-endian code.
18847 @item -mno-crt0
18848 @opindex mno-crt0
18849 Do not link in the C run-time initialization object file.
18851 @end table
18853 @node MSP430 Options
18854 @subsection MSP430 Options
18855 @cindex MSP430 Options
18857 These options are defined for the MSP430:
18859 @table @gcctabopt
18861 @item -masm-hex
18862 @opindex masm-hex
18863 Force assembly output to always use hex constants.  Normally such
18864 constants are signed decimals, but this option is available for
18865 testsuite and/or aesthetic purposes.
18867 @item -mmcu=
18868 @opindex mmcu=
18869 Select the MCU to target.  This is used to create a C preprocessor
18870 symbol based upon the MCU name, converted to upper case and pre- and
18871 post- fixed with @code{__}.  This in turn will be used by the
18872 @code{msp430.h} header file to select an MCU specific supplimentary
18873 header file.
18875 The option also sets the ISA to use.  If the MCU name is one that is
18876 known to only support the 430 ISA then that is selected, otherwise the
18877 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18878 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18879 name will select the 430X ISA.
18881 In addition an MCU specific linker script will be added to the linker
18882 command line.  The script's name is the name of the MCU with
18883 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18884 command line will define the C preprocessor symbol @code{__XXX__} and
18885 cause the linker to search for a script called @file{xxx.ld}.
18887 This option is also passed on to the assembler.
18889 @item -mcpu=
18890 @opindex -mcpu=
18891 Specifies the ISA to use.  Accepted values are @code{msp430},
18892 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18893 @option{-mmcu=} option should be used to select the ISA.
18895 @item -msim
18896 @opindex msim
18897 Link to the simulator runtime libraries and linker script.  Overrides
18898 any scripts that would be selected by the @option{-mmcu=} option.
18900 @item -mlarge
18901 @opindex mlarge
18902 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18904 @item -msmall
18905 @opindex msmall
18906 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18908 @item -mrelax
18909 @opindex mrelax
18910 This option is passed to the assembler and linker, and allows the
18911 linker to perform certain optimizations that cannot be done until
18912 the final link.
18914 @item mhwmult=
18915 @opindex mhwmult=
18916 Describes the type of hardware multiply supported by the target.
18917 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18918 for the original 16-bit-only multiply supported by early MCUs.
18919 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18920 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18921 A value of @code{auto} can also be given.  This tells GCC to deduce
18922 the hardware multiply support based upon the MCU name provided by the
18923 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18924 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18925 default setting.
18927 Hardware multiplies are normally performed by calling a library
18928 routine.  This saves space in the generated code.  When compiling at
18929 @code{-O3} or higher however the hardware multiplier is invoked
18930 inline.  This makes for bigger, but faster code.
18932 The hardware multiply routines disable interrupts whilst running and
18933 restore the previous interrupt state when they finish.  This makes
18934 them safe to use inside interrupt handlers as well as in normal code.
18936 @item -minrt
18937 @opindex minrt
18938 Enable the use of a minimum runtime environment - no static
18939 initializers or constructors.  This is intended for memory-constrained
18940 devices.  The compiler will include special symbols in some objects
18941 that tell the linker and runtime which code fragments are required.
18943 @end table
18945 @node NDS32 Options
18946 @subsection NDS32 Options
18947 @cindex NDS32 Options
18949 These options are defined for NDS32 implementations:
18951 @table @gcctabopt
18953 @item -mbig-endian
18954 @opindex mbig-endian
18955 Generate code in big-endian mode.
18957 @item -mlittle-endian
18958 @opindex mlittle-endian
18959 Generate code in little-endian mode.
18961 @item -mreduced-regs
18962 @opindex mreduced-regs
18963 Use reduced-set registers for register allocation.
18965 @item -mfull-regs
18966 @opindex mfull-regs
18967 Use full-set registers for register allocation.
18969 @item -mcmov
18970 @opindex mcmov
18971 Generate conditional move instructions.
18973 @item -mno-cmov
18974 @opindex mno-cmov
18975 Do not generate conditional move instructions.
18977 @item -mperf-ext
18978 @opindex mperf-ext
18979 Generate performance extension instructions.
18981 @item -mno-perf-ext
18982 @opindex mno-perf-ext
18983 Do not generate performance extension instructions.
18985 @item -mv3push
18986 @opindex mv3push
18987 Generate v3 push25/pop25 instructions.
18989 @item -mno-v3push
18990 @opindex mno-v3push
18991 Do not generate v3 push25/pop25 instructions.
18993 @item -m16-bit
18994 @opindex m16-bit
18995 Generate 16-bit instructions.
18997 @item -mno-16-bit
18998 @opindex mno-16-bit
18999 Do not generate 16-bit instructions.
19001 @item -mgp-direct
19002 @opindex mgp-direct
19003 Generate GP base instructions directly.
19005 @item -mno-gp-direct
19006 @opindex mno-gp-direct
19007 Do no generate GP base instructions directly.
19009 @item -misr-vector-size=@var{num}
19010 @opindex misr-vector-size
19011 Specify the size of each interrupt vector, which must be 4 or 16.
19013 @item -mcache-block-size=@var{num}
19014 @opindex mcache-block-size
19015 Specify the size of each cache block,
19016 which must be a power of 2 between 4 and 512.
19018 @item -march=@var{arch}
19019 @opindex march
19020 Specify the name of the target architecture.
19022 @item -mforce-fp-as-gp
19023 @opindex mforce-fp-as-gp
19024 Prevent $fp being allocated during register allocation so that compiler
19025 is able to force performing fp-as-gp optimization.
19027 @item -mforbid-fp-as-gp
19028 @opindex mforbid-fp-as-gp
19029 Forbid using $fp to access static and global variables.
19030 This option strictly forbids fp-as-gp optimization
19031 regardless of @option{-mforce-fp-as-gp}.
19033 @item -mex9
19034 @opindex mex9
19035 Use special directives to guide linker doing ex9 optimization.
19037 @item -mctor-dtor
19038 @opindex mctor-dtor
19039 Enable constructor/destructor feature.
19041 @item -mrelax
19042 @opindex mrelax
19043 Guide linker to relax instructions.
19045 @end table
19047 @node Nios II Options
19048 @subsection Nios II Options
19049 @cindex Nios II options
19050 @cindex Altera Nios II options
19052 These are the options defined for the Altera Nios II processor.
19054 @table @gcctabopt
19056 @item -G @var{num}
19057 @opindex G
19058 @cindex smaller data references
19059 Put global and static objects less than or equal to @var{num} bytes
19060 into the small data or BSS sections instead of the normal data or BSS
19061 sections.  The default value of @var{num} is 8.
19063 @item -mgpopt
19064 @itemx -mno-gpopt
19065 @opindex mgpopt
19066 @opindex mno-gpopt
19067 Generate (do not generate) GP-relative accesses for objects in the
19068 small data or BSS sections.  The default is @option{-mgpopt} except
19069 when @option{-fpic} or @option{-fPIC} is specified to generate
19070 position-independent code.  Note that the Nios II ABI does not permit
19071 GP-relative accesses from shared libraries.
19073 You may need to specify @option{-mno-gpopt} explicitly when building
19074 programs that include large amounts of small data, including large
19075 GOT data sections.  In this case, the 16-bit offset for GP-relative
19076 addressing may not be large enough to allow access to the entire 
19077 small data section.
19079 @item -mel
19080 @itemx -meb
19081 @opindex mel
19082 @opindex meb
19083 Generate little-endian (default) or big-endian (experimental) code,
19084 respectively.
19086 @item -mbypass-cache
19087 @itemx -mno-bypass-cache
19088 @opindex mno-bypass-cache
19089 @opindex mbypass-cache
19090 Force all load and store instructions to always bypass cache by 
19091 using I/O variants of the instructions. The default is not to
19092 bypass the cache.
19094 @item -mno-cache-volatile 
19095 @itemx -mcache-volatile       
19096 @opindex mcache-volatile 
19097 @opindex mno-cache-volatile
19098 Volatile memory access bypass the cache using the I/O variants of 
19099 the load and store instructions. The default is not to bypass the cache.
19101 @item -mno-fast-sw-div
19102 @itemx -mfast-sw-div
19103 @opindex mno-fast-sw-div
19104 @opindex mfast-sw-div
19105 Do not use table-based fast divide for small numbers. The default 
19106 is to use the fast divide at @option{-O3} and above.
19108 @item -mno-hw-mul
19109 @itemx -mhw-mul
19110 @itemx -mno-hw-mulx
19111 @itemx -mhw-mulx
19112 @itemx -mno-hw-div
19113 @itemx -mhw-div
19114 @opindex mno-hw-mul
19115 @opindex mhw-mul
19116 @opindex mno-hw-mulx
19117 @opindex mhw-mulx
19118 @opindex mno-hw-div
19119 @opindex mhw-div
19120 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
19121 instructions by the compiler. The default is to emit @code{mul}
19122 and not emit @code{div} and @code{mulx}.
19124 @item -mcustom-@var{insn}=@var{N}
19125 @itemx -mno-custom-@var{insn}
19126 @opindex mcustom-@var{insn}
19127 @opindex mno-custom-@var{insn}
19128 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
19129 custom instruction with encoding @var{N} when generating code that uses 
19130 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
19131 instruction 253 for single-precision floating-point add operations instead
19132 of the default behavior of using a library call.
19134 The following values of @var{insn} are supported.  Except as otherwise
19135 noted, floating-point operations are expected to be implemented with
19136 normal IEEE 754 semantics and correspond directly to the C operators or the
19137 equivalent GCC built-in functions (@pxref{Other Builtins}).
19139 Single-precision floating point:
19140 @table @asis
19142 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
19143 Binary arithmetic operations.
19145 @item @samp{fnegs}
19146 Unary negation.
19148 @item @samp{fabss}
19149 Unary absolute value.
19151 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
19152 Comparison operations.
19154 @item @samp{fmins}, @samp{fmaxs}
19155 Floating-point minimum and maximum.  These instructions are only
19156 generated if @option{-ffinite-math-only} is specified.
19158 @item @samp{fsqrts}
19159 Unary square root operation.
19161 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
19162 Floating-point trigonometric and exponential functions.  These instructions
19163 are only generated if @option{-funsafe-math-optimizations} is also specified.
19165 @end table
19167 Double-precision floating point:
19168 @table @asis
19170 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
19171 Binary arithmetic operations.
19173 @item @samp{fnegd}
19174 Unary negation.
19176 @item @samp{fabsd}
19177 Unary absolute value.
19179 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
19180 Comparison operations.
19182 @item @samp{fmind}, @samp{fmaxd}
19183 Double-precision minimum and maximum.  These instructions are only
19184 generated if @option{-ffinite-math-only} is specified.
19186 @item @samp{fsqrtd}
19187 Unary square root operation.
19189 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
19190 Double-precision trigonometric and exponential functions.  These instructions
19191 are only generated if @option{-funsafe-math-optimizations} is also specified.
19193 @end table
19195 Conversions:
19196 @table @asis
19197 @item @samp{fextsd}
19198 Conversion from single precision to double precision.
19200 @item @samp{ftruncds}
19201 Conversion from double precision to single precision.
19203 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
19204 Conversion from floating point to signed or unsigned integer types, with
19205 truncation towards zero.
19207 @item @samp{round}
19208 Conversion from single-precision floating point to signed integer,
19209 rounding to the nearest integer and ties away from zero.
19210 This corresponds to the @code{__builtin_lroundf} function when
19211 @option{-fno-math-errno} is used.
19213 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
19214 Conversion from signed or unsigned integer types to floating-point types.
19216 @end table
19218 In addition, all of the following transfer instructions for internal
19219 registers X and Y must be provided to use any of the double-precision
19220 floating-point instructions.  Custom instructions taking two
19221 double-precision source operands expect the first operand in the
19222 64-bit register X.  The other operand (or only operand of a unary
19223 operation) is given to the custom arithmetic instruction with the
19224 least significant half in source register @var{src1} and the most
19225 significant half in @var{src2}.  A custom instruction that returns a
19226 double-precision result returns the most significant 32 bits in the
19227 destination register and the other half in 32-bit register Y.  
19228 GCC automatically generates the necessary code sequences to write
19229 register X and/or read register Y when double-precision floating-point
19230 instructions are used.
19232 @table @asis
19234 @item @samp{fwrx}
19235 Write @var{src1} into the least significant half of X and @var{src2} into
19236 the most significant half of X.
19238 @item @samp{fwry}
19239 Write @var{src1} into Y.
19241 @item @samp{frdxhi}, @samp{frdxlo}
19242 Read the most or least (respectively) significant half of X and store it in
19243 @var{dest}.
19245 @item @samp{frdy}
19246 Read the value of Y and store it into @var{dest}.
19247 @end table
19249 Note that you can gain more local control over generation of Nios II custom
19250 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
19251 and @code{target("no-custom-@var{insn}")} function attributes
19252 (@pxref{Function Attributes})
19253 or pragmas (@pxref{Function Specific Option Pragmas}).
19255 @item -mcustom-fpu-cfg=@var{name}
19256 @opindex mcustom-fpu-cfg
19258 This option enables a predefined, named set of custom instruction encodings
19259 (see @option{-mcustom-@var{insn}} above).  
19260 Currently, the following sets are defined:
19262 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
19263 @gccoptlist{-mcustom-fmuls=252 @gol
19264 -mcustom-fadds=253 @gol
19265 -mcustom-fsubs=254 @gol
19266 -fsingle-precision-constant}
19268 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
19269 @gccoptlist{-mcustom-fmuls=252 @gol
19270 -mcustom-fadds=253 @gol
19271 -mcustom-fsubs=254 @gol
19272 -mcustom-fdivs=255 @gol
19273 -fsingle-precision-constant}
19275 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
19276 @gccoptlist{-mcustom-floatus=243 @gol
19277 -mcustom-fixsi=244 @gol
19278 -mcustom-floatis=245 @gol
19279 -mcustom-fcmpgts=246 @gol
19280 -mcustom-fcmples=249 @gol
19281 -mcustom-fcmpeqs=250 @gol
19282 -mcustom-fcmpnes=251 @gol
19283 -mcustom-fmuls=252 @gol
19284 -mcustom-fadds=253 @gol
19285 -mcustom-fsubs=254 @gol
19286 -mcustom-fdivs=255 @gol
19287 -fsingle-precision-constant}
19289 Custom instruction assignments given by individual
19290 @option{-mcustom-@var{insn}=} options override those given by
19291 @option{-mcustom-fpu-cfg=}, regardless of the
19292 order of the options on the command line.
19294 Note that you can gain more local control over selection of a FPU
19295 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
19296 function attribute (@pxref{Function Attributes})
19297 or pragma (@pxref{Function Specific Option Pragmas}).
19299 @end table
19301 These additional @samp{-m} options are available for the Altera Nios II
19302 ELF (bare-metal) target:
19304 @table @gcctabopt
19306 @item -mhal
19307 @opindex mhal
19308 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
19309 startup and termination code, and is typically used in conjunction with
19310 @option{-msys-crt0=} to specify the location of the alternate startup code
19311 provided by the HAL BSP.
19313 @item -msmallc
19314 @opindex msmallc
19315 Link with a limited version of the C library, @option{-lsmallc}, rather than
19316 Newlib.
19318 @item -msys-crt0=@var{startfile}
19319 @opindex msys-crt0
19320 @var{startfile} is the file name of the startfile (crt0) to use 
19321 when linking.  This option is only useful in conjunction with @option{-mhal}.
19323 @item -msys-lib=@var{systemlib}
19324 @opindex msys-lib
19325 @var{systemlib} is the library name of the library that provides
19326 low-level system calls required by the C library,
19327 e.g. @code{read} and @code{write}.
19328 This option is typically used to link with a library provided by a HAL BSP.
19330 @end table
19332 @node PDP-11 Options
19333 @subsection PDP-11 Options
19334 @cindex PDP-11 Options
19336 These options are defined for the PDP-11:
19338 @table @gcctabopt
19339 @item -mfpu
19340 @opindex mfpu
19341 Use hardware FPP floating point.  This is the default.  (FIS floating
19342 point on the PDP-11/40 is not supported.)
19344 @item -msoft-float
19345 @opindex msoft-float
19346 Do not use hardware floating point.
19348 @item -mac0
19349 @opindex mac0
19350 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
19352 @item -mno-ac0
19353 @opindex mno-ac0
19354 Return floating-point results in memory.  This is the default.
19356 @item -m40
19357 @opindex m40
19358 Generate code for a PDP-11/40.
19360 @item -m45
19361 @opindex m45
19362 Generate code for a PDP-11/45.  This is the default.
19364 @item -m10
19365 @opindex m10
19366 Generate code for a PDP-11/10.
19368 @item -mbcopy-builtin
19369 @opindex mbcopy-builtin
19370 Use inline @code{movmemhi} patterns for copying memory.  This is the
19371 default.
19373 @item -mbcopy
19374 @opindex mbcopy
19375 Do not use inline @code{movmemhi} patterns for copying memory.
19377 @item -mint16
19378 @itemx -mno-int32
19379 @opindex mint16
19380 @opindex mno-int32
19381 Use 16-bit @code{int}.  This is the default.
19383 @item -mint32
19384 @itemx -mno-int16
19385 @opindex mint32
19386 @opindex mno-int16
19387 Use 32-bit @code{int}.
19389 @item -mfloat64
19390 @itemx -mno-float32
19391 @opindex mfloat64
19392 @opindex mno-float32
19393 Use 64-bit @code{float}.  This is the default.
19395 @item -mfloat32
19396 @itemx -mno-float64
19397 @opindex mfloat32
19398 @opindex mno-float64
19399 Use 32-bit @code{float}.
19401 @item -mabshi
19402 @opindex mabshi
19403 Use @code{abshi2} pattern.  This is the default.
19405 @item -mno-abshi
19406 @opindex mno-abshi
19407 Do not use @code{abshi2} pattern.
19409 @item -mbranch-expensive
19410 @opindex mbranch-expensive
19411 Pretend that branches are expensive.  This is for experimenting with
19412 code generation only.
19414 @item -mbranch-cheap
19415 @opindex mbranch-cheap
19416 Do not pretend that branches are expensive.  This is the default.
19418 @item -munix-asm
19419 @opindex munix-asm
19420 Use Unix assembler syntax.  This is the default when configured for
19421 @samp{pdp11-*-bsd}.
19423 @item -mdec-asm
19424 @opindex mdec-asm
19425 Use DEC assembler syntax.  This is the default when configured for any
19426 PDP-11 target other than @samp{pdp11-*-bsd}.
19427 @end table
19429 @node picoChip Options
19430 @subsection picoChip Options
19431 @cindex picoChip options
19433 These @samp{-m} options are defined for picoChip implementations:
19435 @table @gcctabopt
19437 @item -mae=@var{ae_type}
19438 @opindex mcpu
19439 Set the instruction set, register set, and instruction scheduling
19440 parameters for array element type @var{ae_type}.  Supported values
19441 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
19443 @option{-mae=ANY} selects a completely generic AE type.  Code
19444 generated with this option runs on any of the other AE types.  The
19445 code is not as efficient as it would be if compiled for a specific
19446 AE type, and some types of operation (e.g., multiplication) do not
19447 work properly on all types of AE.
19449 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
19450 for compiled code, and is the default.
19452 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
19453 option may suffer from poor performance of byte (char) manipulation,
19454 since the DSP AE does not provide hardware support for byte load/stores.
19456 @item -msymbol-as-address
19457 Enable the compiler to directly use a symbol name as an address in a
19458 load/store instruction, without first loading it into a
19459 register.  Typically, the use of this option generates larger
19460 programs, which run faster than when the option isn't used.  However, the
19461 results vary from program to program, so it is left as a user option,
19462 rather than being permanently enabled.
19464 @item -mno-inefficient-warnings
19465 Disables warnings about the generation of inefficient code.  These
19466 warnings can be generated, for example, when compiling code that
19467 performs byte-level memory operations on the MAC AE type.  The MAC AE has
19468 no hardware support for byte-level memory operations, so all byte
19469 load/stores must be synthesized from word load/store operations.  This is
19470 inefficient and a warning is generated to indicate
19471 that you should rewrite the code to avoid byte operations, or to target
19472 an AE type that has the necessary hardware support.  This option disables
19473 these warnings.
19475 @end table
19477 @node PowerPC Options
19478 @subsection PowerPC Options
19479 @cindex PowerPC options
19481 These are listed under @xref{RS/6000 and PowerPC Options}.
19483 @node RL78 Options
19484 @subsection RL78 Options
19485 @cindex RL78 Options
19487 @table @gcctabopt
19489 @item -msim
19490 @opindex msim
19491 Links in additional target libraries to support operation within a
19492 simulator.
19494 @item -mmul=none
19495 @itemx -mmul=g13
19496 @itemx -mmul=rl78
19497 @opindex mmul
19498 Specifies the type of hardware multiplication support to be used.  The
19499 default is @code{none}, which uses software multiplication functions.
19500 The @code{g13} option is for the hardware multiply/divide peripheral
19501 only on the RL78/G13 targets.  The @code{rl78} option is for the
19502 standard hardware multiplication defined in the RL78 software manual.
19504 @item -m64bit-doubles
19505 @itemx -m32bit-doubles
19506 @opindex m64bit-doubles
19507 @opindex m32bit-doubles
19508 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19509 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19510 @option{-m32bit-doubles}.
19512 @end table
19514 @node RS/6000 and PowerPC Options
19515 @subsection IBM RS/6000 and PowerPC Options
19516 @cindex RS/6000 and PowerPC Options
19517 @cindex IBM RS/6000 and PowerPC Options
19519 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
19520 @table @gcctabopt
19521 @item -mpowerpc-gpopt
19522 @itemx -mno-powerpc-gpopt
19523 @itemx -mpowerpc-gfxopt
19524 @itemx -mno-powerpc-gfxopt
19525 @need 800
19526 @itemx -mpowerpc64
19527 @itemx -mno-powerpc64
19528 @itemx -mmfcrf
19529 @itemx -mno-mfcrf
19530 @itemx -mpopcntb
19531 @itemx -mno-popcntb
19532 @itemx -mpopcntd
19533 @itemx -mno-popcntd
19534 @itemx -mfprnd
19535 @itemx -mno-fprnd
19536 @need 800
19537 @itemx -mcmpb
19538 @itemx -mno-cmpb
19539 @itemx -mmfpgpr
19540 @itemx -mno-mfpgpr
19541 @itemx -mhard-dfp
19542 @itemx -mno-hard-dfp
19543 @opindex mpowerpc-gpopt
19544 @opindex mno-powerpc-gpopt
19545 @opindex mpowerpc-gfxopt
19546 @opindex mno-powerpc-gfxopt
19547 @opindex mpowerpc64
19548 @opindex mno-powerpc64
19549 @opindex mmfcrf
19550 @opindex mno-mfcrf
19551 @opindex mpopcntb
19552 @opindex mno-popcntb
19553 @opindex mpopcntd
19554 @opindex mno-popcntd
19555 @opindex mfprnd
19556 @opindex mno-fprnd
19557 @opindex mcmpb
19558 @opindex mno-cmpb
19559 @opindex mmfpgpr
19560 @opindex mno-mfpgpr
19561 @opindex mhard-dfp
19562 @opindex mno-hard-dfp
19563 You use these options to specify which instructions are available on the
19564 processor you are using.  The default value of these options is
19565 determined when configuring GCC@.  Specifying the
19566 @option{-mcpu=@var{cpu_type}} overrides the specification of these
19567 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
19568 rather than the options listed above.
19570 Specifying @option{-mpowerpc-gpopt} allows
19571 GCC to use the optional PowerPC architecture instructions in the
19572 General Purpose group, including floating-point square root.  Specifying
19573 @option{-mpowerpc-gfxopt} allows GCC to
19574 use the optional PowerPC architecture instructions in the Graphics
19575 group, including floating-point select.
19577 The @option{-mmfcrf} option allows GCC to generate the move from
19578 condition register field instruction implemented on the POWER4
19579 processor and other processors that support the PowerPC V2.01
19580 architecture.
19581 The @option{-mpopcntb} option allows GCC to generate the popcount and
19582 double-precision FP reciprocal estimate instruction implemented on the
19583 POWER5 processor and other processors that support the PowerPC V2.02
19584 architecture.
19585 The @option{-mpopcntd} option allows GCC to generate the popcount
19586 instruction implemented on the POWER7 processor and other processors
19587 that support the PowerPC V2.06 architecture.
19588 The @option{-mfprnd} option allows GCC to generate the FP round to
19589 integer instructions implemented on the POWER5+ processor and other
19590 processors that support the PowerPC V2.03 architecture.
19591 The @option{-mcmpb} option allows GCC to generate the compare bytes
19592 instruction implemented on the POWER6 processor and other processors
19593 that support the PowerPC V2.05 architecture.
19594 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
19595 general-purpose register instructions implemented on the POWER6X
19596 processor and other processors that support the extended PowerPC V2.05
19597 architecture.
19598 The @option{-mhard-dfp} option allows GCC to generate the decimal
19599 floating-point instructions implemented on some POWER processors.
19601 The @option{-mpowerpc64} option allows GCC to generate the additional
19602 64-bit instructions that are found in the full PowerPC64 architecture
19603 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
19604 @option{-mno-powerpc64}.
19606 @item -mcpu=@var{cpu_type}
19607 @opindex mcpu
19608 Set architecture type, register usage, and
19609 instruction scheduling parameters for machine type @var{cpu_type}.
19610 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
19611 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
19612 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
19613 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
19614 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
19615 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
19616 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
19617 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
19618 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
19619 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
19620 @samp{powerpc64}, and @samp{rs64}.
19622 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
19623 PowerPC and 64-bit PowerPC architecture machine
19624 types, with an appropriate, generic processor model assumed for
19625 scheduling purposes.
19627 The other options specify a specific processor.  Code generated under
19628 those options runs best on that processor, and may not run at all on
19629 others.
19631 The @option{-mcpu} options automatically enable or disable the
19632 following options:
19634 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
19635 -mpopcntb -mpopcntd  -mpowerpc64 @gol
19636 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
19637 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
19638 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
19639 -mquad-memory -mquad-memory-atomic}
19641 The particular options set for any particular CPU varies between
19642 compiler versions, depending on what setting seems to produce optimal
19643 code for that CPU; it doesn't necessarily reflect the actual hardware's
19644 capabilities.  If you wish to set an individual option to a particular
19645 value, you may specify it after the @option{-mcpu} option, like
19646 @option{-mcpu=970 -mno-altivec}.
19648 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
19649 not enabled or disabled by the @option{-mcpu} option at present because
19650 AIX does not have full support for these options.  You may still
19651 enable or disable them individually if you're sure it'll work in your
19652 environment.
19654 @item -mtune=@var{cpu_type}
19655 @opindex mtune
19656 Set the instruction scheduling parameters for machine type
19657 @var{cpu_type}, but do not set the architecture type or register usage,
19658 as @option{-mcpu=@var{cpu_type}} does.  The same
19659 values for @var{cpu_type} are used for @option{-mtune} as for
19660 @option{-mcpu}.  If both are specified, the code generated uses the
19661 architecture and registers set by @option{-mcpu}, but the
19662 scheduling parameters set by @option{-mtune}.
19664 @item -mcmodel=small
19665 @opindex mcmodel=small
19666 Generate PowerPC64 code for the small model: The TOC is limited to
19667 64k.
19669 @item -mcmodel=medium
19670 @opindex mcmodel=medium
19671 Generate PowerPC64 code for the medium model: The TOC and other static
19672 data may be up to a total of 4G in size.
19674 @item -mcmodel=large
19675 @opindex mcmodel=large
19676 Generate PowerPC64 code for the large model: The TOC may be up to 4G
19677 in size.  Other data and code is only limited by the 64-bit address
19678 space.
19680 @item -maltivec
19681 @itemx -mno-altivec
19682 @opindex maltivec
19683 @opindex mno-altivec
19684 Generate code that uses (does not use) AltiVec instructions, and also
19685 enable the use of built-in functions that allow more direct access to
19686 the AltiVec instruction set.  You may also need to set
19687 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19688 enhancements.
19690 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19691 @option{-maltivec=be}, the element order for Altivec intrinsics such
19692 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19693 match array element order corresponding to the endianness of the
19694 target.  That is, element zero identifies the leftmost element in a
19695 vector register when targeting a big-endian platform, and identifies
19696 the rightmost element in a vector register when targeting a
19697 little-endian platform.
19699 @item -maltivec=be
19700 @opindex maltivec=be
19701 Generate Altivec instructions using big-endian element order,
19702 regardless of whether the target is big- or little-endian.  This is
19703 the default when targeting a big-endian platform.
19705 The element order is used to interpret element numbers in Altivec
19706 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19707 @code{vec_insert}.  By default, these will match array element order
19708 corresponding to the endianness for the target.
19710 @item -maltivec=le
19711 @opindex maltivec=le
19712 Generate Altivec instructions using little-endian element order,
19713 regardless of whether the target is big- or little-endian.  This is
19714 the default when targeting a little-endian platform.  This option is
19715 currently ignored when targeting a big-endian platform.
19717 The element order is used to interpret element numbers in Altivec
19718 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19719 @code{vec_insert}.  By default, these will match array element order
19720 corresponding to the endianness for the target.
19722 @item -mvrsave
19723 @itemx -mno-vrsave
19724 @opindex mvrsave
19725 @opindex mno-vrsave
19726 Generate VRSAVE instructions when generating AltiVec code.
19728 @item -mgen-cell-microcode
19729 @opindex mgen-cell-microcode
19730 Generate Cell microcode instructions.
19732 @item -mwarn-cell-microcode
19733 @opindex mwarn-cell-microcode
19734 Warn when a Cell microcode instruction is emitted.  An example
19735 of a Cell microcode instruction is a variable shift.
19737 @item -msecure-plt
19738 @opindex msecure-plt
19739 Generate code that allows @command{ld} and @command{ld.so}
19740 to build executables and shared
19741 libraries with non-executable @code{.plt} and @code{.got} sections.
19742 This is a PowerPC
19743 32-bit SYSV ABI option.
19745 @item -mbss-plt
19746 @opindex mbss-plt
19747 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19748 fills in, and
19749 requires @code{.plt} and @code{.got}
19750 sections that are both writable and executable.
19751 This is a PowerPC 32-bit SYSV ABI option.
19753 @item -misel
19754 @itemx -mno-isel
19755 @opindex misel
19756 @opindex mno-isel
19757 This switch enables or disables the generation of ISEL instructions.
19759 @item -misel=@var{yes/no}
19760 This switch has been deprecated.  Use @option{-misel} and
19761 @option{-mno-isel} instead.
19763 @item -mspe
19764 @itemx -mno-spe
19765 @opindex mspe
19766 @opindex mno-spe
19767 This switch enables or disables the generation of SPE simd
19768 instructions.
19770 @item -mpaired
19771 @itemx -mno-paired
19772 @opindex mpaired
19773 @opindex mno-paired
19774 This switch enables or disables the generation of PAIRED simd
19775 instructions.
19777 @item -mspe=@var{yes/no}
19778 This option has been deprecated.  Use @option{-mspe} and
19779 @option{-mno-spe} instead.
19781 @item -mvsx
19782 @itemx -mno-vsx
19783 @opindex mvsx
19784 @opindex mno-vsx
19785 Generate code that uses (does not use) vector/scalar (VSX)
19786 instructions, and also enable the use of built-in functions that allow
19787 more direct access to the VSX instruction set.
19789 @item -mcrypto
19790 @itemx -mno-crypto
19791 @opindex mcrypto
19792 @opindex mno-crypto
19793 Enable the use (disable) of the built-in functions that allow direct
19794 access to the cryptographic instructions that were added in version
19795 2.07 of the PowerPC ISA.
19797 @item -mdirect-move
19798 @itemx -mno-direct-move
19799 @opindex mdirect-move
19800 @opindex mno-direct-move
19801 Generate code that uses (does not use) the instructions to move data
19802 between the general purpose registers and the vector/scalar (VSX)
19803 registers that were added in version 2.07 of the PowerPC ISA.
19805 @item -mpower8-fusion
19806 @itemx -mno-power8-fusion
19807 @opindex mpower8-fusion
19808 @opindex mno-power8-fusion
19809 Generate code that keeps (does not keeps) some integer operations
19810 adjacent so that the instructions can be fused together on power8 and
19811 later processors.
19813 @item -mpower8-vector
19814 @itemx -mno-power8-vector
19815 @opindex mpower8-vector
19816 @opindex mno-power8-vector
19817 Generate code that uses (does not use) the vector and scalar
19818 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19819 enable the use of built-in functions that allow more direct access to
19820 the vector instructions.
19822 @item -mquad-memory
19823 @itemx -mno-quad-memory
19824 @opindex mquad-memory
19825 @opindex mno-quad-memory
19826 Generate code that uses (does not use) the non-atomic quad word memory
19827 instructions.  The @option{-mquad-memory} option requires use of
19828 64-bit mode.
19830 @item -mquad-memory-atomic
19831 @itemx -mno-quad-memory-atomic
19832 @opindex mquad-memory-atomic
19833 @opindex mno-quad-memory-atomic
19834 Generate code that uses (does not use) the atomic quad word memory
19835 instructions.  The @option{-mquad-memory-atomic} option requires use of
19836 64-bit mode.
19838 @item -mupper-regs-df
19839 @itemx -mno-upper-regs-df
19840 @opindex mupper-regs-df
19841 @opindex mno-upper-regs-df
19842 Generate code that uses (does not use) the scalar double precision
19843 instructions that target all 64 registers in the vector/scalar
19844 floating point register set that were added in version 2.06 of the
19845 PowerPC ISA.  The @option{-mupper-regs-df} turned on by default if you
19846 use either of the @option{-mcpu=power7}, @option{-mcpu=power8}, or
19847 @option{-mvsx} options.
19849 @item -mupper-regs-sf
19850 @itemx -mno-upper-regs-sf
19851 @opindex mupper-regs-sf
19852 @opindex mno-upper-regs-sf
19853 Generate code that uses (does not use) the scalar single precision
19854 instructions that target all 64 registers in the vector/scalar
19855 floating point register set that were added in version 2.07 of the
19856 PowerPC ISA.  The @option{-mupper-regs-sf} turned on by default if you
19857 use either of the @option{-mcpu=power8}, or @option{-mpower8-vector}
19858 options.
19860 @item -mupper-regs
19861 @itemx -mno-upper-regs
19862 @opindex mupper-regs
19863 @opindex mno-upper-regs
19864 Generate code that uses (does not use) the scalar
19865 instructions that target all 64 registers in the vector/scalar
19866 floating point register set, depending on the model of the machine.
19868 If the @option{-mno-upper-regs} option was used, it will turn off both
19869 @option{-mupper-regs-sf} and @option{-mupper-regs-df} options.
19871 @item -mfloat-gprs=@var{yes/single/double/no}
19872 @itemx -mfloat-gprs
19873 @opindex mfloat-gprs
19874 This switch enables or disables the generation of floating-point
19875 operations on the general-purpose registers for architectures that
19876 support it.
19878 The argument @var{yes} or @var{single} enables the use of
19879 single-precision floating-point operations.
19881 The argument @var{double} enables the use of single and
19882 double-precision floating-point operations.
19884 The argument @var{no} disables floating-point operations on the
19885 general-purpose registers.
19887 This option is currently only available on the MPC854x.
19889 @item -m32
19890 @itemx -m64
19891 @opindex m32
19892 @opindex m64
19893 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19894 targets (including GNU/Linux).  The 32-bit environment sets int, long
19895 and pointer to 32 bits and generates code that runs on any PowerPC
19896 variant.  The 64-bit environment sets int to 32 bits and long and
19897 pointer to 64 bits, and generates code for PowerPC64, as for
19898 @option{-mpowerpc64}.
19900 @item -mfull-toc
19901 @itemx -mno-fp-in-toc
19902 @itemx -mno-sum-in-toc
19903 @itemx -mminimal-toc
19904 @opindex mfull-toc
19905 @opindex mno-fp-in-toc
19906 @opindex mno-sum-in-toc
19907 @opindex mminimal-toc
19908 Modify generation of the TOC (Table Of Contents), which is created for
19909 every executable file.  The @option{-mfull-toc} option is selected by
19910 default.  In that case, GCC allocates at least one TOC entry for
19911 each unique non-automatic variable reference in your program.  GCC
19912 also places floating-point constants in the TOC@.  However, only
19913 16,384 entries are available in the TOC@.
19915 If you receive a linker error message that saying you have overflowed
19916 the available TOC space, you can reduce the amount of TOC space used
19917 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19918 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19919 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19920 generate code to calculate the sum of an address and a constant at
19921 run time instead of putting that sum into the TOC@.  You may specify one
19922 or both of these options.  Each causes GCC to produce very slightly
19923 slower and larger code at the expense of conserving TOC space.
19925 If you still run out of space in the TOC even when you specify both of
19926 these options, specify @option{-mminimal-toc} instead.  This option causes
19927 GCC to make only one TOC entry for every file.  When you specify this
19928 option, GCC produces code that is slower and larger but which
19929 uses extremely little TOC space.  You may wish to use this option
19930 only on files that contain less frequently-executed code.
19932 @item -maix64
19933 @itemx -maix32
19934 @opindex maix64
19935 @opindex maix32
19936 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19937 @code{long} type, and the infrastructure needed to support them.
19938 Specifying @option{-maix64} implies @option{-mpowerpc64},
19939 while @option{-maix32} disables the 64-bit ABI and
19940 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19942 @item -mxl-compat
19943 @itemx -mno-xl-compat
19944 @opindex mxl-compat
19945 @opindex mno-xl-compat
19946 Produce code that conforms more closely to IBM XL compiler semantics
19947 when using AIX-compatible ABI@.  Pass floating-point arguments to
19948 prototyped functions beyond the register save area (RSA) on the stack
19949 in addition to argument FPRs.  Do not assume that most significant
19950 double in 128-bit long double value is properly rounded when comparing
19951 values and converting to double.  Use XL symbol names for long double
19952 support routines.
19954 The AIX calling convention was extended but not initially documented to
19955 handle an obscure K&R C case of calling a function that takes the
19956 address of its arguments with fewer arguments than declared.  IBM XL
19957 compilers access floating-point arguments that do not fit in the
19958 RSA from the stack when a subroutine is compiled without
19959 optimization.  Because always storing floating-point arguments on the
19960 stack is inefficient and rarely needed, this option is not enabled by
19961 default and only is necessary when calling subroutines compiled by IBM
19962 XL compilers without optimization.
19964 @item -mpe
19965 @opindex mpe
19966 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19967 application written to use message passing with special startup code to
19968 enable the application to run.  The system must have PE installed in the
19969 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19970 must be overridden with the @option{-specs=} option to specify the
19971 appropriate directory location.  The Parallel Environment does not
19972 support threads, so the @option{-mpe} option and the @option{-pthread}
19973 option are incompatible.
19975 @item -malign-natural
19976 @itemx -malign-power
19977 @opindex malign-natural
19978 @opindex malign-power
19979 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19980 @option{-malign-natural} overrides the ABI-defined alignment of larger
19981 types, such as floating-point doubles, on their natural size-based boundary.
19982 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19983 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19985 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19986 is not supported.
19988 @item -msoft-float
19989 @itemx -mhard-float
19990 @opindex msoft-float
19991 @opindex mhard-float
19992 Generate code that does not use (uses) the floating-point register set.
19993 Software floating-point emulation is provided if you use the
19994 @option{-msoft-float} option, and pass the option to GCC when linking.
19996 @item -msingle-float
19997 @itemx -mdouble-float
19998 @opindex msingle-float
19999 @opindex mdouble-float
20000 Generate code for single- or double-precision floating-point operations.
20001 @option{-mdouble-float} implies @option{-msingle-float}.
20003 @item -msimple-fpu
20004 @opindex msimple-fpu
20005 Do not generate @code{sqrt} and @code{div} instructions for hardware
20006 floating-point unit.
20008 @item -mfpu=@var{name}
20009 @opindex mfpu
20010 Specify type of floating-point unit.  Valid values for @var{name} are
20011 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
20012 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
20013 @samp{sp_full} (equivalent to @option{-msingle-float}),
20014 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
20016 @item -mxilinx-fpu
20017 @opindex mxilinx-fpu
20018 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
20020 @item -mmultiple
20021 @itemx -mno-multiple
20022 @opindex mmultiple
20023 @opindex mno-multiple
20024 Generate code that uses (does not use) the load multiple word
20025 instructions and the store multiple word instructions.  These
20026 instructions are generated by default on POWER systems, and not
20027 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
20028 PowerPC systems, since those instructions do not work when the
20029 processor is in little-endian mode.  The exceptions are PPC740 and
20030 PPC750 which permit these instructions in little-endian mode.
20032 @item -mstring
20033 @itemx -mno-string
20034 @opindex mstring
20035 @opindex mno-string
20036 Generate code that uses (does not use) the load string instructions
20037 and the store string word instructions to save multiple registers and
20038 do small block moves.  These instructions are generated by default on
20039 POWER systems, and not generated on PowerPC systems.  Do not use
20040 @option{-mstring} on little-endian PowerPC systems, since those
20041 instructions do not work when the processor is in little-endian mode.
20042 The exceptions are PPC740 and PPC750 which permit these instructions
20043 in little-endian mode.
20045 @item -mupdate
20046 @itemx -mno-update
20047 @opindex mupdate
20048 @opindex mno-update
20049 Generate code that uses (does not use) the load or store instructions
20050 that update the base register to the address of the calculated memory
20051 location.  These instructions are generated by default.  If you use
20052 @option{-mno-update}, there is a small window between the time that the
20053 stack pointer is updated and the address of the previous frame is
20054 stored, which means code that walks the stack frame across interrupts or
20055 signals may get corrupted data.
20057 @item -mavoid-indexed-addresses
20058 @itemx -mno-avoid-indexed-addresses
20059 @opindex mavoid-indexed-addresses
20060 @opindex mno-avoid-indexed-addresses
20061 Generate code that tries to avoid (not avoid) the use of indexed load
20062 or store instructions. These instructions can incur a performance
20063 penalty on Power6 processors in certain situations, such as when
20064 stepping through large arrays that cross a 16M boundary.  This option
20065 is enabled by default when targeting Power6 and disabled otherwise.
20067 @item -mfused-madd
20068 @itemx -mno-fused-madd
20069 @opindex mfused-madd
20070 @opindex mno-fused-madd
20071 Generate code that uses (does not use) the floating-point multiply and
20072 accumulate instructions.  These instructions are generated by default
20073 if hardware floating point is used.  The machine-dependent
20074 @option{-mfused-madd} option is now mapped to the machine-independent
20075 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20076 mapped to @option{-ffp-contract=off}.
20078 @item -mmulhw
20079 @itemx -mno-mulhw
20080 @opindex mmulhw
20081 @opindex mno-mulhw
20082 Generate code that uses (does not use) the half-word multiply and
20083 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
20084 These instructions are generated by default when targeting those
20085 processors.
20087 @item -mdlmzb
20088 @itemx -mno-dlmzb
20089 @opindex mdlmzb
20090 @opindex mno-dlmzb
20091 Generate code that uses (does not use) the string-search @samp{dlmzb}
20092 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
20093 generated by default when targeting those processors.
20095 @item -mno-bit-align
20096 @itemx -mbit-align
20097 @opindex mno-bit-align
20098 @opindex mbit-align
20099 On System V.4 and embedded PowerPC systems do not (do) force structures
20100 and unions that contain bit-fields to be aligned to the base type of the
20101 bit-field.
20103 For example, by default a structure containing nothing but 8
20104 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
20105 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
20106 the structure is aligned to a 1-byte boundary and is 1 byte in
20107 size.
20109 @item -mno-strict-align
20110 @itemx -mstrict-align
20111 @opindex mno-strict-align
20112 @opindex mstrict-align
20113 On System V.4 and embedded PowerPC systems do not (do) assume that
20114 unaligned memory references are handled by the system.
20116 @item -mrelocatable
20117 @itemx -mno-relocatable
20118 @opindex mrelocatable
20119 @opindex mno-relocatable
20120 Generate code that allows (does not allow) a static executable to be
20121 relocated to a different address at run time.  A simple embedded
20122 PowerPC system loader should relocate the entire contents of
20123 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
20124 a table of 32-bit addresses generated by this option.  For this to
20125 work, all objects linked together must be compiled with
20126 @option{-mrelocatable} or @option{-mrelocatable-lib}.
20127 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
20129 @item -mrelocatable-lib
20130 @itemx -mno-relocatable-lib
20131 @opindex mrelocatable-lib
20132 @opindex mno-relocatable-lib
20133 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
20134 @code{.fixup} section to allow static executables to be relocated at
20135 run time, but @option{-mrelocatable-lib} does not use the smaller stack
20136 alignment of @option{-mrelocatable}.  Objects compiled with
20137 @option{-mrelocatable-lib} may be linked with objects compiled with
20138 any combination of the @option{-mrelocatable} options.
20140 @item -mno-toc
20141 @itemx -mtoc
20142 @opindex mno-toc
20143 @opindex mtoc
20144 On System V.4 and embedded PowerPC systems do not (do) assume that
20145 register 2 contains a pointer to a global area pointing to the addresses
20146 used in the program.
20148 @item -mlittle
20149 @itemx -mlittle-endian
20150 @opindex mlittle
20151 @opindex mlittle-endian
20152 On System V.4 and embedded PowerPC systems compile code for the
20153 processor in little-endian mode.  The @option{-mlittle-endian} option is
20154 the same as @option{-mlittle}.
20156 @item -mbig
20157 @itemx -mbig-endian
20158 @opindex mbig
20159 @opindex mbig-endian
20160 On System V.4 and embedded PowerPC systems compile code for the
20161 processor in big-endian mode.  The @option{-mbig-endian} option is
20162 the same as @option{-mbig}.
20164 @item -mdynamic-no-pic
20165 @opindex mdynamic-no-pic
20166 On Darwin and Mac OS X systems, compile code so that it is not
20167 relocatable, but that its external references are relocatable.  The
20168 resulting code is suitable for applications, but not shared
20169 libraries.
20171 @item -msingle-pic-base
20172 @opindex msingle-pic-base
20173 Treat the register used for PIC addressing as read-only, rather than
20174 loading it in the prologue for each function.  The runtime system is
20175 responsible for initializing this register with an appropriate value
20176 before execution begins.
20178 @item -mprioritize-restricted-insns=@var{priority}
20179 @opindex mprioritize-restricted-insns
20180 This option controls the priority that is assigned to
20181 dispatch-slot restricted instructions during the second scheduling
20182 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
20183 or @samp{2} to assign no, highest, or second-highest (respectively) 
20184 priority to dispatch-slot restricted
20185 instructions.
20187 @item -msched-costly-dep=@var{dependence_type}
20188 @opindex msched-costly-dep
20189 This option controls which dependences are considered costly
20190 by the target during instruction scheduling.  The argument
20191 @var{dependence_type} takes one of the following values:
20193 @table @asis
20194 @item @samp{no}
20195 No dependence is costly.
20197 @item @samp{all}
20198 All dependences are costly.
20200 @item @samp{true_store_to_load}
20201 A true dependence from store to load is costly.
20203 @item @samp{store_to_load}
20204 Any dependence from store to load is costly.
20206 @item @var{number}
20207 Any dependence for which the latency is greater than or equal to 
20208 @var{number} is costly.
20209 @end table
20211 @item -minsert-sched-nops=@var{scheme}
20212 @opindex minsert-sched-nops
20213 This option controls which NOP insertion scheme is used during
20214 the second scheduling pass.  The argument @var{scheme} takes one of the
20215 following values:
20217 @table @asis
20218 @item @samp{no}
20219 Don't insert NOPs.
20221 @item @samp{pad}
20222 Pad with NOPs any dispatch group that has vacant issue slots,
20223 according to the scheduler's grouping.
20225 @item @samp{regroup_exact}
20226 Insert NOPs to force costly dependent insns into
20227 separate groups.  Insert exactly as many NOPs as needed to force an insn
20228 to a new group, according to the estimated processor grouping.
20230 @item @var{number}
20231 Insert NOPs to force costly dependent insns into
20232 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
20233 @end table
20235 @item -mcall-sysv
20236 @opindex mcall-sysv
20237 On System V.4 and embedded PowerPC systems compile code using calling
20238 conventions that adhere to the March 1995 draft of the System V
20239 Application Binary Interface, PowerPC processor supplement.  This is the
20240 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
20242 @item -mcall-sysv-eabi
20243 @itemx -mcall-eabi
20244 @opindex mcall-sysv-eabi
20245 @opindex mcall-eabi
20246 Specify both @option{-mcall-sysv} and @option{-meabi} options.
20248 @item -mcall-sysv-noeabi
20249 @opindex mcall-sysv-noeabi
20250 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
20252 @item -mcall-aixdesc
20253 @opindex m
20254 On System V.4 and embedded PowerPC systems compile code for the AIX
20255 operating system.
20257 @item -mcall-linux
20258 @opindex mcall-linux
20259 On System V.4 and embedded PowerPC systems compile code for the
20260 Linux-based GNU system.
20262 @item -mcall-freebsd
20263 @opindex mcall-freebsd
20264 On System V.4 and embedded PowerPC systems compile code for the
20265 FreeBSD operating system.
20267 @item -mcall-netbsd
20268 @opindex mcall-netbsd
20269 On System V.4 and embedded PowerPC systems compile code for the
20270 NetBSD operating system.
20272 @item -mcall-openbsd
20273 @opindex mcall-netbsd
20274 On System V.4 and embedded PowerPC systems compile code for the
20275 OpenBSD operating system.
20277 @item -maix-struct-return
20278 @opindex maix-struct-return
20279 Return all structures in memory (as specified by the AIX ABI)@.
20281 @item -msvr4-struct-return
20282 @opindex msvr4-struct-return
20283 Return structures smaller than 8 bytes in registers (as specified by the
20284 SVR4 ABI)@.
20286 @item -mabi=@var{abi-type}
20287 @opindex mabi
20288 Extend the current ABI with a particular extension, or remove such extension.
20289 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
20290 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
20291 @var{elfv1}, @var{elfv2}@.
20293 @item -mabi=spe
20294 @opindex mabi=spe
20295 Extend the current ABI with SPE ABI extensions.  This does not change
20296 the default ABI, instead it adds the SPE ABI extensions to the current
20297 ABI@.
20299 @item -mabi=no-spe
20300 @opindex mabi=no-spe
20301 Disable Book-E SPE ABI extensions for the current ABI@.
20303 @item -mabi=ibmlongdouble
20304 @opindex mabi=ibmlongdouble
20305 Change the current ABI to use IBM extended-precision long double.
20306 This is a PowerPC 32-bit SYSV ABI option.
20308 @item -mabi=ieeelongdouble
20309 @opindex mabi=ieeelongdouble
20310 Change the current ABI to use IEEE extended-precision long double.
20311 This is a PowerPC 32-bit Linux ABI option.
20313 @item -mabi=elfv1
20314 @opindex mabi=elfv1
20315 Change the current ABI to use the ELFv1 ABI.
20316 This is the default ABI for big-endian PowerPC 64-bit Linux.
20317 Overriding the default ABI requires special system support and is
20318 likely to fail in spectacular ways.
20320 @item -mabi=elfv2
20321 @opindex mabi=elfv2
20322 Change the current ABI to use the ELFv2 ABI.
20323 This is the default ABI for little-endian PowerPC 64-bit Linux.
20324 Overriding the default ABI requires special system support and is
20325 likely to fail in spectacular ways.
20327 @item -mprototype
20328 @itemx -mno-prototype
20329 @opindex mprototype
20330 @opindex mno-prototype
20331 On System V.4 and embedded PowerPC systems assume that all calls to
20332 variable argument functions are properly prototyped.  Otherwise, the
20333 compiler must insert an instruction before every non-prototyped call to
20334 set or clear bit 6 of the condition code register (@var{CR}) to
20335 indicate whether floating-point values are passed in the floating-point
20336 registers in case the function takes variable arguments.  With
20337 @option{-mprototype}, only calls to prototyped variable argument functions
20338 set or clear the bit.
20340 @item -msim
20341 @opindex msim
20342 On embedded PowerPC systems, assume that the startup module is called
20343 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
20344 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
20345 configurations.
20347 @item -mmvme
20348 @opindex mmvme
20349 On embedded PowerPC systems, assume that the startup module is called
20350 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
20351 @file{libc.a}.
20353 @item -mads
20354 @opindex mads
20355 On embedded PowerPC systems, assume that the startup module is called
20356 @file{crt0.o} and the standard C libraries are @file{libads.a} and
20357 @file{libc.a}.
20359 @item -myellowknife
20360 @opindex myellowknife
20361 On embedded PowerPC systems, assume that the startup module is called
20362 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
20363 @file{libc.a}.
20365 @item -mvxworks
20366 @opindex mvxworks
20367 On System V.4 and embedded PowerPC systems, specify that you are
20368 compiling for a VxWorks system.
20370 @item -memb
20371 @opindex memb
20372 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
20373 header to indicate that @samp{eabi} extended relocations are used.
20375 @item -meabi
20376 @itemx -mno-eabi
20377 @opindex meabi
20378 @opindex mno-eabi
20379 On System V.4 and embedded PowerPC systems do (do not) adhere to the
20380 Embedded Applications Binary Interface (EABI), which is a set of
20381 modifications to the System V.4 specifications.  Selecting @option{-meabi}
20382 means that the stack is aligned to an 8-byte boundary, a function
20383 @code{__eabi} is called from @code{main} to set up the EABI
20384 environment, and the @option{-msdata} option can use both @code{r2} and
20385 @code{r13} to point to two separate small data areas.  Selecting
20386 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
20387 no EABI initialization function is called from @code{main}, and the
20388 @option{-msdata} option only uses @code{r13} to point to a single
20389 small data area.  The @option{-meabi} option is on by default if you
20390 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
20392 @item -msdata=eabi
20393 @opindex msdata=eabi
20394 On System V.4 and embedded PowerPC systems, put small initialized
20395 @code{const} global and static data in the @samp{.sdata2} section, which
20396 is pointed to by register @code{r2}.  Put small initialized
20397 non-@code{const} global and static data in the @samp{.sdata} section,
20398 which is pointed to by register @code{r13}.  Put small uninitialized
20399 global and static data in the @samp{.sbss} section, which is adjacent to
20400 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
20401 incompatible with the @option{-mrelocatable} option.  The
20402 @option{-msdata=eabi} option also sets the @option{-memb} option.
20404 @item -msdata=sysv
20405 @opindex msdata=sysv
20406 On System V.4 and embedded PowerPC systems, put small global and static
20407 data in the @samp{.sdata} section, which is pointed to by register
20408 @code{r13}.  Put small uninitialized global and static data in the
20409 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
20410 The @option{-msdata=sysv} option is incompatible with the
20411 @option{-mrelocatable} option.
20413 @item -msdata=default
20414 @itemx -msdata
20415 @opindex msdata=default
20416 @opindex msdata
20417 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
20418 compile code the same as @option{-msdata=eabi}, otherwise compile code the
20419 same as @option{-msdata=sysv}.
20421 @item -msdata=data
20422 @opindex msdata=data
20423 On System V.4 and embedded PowerPC systems, put small global
20424 data in the @samp{.sdata} section.  Put small uninitialized global
20425 data in the @samp{.sbss} section.  Do not use register @code{r13}
20426 to address small data however.  This is the default behavior unless
20427 other @option{-msdata} options are used.
20429 @item -msdata=none
20430 @itemx -mno-sdata
20431 @opindex msdata=none
20432 @opindex mno-sdata
20433 On embedded PowerPC systems, put all initialized global and static data
20434 in the @samp{.data} section, and all uninitialized data in the
20435 @samp{.bss} section.
20437 @item -mblock-move-inline-limit=@var{num}
20438 @opindex mblock-move-inline-limit
20439 Inline all block moves (such as calls to @code{memcpy} or structure
20440 copies) less than or equal to @var{num} bytes.  The minimum value for
20441 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
20442 targets.  The default value is target-specific.
20444 @item -G @var{num}
20445 @opindex G
20446 @cindex smaller data references (PowerPC)
20447 @cindex .sdata/.sdata2 references (PowerPC)
20448 On embedded PowerPC systems, put global and static items less than or
20449 equal to @var{num} bytes into the small data or BSS sections instead of
20450 the normal data or BSS section.  By default, @var{num} is 8.  The
20451 @option{-G @var{num}} switch is also passed to the linker.
20452 All modules should be compiled with the same @option{-G @var{num}} value.
20454 @item -mregnames
20455 @itemx -mno-regnames
20456 @opindex mregnames
20457 @opindex mno-regnames
20458 On System V.4 and embedded PowerPC systems do (do not) emit register
20459 names in the assembly language output using symbolic forms.
20461 @item -mlongcall
20462 @itemx -mno-longcall
20463 @opindex mlongcall
20464 @opindex mno-longcall
20465 By default assume that all calls are far away so that a longer and more
20466 expensive calling sequence is required.  This is required for calls
20467 farther than 32 megabytes (33,554,432 bytes) from the current location.
20468 A short call is generated if the compiler knows
20469 the call cannot be that far away.  This setting can be overridden by
20470 the @code{shortcall} function attribute, or by @code{#pragma
20471 longcall(0)}.
20473 Some linkers are capable of detecting out-of-range calls and generating
20474 glue code on the fly.  On these systems, long calls are unnecessary and
20475 generate slower code.  As of this writing, the AIX linker can do this,
20476 as can the GNU linker for PowerPC/64.  It is planned to add this feature
20477 to the GNU linker for 32-bit PowerPC systems as well.
20479 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
20480 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
20481 addresses represent the callee and the branch island.  The
20482 Darwin/PPC linker prefers the first address and generates a @code{bl
20483 callee} if the PPC @code{bl} instruction reaches the callee directly;
20484 otherwise, the linker generates @code{bl L42} to call the branch
20485 island.  The branch island is appended to the body of the
20486 calling function; it computes the full 32-bit address of the callee
20487 and jumps to it.
20489 On Mach-O (Darwin) systems, this option directs the compiler emit to
20490 the glue for every direct call, and the Darwin linker decides whether
20491 to use or discard it.
20493 In the future, GCC may ignore all longcall specifications
20494 when the linker is known to generate glue.
20496 @item -mtls-markers
20497 @itemx -mno-tls-markers
20498 @opindex mtls-markers
20499 @opindex mno-tls-markers
20500 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
20501 specifying the function argument.  The relocation allows the linker to
20502 reliably associate function call with argument setup instructions for
20503 TLS optimization, which in turn allows GCC to better schedule the
20504 sequence.
20506 @item -pthread
20507 @opindex pthread
20508 Adds support for multithreading with the @dfn{pthreads} library.
20509 This option sets flags for both the preprocessor and linker.
20511 @item -mrecip
20512 @itemx -mno-recip
20513 @opindex mrecip
20514 This option enables use of the reciprocal estimate and
20515 reciprocal square root estimate instructions with additional
20516 Newton-Raphson steps to increase precision instead of doing a divide or
20517 square root and divide for floating-point arguments.  You should use
20518 the @option{-ffast-math} option when using @option{-mrecip} (or at
20519 least @option{-funsafe-math-optimizations},
20520 @option{-finite-math-only}, @option{-freciprocal-math} and
20521 @option{-fno-trapping-math}).  Note that while the throughput of the
20522 sequence is generally higher than the throughput of the non-reciprocal
20523 instruction, the precision of the sequence can be decreased by up to 2
20524 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
20525 roots.
20527 @item -mrecip=@var{opt}
20528 @opindex mrecip=opt
20529 This option controls which reciprocal estimate instructions
20530 may be used.  @var{opt} is a comma-separated list of options, which may
20531 be preceded by a @code{!} to invert the option:
20532 @code{all}: enable all estimate instructions,
20533 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
20534 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
20535 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
20536 @code{divf}: enable the single-precision reciprocal approximation instructions;
20537 @code{divd}: enable the double-precision reciprocal approximation instructions;
20538 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
20539 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
20540 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
20542 So, for example, @option{-mrecip=all,!rsqrtd} enables
20543 all of the reciprocal estimate instructions, except for the
20544 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
20545 which handle the double-precision reciprocal square root calculations.
20547 @item -mrecip-precision
20548 @itemx -mno-recip-precision
20549 @opindex mrecip-precision
20550 Assume (do not assume) that the reciprocal estimate instructions
20551 provide higher-precision estimates than is mandated by the PowerPC
20552 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
20553 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
20554 The double-precision square root estimate instructions are not generated by
20555 default on low-precision machines, since they do not provide an
20556 estimate that converges after three steps.
20558 @item -mveclibabi=@var{type}
20559 @opindex mveclibabi
20560 Specifies the ABI type to use for vectorizing intrinsics using an
20561 external library.  The only type supported at present is @code{mass},
20562 which specifies to use IBM's Mathematical Acceleration Subsystem
20563 (MASS) libraries for vectorizing intrinsics using external libraries.
20564 GCC currently emits calls to @code{acosd2}, @code{acosf4},
20565 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
20566 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
20567 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
20568 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
20569 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
20570 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
20571 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
20572 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
20573 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
20574 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
20575 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
20576 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
20577 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
20578 for power7.  Both @option{-ftree-vectorize} and
20579 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
20580 libraries must be specified at link time.
20582 @item -mfriz
20583 @itemx -mno-friz
20584 @opindex mfriz
20585 Generate (do not generate) the @code{friz} instruction when the
20586 @option{-funsafe-math-optimizations} option is used to optimize
20587 rounding of floating-point values to 64-bit integer and back to floating
20588 point.  The @code{friz} instruction does not return the same value if
20589 the floating-point number is too large to fit in an integer.
20591 @item -mpointers-to-nested-functions
20592 @itemx -mno-pointers-to-nested-functions
20593 @opindex mpointers-to-nested-functions
20594 Generate (do not generate) code to load up the static chain register
20595 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
20596 systems where a function pointer points to a 3-word descriptor giving
20597 the function address, TOC value to be loaded in register @var{r2}, and
20598 static chain value to be loaded in register @var{r11}.  The
20599 @option{-mpointers-to-nested-functions} is on by default.  You cannot
20600 call through pointers to nested functions or pointers
20601 to functions compiled in other languages that use the static chain if
20602 you use the @option{-mno-pointers-to-nested-functions}.
20604 @item -msave-toc-indirect
20605 @itemx -mno-save-toc-indirect
20606 @opindex msave-toc-indirect
20607 Generate (do not generate) code to save the TOC value in the reserved
20608 stack location in the function prologue if the function calls through
20609 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
20610 saved in the prologue, it is saved just before the call through the
20611 pointer.  The @option{-mno-save-toc-indirect} option is the default.
20613 @item -mcompat-align-parm
20614 @itemx -mno-compat-align-parm
20615 @opindex mcompat-align-parm
20616 Generate (do not generate) code to pass structure parameters with a
20617 maximum alignment of 64 bits, for compatibility with older versions
20618 of GCC.
20620 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
20621 structure parameter on a 128-bit boundary when that structure contained
20622 a member requiring 128-bit alignment.  This is corrected in more
20623 recent versions of GCC.  This option may be used to generate code
20624 that is compatible with functions compiled with older versions of
20625 GCC.
20627 The @option{-mno-compat-align-parm} option is the default.
20628 @end table
20630 @node RX Options
20631 @subsection RX Options
20632 @cindex RX Options
20634 These command-line options are defined for RX targets:
20636 @table @gcctabopt
20637 @item -m64bit-doubles
20638 @itemx -m32bit-doubles
20639 @opindex m64bit-doubles
20640 @opindex m32bit-doubles
20641 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
20642 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
20643 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
20644 works on 32-bit values, which is why the default is
20645 @option{-m32bit-doubles}.
20647 @item -fpu
20648 @itemx -nofpu
20649 @opindex fpu
20650 @opindex nofpu
20651 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
20652 floating-point hardware.  The default is enabled for the @var{RX600}
20653 series and disabled for the @var{RX200} series.
20655 Floating-point instructions are only generated for 32-bit floating-point 
20656 values, however, so the FPU hardware is not used for doubles if the
20657 @option{-m64bit-doubles} option is used.
20659 @emph{Note} If the @option{-fpu} option is enabled then
20660 @option{-funsafe-math-optimizations} is also enabled automatically.
20661 This is because the RX FPU instructions are themselves unsafe.
20663 @item -mcpu=@var{name}
20664 @opindex -mcpu
20665 Selects the type of RX CPU to be targeted.  Currently three types are
20666 supported, the generic @var{RX600} and @var{RX200} series hardware and
20667 the specific @var{RX610} CPU.  The default is @var{RX600}.
20669 The only difference between @var{RX600} and @var{RX610} is that the
20670 @var{RX610} does not support the @code{MVTIPL} instruction.
20672 The @var{RX200} series does not have a hardware floating-point unit
20673 and so @option{-nofpu} is enabled by default when this type is
20674 selected.
20676 @item -mbig-endian-data
20677 @itemx -mlittle-endian-data
20678 @opindex mbig-endian-data
20679 @opindex mlittle-endian-data
20680 Store data (but not code) in the big-endian format.  The default is
20681 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
20682 format.
20684 @item -msmall-data-limit=@var{N}
20685 @opindex msmall-data-limit
20686 Specifies the maximum size in bytes of global and static variables
20687 which can be placed into the small data area.  Using the small data
20688 area can lead to smaller and faster code, but the size of area is
20689 limited and it is up to the programmer to ensure that the area does
20690 not overflow.  Also when the small data area is used one of the RX's
20691 registers (usually @code{r13}) is reserved for use pointing to this
20692 area, so it is no longer available for use by the compiler.  This
20693 could result in slower and/or larger code if variables are pushed onto
20694 the stack instead of being held in this register.
20696 Note, common variables (variables that have not been initialized) and
20697 constants are not placed into the small data area as they are assigned
20698 to other sections in the output executable.
20700 The default value is zero, which disables this feature.  Note, this
20701 feature is not enabled by default with higher optimization levels
20702 (@option{-O2} etc) because of the potentially detrimental effects of
20703 reserving a register.  It is up to the programmer to experiment and
20704 discover whether this feature is of benefit to their program.  See the
20705 description of the @option{-mpid} option for a description of how the
20706 actual register to hold the small data area pointer is chosen.
20708 @item -msim
20709 @itemx -mno-sim
20710 @opindex msim
20711 @opindex mno-sim
20712 Use the simulator runtime.  The default is to use the libgloss
20713 board-specific runtime.
20715 @item -mas100-syntax
20716 @itemx -mno-as100-syntax
20717 @opindex mas100-syntax
20718 @opindex mno-as100-syntax
20719 When generating assembler output use a syntax that is compatible with
20720 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20721 assembler, but it has some restrictions so it is not generated by default.
20723 @item -mmax-constant-size=@var{N}
20724 @opindex mmax-constant-size
20725 Specifies the maximum size, in bytes, of a constant that can be used as
20726 an operand in a RX instruction.  Although the RX instruction set does
20727 allow constants of up to 4 bytes in length to be used in instructions,
20728 a longer value equates to a longer instruction.  Thus in some
20729 circumstances it can be beneficial to restrict the size of constants
20730 that are used in instructions.  Constants that are too big are instead
20731 placed into a constant pool and referenced via register indirection.
20733 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20734 or 4 means that constants of any size are allowed.
20736 @item -mrelax
20737 @opindex mrelax
20738 Enable linker relaxation.  Linker relaxation is a process whereby the
20739 linker attempts to reduce the size of a program by finding shorter
20740 versions of various instructions.  Disabled by default.
20742 @item -mint-register=@var{N}
20743 @opindex mint-register
20744 Specify the number of registers to reserve for fast interrupt handler
20745 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20746 means that register @code{r13} is reserved for the exclusive use
20747 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20748 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20749 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20750 A value of 0, the default, does not reserve any registers.
20752 @item -msave-acc-in-interrupts
20753 @opindex msave-acc-in-interrupts
20754 Specifies that interrupt handler functions should preserve the
20755 accumulator register.  This is only necessary if normal code might use
20756 the accumulator register, for example because it performs 64-bit
20757 multiplications.  The default is to ignore the accumulator as this
20758 makes the interrupt handlers faster.
20760 @item -mpid
20761 @itemx -mno-pid
20762 @opindex mpid
20763 @opindex mno-pid
20764 Enables the generation of position independent data.  When enabled any
20765 access to constant data is done via an offset from a base address
20766 held in a register.  This allows the location of constant data to be
20767 determined at run time without requiring the executable to be
20768 relocated, which is a benefit to embedded applications with tight
20769 memory constraints.  Data that can be modified is not affected by this
20770 option.
20772 Note, using this feature reserves a register, usually @code{r13}, for
20773 the constant data base address.  This can result in slower and/or
20774 larger code, especially in complicated functions.
20776 The actual register chosen to hold the constant data base address
20777 depends upon whether the @option{-msmall-data-limit} and/or the
20778 @option{-mint-register} command-line options are enabled.  Starting
20779 with register @code{r13} and proceeding downwards, registers are
20780 allocated first to satisfy the requirements of @option{-mint-register},
20781 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20782 is possible for the small data area register to be @code{r8} if both
20783 @option{-mint-register=4} and @option{-mpid} are specified on the
20784 command line.
20786 By default this feature is not enabled.  The default can be restored
20787 via the @option{-mno-pid} command-line option.
20789 @item -mno-warn-multiple-fast-interrupts
20790 @itemx -mwarn-multiple-fast-interrupts
20791 @opindex mno-warn-multiple-fast-interrupts
20792 @opindex mwarn-multiple-fast-interrupts
20793 Prevents GCC from issuing a warning message if it finds more than one
20794 fast interrupt handler when it is compiling a file.  The default is to
20795 issue a warning for each extra fast interrupt handler found, as the RX
20796 only supports one such interrupt.
20798 @end table
20800 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20801 has special significance to the RX port when used with the
20802 @code{interrupt} function attribute.  This attribute indicates a
20803 function intended to process fast interrupts.  GCC ensures
20804 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20805 and/or @code{r13} and only provided that the normal use of the
20806 corresponding registers have been restricted via the
20807 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20808 options.
20810 @node S/390 and zSeries Options
20811 @subsection S/390 and zSeries Options
20812 @cindex S/390 and zSeries Options
20814 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20816 @table @gcctabopt
20817 @item -mhard-float
20818 @itemx -msoft-float
20819 @opindex mhard-float
20820 @opindex msoft-float
20821 Use (do not use) the hardware floating-point instructions and registers
20822 for floating-point operations.  When @option{-msoft-float} is specified,
20823 functions in @file{libgcc.a} are used to perform floating-point
20824 operations.  When @option{-mhard-float} is specified, the compiler
20825 generates IEEE floating-point instructions.  This is the default.
20827 @item -mhard-dfp
20828 @itemx -mno-hard-dfp
20829 @opindex mhard-dfp
20830 @opindex mno-hard-dfp
20831 Use (do not use) the hardware decimal-floating-point instructions for
20832 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20833 specified, functions in @file{libgcc.a} are used to perform
20834 decimal-floating-point operations.  When @option{-mhard-dfp} is
20835 specified, the compiler generates decimal-floating-point hardware
20836 instructions.  This is the default for @option{-march=z9-ec} or higher.
20838 @item -mlong-double-64
20839 @itemx -mlong-double-128
20840 @opindex mlong-double-64
20841 @opindex mlong-double-128
20842 These switches control the size of @code{long double} type. A size
20843 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20844 type. This is the default.
20846 @item -mbackchain
20847 @itemx -mno-backchain
20848 @opindex mbackchain
20849 @opindex mno-backchain
20850 Store (do not store) the address of the caller's frame as backchain pointer
20851 into the callee's stack frame.
20852 A backchain may be needed to allow debugging using tools that do not understand
20853 DWARF 2 call frame information.
20854 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20855 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20856 the backchain is placed into the topmost word of the 96/160 byte register
20857 save area.
20859 In general, code compiled with @option{-mbackchain} is call-compatible with
20860 code compiled with @option{-mmo-backchain}; however, use of the backchain
20861 for debugging purposes usually requires that the whole binary is built with
20862 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20863 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20864 to build a linux kernel use @option{-msoft-float}.
20866 The default is to not maintain the backchain.
20868 @item -mpacked-stack
20869 @itemx -mno-packed-stack
20870 @opindex mpacked-stack
20871 @opindex mno-packed-stack
20872 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20873 specified, the compiler uses the all fields of the 96/160 byte register save
20874 area only for their default purpose; unused fields still take up stack space.
20875 When @option{-mpacked-stack} is specified, register save slots are densely
20876 packed at the top of the register save area; unused space is reused for other
20877 purposes, allowing for more efficient use of the available stack space.
20878 However, when @option{-mbackchain} is also in effect, the topmost word of
20879 the save area is always used to store the backchain, and the return address
20880 register is always saved two words below the backchain.
20882 As long as the stack frame backchain is not used, code generated with
20883 @option{-mpacked-stack} is call-compatible with code generated with
20884 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20885 S/390 or zSeries generated code that uses the stack frame backchain at run
20886 time, not just for debugging purposes.  Such code is not call-compatible
20887 with code compiled with @option{-mpacked-stack}.  Also, note that the
20888 combination of @option{-mbackchain},
20889 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20890 to build a linux kernel use @option{-msoft-float}.
20892 The default is to not use the packed stack layout.
20894 @item -msmall-exec
20895 @itemx -mno-small-exec
20896 @opindex msmall-exec
20897 @opindex mno-small-exec
20898 Generate (or do not generate) code using the @code{bras} instruction
20899 to do subroutine calls.
20900 This only works reliably if the total executable size does not
20901 exceed 64k.  The default is to use the @code{basr} instruction instead,
20902 which does not have this limitation.
20904 @item -m64
20905 @itemx -m31
20906 @opindex m64
20907 @opindex m31
20908 When @option{-m31} is specified, generate code compliant to the
20909 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20910 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20911 particular to generate 64-bit instructions.  For the @samp{s390}
20912 targets, the default is @option{-m31}, while the @samp{s390x}
20913 targets default to @option{-m64}.
20915 @item -mzarch
20916 @itemx -mesa
20917 @opindex mzarch
20918 @opindex mesa
20919 When @option{-mzarch} is specified, generate code using the
20920 instructions available on z/Architecture.
20921 When @option{-mesa} is specified, generate code using the
20922 instructions available on ESA/390.  Note that @option{-mesa} is
20923 not possible with @option{-m64}.
20924 When generating code compliant to the GNU/Linux for S/390 ABI,
20925 the default is @option{-mesa}.  When generating code compliant
20926 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20928 @item -mmvcle
20929 @itemx -mno-mvcle
20930 @opindex mmvcle
20931 @opindex mno-mvcle
20932 Generate (or do not generate) code using the @code{mvcle} instruction
20933 to perform block moves.  When @option{-mno-mvcle} is specified,
20934 use a @code{mvc} loop instead.  This is the default unless optimizing for
20935 size.
20937 @item -mdebug
20938 @itemx -mno-debug
20939 @opindex mdebug
20940 @opindex mno-debug
20941 Print (or do not print) additional debug information when compiling.
20942 The default is to not print debug information.
20944 @item -march=@var{cpu-type}
20945 @opindex march
20946 Generate code that runs on @var{cpu-type}, which is the name of a system
20947 representing a certain processor type.  Possible values for
20948 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20949 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20950 When generating code using the instructions available on z/Architecture,
20951 the default is @option{-march=z900}.  Otherwise, the default is
20952 @option{-march=g5}.
20954 @item -mtune=@var{cpu-type}
20955 @opindex mtune
20956 Tune to @var{cpu-type} everything applicable about the generated code,
20957 except for the ABI and the set of available instructions.
20958 The list of @var{cpu-type} values is the same as for @option{-march}.
20959 The default is the value used for @option{-march}.
20961 @item -mtpf-trace
20962 @itemx -mno-tpf-trace
20963 @opindex mtpf-trace
20964 @opindex mno-tpf-trace
20965 Generate code that adds (does not add) in TPF OS specific branches to trace
20966 routines in the operating system.  This option is off by default, even
20967 when compiling for the TPF OS@.
20969 @item -mfused-madd
20970 @itemx -mno-fused-madd
20971 @opindex mfused-madd
20972 @opindex mno-fused-madd
20973 Generate code that uses (does not use) the floating-point multiply and
20974 accumulate instructions.  These instructions are generated by default if
20975 hardware floating point is used.
20977 @item -mwarn-framesize=@var{framesize}
20978 @opindex mwarn-framesize
20979 Emit a warning if the current function exceeds the given frame size.  Because
20980 this is a compile-time check it doesn't need to be a real problem when the program
20981 runs.  It is intended to identify functions that most probably cause
20982 a stack overflow.  It is useful to be used in an environment with limited stack
20983 size e.g.@: the linux kernel.
20985 @item -mwarn-dynamicstack
20986 @opindex mwarn-dynamicstack
20987 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20988 arrays.  This is generally a bad idea with a limited stack size.
20990 @item -mstack-guard=@var{stack-guard}
20991 @itemx -mstack-size=@var{stack-size}
20992 @opindex mstack-guard
20993 @opindex mstack-size
20994 If these options are provided the S/390 back end emits additional instructions in
20995 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20996 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20997 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20998 the frame size of the compiled function is chosen.
20999 These options are intended to be used to help debugging stack overflow problems.
21000 The additionally emitted code causes only little overhead and hence can also be
21001 used in production-like systems without greater performance degradation.  The given
21002 values have to be exact powers of 2 and @var{stack-size} has to be greater than
21003 @var{stack-guard} without exceeding 64k.
21004 In order to be efficient the extra code makes the assumption that the stack starts
21005 at an address aligned to the value given by @var{stack-size}.
21006 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
21008 @item -mhotpatch[=@var{halfwords}]
21009 @itemx -mno-hotpatch
21010 @opindex mhotpatch
21011 If the hotpatch option is enabled, a ``hot-patching'' function
21012 prologue is generated for all functions in the compilation unit.
21013 The funtion label is prepended with the given number of two-byte
21014 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
21015 instructions if no argument is present.  Functions with a
21016 hot-patching prologue are never inlined automatically, and a
21017 hot-patching prologue is never generated for functions
21018 that are explicitly inline.
21020 This option can be overridden for individual functions with the
21021 @code{hotpatch} attribute.
21022 @end table
21024 @node Score Options
21025 @subsection Score Options
21026 @cindex Score Options
21028 These options are defined for Score implementations:
21030 @table @gcctabopt
21031 @item -meb
21032 @opindex meb
21033 Compile code for big-endian mode.  This is the default.
21035 @item -mel
21036 @opindex mel
21037 Compile code for little-endian mode.
21039 @item -mnhwloop
21040 @opindex mnhwloop
21041 Disable generation of @code{bcnz} instructions.
21043 @item -muls
21044 @opindex muls
21045 Enable generation of unaligned load and store instructions.
21047 @item -mmac
21048 @opindex mmac
21049 Enable the use of multiply-accumulate instructions. Disabled by default.
21051 @item -mscore5
21052 @opindex mscore5
21053 Specify the SCORE5 as the target architecture.
21055 @item -mscore5u
21056 @opindex mscore5u
21057 Specify the SCORE5U of the target architecture.
21059 @item -mscore7
21060 @opindex mscore7
21061 Specify the SCORE7 as the target architecture. This is the default.
21063 @item -mscore7d
21064 @opindex mscore7d
21065 Specify the SCORE7D as the target architecture.
21066 @end table
21068 @node SH Options
21069 @subsection SH Options
21071 These @samp{-m} options are defined for the SH implementations:
21073 @table @gcctabopt
21074 @item -m1
21075 @opindex m1
21076 Generate code for the SH1.
21078 @item -m2
21079 @opindex m2
21080 Generate code for the SH2.
21082 @item -m2e
21083 Generate code for the SH2e.
21085 @item -m2a-nofpu
21086 @opindex m2a-nofpu
21087 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
21088 that the floating-point unit is not used.
21090 @item -m2a-single-only
21091 @opindex m2a-single-only
21092 Generate code for the SH2a-FPU, in such a way that no double-precision
21093 floating-point operations are used.
21095 @item -m2a-single
21096 @opindex m2a-single
21097 Generate code for the SH2a-FPU assuming the floating-point unit is in
21098 single-precision mode by default.
21100 @item -m2a
21101 @opindex m2a
21102 Generate code for the SH2a-FPU assuming the floating-point unit is in
21103 double-precision mode by default.
21105 @item -m3
21106 @opindex m3
21107 Generate code for the SH3.
21109 @item -m3e
21110 @opindex m3e
21111 Generate code for the SH3e.
21113 @item -m4-nofpu
21114 @opindex m4-nofpu
21115 Generate code for the SH4 without a floating-point unit.
21117 @item -m4-single-only
21118 @opindex m4-single-only
21119 Generate code for the SH4 with a floating-point unit that only
21120 supports single-precision arithmetic.
21122 @item -m4-single
21123 @opindex m4-single
21124 Generate code for the SH4 assuming the floating-point unit is in
21125 single-precision mode by default.
21127 @item -m4
21128 @opindex m4
21129 Generate code for the SH4.
21131 @item -m4-100
21132 @opindex m4-100
21133 Generate code for SH4-100.
21135 @item -m4-100-nofpu
21136 @opindex m4-100-nofpu
21137 Generate code for SH4-100 in such a way that the
21138 floating-point unit is not used.
21140 @item -m4-100-single
21141 @opindex m4-100-single
21142 Generate code for SH4-100 assuming the floating-point unit is in
21143 single-precision mode by default.
21145 @item -m4-100-single-only
21146 @opindex m4-100-single-only
21147 Generate code for SH4-100 in such a way that no double-precision
21148 floating-point operations are used.
21150 @item -m4-200
21151 @opindex m4-200
21152 Generate code for SH4-200.
21154 @item -m4-200-nofpu
21155 @opindex m4-200-nofpu
21156 Generate code for SH4-200 without in such a way that the
21157 floating-point unit is not used.
21159 @item -m4-200-single
21160 @opindex m4-200-single
21161 Generate code for SH4-200 assuming the floating-point unit is in
21162 single-precision mode by default.
21164 @item -m4-200-single-only
21165 @opindex m4-200-single-only
21166 Generate code for SH4-200 in such a way that no double-precision
21167 floating-point operations are used.
21169 @item -m4-300
21170 @opindex m4-300
21171 Generate code for SH4-300.
21173 @item -m4-300-nofpu
21174 @opindex m4-300-nofpu
21175 Generate code for SH4-300 without in such a way that the
21176 floating-point unit is not used.
21178 @item -m4-300-single
21179 @opindex m4-300-single
21180 Generate code for SH4-300 in such a way that no double-precision
21181 floating-point operations are used.
21183 @item -m4-300-single-only
21184 @opindex m4-300-single-only
21185 Generate code for SH4-300 in such a way that no double-precision
21186 floating-point operations are used.
21188 @item -m4-340
21189 @opindex m4-340
21190 Generate code for SH4-340 (no MMU, no FPU).
21192 @item -m4-500
21193 @opindex m4-500
21194 Generate code for SH4-500 (no FPU).  Passes @option{-isa=sh4-nofpu} to the
21195 assembler.
21197 @item -m4a-nofpu
21198 @opindex m4a-nofpu
21199 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
21200 floating-point unit is not used.
21202 @item -m4a-single-only
21203 @opindex m4a-single-only
21204 Generate code for the SH4a, in such a way that no double-precision
21205 floating-point operations are used.
21207 @item -m4a-single
21208 @opindex m4a-single
21209 Generate code for the SH4a assuming the floating-point unit is in
21210 single-precision mode by default.
21212 @item -m4a
21213 @opindex m4a
21214 Generate code for the SH4a.
21216 @item -m4al
21217 @opindex m4al
21218 Same as @option{-m4a-nofpu}, except that it implicitly passes
21219 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
21220 instructions at the moment.
21222 @item -m5-32media
21223 @opindex m5-32media
21224 Generate 32-bit code for SHmedia.
21226 @item -m5-32media-nofpu
21227 @opindex m5-32media-nofpu
21228 Generate 32-bit code for SHmedia in such a way that the
21229 floating-point unit is not used.
21231 @item -m5-64media
21232 @opindex m5-64media
21233 Generate 64-bit code for SHmedia.
21235 @item -m5-64media-nofpu
21236 @opindex m5-64media-nofpu
21237 Generate 64-bit code for SHmedia in such a way that the
21238 floating-point unit is not used.
21240 @item -m5-compact
21241 @opindex m5-compact
21242 Generate code for SHcompact.
21244 @item -m5-compact-nofpu
21245 @opindex m5-compact-nofpu
21246 Generate code for SHcompact in such a way that the
21247 floating-point unit is not used.
21249 @item -mb
21250 @opindex mb
21251 Compile code for the processor in big-endian mode.
21253 @item -ml
21254 @opindex ml
21255 Compile code for the processor in little-endian mode.
21257 @item -mdalign
21258 @opindex mdalign
21259 Align doubles at 64-bit boundaries.  Note that this changes the calling
21260 conventions, and thus some functions from the standard C library do
21261 not work unless you recompile it first with @option{-mdalign}.
21263 @item -mrelax
21264 @opindex mrelax
21265 Shorten some address references at link time, when possible; uses the
21266 linker option @option{-relax}.
21268 @item -mbigtable
21269 @opindex mbigtable
21270 Use 32-bit offsets in @code{switch} tables.  The default is to use
21271 16-bit offsets.
21273 @item -mbitops
21274 @opindex mbitops
21275 Enable the use of bit manipulation instructions on SH2A.
21277 @item -mfmovd
21278 @opindex mfmovd
21279 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
21280 alignment constraints.
21282 @item -mrenesas
21283 @opindex mrenesas
21284 Comply with the calling conventions defined by Renesas.
21286 @item -mno-renesas
21287 @opindex mno-renesas
21288 Comply with the calling conventions defined for GCC before the Renesas
21289 conventions were available.  This option is the default for all
21290 targets of the SH toolchain.
21292 @item -mnomacsave
21293 @opindex mnomacsave
21294 Mark the @code{MAC} register as call-clobbered, even if
21295 @option{-mrenesas} is given.
21297 @item -mieee
21298 @itemx -mno-ieee
21299 @opindex mieee
21300 @opindex mno-ieee
21301 Control the IEEE compliance of floating-point comparisons, which affects the
21302 handling of cases where the result of a comparison is unordered.  By default
21303 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
21304 enabled @option{-mno-ieee} is implicitly set, which results in faster
21305 floating-point greater-equal and less-equal comparisons.  The implcit settings
21306 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
21308 @item -minline-ic_invalidate
21309 @opindex minline-ic_invalidate
21310 Inline code to invalidate instruction cache entries after setting up
21311 nested function trampolines.
21312 This option has no effect if @option{-musermode} is in effect and the selected
21313 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
21314 instruction.
21315 If the selected code generation option does not allow the use of the @code{icbi}
21316 instruction, and @option{-musermode} is not in effect, the inlined code
21317 manipulates the instruction cache address array directly with an associative
21318 write.  This not only requires privileged mode at run time, but it also
21319 fails if the cache line had been mapped via the TLB and has become unmapped.
21321 @item -misize
21322 @opindex misize
21323 Dump instruction size and location in the assembly code.
21325 @item -mpadstruct
21326 @opindex mpadstruct
21327 This option is deprecated.  It pads structures to multiple of 4 bytes,
21328 which is incompatible with the SH ABI@.
21330 @item -matomic-model=@var{model}
21331 @opindex matomic-model=@var{model}
21332 Sets the model of atomic operations and additional parameters as a comma
21333 separated list.  For details on the atomic built-in functions see
21334 @ref{__atomic Builtins}.  The following models and parameters are supported:
21336 @table @samp
21338 @item none
21339 Disable compiler generated atomic sequences and emit library calls for atomic
21340 operations.  This is the default if the target is not @code{sh*-*-linux*}.
21342 @item soft-gusa
21343 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
21344 built-in functions.  The generated atomic sequences require additional support
21345 from the interrupt/exception handling code of the system and are only suitable
21346 for SH3* and SH4* single-core systems.  This option is enabled by default when
21347 the target is @code{sh*-*-linux*} and SH3* or SH4*.  When the target is SH4A,
21348 this option will also partially utilize the hardware atomic instructions
21349 @code{movli.l} and @code{movco.l} to create more efficient code, unless
21350 @samp{strict} is specified.  
21352 @item soft-tcb
21353 Generate software atomic sequences that use a variable in the thread control
21354 block.  This is a variation of the gUSA sequences which can also be used on
21355 SH1* and SH2* targets.  The generated atomic sequences require additional
21356 support from the interrupt/exception handling code of the system and are only
21357 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
21358 parameter has to be specified as well.
21360 @item soft-imask
21361 Generate software atomic sequences that temporarily disable interrupts by
21362 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
21363 in privileged mode and is only suitable for single-core systems.  Additional
21364 support from the interrupt/exception handling code of the system is not
21365 required.  This model is enabled by default when the target is
21366 @code{sh*-*-linux*} and SH1* or SH2*.
21368 @item hard-llcs
21369 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
21370 instructions only.  This is only available on SH4A and is suitable for
21371 multi-core systems.  Since the hardware instructions support only 32 bit atomic
21372 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
21373 Code compiled with this option will also be compatible with other software
21374 atomic model interrupt/exception handling systems if executed on an SH4A
21375 system.  Additional support from the interrupt/exception handling code of the
21376 system is not required for this model.
21378 @item gbr-offset=
21379 This parameter specifies the offset in bytes of the variable in the thread
21380 control block structure that should be used by the generated atomic sequences
21381 when the @samp{soft-tcb} model has been selected.  For other models this
21382 parameter is ignored.  The specified value must be an integer multiple of four
21383 and in the range 0-1020.
21385 @item strict
21386 This parameter prevents mixed usage of multiple atomic models, even though they
21387 would be compatible, and will make the compiler generate atomic sequences of the
21388 specified model only.
21390 @end table
21392 @item -mtas
21393 @opindex mtas
21394 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
21395 Notice that depending on the particular hardware and software configuration
21396 this can degrade overall performance due to the operand cache line flushes
21397 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
21398 processors the @code{tas.b} instruction must be used with caution since it
21399 can result in data corruption for certain cache configurations.
21401 @item -mprefergot
21402 @opindex mprefergot
21403 When generating position-independent code, emit function calls using
21404 the Global Offset Table instead of the Procedure Linkage Table.
21406 @item -musermode
21407 @itemx -mno-usermode
21408 @opindex musermode
21409 @opindex mno-usermode
21410 Don't allow (allow) the compiler generating privileged mode code.  Specifying
21411 @option{-musermode} also implies @option{-mno-inline-ic_invalidate} if the
21412 inlined code would not work in user mode.  @option{-musermode} is the default
21413 when the target is @code{sh*-*-linux*}.  If the target is SH1* or SH2*
21414 @option{-musermode} has no effect, since there is no user mode.
21416 @item -multcost=@var{number}
21417 @opindex multcost=@var{number}
21418 Set the cost to assume for a multiply insn.
21420 @item -mdiv=@var{strategy}
21421 @opindex mdiv=@var{strategy}
21422 Set the division strategy to be used for integer division operations.
21423 For SHmedia @var{strategy} can be one of: 
21425 @table @samp
21427 @item fp 
21428 Performs the operation in floating point.  This has a very high latency,
21429 but needs only a few instructions, so it might be a good choice if
21430 your code has enough easily-exploitable ILP to allow the compiler to
21431 schedule the floating-point instructions together with other instructions.
21432 Division by zero causes a floating-point exception.
21434 @item inv
21435 Uses integer operations to calculate the inverse of the divisor,
21436 and then multiplies the dividend with the inverse.  This strategy allows
21437 CSE and hoisting of the inverse calculation.  Division by zero calculates
21438 an unspecified result, but does not trap.
21440 @item inv:minlat
21441 A variant of @samp{inv} where, if no CSE or hoisting opportunities
21442 have been found, or if the entire operation has been hoisted to the same
21443 place, the last stages of the inverse calculation are intertwined with the
21444 final multiply to reduce the overall latency, at the expense of using a few
21445 more instructions, and thus offering fewer scheduling opportunities with
21446 other code.
21448 @item call
21449 Calls a library function that usually implements the @samp{inv:minlat}
21450 strategy.
21451 This gives high code density for @code{m5-*media-nofpu} compilations.
21453 @item call2
21454 Uses a different entry point of the same library function, where it
21455 assumes that a pointer to a lookup table has already been set up, which
21456 exposes the pointer load to CSE and code hoisting optimizations.
21458 @item inv:call
21459 @itemx inv:call2
21460 @itemx inv:fp
21461 Use the @samp{inv} algorithm for initial
21462 code generation, but if the code stays unoptimized, revert to the @samp{call},
21463 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
21464 potentially-trapping side effect of division by zero is carried by a
21465 separate instruction, so it is possible that all the integer instructions
21466 are hoisted out, but the marker for the side effect stays where it is.
21467 A recombination to floating-point operations or a call is not possible
21468 in that case.
21470 @item inv20u
21471 @itemx inv20l
21472 Variants of the @samp{inv:minlat} strategy.  In the case
21473 that the inverse calculation is not separated from the multiply, they speed
21474 up division where the dividend fits into 20 bits (plus sign where applicable)
21475 by inserting a test to skip a number of operations in this case; this test
21476 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
21477 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
21479 @end table
21481 For targets other than SHmedia @var{strategy} can be one of:
21483 @table @samp
21485 @item call-div1
21486 Calls a library function that uses the single-step division instruction
21487 @code{div1} to perform the operation.  Division by zero calculates an
21488 unspecified result and does not trap.  This is the default except for SH4,
21489 SH2A and SHcompact.
21491 @item call-fp
21492 Calls a library function that performs the operation in double precision
21493 floating point.  Division by zero causes a floating-point exception.  This is
21494 the default for SHcompact with FPU.  Specifying this for targets that do not
21495 have a double precision FPU will default to @code{call-div1}.
21497 @item call-table
21498 Calls a library function that uses a lookup table for small divisors and
21499 the @code{div1} instruction with case distinction for larger divisors.  Division
21500 by zero calculates an unspecified result and does not trap.  This is the default
21501 for SH4.  Specifying this for targets that do not have dynamic shift
21502 instructions will default to @code{call-div1}.
21504 @end table
21506 When a division strategy has not been specified the default strategy will be
21507 selected based on the current target.  For SH2A the default strategy is to
21508 use the @code{divs} and @code{divu} instructions instead of library function
21509 calls.
21511 @item -maccumulate-outgoing-args
21512 @opindex maccumulate-outgoing-args
21513 Reserve space once for outgoing arguments in the function prologue rather
21514 than around each call.  Generally beneficial for performance and size.  Also
21515 needed for unwinding to avoid changing the stack frame around conditional code.
21517 @item -mdivsi3_libfunc=@var{name}
21518 @opindex mdivsi3_libfunc=@var{name}
21519 Set the name of the library function used for 32-bit signed division to
21520 @var{name}.
21521 This only affects the name used in the @samp{call} and @samp{inv:call}
21522 division strategies, and the compiler still expects the same
21523 sets of input/output/clobbered registers as if this option were not present.
21525 @item -mfixed-range=@var{register-range}
21526 @opindex mfixed-range
21527 Generate code treating the given register range as fixed registers.
21528 A fixed register is one that the register allocator can not use.  This is
21529 useful when compiling kernel code.  A register range is specified as
21530 two registers separated by a dash.  Multiple register ranges can be
21531 specified separated by a comma.
21533 @item -mindexed-addressing
21534 @opindex mindexed-addressing
21535 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
21536 This is only safe if the hardware and/or OS implement 32-bit wrap-around
21537 semantics for the indexed addressing mode.  The architecture allows the
21538 implementation of processors with 64-bit MMU, which the OS could use to
21539 get 32-bit addressing, but since no current hardware implementation supports
21540 this or any other way to make the indexed addressing mode safe to use in
21541 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
21543 @item -mgettrcost=@var{number}
21544 @opindex mgettrcost=@var{number}
21545 Set the cost assumed for the @code{gettr} instruction to @var{number}.
21546 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
21548 @item -mpt-fixed
21549 @opindex mpt-fixed
21550 Assume @code{pt*} instructions won't trap.  This generally generates
21551 better-scheduled code, but is unsafe on current hardware.
21552 The current architecture
21553 definition says that @code{ptabs} and @code{ptrel} trap when the target 
21554 anded with 3 is 3.
21555 This has the unintentional effect of making it unsafe to schedule these
21556 instructions before a branch, or hoist them out of a loop.  For example,
21557 @code{__do_global_ctors}, a part of @file{libgcc}
21558 that runs constructors at program
21559 startup, calls functions in a list which is delimited by @minus{}1.  With the
21560 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
21561 That means that all the constructors run a bit more quickly, but when
21562 the loop comes to the end of the list, the program crashes because @code{ptabs}
21563 loads @minus{}1 into a target register.  
21565 Since this option is unsafe for any
21566 hardware implementing the current architecture specification, the default
21567 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
21568 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
21569 this deters register allocation from using target registers for storing
21570 ordinary integers.
21572 @item -minvalid-symbols
21573 @opindex minvalid-symbols
21574 Assume symbols might be invalid.  Ordinary function symbols generated by
21575 the compiler are always valid to load with
21576 @code{movi}/@code{shori}/@code{ptabs} or
21577 @code{movi}/@code{shori}/@code{ptrel},
21578 but with assembler and/or linker tricks it is possible
21579 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
21580 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
21581 It prevents cross-basic-block CSE, hoisting and most scheduling
21582 of symbol loads.  The default is @option{-mno-invalid-symbols}.
21584 @item -mbranch-cost=@var{num}
21585 @opindex mbranch-cost=@var{num}
21586 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
21587 make the compiler try to generate more branch-free code if possible.  
21588 If not specified the value is selected depending on the processor type that
21589 is being compiled for.
21591 @item -mzdcbranch
21592 @itemx -mno-zdcbranch
21593 @opindex mzdcbranch
21594 @opindex mno-zdcbranch
21595 Assume (do not assume) that zero displacement conditional branch instructions
21596 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
21597 compiler will try to prefer zero displacement branch code sequences.  This is
21598 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
21599 disabled by specifying @option{-mno-zdcbranch}.
21601 @item -mfused-madd
21602 @itemx -mno-fused-madd
21603 @opindex mfused-madd
21604 @opindex mno-fused-madd
21605 Generate code that uses (does not use) the floating-point multiply and
21606 accumulate instructions.  These instructions are generated by default
21607 if hardware floating point is used.  The machine-dependent
21608 @option{-mfused-madd} option is now mapped to the machine-independent
21609 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
21610 mapped to @option{-ffp-contract=off}.
21612 @item -mfsca
21613 @itemx -mno-fsca
21614 @opindex mfsca
21615 @opindex mno-fsca
21616 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
21617 and cosine approximations.  The option @code{-mfsca} must be used in
21618 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
21619 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
21620 approximations even if @code{-funsafe-math-optimizations} is in effect.
21622 @item -mfsrra
21623 @itemx -mno-fsrra
21624 @opindex mfsrra
21625 @opindex mno-fsrra
21626 Allow or disallow the compiler to emit the @code{fsrra} instruction for
21627 reciprocal square root approximations.  The option @code{-mfsrra} must be used
21628 in combination with @code{-funsafe-math-optimizations} and
21629 @code{-ffinite-math-only}.  It is enabled by default when generating code for
21630 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
21631 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
21632 in effect.
21634 @item -mpretend-cmove
21635 @opindex mpretend-cmove
21636 Prefer zero-displacement conditional branches for conditional move instruction
21637 patterns.  This can result in faster code on the SH4 processor.
21639 @end table
21641 @node Solaris 2 Options
21642 @subsection Solaris 2 Options
21643 @cindex Solaris 2 options
21645 These @samp{-m} options are supported on Solaris 2:
21647 @table @gcctabopt
21648 @item -mclear-hwcap
21649 @opindex mclear-hwcap
21650 @option{-mclear-hwcap} tells the compiler to remove the hardware
21651 capabilities generated by the Solaris assembler.  This is only necessary
21652 when object files use ISA extensions not supported by the current
21653 machine, but check at runtime whether or not to use them.
21655 @item -mimpure-text
21656 @opindex mimpure-text
21657 @option{-mimpure-text}, used in addition to @option{-shared}, tells
21658 the compiler to not pass @option{-z text} to the linker when linking a
21659 shared object.  Using this option, you can link position-dependent
21660 code into a shared object.
21662 @option{-mimpure-text} suppresses the ``relocations remain against
21663 allocatable but non-writable sections'' linker error message.
21664 However, the necessary relocations trigger copy-on-write, and the
21665 shared object is not actually shared across processes.  Instead of
21666 using @option{-mimpure-text}, you should compile all source code with
21667 @option{-fpic} or @option{-fPIC}.
21669 @end table
21671 These switches are supported in addition to the above on Solaris 2:
21673 @table @gcctabopt
21674 @item -pthreads
21675 @opindex pthreads
21676 Add support for multithreading using the POSIX threads library.  This
21677 option sets flags for both the preprocessor and linker.  This option does
21678 not affect the thread safety of object code produced  by the compiler or
21679 that of libraries supplied with it.
21681 @item -pthread
21682 @opindex pthread
21683 This is a synonym for @option{-pthreads}.
21684 @end table
21686 @node SPARC Options
21687 @subsection SPARC Options
21688 @cindex SPARC options
21690 These @samp{-m} options are supported on the SPARC:
21692 @table @gcctabopt
21693 @item -mno-app-regs
21694 @itemx -mapp-regs
21695 @opindex mno-app-regs
21696 @opindex mapp-regs
21697 Specify @option{-mapp-regs} to generate output using the global registers
21698 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
21699 global register 1, each global register 2 through 4 is then treated as an
21700 allocable register that is clobbered by function calls.  This is the default.
21702 To be fully SVR4 ABI-compliant at the cost of some performance loss,
21703 specify @option{-mno-app-regs}.  You should compile libraries and system
21704 software with this option.
21706 @item -mflat
21707 @itemx -mno-flat
21708 @opindex mflat
21709 @opindex mno-flat
21710 With @option{-mflat}, the compiler does not generate save/restore instructions
21711 and uses a ``flat'' or single register window model.  This model is compatible
21712 with the regular register window model.  The local registers and the input
21713 registers (0--5) are still treated as ``call-saved'' registers and are
21714 saved on the stack as needed.
21716 With @option{-mno-flat} (the default), the compiler generates save/restore
21717 instructions (except for leaf functions).  This is the normal operating mode.
21719 @item -mfpu
21720 @itemx -mhard-float
21721 @opindex mfpu
21722 @opindex mhard-float
21723 Generate output containing floating-point instructions.  This is the
21724 default.
21726 @item -mno-fpu
21727 @itemx -msoft-float
21728 @opindex mno-fpu
21729 @opindex msoft-float
21730 Generate output containing library calls for floating point.
21731 @strong{Warning:} the requisite libraries are not available for all SPARC
21732 targets.  Normally the facilities of the machine's usual C compiler are
21733 used, but this cannot be done directly in cross-compilation.  You must make
21734 your own arrangements to provide suitable library functions for
21735 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
21736 @samp{sparclite-*-*} do provide software floating-point support.
21738 @option{-msoft-float} changes the calling convention in the output file;
21739 therefore, it is only useful if you compile @emph{all} of a program with
21740 this option.  In particular, you need to compile @file{libgcc.a}, the
21741 library that comes with GCC, with @option{-msoft-float} in order for
21742 this to work.
21744 @item -mhard-quad-float
21745 @opindex mhard-quad-float
21746 Generate output containing quad-word (long double) floating-point
21747 instructions.
21749 @item -msoft-quad-float
21750 @opindex msoft-quad-float
21751 Generate output containing library calls for quad-word (long double)
21752 floating-point instructions.  The functions called are those specified
21753 in the SPARC ABI@.  This is the default.
21755 As of this writing, there are no SPARC implementations that have hardware
21756 support for the quad-word floating-point instructions.  They all invoke
21757 a trap handler for one of these instructions, and then the trap handler
21758 emulates the effect of the instruction.  Because of the trap handler overhead,
21759 this is much slower than calling the ABI library routines.  Thus the
21760 @option{-msoft-quad-float} option is the default.
21762 @item -mno-unaligned-doubles
21763 @itemx -munaligned-doubles
21764 @opindex mno-unaligned-doubles
21765 @opindex munaligned-doubles
21766 Assume that doubles have 8-byte alignment.  This is the default.
21768 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
21769 alignment only if they are contained in another type, or if they have an
21770 absolute address.  Otherwise, it assumes they have 4-byte alignment.
21771 Specifying this option avoids some rare compatibility problems with code
21772 generated by other compilers.  It is not the default because it results
21773 in a performance loss, especially for floating-point code.
21775 @item -muser-mode
21776 @itemx -mno-user-mode
21777 @opindex muser-mode
21778 @opindex mno-user-mode
21779 Do not generate code that can only run in supervisor mode.  This is relevant
21780 only for the @code{casa} instruction emitted for the LEON3 processor.  The
21781 default is @option{-mno-user-mode}.
21783 @item -mno-faster-structs
21784 @itemx -mfaster-structs
21785 @opindex mno-faster-structs
21786 @opindex mfaster-structs
21787 With @option{-mfaster-structs}, the compiler assumes that structures
21788 should have 8-byte alignment.  This enables the use of pairs of
21789 @code{ldd} and @code{std} instructions for copies in structure
21790 assignment, in place of twice as many @code{ld} and @code{st} pairs.
21791 However, the use of this changed alignment directly violates the SPARC
21792 ABI@.  Thus, it's intended only for use on targets where the developer
21793 acknowledges that their resulting code is not directly in line with
21794 the rules of the ABI@.
21796 @item -mcpu=@var{cpu_type}
21797 @opindex mcpu
21798 Set the instruction set, register set, and instruction scheduling parameters
21799 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
21800 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
21801 @samp{leon}, @samp{leon3}, @samp{leon3v7}, @samp{sparclite}, @samp{f930},
21802 @samp{f934}, @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
21803 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21804 @samp{niagara3} and @samp{niagara4}.
21806 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
21807 which selects the best architecture option for the host processor.
21808 @option{-mcpu=native} has no effect if GCC does not recognize
21809 the processor.
21811 Default instruction scheduling parameters are used for values that select
21812 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21813 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21815 Here is a list of each supported architecture and their supported
21816 implementations.
21818 @table @asis
21819 @item v7
21820 cypress, leon3v7
21822 @item v8
21823 supersparc, hypersparc, leon, leon3
21825 @item sparclite
21826 f930, f934, sparclite86x
21828 @item sparclet
21829 tsc701
21831 @item v9
21832 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21833 @end table
21835 By default (unless configured otherwise), GCC generates code for the V7
21836 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21837 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21838 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21839 SPARCStation 1, 2, IPX etc.
21841 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21842 architecture.  The only difference from V7 code is that the compiler emits
21843 the integer multiply and integer divide instructions which exist in SPARC-V8
21844 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21845 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21846 2000 series.
21848 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21849 the SPARC architecture.  This adds the integer multiply, integer divide step
21850 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21851 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21852 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21853 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21854 MB86934 chip, which is the more recent SPARClite with FPU@.
21856 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21857 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21858 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21859 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21860 optimizes it for the TEMIC SPARClet chip.
21862 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21863 architecture.  This adds 64-bit integer and floating-point move instructions,
21864 3 additional floating-point condition code registers and conditional move
21865 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21866 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21867 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21868 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21869 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21870 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21871 additionally optimizes it for Sun UltraSPARC T2 chips. With
21872 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21873 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21874 additionally optimizes it for Sun UltraSPARC T4 chips.
21876 @item -mtune=@var{cpu_type}
21877 @opindex mtune
21878 Set the instruction scheduling parameters for machine type
21879 @var{cpu_type}, but do not set the instruction set or register set that the
21880 option @option{-mcpu=@var{cpu_type}} does.
21882 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21883 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21884 that select a particular CPU implementation.  Those are @samp{cypress},
21885 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3},
21886 @samp{leon3v7}, @samp{f930}, @samp{f934}, @samp{sparclite86x}, @samp{tsc701},
21887 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
21888 @samp{niagara3} and @samp{niagara4}.  With native Solaris and GNU/Linux
21889 toolchains, @samp{native} can also be used.
21891 @item -mv8plus
21892 @itemx -mno-v8plus
21893 @opindex mv8plus
21894 @opindex mno-v8plus
21895 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21896 difference from the V8 ABI is that the global and out registers are
21897 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21898 mode for all SPARC-V9 processors.
21900 @item -mvis
21901 @itemx -mno-vis
21902 @opindex mvis
21903 @opindex mno-vis
21904 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21905 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21907 @item -mvis2
21908 @itemx -mno-vis2
21909 @opindex mvis2
21910 @opindex mno-vis2
21911 With @option{-mvis2}, GCC generates code that takes advantage of
21912 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21913 default is @option{-mvis2} when targeting a cpu that supports such
21914 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21915 also sets @option{-mvis}.
21917 @item -mvis3
21918 @itemx -mno-vis3
21919 @opindex mvis3
21920 @opindex mno-vis3
21921 With @option{-mvis3}, GCC generates code that takes advantage of
21922 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21923 default is @option{-mvis3} when targeting a cpu that supports such
21924 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21925 also sets @option{-mvis2} and @option{-mvis}.
21927 @item -mcbcond
21928 @itemx -mno-cbcond
21929 @opindex mcbcond
21930 @opindex mno-cbcond
21931 With @option{-mcbcond}, GCC generates code that takes advantage of
21932 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21933 The default is @option{-mcbcond} when targeting a cpu that supports such
21934 instructions, such as niagara-4 and later.
21936 @item -mpopc
21937 @itemx -mno-popc
21938 @opindex mpopc
21939 @opindex mno-popc
21940 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21941 population count instruction.  The default is @option{-mpopc}
21942 when targeting a cpu that supports such instructions, such as Niagara-2 and
21943 later.
21945 @item -mfmaf
21946 @itemx -mno-fmaf
21947 @opindex mfmaf
21948 @opindex mno-fmaf
21949 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21950 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21951 when targeting a cpu that supports such instructions, such as Niagara-3 and
21952 later.
21954 @item -mfix-at697f
21955 @opindex mfix-at697f
21956 Enable the documented workaround for the single erratum of the Atmel AT697F
21957 processor (which corresponds to erratum #13 of the AT697E processor).
21959 @item -mfix-ut699
21960 @opindex mfix-ut699
21961 Enable the documented workarounds for the floating-point errata and the data
21962 cache nullify errata of the UT699 processor.
21963 @end table
21965 These @samp{-m} options are supported in addition to the above
21966 on SPARC-V9 processors in 64-bit environments:
21968 @table @gcctabopt
21969 @item -m32
21970 @itemx -m64
21971 @opindex m32
21972 @opindex m64
21973 Generate code for a 32-bit or 64-bit environment.
21974 The 32-bit environment sets int, long and pointer to 32 bits.
21975 The 64-bit environment sets int to 32 bits and long and pointer
21976 to 64 bits.
21978 @item -mcmodel=@var{which}
21979 @opindex mcmodel
21980 Set the code model to one of
21982 @table @samp
21983 @item medlow
21984 The Medium/Low code model: 64-bit addresses, programs
21985 must be linked in the low 32 bits of memory.  Programs can be statically
21986 or dynamically linked.
21988 @item medmid
21989 The Medium/Middle code model: 64-bit addresses, programs
21990 must be linked in the low 44 bits of memory, the text and data segments must
21991 be less than 2GB in size and the data segment must be located within 2GB of
21992 the text segment.
21994 @item medany
21995 The Medium/Anywhere code model: 64-bit addresses, programs
21996 may be linked anywhere in memory, the text and data segments must be less
21997 than 2GB in size and the data segment must be located within 2GB of the
21998 text segment.
22000 @item embmedany
22001 The Medium/Anywhere code model for embedded systems:
22002 64-bit addresses, the text and data segments must be less than 2GB in
22003 size, both starting anywhere in memory (determined at link time).  The
22004 global register %g4 points to the base of the data segment.  Programs
22005 are statically linked and PIC is not supported.
22006 @end table
22008 @item -mmemory-model=@var{mem-model}
22009 @opindex mmemory-model
22010 Set the memory model in force on the processor to one of
22012 @table @samp
22013 @item default
22014 The default memory model for the processor and operating system.
22016 @item rmo
22017 Relaxed Memory Order
22019 @item pso
22020 Partial Store Order
22022 @item tso
22023 Total Store Order
22025 @item sc
22026 Sequential Consistency
22027 @end table
22029 These memory models are formally defined in Appendix D of the Sparc V9
22030 architecture manual, as set in the processor's @code{PSTATE.MM} field.
22032 @item -mstack-bias
22033 @itemx -mno-stack-bias
22034 @opindex mstack-bias
22035 @opindex mno-stack-bias
22036 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
22037 frame pointer if present, are offset by @minus{}2047 which must be added back
22038 when making stack frame references.  This is the default in 64-bit mode.
22039 Otherwise, assume no such offset is present.
22040 @end table
22042 @node SPU Options
22043 @subsection SPU Options
22044 @cindex SPU options
22046 These @samp{-m} options are supported on the SPU:
22048 @table @gcctabopt
22049 @item -mwarn-reloc
22050 @itemx -merror-reloc
22051 @opindex mwarn-reloc
22052 @opindex merror-reloc
22054 The loader for SPU does not handle dynamic relocations.  By default, GCC
22055 gives an error when it generates code that requires a dynamic
22056 relocation.  @option{-mno-error-reloc} disables the error,
22057 @option{-mwarn-reloc} generates a warning instead.
22059 @item -msafe-dma
22060 @itemx -munsafe-dma
22061 @opindex msafe-dma
22062 @opindex munsafe-dma
22064 Instructions that initiate or test completion of DMA must not be
22065 reordered with respect to loads and stores of the memory that is being
22066 accessed.
22067 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
22068 memory accesses, but that can lead to inefficient code in places where the
22069 memory is known to not change.  Rather than mark the memory as volatile,
22070 you can use @option{-msafe-dma} to tell the compiler to treat
22071 the DMA instructions as potentially affecting all memory.  
22073 @item -mbranch-hints
22074 @opindex mbranch-hints
22076 By default, GCC generates a branch hint instruction to avoid
22077 pipeline stalls for always-taken or probably-taken branches.  A hint
22078 is not generated closer than 8 instructions away from its branch.
22079 There is little reason to disable them, except for debugging purposes,
22080 or to make an object a little bit smaller.
22082 @item -msmall-mem
22083 @itemx -mlarge-mem
22084 @opindex msmall-mem
22085 @opindex mlarge-mem
22087 By default, GCC generates code assuming that addresses are never larger
22088 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
22089 a full 32-bit address.
22091 @item -mstdmain
22092 @opindex mstdmain
22094 By default, GCC links against startup code that assumes the SPU-style
22095 main function interface (which has an unconventional parameter list).
22096 With @option{-mstdmain}, GCC links your program against startup
22097 code that assumes a C99-style interface to @code{main}, including a
22098 local copy of @code{argv} strings.
22100 @item -mfixed-range=@var{register-range}
22101 @opindex mfixed-range
22102 Generate code treating the given register range as fixed registers.
22103 A fixed register is one that the register allocator cannot use.  This is
22104 useful when compiling kernel code.  A register range is specified as
22105 two registers separated by a dash.  Multiple register ranges can be
22106 specified separated by a comma.
22108 @item -mea32
22109 @itemx -mea64
22110 @opindex mea32
22111 @opindex mea64
22112 Compile code assuming that pointers to the PPU address space accessed
22113 via the @code{__ea} named address space qualifier are either 32 or 64
22114 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
22115 all object code in an executable must be compiled with the same setting.
22117 @item -maddress-space-conversion
22118 @itemx -mno-address-space-conversion
22119 @opindex maddress-space-conversion
22120 @opindex mno-address-space-conversion
22121 Allow/disallow treating the @code{__ea} address space as superset
22122 of the generic address space.  This enables explicit type casts
22123 between @code{__ea} and generic pointer as well as implicit
22124 conversions of generic pointers to @code{__ea} pointers.  The
22125 default is to allow address space pointer conversions.
22127 @item -mcache-size=@var{cache-size}
22128 @opindex mcache-size
22129 This option controls the version of libgcc that the compiler links to an
22130 executable and selects a software-managed cache for accessing variables
22131 in the @code{__ea} address space with a particular cache size.  Possible
22132 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
22133 and @samp{128}.  The default cache size is 64KB.
22135 @item -matomic-updates
22136 @itemx -mno-atomic-updates
22137 @opindex matomic-updates
22138 @opindex mno-atomic-updates
22139 This option controls the version of libgcc that the compiler links to an
22140 executable and selects whether atomic updates to the software-managed
22141 cache of PPU-side variables are used.  If you use atomic updates, changes
22142 to a PPU variable from SPU code using the @code{__ea} named address space
22143 qualifier do not interfere with changes to other PPU variables residing
22144 in the same cache line from PPU code.  If you do not use atomic updates,
22145 such interference may occur; however, writing back cache lines is
22146 more efficient.  The default behavior is to use atomic updates.
22148 @item -mdual-nops
22149 @itemx -mdual-nops=@var{n}
22150 @opindex mdual-nops
22151 By default, GCC inserts nops to increase dual issue when it expects
22152 it to increase performance.  @var{n} can be a value from 0 to 10.  A
22153 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
22154 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
22156 @item -mhint-max-nops=@var{n}
22157 @opindex mhint-max-nops
22158 Maximum number of nops to insert for a branch hint.  A branch hint must
22159 be at least 8 instructions away from the branch it is affecting.  GCC
22160 inserts up to @var{n} nops to enforce this, otherwise it does not
22161 generate the branch hint.
22163 @item -mhint-max-distance=@var{n}
22164 @opindex mhint-max-distance
22165 The encoding of the branch hint instruction limits the hint to be within
22166 256 instructions of the branch it is affecting.  By default, GCC makes
22167 sure it is within 125.
22169 @item -msafe-hints
22170 @opindex msafe-hints
22171 Work around a hardware bug that causes the SPU to stall indefinitely.
22172 By default, GCC inserts the @code{hbrp} instruction to make sure
22173 this stall won't happen.
22175 @end table
22177 @node System V Options
22178 @subsection Options for System V
22180 These additional options are available on System V Release 4 for
22181 compatibility with other compilers on those systems:
22183 @table @gcctabopt
22184 @item -G
22185 @opindex G
22186 Create a shared object.
22187 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
22189 @item -Qy
22190 @opindex Qy
22191 Identify the versions of each tool used by the compiler, in a
22192 @code{.ident} assembler directive in the output.
22194 @item -Qn
22195 @opindex Qn
22196 Refrain from adding @code{.ident} directives to the output file (this is
22197 the default).
22199 @item -YP,@var{dirs}
22200 @opindex YP
22201 Search the directories @var{dirs}, and no others, for libraries
22202 specified with @option{-l}.
22204 @item -Ym,@var{dir}
22205 @opindex Ym
22206 Look in the directory @var{dir} to find the M4 preprocessor.
22207 The assembler uses this option.
22208 @c This is supposed to go with a -Yd for predefined M4 macro files, but
22209 @c the generic assembler that comes with Solaris takes just -Ym.
22210 @end table
22212 @node TILE-Gx Options
22213 @subsection TILE-Gx Options
22214 @cindex TILE-Gx options
22216 These @samp{-m} options are supported on the TILE-Gx:
22218 @table @gcctabopt
22219 @item -mcmodel=small
22220 @opindex mcmodel=small
22221 Generate code for the small model.  The distance for direct calls is
22222 limited to 500M in either direction.  PC-relative addresses are 32
22223 bits.  Absolute addresses support the full address range.
22225 @item -mcmodel=large
22226 @opindex mcmodel=large
22227 Generate code for the large model.  There is no limitation on call
22228 distance, pc-relative addresses, or absolute addresses.
22230 @item -mcpu=@var{name}
22231 @opindex mcpu
22232 Selects the type of CPU to be targeted.  Currently the only supported
22233 type is @samp{tilegx}.
22235 @item -m32
22236 @itemx -m64
22237 @opindex m32
22238 @opindex m64
22239 Generate code for a 32-bit or 64-bit environment.  The 32-bit
22240 environment sets int, long, and pointer to 32 bits.  The 64-bit
22241 environment sets int to 32 bits and long and pointer to 64 bits.
22243 @item -mbig-endian
22244 @itemx -mlittle-endian
22245 @opindex mbig-endian
22246 @opindex mlittle-endian
22247 Generate code in big/little endian mode, respectively.
22248 @end table
22250 @node TILEPro Options
22251 @subsection TILEPro Options
22252 @cindex TILEPro options
22254 These @samp{-m} options are supported on the TILEPro:
22256 @table @gcctabopt
22257 @item -mcpu=@var{name}
22258 @opindex mcpu
22259 Selects the type of CPU to be targeted.  Currently the only supported
22260 type is @samp{tilepro}.
22262 @item -m32
22263 @opindex m32
22264 Generate code for a 32-bit environment, which sets int, long, and
22265 pointer to 32 bits.  This is the only supported behavior so the flag
22266 is essentially ignored.
22267 @end table
22269 @node V850 Options
22270 @subsection V850 Options
22271 @cindex V850 Options
22273 These @samp{-m} options are defined for V850 implementations:
22275 @table @gcctabopt
22276 @item -mlong-calls
22277 @itemx -mno-long-calls
22278 @opindex mlong-calls
22279 @opindex mno-long-calls
22280 Treat all calls as being far away (near).  If calls are assumed to be
22281 far away, the compiler always loads the function's address into a
22282 register, and calls indirect through the pointer.
22284 @item -mno-ep
22285 @itemx -mep
22286 @opindex mno-ep
22287 @opindex mep
22288 Do not optimize (do optimize) basic blocks that use the same index
22289 pointer 4 or more times to copy pointer into the @code{ep} register, and
22290 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
22291 option is on by default if you optimize.
22293 @item -mno-prolog-function
22294 @itemx -mprolog-function
22295 @opindex mno-prolog-function
22296 @opindex mprolog-function
22297 Do not use (do use) external functions to save and restore registers
22298 at the prologue and epilogue of a function.  The external functions
22299 are slower, but use less code space if more than one function saves
22300 the same number of registers.  The @option{-mprolog-function} option
22301 is on by default if you optimize.
22303 @item -mspace
22304 @opindex mspace
22305 Try to make the code as small as possible.  At present, this just turns
22306 on the @option{-mep} and @option{-mprolog-function} options.
22308 @item -mtda=@var{n}
22309 @opindex mtda
22310 Put static or global variables whose size is @var{n} bytes or less into
22311 the tiny data area that register @code{ep} points to.  The tiny data
22312 area can hold up to 256 bytes in total (128 bytes for byte references).
22314 @item -msda=@var{n}
22315 @opindex msda
22316 Put static or global variables whose size is @var{n} bytes or less into
22317 the small data area that register @code{gp} points to.  The small data
22318 area can hold up to 64 kilobytes.
22320 @item -mzda=@var{n}
22321 @opindex mzda
22322 Put static or global variables whose size is @var{n} bytes or less into
22323 the first 32 kilobytes of memory.
22325 @item -mv850
22326 @opindex mv850
22327 Specify that the target processor is the V850.
22329 @item -mv850e3v5
22330 @opindex mv850e3v5
22331 Specify that the target processor is the V850E3V5.  The preprocessor
22332 constant @samp{__v850e3v5__} is defined if this option is used.
22334 @item -mv850e2v4
22335 @opindex mv850e2v4
22336 Specify that the target processor is the V850E3V5.  This is an alias for
22337 the @option{-mv850e3v5} option.
22339 @item -mv850e2v3
22340 @opindex mv850e2v3
22341 Specify that the target processor is the V850E2V3.  The preprocessor
22342 constant @samp{__v850e2v3__} is defined if this option is used.
22344 @item -mv850e2
22345 @opindex mv850e2
22346 Specify that the target processor is the V850E2.  The preprocessor
22347 constant @samp{__v850e2__} is defined if this option is used.
22349 @item -mv850e1
22350 @opindex mv850e1
22351 Specify that the target processor is the V850E1.  The preprocessor
22352 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
22353 this option is used.
22355 @item -mv850es
22356 @opindex mv850es
22357 Specify that the target processor is the V850ES.  This is an alias for
22358 the @option{-mv850e1} option.
22360 @item -mv850e
22361 @opindex mv850e
22362 Specify that the target processor is the V850E@.  The preprocessor
22363 constant @samp{__v850e__} is defined if this option is used.
22365 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
22366 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
22367 are defined then a default target processor is chosen and the
22368 relevant @samp{__v850*__} preprocessor constant is defined.
22370 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
22371 defined, regardless of which processor variant is the target.
22373 @item -mdisable-callt
22374 @itemx -mno-disable-callt
22375 @opindex mdisable-callt
22376 @opindex mno-disable-callt
22377 This option suppresses generation of the @code{CALLT} instruction for the
22378 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
22379 architecture.
22381 This option is enabled by default when the RH850 ABI is
22382 in use (see @option{-mrh850-abi}), and disabled by default when the
22383 GCC ABI is in use.  If @code{CALLT} instructions are being generated
22384 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
22386 @item -mrelax
22387 @itemx -mno-relax
22388 @opindex mrelax
22389 @opindex mno-relax
22390 Pass on (or do not pass on) the @option{-mrelax} command line option
22391 to the assembler.
22393 @item -mlong-jumps
22394 @itemx -mno-long-jumps
22395 @opindex mlong-jumps
22396 @opindex mno-long-jumps
22397 Disable (or re-enable) the generation of PC-relative jump instructions.
22399 @item -msoft-float
22400 @itemx -mhard-float
22401 @opindex msoft-float
22402 @opindex mhard-float
22403 Disable (or re-enable) the generation of hardware floating point
22404 instructions.  This option is only significant when the target
22405 architecture is @samp{V850E2V3} or higher.  If hardware floating point
22406 instructions are being generated then the C preprocessor symbol
22407 @code{__FPU_OK__} will be defined, otherwise the symbol
22408 @code{__NO_FPU__} will be defined.
22410 @item -mloop
22411 @opindex mloop
22412 Enables the use of the e3v5 LOOP instruction.  The use of this
22413 instruction is not enabled by default when the e3v5 architecture is
22414 selected because its use is still experimental.
22416 @item -mrh850-abi
22417 @itemx -mghs
22418 @opindex mrh850-abi
22419 @opindex mghs
22420 Enables support for the RH850 version of the V850 ABI.  This is the
22421 default.  With this version of the ABI the following rules apply:
22423 @itemize
22424 @item
22425 Integer sized structures and unions are returned via a memory pointer
22426 rather than a register.
22428 @item
22429 Large structures and unions (more than 8 bytes in size) are passed by
22430 value.
22432 @item
22433 Functions are aligned to 16-bit boundaries.
22435 @item
22436 The @option{-m8byte-align} command line option is supported.
22438 @item
22439 The @option{-mdisable-callt} command line option is enabled by
22440 default.  The @option{-mno-disable-callt} command line option is not
22441 supported.
22442 @end itemize
22444 When this version of the ABI is enabled the C preprocessor symbol
22445 @code{__V850_RH850_ABI__} is defined.
22447 @item -mgcc-abi
22448 @opindex mgcc-abi
22449 Enables support for the old GCC version of the V850 ABI.  With this
22450 version of the ABI the following rules apply:
22452 @itemize
22453 @item
22454 Integer sized structures and unions are returned in register @code{r10}.
22456 @item
22457 Large structures and unions (more than 8 bytes in size) are passed by
22458 reference.
22460 @item
22461 Functions are aligned to 32-bit boundaries, unless optimizing for
22462 size.
22464 @item
22465 The @option{-m8byte-align} command line option is not supported.
22467 @item
22468 The @option{-mdisable-callt} command line option is supported but not
22469 enabled by default.
22470 @end itemize
22472 When this version of the ABI is enabled the C preprocessor symbol
22473 @code{__V850_GCC_ABI__} is defined.
22475 @item -m8byte-align
22476 @itemx -mno-8byte-align
22477 @opindex m8byte-align
22478 @opindex mno-8byte-align
22479 Enables support for @code{doubles} and @code{long long} types to be
22480 aligned on 8-byte boundaries.  The default is to restrict the
22481 alignment of all objects to at most 4-bytes.  When
22482 @option{-m8byte-align} is in effect the C preprocessor symbol
22483 @code{__V850_8BYTE_ALIGN__} will be defined.
22485 @item -mbig-switch
22486 @opindex mbig-switch
22487 Generate code suitable for big switch tables.  Use this option only if
22488 the assembler/linker complain about out of range branches within a switch
22489 table.
22491 @item -mapp-regs
22492 @opindex mapp-regs
22493 This option causes r2 and r5 to be used in the code generated by
22494 the compiler.  This setting is the default.
22496 @item -mno-app-regs
22497 @opindex mno-app-regs
22498 This option causes r2 and r5 to be treated as fixed registers.
22500 @end table
22502 @node VAX Options
22503 @subsection VAX Options
22504 @cindex VAX options
22506 These @samp{-m} options are defined for the VAX:
22508 @table @gcctabopt
22509 @item -munix
22510 @opindex munix
22511 Do not output certain jump instructions (@code{aobleq} and so on)
22512 that the Unix assembler for the VAX cannot handle across long
22513 ranges.
22515 @item -mgnu
22516 @opindex mgnu
22517 Do output those jump instructions, on the assumption that the
22518 GNU assembler is being used.
22520 @item -mg
22521 @opindex mg
22522 Output code for G-format floating-point numbers instead of D-format.
22523 @end table
22525 @node VMS Options
22526 @subsection VMS Options
22528 These @samp{-m} options are defined for the VMS implementations:
22530 @table @gcctabopt
22531 @item -mvms-return-codes
22532 @opindex mvms-return-codes
22533 Return VMS condition codes from @code{main}. The default is to return POSIX-style
22534 condition (e.g.@ error) codes.
22536 @item -mdebug-main=@var{prefix}
22537 @opindex mdebug-main=@var{prefix}
22538 Flag the first routine whose name starts with @var{prefix} as the main
22539 routine for the debugger.
22541 @item -mmalloc64
22542 @opindex mmalloc64
22543 Default to 64-bit memory allocation routines.
22545 @item -mpointer-size=@var{size}
22546 @opindex -mpointer-size=@var{size}
22547 Set the default size of pointers. Possible options for @var{size} are
22548 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
22549 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
22550 The later option disables @code{pragma pointer_size}.
22551 @end table
22553 @node VxWorks Options
22554 @subsection VxWorks Options
22555 @cindex VxWorks Options
22557 The options in this section are defined for all VxWorks targets.
22558 Options specific to the target hardware are listed with the other
22559 options for that target.
22561 @table @gcctabopt
22562 @item -mrtp
22563 @opindex mrtp
22564 GCC can generate code for both VxWorks kernels and real time processes
22565 (RTPs).  This option switches from the former to the latter.  It also
22566 defines the preprocessor macro @code{__RTP__}.
22568 @item -non-static
22569 @opindex non-static
22570 Link an RTP executable against shared libraries rather than static
22571 libraries.  The options @option{-static} and @option{-shared} can
22572 also be used for RTPs (@pxref{Link Options}); @option{-static}
22573 is the default.
22575 @item -Bstatic
22576 @itemx -Bdynamic
22577 @opindex Bstatic
22578 @opindex Bdynamic
22579 These options are passed down to the linker.  They are defined for
22580 compatibility with Diab.
22582 @item -Xbind-lazy
22583 @opindex Xbind-lazy
22584 Enable lazy binding of function calls.  This option is equivalent to
22585 @option{-Wl,-z,now} and is defined for compatibility with Diab.
22587 @item -Xbind-now
22588 @opindex Xbind-now
22589 Disable lazy binding of function calls.  This option is the default and
22590 is defined for compatibility with Diab.
22591 @end table
22593 @node x86-64 Options
22594 @subsection x86-64 Options
22595 @cindex x86-64 options
22597 These are listed under @xref{i386 and x86-64 Options}.
22599 @node Xstormy16 Options
22600 @subsection Xstormy16 Options
22601 @cindex Xstormy16 Options
22603 These options are defined for Xstormy16:
22605 @table @gcctabopt
22606 @item -msim
22607 @opindex msim
22608 Choose startup files and linker script suitable for the simulator.
22609 @end table
22611 @node Xtensa Options
22612 @subsection Xtensa Options
22613 @cindex Xtensa Options
22615 These options are supported for Xtensa targets:
22617 @table @gcctabopt
22618 @item -mconst16
22619 @itemx -mno-const16
22620 @opindex mconst16
22621 @opindex mno-const16
22622 Enable or disable use of @code{CONST16} instructions for loading
22623 constant values.  The @code{CONST16} instruction is currently not a
22624 standard option from Tensilica.  When enabled, @code{CONST16}
22625 instructions are always used in place of the standard @code{L32R}
22626 instructions.  The use of @code{CONST16} is enabled by default only if
22627 the @code{L32R} instruction is not available.
22629 @item -mfused-madd
22630 @itemx -mno-fused-madd
22631 @opindex mfused-madd
22632 @opindex mno-fused-madd
22633 Enable or disable use of fused multiply/add and multiply/subtract
22634 instructions in the floating-point option.  This has no effect if the
22635 floating-point option is not also enabled.  Disabling fused multiply/add
22636 and multiply/subtract instructions forces the compiler to use separate
22637 instructions for the multiply and add/subtract operations.  This may be
22638 desirable in some cases where strict IEEE 754-compliant results are
22639 required: the fused multiply add/subtract instructions do not round the
22640 intermediate result, thereby producing results with @emph{more} bits of
22641 precision than specified by the IEEE standard.  Disabling fused multiply
22642 add/subtract instructions also ensures that the program output is not
22643 sensitive to the compiler's ability to combine multiply and add/subtract
22644 operations.
22646 @item -mserialize-volatile
22647 @itemx -mno-serialize-volatile
22648 @opindex mserialize-volatile
22649 @opindex mno-serialize-volatile
22650 When this option is enabled, GCC inserts @code{MEMW} instructions before
22651 @code{volatile} memory references to guarantee sequential consistency.
22652 The default is @option{-mserialize-volatile}.  Use
22653 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
22655 @item -mforce-no-pic
22656 @opindex mforce-no-pic
22657 For targets, like GNU/Linux, where all user-mode Xtensa code must be
22658 position-independent code (PIC), this option disables PIC for compiling
22659 kernel code.
22661 @item -mtext-section-literals
22662 @itemx -mno-text-section-literals
22663 @opindex mtext-section-literals
22664 @opindex mno-text-section-literals
22665 Control the treatment of literal pools.  The default is
22666 @option{-mno-text-section-literals}, which places literals in a separate
22667 section in the output file.  This allows the literal pool to be placed
22668 in a data RAM/ROM, and it also allows the linker to combine literal
22669 pools from separate object files to remove redundant literals and
22670 improve code size.  With @option{-mtext-section-literals}, the literals
22671 are interspersed in the text section in order to keep them as close as
22672 possible to their references.  This may be necessary for large assembly
22673 files.
22675 @item -mtarget-align
22676 @itemx -mno-target-align
22677 @opindex mtarget-align
22678 @opindex mno-target-align
22679 When this option is enabled, GCC instructs the assembler to
22680 automatically align instructions to reduce branch penalties at the
22681 expense of some code density.  The assembler attempts to widen density
22682 instructions to align branch targets and the instructions following call
22683 instructions.  If there are not enough preceding safe density
22684 instructions to align a target, no widening is performed.  The
22685 default is @option{-mtarget-align}.  These options do not affect the
22686 treatment of auto-aligned instructions like @code{LOOP}, which the
22687 assembler always aligns, either by widening density instructions or
22688 by inserting NOP instructions.
22690 @item -mlongcalls
22691 @itemx -mno-longcalls
22692 @opindex mlongcalls
22693 @opindex mno-longcalls
22694 When this option is enabled, GCC instructs the assembler to translate
22695 direct calls to indirect calls unless it can determine that the target
22696 of a direct call is in the range allowed by the call instruction.  This
22697 translation typically occurs for calls to functions in other source
22698 files.  Specifically, the assembler translates a direct @code{CALL}
22699 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
22700 The default is @option{-mno-longcalls}.  This option should be used in
22701 programs where the call target can potentially be out of range.  This
22702 option is implemented in the assembler, not the compiler, so the
22703 assembly code generated by GCC still shows direct call
22704 instructions---look at the disassembled object code to see the actual
22705 instructions.  Note that the assembler uses an indirect call for
22706 every cross-file call, not just those that really are out of range.
22707 @end table
22709 @node zSeries Options
22710 @subsection zSeries Options
22711 @cindex zSeries options
22713 These are listed under @xref{S/390 and zSeries Options}.
22715 @node Code Gen Options
22716 @section Options for Code Generation Conventions
22717 @cindex code generation conventions
22718 @cindex options, code generation
22719 @cindex run-time options
22721 These machine-independent options control the interface conventions
22722 used in code generation.
22724 Most of them have both positive and negative forms; the negative form
22725 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
22726 one of the forms is listed---the one that is not the default.  You
22727 can figure out the other form by either removing @samp{no-} or adding
22730 @table @gcctabopt
22731 @item -fbounds-check
22732 @opindex fbounds-check
22733 For front ends that support it, generate additional code to check that
22734 indices used to access arrays are within the declared range.  This is
22735 currently only supported by the Java and Fortran front ends, where
22736 this option defaults to true and false respectively.
22738 @item -fstack-reuse=@var{reuse-level}
22739 @opindex fstack_reuse
22740 This option controls stack space reuse for user declared local/auto variables
22741 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
22742 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
22743 local variables and temporaries, @samp{named_vars} enables the reuse only for
22744 user defined local variables with names, and @samp{none} disables stack reuse
22745 completely. The default value is @samp{all}. The option is needed when the
22746 program extends the lifetime of a scoped local variable or a compiler generated
22747 temporary beyond the end point defined by the language.  When a lifetime of
22748 a variable ends, and if the variable lives in memory, the optimizing compiler
22749 has the freedom to reuse its stack space with other temporaries or scoped
22750 local variables whose live range does not overlap with it. Legacy code extending
22751 local lifetime will likely to break with the stack reuse optimization.
22753 For example,
22755 @smallexample
22756    int *p;
22757    @{
22758      int local1;
22760      p = &local1;
22761      local1 = 10;
22762      ....
22763    @}
22764    @{
22765       int local2;
22766       local2 = 20;
22767       ...
22768    @}
22770    if (*p == 10)  // out of scope use of local1
22771      @{
22773      @}
22774 @end smallexample
22776 Another example:
22777 @smallexample
22779    struct A
22780    @{
22781        A(int k) : i(k), j(k) @{ @}
22782        int i;
22783        int j;
22784    @};
22786    A *ap;
22788    void foo(const A& ar)
22789    @{
22790       ap = &ar;
22791    @}
22793    void bar()
22794    @{
22795       foo(A(10)); // temp object's lifetime ends when foo returns
22797       @{
22798         A a(20);
22799         ....
22800       @}
22801       ap->i+= 10;  // ap references out of scope temp whose space
22802                    // is reused with a. What is the value of ap->i?
22803    @}
22805 @end smallexample
22807 The lifetime of a compiler generated temporary is well defined by the C++
22808 standard. When a lifetime of a temporary ends, and if the temporary lives
22809 in memory, the optimizing compiler has the freedom to reuse its stack
22810 space with other temporaries or scoped local variables whose live range
22811 does not overlap with it. However some of the legacy code relies on
22812 the behavior of older compilers in which temporaries' stack space is
22813 not reused, the aggressive stack reuse can lead to runtime errors. This
22814 option is used to control the temporary stack reuse optimization.
22816 @item -ftrapv
22817 @opindex ftrapv
22818 This option generates traps for signed overflow on addition, subtraction,
22819 multiplication operations.
22821 @item -fwrapv
22822 @opindex fwrapv
22823 This option instructs the compiler to assume that signed arithmetic
22824 overflow of addition, subtraction and multiplication wraps around
22825 using twos-complement representation.  This flag enables some optimizations
22826 and disables others.  This option is enabled by default for the Java
22827 front end, as required by the Java language specification.
22829 @item -fexceptions
22830 @opindex fexceptions
22831 Enable exception handling.  Generates extra code needed to propagate
22832 exceptions.  For some targets, this implies GCC generates frame
22833 unwind information for all functions, which can produce significant data
22834 size overhead, although it does not affect execution.  If you do not
22835 specify this option, GCC enables it by default for languages like
22836 C++ that normally require exception handling, and disables it for
22837 languages like C that do not normally require it.  However, you may need
22838 to enable this option when compiling C code that needs to interoperate
22839 properly with exception handlers written in C++.  You may also wish to
22840 disable this option if you are compiling older C++ programs that don't
22841 use exception handling.
22843 @item -fnon-call-exceptions
22844 @opindex fnon-call-exceptions
22845 Generate code that allows trapping instructions to throw exceptions.
22846 Note that this requires platform-specific runtime support that does
22847 not exist everywhere.  Moreover, it only allows @emph{trapping}
22848 instructions to throw exceptions, i.e.@: memory references or floating-point
22849 instructions.  It does not allow exceptions to be thrown from
22850 arbitrary signal handlers such as @code{SIGALRM}.
22852 @item -fdelete-dead-exceptions
22853 @opindex fdelete-dead-exceptions
22854 Consider that instructions that may throw exceptions but don't otherwise
22855 contribute to the execution of the program can be optimized away.
22856 This option is enabled by default for the Ada front end, as permitted by
22857 the Ada language specification.
22858 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22860 @item -funwind-tables
22861 @opindex funwind-tables
22862 Similar to @option{-fexceptions}, except that it just generates any needed
22863 static data, but does not affect the generated code in any other way.
22864 You normally do not need to enable this option; instead, a language processor
22865 that needs this handling enables it on your behalf.
22867 @item -fasynchronous-unwind-tables
22868 @opindex fasynchronous-unwind-tables
22869 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22870 table is exact at each instruction boundary, so it can be used for stack
22871 unwinding from asynchronous events (such as debugger or garbage collector).
22873 @item -fno-gnu-unique
22874 @opindex fno-gnu-unique
22875 On systems with recent GNU assembler and C library, the C++ compiler
22876 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22877 of template static data members and static local variables in inline
22878 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22879 is necessary to avoid problems with a library used by two different
22880 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22881 therefore disagreeing with the other one about the binding of the
22882 symbol.  But this causes @code{dlclose} to be ignored for affected
22883 DSOs; if your program relies on reinitialization of a DSO via
22884 @code{dlclose} and @code{dlopen}, you can use
22885 @option{-fno-gnu-unique}.
22887 @item -fpcc-struct-return
22888 @opindex fpcc-struct-return
22889 Return ``short'' @code{struct} and @code{union} values in memory like
22890 longer ones, rather than in registers.  This convention is less
22891 efficient, but it has the advantage of allowing intercallability between
22892 GCC-compiled files and files compiled with other compilers, particularly
22893 the Portable C Compiler (pcc).
22895 The precise convention for returning structures in memory depends
22896 on the target configuration macros.
22898 Short structures and unions are those whose size and alignment match
22899 that of some integer type.
22901 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22902 switch is not binary compatible with code compiled with the
22903 @option{-freg-struct-return} switch.
22904 Use it to conform to a non-default application binary interface.
22906 @item -freg-struct-return
22907 @opindex freg-struct-return
22908 Return @code{struct} and @code{union} values in registers when possible.
22909 This is more efficient for small structures than
22910 @option{-fpcc-struct-return}.
22912 If you specify neither @option{-fpcc-struct-return} nor
22913 @option{-freg-struct-return}, GCC defaults to whichever convention is
22914 standard for the target.  If there is no standard convention, GCC
22915 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22916 the principal compiler.  In those cases, we can choose the standard, and
22917 we chose the more efficient register return alternative.
22919 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22920 switch is not binary compatible with code compiled with the
22921 @option{-fpcc-struct-return} switch.
22922 Use it to conform to a non-default application binary interface.
22924 @item -fshort-enums
22925 @opindex fshort-enums
22926 Allocate to an @code{enum} type only as many bytes as it needs for the
22927 declared range of possible values.  Specifically, the @code{enum} type
22928 is equivalent to the smallest integer type that has enough room.
22930 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22931 code that is not binary compatible with code generated without that switch.
22932 Use it to conform to a non-default application binary interface.
22934 @item -fshort-double
22935 @opindex fshort-double
22936 Use the same size for @code{double} as for @code{float}.
22938 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22939 code that is not binary compatible with code generated without that switch.
22940 Use it to conform to a non-default application binary interface.
22942 @item -fshort-wchar
22943 @opindex fshort-wchar
22944 Override the underlying type for @samp{wchar_t} to be @samp{short
22945 unsigned int} instead of the default for the target.  This option is
22946 useful for building programs to run under WINE@.
22948 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22949 code that is not binary compatible with code generated without that switch.
22950 Use it to conform to a non-default application binary interface.
22952 @item -fno-common
22953 @opindex fno-common
22954 In C code, controls the placement of uninitialized global variables.
22955 Unix C compilers have traditionally permitted multiple definitions of
22956 such variables in different compilation units by placing the variables
22957 in a common block.
22958 This is the behavior specified by @option{-fcommon}, and is the default
22959 for GCC on most targets.
22960 On the other hand, this behavior is not required by ISO C, and on some
22961 targets may carry a speed or code size penalty on variable references.
22962 The @option{-fno-common} option specifies that the compiler should place
22963 uninitialized global variables in the data section of the object file,
22964 rather than generating them as common blocks.
22965 This has the effect that if the same variable is declared
22966 (without @code{extern}) in two different compilations,
22967 you get a multiple-definition error when you link them.
22968 In this case, you must compile with @option{-fcommon} instead.
22969 Compiling with @option{-fno-common} is useful on targets for which
22970 it provides better performance, or if you wish to verify that the
22971 program will work on other systems that always treat uninitialized
22972 variable declarations this way.
22974 @item -fno-ident
22975 @opindex fno-ident
22976 Ignore the @samp{#ident} directive.
22978 @item -finhibit-size-directive
22979 @opindex finhibit-size-directive
22980 Don't output a @code{.size} assembler directive, or anything else that
22981 would cause trouble if the function is split in the middle, and the
22982 two halves are placed at locations far apart in memory.  This option is
22983 used when compiling @file{crtstuff.c}; you should not need to use it
22984 for anything else.
22986 @item -fverbose-asm
22987 @opindex fverbose-asm
22988 Put extra commentary information in the generated assembly code to
22989 make it more readable.  This option is generally only of use to those
22990 who actually need to read the generated assembly code (perhaps while
22991 debugging the compiler itself).
22993 @option{-fno-verbose-asm}, the default, causes the
22994 extra information to be omitted and is useful when comparing two assembler
22995 files.
22997 @item -frecord-gcc-switches
22998 @opindex frecord-gcc-switches
22999 This switch causes the command line used to invoke the
23000 compiler to be recorded into the object file that is being created.
23001 This switch is only implemented on some targets and the exact format
23002 of the recording is target and binary file format dependent, but it
23003 usually takes the form of a section containing ASCII text.  This
23004 switch is related to the @option{-fverbose-asm} switch, but that
23005 switch only records information in the assembler output file as
23006 comments, so it never reaches the object file.
23007 See also @option{-grecord-gcc-switches} for another
23008 way of storing compiler options into the object file.
23010 @item -fpic
23011 @opindex fpic
23012 @cindex global offset table
23013 @cindex PIC
23014 Generate position-independent code (PIC) suitable for use in a shared
23015 library, if supported for the target machine.  Such code accesses all
23016 constant addresses through a global offset table (GOT)@.  The dynamic
23017 loader resolves the GOT entries when the program starts (the dynamic
23018 loader is not part of GCC; it is part of the operating system).  If
23019 the GOT size for the linked executable exceeds a machine-specific
23020 maximum size, you get an error message from the linker indicating that
23021 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
23022 instead.  (These maximums are 8k on the SPARC and 32k
23023 on the m68k and RS/6000.  The 386 has no such limit.)
23025 Position-independent code requires special support, and therefore works
23026 only on certain machines.  For the 386, GCC supports PIC for System V
23027 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
23028 position-independent.
23030 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23031 are defined to 1.
23033 @item -fPIC
23034 @opindex fPIC
23035 If supported for the target machine, emit position-independent code,
23036 suitable for dynamic linking and avoiding any limit on the size of the
23037 global offset table.  This option makes a difference on the m68k,
23038 PowerPC and SPARC@.
23040 Position-independent code requires special support, and therefore works
23041 only on certain machines.
23043 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
23044 are defined to 2.
23046 @item -fpie
23047 @itemx -fPIE
23048 @opindex fpie
23049 @opindex fPIE
23050 These options are similar to @option{-fpic} and @option{-fPIC}, but
23051 generated position independent code can be only linked into executables.
23052 Usually these options are used when @option{-pie} GCC option is
23053 used during linking.
23055 @option{-fpie} and @option{-fPIE} both define the macros
23056 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
23057 for @option{-fpie} and 2 for @option{-fPIE}.
23059 @item -fno-jump-tables
23060 @opindex fno-jump-tables
23061 Do not use jump tables for switch statements even where it would be
23062 more efficient than other code generation strategies.  This option is
23063 of use in conjunction with @option{-fpic} or @option{-fPIC} for
23064 building code that forms part of a dynamic linker and cannot
23065 reference the address of a jump table.  On some targets, jump tables
23066 do not require a GOT and this option is not needed.
23068 @item -ffixed-@var{reg}
23069 @opindex ffixed
23070 Treat the register named @var{reg} as a fixed register; generated code
23071 should never refer to it (except perhaps as a stack pointer, frame
23072 pointer or in some other fixed role).
23074 @var{reg} must be the name of a register.  The register names accepted
23075 are machine-specific and are defined in the @code{REGISTER_NAMES}
23076 macro in the machine description macro file.
23078 This flag does not have a negative form, because it specifies a
23079 three-way choice.
23081 @item -fcall-used-@var{reg}
23082 @opindex fcall-used
23083 Treat the register named @var{reg} as an allocable register that is
23084 clobbered by function calls.  It may be allocated for temporaries or
23085 variables that do not live across a call.  Functions compiled this way
23086 do not save and restore the register @var{reg}.
23088 It is an error to use this flag with the frame pointer or stack pointer.
23089 Use of this flag for other registers that have fixed pervasive roles in
23090 the machine's execution model produces disastrous results.
23092 This flag does not have a negative form, because it specifies a
23093 three-way choice.
23095 @item -fcall-saved-@var{reg}
23096 @opindex fcall-saved
23097 Treat the register named @var{reg} as an allocable register saved by
23098 functions.  It may be allocated even for temporaries or variables that
23099 live across a call.  Functions compiled this way save and restore
23100 the register @var{reg} if they use it.
23102 It is an error to use this flag with the frame pointer or stack pointer.
23103 Use of this flag for other registers that have fixed pervasive roles in
23104 the machine's execution model produces disastrous results.
23106 A different sort of disaster results from the use of this flag for
23107 a register in which function values may be returned.
23109 This flag does not have a negative form, because it specifies a
23110 three-way choice.
23112 @item -fpack-struct[=@var{n}]
23113 @opindex fpack-struct
23114 Without a value specified, pack all structure members together without
23115 holes.  When a value is specified (which must be a small power of two), pack
23116 structure members according to this value, representing the maximum
23117 alignment (that is, objects with default alignment requirements larger than
23118 this are output potentially unaligned at the next fitting location.
23120 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
23121 code that is not binary compatible with code generated without that switch.
23122 Additionally, it makes the code suboptimal.
23123 Use it to conform to a non-default application binary interface.
23125 @item -finstrument-functions
23126 @opindex finstrument-functions
23127 Generate instrumentation calls for entry and exit to functions.  Just
23128 after function entry and just before function exit, the following
23129 profiling functions are called with the address of the current
23130 function and its call site.  (On some platforms,
23131 @code{__builtin_return_address} does not work beyond the current
23132 function, so the call site information may not be available to the
23133 profiling functions otherwise.)
23135 @smallexample
23136 void __cyg_profile_func_enter (void *this_fn,
23137                                void *call_site);
23138 void __cyg_profile_func_exit  (void *this_fn,
23139                                void *call_site);
23140 @end smallexample
23142 The first argument is the address of the start of the current function,
23143 which may be looked up exactly in the symbol table.
23145 This instrumentation is also done for functions expanded inline in other
23146 functions.  The profiling calls indicate where, conceptually, the
23147 inline function is entered and exited.  This means that addressable
23148 versions of such functions must be available.  If all your uses of a
23149 function are expanded inline, this may mean an additional expansion of
23150 code size.  If you use @samp{extern inline} in your C code, an
23151 addressable version of such functions must be provided.  (This is
23152 normally the case anyway, but if you get lucky and the optimizer always
23153 expands the functions inline, you might have gotten away without
23154 providing static copies.)
23156 A function may be given the attribute @code{no_instrument_function}, in
23157 which case this instrumentation is not done.  This can be used, for
23158 example, for the profiling functions listed above, high-priority
23159 interrupt routines, and any functions from which the profiling functions
23160 cannot safely be called (perhaps signal handlers, if the profiling
23161 routines generate output or allocate memory).
23163 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
23164 @opindex finstrument-functions-exclude-file-list
23166 Set the list of functions that are excluded from instrumentation (see
23167 the description of @code{-finstrument-functions}).  If the file that
23168 contains a function definition matches with one of @var{file}, then
23169 that function is not instrumented.  The match is done on substrings:
23170 if the @var{file} parameter is a substring of the file name, it is
23171 considered to be a match.
23173 For example:
23175 @smallexample
23176 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
23177 @end smallexample
23179 @noindent
23180 excludes any inline function defined in files whose pathnames
23181 contain @code{/bits/stl} or @code{include/sys}.
23183 If, for some reason, you want to include letter @code{','} in one of
23184 @var{sym}, write @code{'\,'}. For example,
23185 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
23186 (note the single quote surrounding the option).
23188 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
23189 @opindex finstrument-functions-exclude-function-list
23191 This is similar to @code{-finstrument-functions-exclude-file-list},
23192 but this option sets the list of function names to be excluded from
23193 instrumentation.  The function name to be matched is its user-visible
23194 name, such as @code{vector<int> blah(const vector<int> &)}, not the
23195 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
23196 match is done on substrings: if the @var{sym} parameter is a substring
23197 of the function name, it is considered to be a match.  For C99 and C++
23198 extended identifiers, the function name must be given in UTF-8, not
23199 using universal character names.
23201 @item -fstack-check
23202 @opindex fstack-check
23203 Generate code to verify that you do not go beyond the boundary of the
23204 stack.  You should specify this flag if you are running in an
23205 environment with multiple threads, but you only rarely need to specify it in
23206 a single-threaded environment since stack overflow is automatically
23207 detected on nearly all systems if there is only one stack.
23209 Note that this switch does not actually cause checking to be done; the
23210 operating system or the language runtime must do that.  The switch causes
23211 generation of code to ensure that they see the stack being extended.
23213 You can additionally specify a string parameter: @code{no} means no
23214 checking, @code{generic} means force the use of old-style checking,
23215 @code{specific} means use the best checking method and is equivalent
23216 to bare @option{-fstack-check}.
23218 Old-style checking is a generic mechanism that requires no specific
23219 target support in the compiler but comes with the following drawbacks:
23221 @enumerate
23222 @item
23223 Modified allocation strategy for large objects: they are always
23224 allocated dynamically if their size exceeds a fixed threshold.
23226 @item
23227 Fixed limit on the size of the static frame of functions: when it is
23228 topped by a particular function, stack checking is not reliable and
23229 a warning is issued by the compiler.
23231 @item
23232 Inefficiency: because of both the modified allocation strategy and the
23233 generic implementation, code performance is hampered.
23234 @end enumerate
23236 Note that old-style stack checking is also the fallback method for
23237 @code{specific} if no target support has been added in the compiler.
23239 @item -fstack-limit-register=@var{reg}
23240 @itemx -fstack-limit-symbol=@var{sym}
23241 @itemx -fno-stack-limit
23242 @opindex fstack-limit-register
23243 @opindex fstack-limit-symbol
23244 @opindex fno-stack-limit
23245 Generate code to ensure that the stack does not grow beyond a certain value,
23246 either the value of a register or the address of a symbol.  If a larger
23247 stack is required, a signal is raised at run time.  For most targets,
23248 the signal is raised before the stack overruns the boundary, so
23249 it is possible to catch the signal without taking special precautions.
23251 For instance, if the stack starts at absolute address @samp{0x80000000}
23252 and grows downwards, you can use the flags
23253 @option{-fstack-limit-symbol=__stack_limit} and
23254 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
23255 of 128KB@.  Note that this may only work with the GNU linker.
23257 @item -fsplit-stack
23258 @opindex fsplit-stack
23259 Generate code to automatically split the stack before it overflows.
23260 The resulting program has a discontiguous stack which can only
23261 overflow if the program is unable to allocate any more memory.  This
23262 is most useful when running threaded programs, as it is no longer
23263 necessary to calculate a good stack size to use for each thread.  This
23264 is currently only implemented for the i386 and x86_64 back ends running
23265 GNU/Linux.
23267 When code compiled with @option{-fsplit-stack} calls code compiled
23268 without @option{-fsplit-stack}, there may not be much stack space
23269 available for the latter code to run.  If compiling all code,
23270 including library code, with @option{-fsplit-stack} is not an option,
23271 then the linker can fix up these calls so that the code compiled
23272 without @option{-fsplit-stack} always has a large stack.  Support for
23273 this is implemented in the gold linker in GNU binutils release 2.21
23274 and later.
23276 @item -fleading-underscore
23277 @opindex fleading-underscore
23278 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
23279 change the way C symbols are represented in the object file.  One use
23280 is to help link with legacy assembly code.
23282 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
23283 generate code that is not binary compatible with code generated without that
23284 switch.  Use it to conform to a non-default application binary interface.
23285 Not all targets provide complete support for this switch.
23287 @item -ftls-model=@var{model}
23288 @opindex ftls-model
23289 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
23290 The @var{model} argument should be one of @code{global-dynamic},
23291 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
23292 Note that the choice is subject to optimization: the compiler may use
23293 a more efficient model for symbols not visible outside of the translation
23294 unit, or if @option{-fpic} is not given on the command line.
23296 The default without @option{-fpic} is @code{initial-exec}; with
23297 @option{-fpic} the default is @code{global-dynamic}.
23299 @item -fvisibility=@var{default|internal|hidden|protected}
23300 @opindex fvisibility
23301 Set the default ELF image symbol visibility to the specified option---all
23302 symbols are marked with this unless overridden within the code.
23303 Using this feature can very substantially improve linking and
23304 load times of shared object libraries, produce more optimized
23305 code, provide near-perfect API export and prevent symbol clashes.
23306 It is @strong{strongly} recommended that you use this in any shared objects
23307 you distribute.
23309 Despite the nomenclature, @code{default} always means public; i.e.,
23310 available to be linked against from outside the shared object.
23311 @code{protected} and @code{internal} are pretty useless in real-world
23312 usage so the only other commonly used option is @code{hidden}.
23313 The default if @option{-fvisibility} isn't specified is
23314 @code{default}, i.e., make every
23315 symbol public---this causes the same behavior as previous versions of
23316 GCC@.
23318 A good explanation of the benefits offered by ensuring ELF
23319 symbols have the correct visibility is given by ``How To Write
23320 Shared Libraries'' by Ulrich Drepper (which can be found at
23321 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
23322 solution made possible by this option to marking things hidden when
23323 the default is public is to make the default hidden and mark things
23324 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
23325 and @code{__attribute__ ((visibility("default")))} instead of
23326 @code{__declspec(dllexport)} you get almost identical semantics with
23327 identical syntax.  This is a great boon to those working with
23328 cross-platform projects.
23330 For those adding visibility support to existing code, you may find
23331 @samp{#pragma GCC visibility} of use.  This works by you enclosing
23332 the declarations you wish to set visibility for with (for example)
23333 @samp{#pragma GCC visibility push(hidden)} and
23334 @samp{#pragma GCC visibility pop}.
23335 Bear in mind that symbol visibility should be viewed @strong{as
23336 part of the API interface contract} and thus all new code should
23337 always specify visibility when it is not the default; i.e., declarations
23338 only for use within the local DSO should @strong{always} be marked explicitly
23339 as hidden as so to avoid PLT indirection overheads---making this
23340 abundantly clear also aids readability and self-documentation of the code.
23341 Note that due to ISO C++ specification requirements, @code{operator new} and
23342 @code{operator delete} must always be of default visibility.
23344 Be aware that headers from outside your project, in particular system
23345 headers and headers from any other library you use, may not be
23346 expecting to be compiled with visibility other than the default.  You
23347 may need to explicitly say @samp{#pragma GCC visibility push(default)}
23348 before including any such headers.
23350 @samp{extern} declarations are not affected by @option{-fvisibility}, so
23351 a lot of code can be recompiled with @option{-fvisibility=hidden} with
23352 no modifications.  However, this means that calls to @code{extern}
23353 functions with no explicit visibility use the PLT, so it is more
23354 effective to use @code{__attribute ((visibility))} and/or
23355 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
23356 declarations should be treated as hidden.
23358 Note that @option{-fvisibility} does affect C++ vague linkage
23359 entities. This means that, for instance, an exception class that is
23360 be thrown between DSOs must be explicitly marked with default
23361 visibility so that the @samp{type_info} nodes are unified between
23362 the DSOs.
23364 An overview of these techniques, their benefits and how to use them
23365 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
23367 @item -fstrict-volatile-bitfields
23368 @opindex fstrict-volatile-bitfields
23369 This option should be used if accesses to volatile bit-fields (or other
23370 structure fields, although the compiler usually honors those types
23371 anyway) should use a single access of the width of the
23372 field's type, aligned to a natural alignment if possible.  For
23373 example, targets with memory-mapped peripheral registers might require
23374 all such accesses to be 16 bits wide; with this flag you can
23375 declare all peripheral bit-fields as @code{unsigned short} (assuming short
23376 is 16 bits on these targets) to force GCC to use 16-bit accesses
23377 instead of, perhaps, a more efficient 32-bit access.
23379 If this option is disabled, the compiler uses the most efficient
23380 instruction.  In the previous example, that might be a 32-bit load
23381 instruction, even though that accesses bytes that do not contain
23382 any portion of the bit-field, or memory-mapped registers unrelated to
23383 the one being updated.
23385 In some cases, such as when the @code{packed} attribute is applied to a 
23386 structure field, it may not be possible to access the field with a single
23387 read or write that is correctly aligned for the target machine.  In this
23388 case GCC falls back to generating multiple accesses rather than code that 
23389 will fault or truncate the result at run time.
23391 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
23392 not allowed to touch non bit-field members.  It is therefore recommended
23393 to define all bits of the field's type as bit-field members.
23395 The default value of this option is determined by the application binary
23396 interface for the target processor.
23398 @item -fsync-libcalls
23399 @opindex fsync-libcalls
23400 This option controls whether any out-of-line instance of the @code{__sync}
23401 family of functions may be used to implement the C++11 @code{__atomic}
23402 family of functions.
23404 The default value of this option is enabled, thus the only useful form
23405 of the option is @option{-fno-sync-libcalls}.  This option is used in
23406 the implementation of the @file{libatomic} runtime library.
23408 @end table
23410 @c man end
23412 @node Environment Variables
23413 @section Environment Variables Affecting GCC
23414 @cindex environment variables
23416 @c man begin ENVIRONMENT
23417 This section describes several environment variables that affect how GCC
23418 operates.  Some of them work by specifying directories or prefixes to use
23419 when searching for various kinds of files.  Some are used to specify other
23420 aspects of the compilation environment.
23422 Note that you can also specify places to search using options such as
23423 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
23424 take precedence over places specified using environment variables, which
23425 in turn take precedence over those specified by the configuration of GCC@.
23426 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
23427 GNU Compiler Collection (GCC) Internals}.
23429 @table @env
23430 @item LANG
23431 @itemx LC_CTYPE
23432 @c @itemx LC_COLLATE
23433 @itemx LC_MESSAGES
23434 @c @itemx LC_MONETARY
23435 @c @itemx LC_NUMERIC
23436 @c @itemx LC_TIME
23437 @itemx LC_ALL
23438 @findex LANG
23439 @findex LC_CTYPE
23440 @c @findex LC_COLLATE
23441 @findex LC_MESSAGES
23442 @c @findex LC_MONETARY
23443 @c @findex LC_NUMERIC
23444 @c @findex LC_TIME
23445 @findex LC_ALL
23446 @cindex locale
23447 These environment variables control the way that GCC uses
23448 localization information which allows GCC to work with different
23449 national conventions.  GCC inspects the locale categories
23450 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
23451 so.  These locale categories can be set to any value supported by your
23452 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
23453 Kingdom encoded in UTF-8.
23455 The @env{LC_CTYPE} environment variable specifies character
23456 classification.  GCC uses it to determine the character boundaries in
23457 a string; this is needed for some multibyte encodings that contain quote
23458 and escape characters that are otherwise interpreted as a string
23459 end or escape.
23461 The @env{LC_MESSAGES} environment variable specifies the language to
23462 use in diagnostic messages.
23464 If the @env{LC_ALL} environment variable is set, it overrides the value
23465 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
23466 and @env{LC_MESSAGES} default to the value of the @env{LANG}
23467 environment variable.  If none of these variables are set, GCC
23468 defaults to traditional C English behavior.
23470 @item TMPDIR
23471 @findex TMPDIR
23472 If @env{TMPDIR} is set, it specifies the directory to use for temporary
23473 files.  GCC uses temporary files to hold the output of one stage of
23474 compilation which is to be used as input to the next stage: for example,
23475 the output of the preprocessor, which is the input to the compiler
23476 proper.
23478 @item GCC_COMPARE_DEBUG
23479 @findex GCC_COMPARE_DEBUG
23480 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
23481 @option{-fcompare-debug} to the compiler driver.  See the documentation
23482 of this option for more details.
23484 @item GCC_EXEC_PREFIX
23485 @findex GCC_EXEC_PREFIX
23486 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
23487 names of the subprograms executed by the compiler.  No slash is added
23488 when this prefix is combined with the name of a subprogram, but you can
23489 specify a prefix that ends with a slash if you wish.
23491 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
23492 an appropriate prefix to use based on the pathname it is invoked with.
23494 If GCC cannot find the subprogram using the specified prefix, it
23495 tries looking in the usual places for the subprogram.
23497 The default value of @env{GCC_EXEC_PREFIX} is
23498 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
23499 the installed compiler. In many cases @var{prefix} is the value
23500 of @code{prefix} when you ran the @file{configure} script.
23502 Other prefixes specified with @option{-B} take precedence over this prefix.
23504 This prefix is also used for finding files such as @file{crt0.o} that are
23505 used for linking.
23507 In addition, the prefix is used in an unusual way in finding the
23508 directories to search for header files.  For each of the standard
23509 directories whose name normally begins with @samp{/usr/local/lib/gcc}
23510 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
23511 replacing that beginning with the specified prefix to produce an
23512 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
23513 @file{foo/bar} just before it searches the standard directory 
23514 @file{/usr/local/lib/bar}.
23515 If a standard directory begins with the configured
23516 @var{prefix} then the value of @var{prefix} is replaced by
23517 @env{GCC_EXEC_PREFIX} when looking for header files.
23519 @item COMPILER_PATH
23520 @findex COMPILER_PATH
23521 The value of @env{COMPILER_PATH} is a colon-separated list of
23522 directories, much like @env{PATH}.  GCC tries the directories thus
23523 specified when searching for subprograms, if it can't find the
23524 subprograms using @env{GCC_EXEC_PREFIX}.
23526 @item LIBRARY_PATH
23527 @findex LIBRARY_PATH
23528 The value of @env{LIBRARY_PATH} is a colon-separated list of
23529 directories, much like @env{PATH}.  When configured as a native compiler,
23530 GCC tries the directories thus specified when searching for special
23531 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
23532 using GCC also uses these directories when searching for ordinary
23533 libraries for the @option{-l} option (but directories specified with
23534 @option{-L} come first).
23536 @item LANG
23537 @findex LANG
23538 @cindex locale definition
23539 This variable is used to pass locale information to the compiler.  One way in
23540 which this information is used is to determine the character set to be used
23541 when character literals, string literals and comments are parsed in C and C++.
23542 When the compiler is configured to allow multibyte characters,
23543 the following values for @env{LANG} are recognized:
23545 @table @samp
23546 @item C-JIS
23547 Recognize JIS characters.
23548 @item C-SJIS
23549 Recognize SJIS characters.
23550 @item C-EUCJP
23551 Recognize EUCJP characters.
23552 @end table
23554 If @env{LANG} is not defined, or if it has some other value, then the
23555 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
23556 recognize and translate multibyte characters.
23557 @end table
23559 @noindent
23560 Some additional environment variables affect the behavior of the
23561 preprocessor.
23563 @include cppenv.texi
23565 @c man end
23567 @node Precompiled Headers
23568 @section Using Precompiled Headers
23569 @cindex precompiled headers
23570 @cindex speed of compilation
23572 Often large projects have many header files that are included in every
23573 source file.  The time the compiler takes to process these header files
23574 over and over again can account for nearly all of the time required to
23575 build the project.  To make builds faster, GCC allows you to
23576 @dfn{precompile} a header file.
23578 To create a precompiled header file, simply compile it as you would any
23579 other file, if necessary using the @option{-x} option to make the driver
23580 treat it as a C or C++ header file.  You may want to use a
23581 tool like @command{make} to keep the precompiled header up-to-date when
23582 the headers it contains change.
23584 A precompiled header file is searched for when @code{#include} is
23585 seen in the compilation.  As it searches for the included file
23586 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
23587 compiler looks for a precompiled header in each directory just before it
23588 looks for the include file in that directory.  The name searched for is
23589 the name specified in the @code{#include} with @samp{.gch} appended.  If
23590 the precompiled header file can't be used, it is ignored.
23592 For instance, if you have @code{#include "all.h"}, and you have
23593 @file{all.h.gch} in the same directory as @file{all.h}, then the
23594 precompiled header file is used if possible, and the original
23595 header is used otherwise.
23597 Alternatively, you might decide to put the precompiled header file in a
23598 directory and use @option{-I} to ensure that directory is searched
23599 before (or instead of) the directory containing the original header.
23600 Then, if you want to check that the precompiled header file is always
23601 used, you can put a file of the same name as the original header in this
23602 directory containing an @code{#error} command.
23604 This also works with @option{-include}.  So yet another way to use
23605 precompiled headers, good for projects not designed with precompiled
23606 header files in mind, is to simply take most of the header files used by
23607 a project, include them from another header file, precompile that header
23608 file, and @option{-include} the precompiled header.  If the header files
23609 have guards against multiple inclusion, they are skipped because
23610 they've already been included (in the precompiled header).
23612 If you need to precompile the same header file for different
23613 languages, targets, or compiler options, you can instead make a
23614 @emph{directory} named like @file{all.h.gch}, and put each precompiled
23615 header in the directory, perhaps using @option{-o}.  It doesn't matter
23616 what you call the files in the directory; every precompiled header in
23617 the directory is considered.  The first precompiled header
23618 encountered in the directory that is valid for this compilation is
23619 used; they're searched in no particular order.
23621 There are many other possibilities, limited only by your imagination,
23622 good sense, and the constraints of your build system.
23624 A precompiled header file can be used only when these conditions apply:
23626 @itemize
23627 @item
23628 Only one precompiled header can be used in a particular compilation.
23630 @item
23631 A precompiled header can't be used once the first C token is seen.  You
23632 can have preprocessor directives before a precompiled header; you cannot
23633 include a precompiled header from inside another header.
23635 @item
23636 The precompiled header file must be produced for the same language as
23637 the current compilation.  You can't use a C precompiled header for a C++
23638 compilation.
23640 @item
23641 The precompiled header file must have been produced by the same compiler
23642 binary as the current compilation is using.
23644 @item
23645 Any macros defined before the precompiled header is included must
23646 either be defined in the same way as when the precompiled header was
23647 generated, or must not affect the precompiled header, which usually
23648 means that they don't appear in the precompiled header at all.
23650 The @option{-D} option is one way to define a macro before a
23651 precompiled header is included; using a @code{#define} can also do it.
23652 There are also some options that define macros implicitly, like
23653 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
23654 defined this way.
23656 @item If debugging information is output when using the precompiled
23657 header, using @option{-g} or similar, the same kind of debugging information
23658 must have been output when building the precompiled header.  However,
23659 a precompiled header built using @option{-g} can be used in a compilation
23660 when no debugging information is being output.
23662 @item The same @option{-m} options must generally be used when building
23663 and using the precompiled header.  @xref{Submodel Options},
23664 for any cases where this rule is relaxed.
23666 @item Each of the following options must be the same when building and using
23667 the precompiled header:
23669 @gccoptlist{-fexceptions}
23671 @item
23672 Some other command-line options starting with @option{-f},
23673 @option{-p}, or @option{-O} must be defined in the same way as when
23674 the precompiled header was generated.  At present, it's not clear
23675 which options are safe to change and which are not; the safest choice
23676 is to use exactly the same options when generating and using the
23677 precompiled header.  The following are known to be safe:
23679 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
23680 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
23681 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
23682 -pedantic-errors}
23684 @end itemize
23686 For all of these except the last, the compiler automatically
23687 ignores the precompiled header if the conditions aren't met.  If you
23688 find an option combination that doesn't work and doesn't cause the
23689 precompiled header to be ignored, please consider filing a bug report,
23690 see @ref{Bugs}.
23692 If you do use differing options when generating and using the
23693 precompiled header, the actual behavior is a mixture of the
23694 behavior for the options.  For instance, if you use @option{-g} to
23695 generate the precompiled header but not when using it, you may or may
23696 not get debugging information for routines in the precompiled header.