configure.ac: Tweak GAS check for LEON instructions on SPARC.
[official-gcc.git] / gcc / doc / invoke.texi
blobda7a00ed00ce9f1e259f2a221bf916489d7bcb39
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  -fstats  -ftemplate-backtrace-limit=@var{n} @gol
191 -ftemplate-depth=@var{n} @gol
192 -fno-threadsafe-statics -fuse-cxa-atexit  -fno-weak  -nostdinc++ @gol
193 -fvisibility-inlines-hidden @gol
194 -fvtable-verify=@var{std|preinit|none} @gol
195 -fvtv-counts -fvtv-debug @gol
196 -fvisibility-ms-compat @gol
197 -fext-numeric-literals @gol
198 -Wabi  -Wconversion-null  -Wctor-dtor-privacy @gol
199 -Wdelete-non-virtual-dtor -Wliteral-suffix -Wnarrowing @gol
200 -Wnoexcept -Wnon-virtual-dtor  -Wreorder @gol
201 -Weffc++  -Wstrict-null-sentinel @gol
202 -Wno-non-template-friend  -Wold-style-cast @gol
203 -Woverloaded-virtual  -Wno-pmf-conversions @gol
204 -Wsign-promo}
206 @item Objective-C and Objective-C++ Language Options
207 @xref{Objective-C and Objective-C++ Dialect Options,,Options Controlling
208 Objective-C and Objective-C++ Dialects}.
209 @gccoptlist{-fconstant-string-class=@var{class-name} @gol
210 -fgnu-runtime  -fnext-runtime @gol
211 -fno-nil-receivers @gol
212 -fobjc-abi-version=@var{n} @gol
213 -fobjc-call-cxx-cdtors @gol
214 -fobjc-direct-dispatch @gol
215 -fobjc-exceptions @gol
216 -fobjc-gc @gol
217 -fobjc-nilcheck @gol
218 -fobjc-std=objc1 @gol
219 -freplace-objc-classes @gol
220 -fzero-link @gol
221 -gen-decls @gol
222 -Wassign-intercept @gol
223 -Wno-protocol  -Wselector @gol
224 -Wstrict-selector-match @gol
225 -Wundeclared-selector}
227 @item Language Independent Options
228 @xref{Language Independent Options,,Options to Control Diagnostic Messages Formatting}.
229 @gccoptlist{-fmessage-length=@var{n}  @gol
230 -fdiagnostics-show-location=@r{[}once@r{|}every-line@r{]}  @gol
231 -fdiagnostics-color=@r{[}auto@r{|}never@r{|}always@r{]}  @gol
232 -fno-diagnostics-show-option -fno-diagnostics-show-caret}
234 @item Warning Options
235 @xref{Warning Options,,Options to Request or Suppress Warnings}.
236 @gccoptlist{-fsyntax-only  -fmax-errors=@var{n}  -Wpedantic @gol
237 -pedantic-errors @gol
238 -w  -Wextra  -Wall  -Waddress  -Waggregate-return  @gol
239 -Waggressive-loop-optimizations -Warray-bounds @gol
240 -Wno-attributes -Wno-builtin-macro-redefined @gol
241 -Wc++-compat -Wc++11-compat -Wcast-align  -Wcast-qual  @gol
242 -Wchar-subscripts -Wclobbered  -Wcomment -Wconditionally-supported  @gol
243 -Wconversion -Wcoverage-mismatch -Wdate-time -Wdelete-incomplete -Wno-cpp  @gol
244 -Wno-deprecated -Wno-deprecated-declarations -Wdisabled-optimization  @gol
245 -Wno-div-by-zero -Wdouble-promotion -Wempty-body  -Wenum-compare @gol
246 -Wno-endif-labels -Werror  -Werror=* @gol
247 -Wfatal-errors  -Wfloat-equal  -Wformat  -Wformat=2 @gol
248 -Wno-format-contains-nul -Wno-format-extra-args -Wformat-nonliteral @gol
249 -Wformat-security  -Wformat-signedness  -Wformat-y2k @gol
250 -Wframe-larger-than=@var{len} -Wno-free-nonheap-object -Wjump-misses-init @gol
251 -Wignored-qualifiers @gol
252 -Wimplicit  -Wimplicit-function-declaration  -Wimplicit-int @gol
253 -Winit-self  -Winline -Wmaybe-uninitialized @gol
254 -Wno-int-to-pointer-cast -Wno-invalid-offsetof @gol
255 -Winvalid-pch -Wlarger-than=@var{len}  -Wunsafe-loop-optimizations @gol
256 -Wlogical-op -Wlong-long @gol
257 -Wmain -Wmaybe-uninitialized -Wmissing-braces  -Wmissing-field-initializers @gol
258 -Wmissing-include-dirs @gol
259 -Wno-multichar  -Wnonnull  -Wno-overflow -Wopenmp-simd @gol
260 -Woverlength-strings  -Wpacked  -Wpacked-bitfield-compat  -Wpadded @gol
261 -Wparentheses  -Wpedantic-ms-format -Wno-pedantic-ms-format @gol
262 -Wpointer-arith  -Wno-pointer-to-int-cast @gol
263 -Wredundant-decls  -Wno-return-local-addr @gol
264 -Wreturn-type  -Wsequence-point  -Wshadow @gol
265 -Wsign-compare  -Wsign-conversion -Wfloat-conversion @gol
266 -Wsizeof-pointer-memaccess @gol
267 -Wstack-protector -Wstack-usage=@var{len} -Wstrict-aliasing @gol
268 -Wstrict-aliasing=n @gol -Wstrict-overflow -Wstrict-overflow=@var{n} @gol
269 -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]} @gol
270 -Wmissing-format-attribute @gol
271 -Wswitch  -Wswitch-default  -Wswitch-enum -Wsync-nand @gol
272 -Wsystem-headers  -Wtrampolines  -Wtrigraphs  -Wtype-limits  -Wundef @gol
273 -Wuninitialized  -Wunknown-pragmas  -Wno-pragmas @gol
274 -Wunsuffixed-float-constants  -Wunused  -Wunused-function @gol
275 -Wunused-label  -Wunused-local-typedefs -Wunused-parameter @gol
276 -Wno-unused-result -Wunused-value @gol -Wunused-variable @gol
277 -Wunused-but-set-parameter -Wunused-but-set-variable @gol
278 -Wuseless-cast -Wvariadic-macros -Wvector-operation-performance @gol
279 -Wvla -Wvolatile-register-var  -Wwrite-strings -Wzero-as-null-pointer-constant}
281 @item C and Objective-C-only Warning Options
282 @gccoptlist{-Wbad-function-cast  -Wmissing-declarations @gol
283 -Wmissing-parameter-type  -Wmissing-prototypes  -Wnested-externs @gol
284 -Wold-style-declaration  -Wold-style-definition @gol
285 -Wstrict-prototypes  -Wtraditional  -Wtraditional-conversion @gol
286 -Wdeclaration-after-statement -Wpointer-sign}
288 @item Debugging Options
289 @xref{Debugging Options,,Options for Debugging Your Program or GCC}.
290 @gccoptlist{-d@var{letters}  -dumpspecs  -dumpmachine  -dumpversion @gol
291 -fsanitize=@var{style} -fsanitize-recover @gol
292 -fsanitize-undefined-trap-on-error @gol
293 -fdbg-cnt-list -fdbg-cnt=@var{counter-value-list} @gol
294 -fdisable-ipa-@var{pass_name} @gol
295 -fdisable-rtl-@var{pass_name} @gol
296 -fdisable-rtl-@var{pass-name}=@var{range-list} @gol
297 -fdisable-tree-@var{pass_name} @gol
298 -fdisable-tree-@var{pass-name}=@var{range-list} @gol
299 -fdump-noaddr -fdump-unnumbered -fdump-unnumbered-links @gol
300 -fdump-translation-unit@r{[}-@var{n}@r{]} @gol
301 -fdump-class-hierarchy@r{[}-@var{n}@r{]} @gol
302 -fdump-ipa-all -fdump-ipa-cgraph -fdump-ipa-inline @gol
303 -fdump-passes @gol
304 -fdump-statistics @gol
305 -fdump-tree-all @gol
306 -fdump-tree-original@r{[}-@var{n}@r{]}  @gol
307 -fdump-tree-optimized@r{[}-@var{n}@r{]} @gol
308 -fdump-tree-cfg -fdump-tree-alias @gol
309 -fdump-tree-ch @gol
310 -fdump-tree-ssa@r{[}-@var{n}@r{]} -fdump-tree-pre@r{[}-@var{n}@r{]} @gol
311 -fdump-tree-ccp@r{[}-@var{n}@r{]} -fdump-tree-dce@r{[}-@var{n}@r{]} @gol
312 -fdump-tree-gimple@r{[}-raw@r{]} @gol
313 -fdump-tree-dom@r{[}-@var{n}@r{]} @gol
314 -fdump-tree-dse@r{[}-@var{n}@r{]} @gol
315 -fdump-tree-phiprop@r{[}-@var{n}@r{]} @gol
316 -fdump-tree-phiopt@r{[}-@var{n}@r{]} @gol
317 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
318 -fdump-tree-copyrename@r{[}-@var{n}@r{]} @gol
319 -fdump-tree-nrv -fdump-tree-vect @gol
320 -fdump-tree-sink @gol
321 -fdump-tree-sra@r{[}-@var{n}@r{]} @gol
322 -fdump-tree-forwprop@r{[}-@var{n}@r{]} @gol
323 -fdump-tree-fre@r{[}-@var{n}@r{]} @gol
324 -fdump-tree-vtable-verify @gol
325 -fdump-tree-vrp@r{[}-@var{n}@r{]} @gol
326 -fdump-tree-storeccp@r{[}-@var{n}@r{]} @gol
327 -fdump-final-insns=@var{file} @gol
328 -fcompare-debug@r{[}=@var{opts}@r{]}  -fcompare-debug-second @gol
329 -feliminate-dwarf2-dups -fno-eliminate-unused-debug-types @gol
330 -feliminate-unused-debug-symbols -femit-class-debug-always @gol
331 -fenable-@var{kind}-@var{pass} @gol
332 -fenable-@var{kind}-@var{pass}=@var{range-list} @gol
333 -fdebug-types-section -fmem-report-wpa @gol
334 -fmem-report -fpre-ipa-mem-report -fpost-ipa-mem-report -fprofile-arcs @gol
335 -fopt-info @gol
336 -fopt-info-@var{options}@r{[}=@var{file}@r{]} @gol
337 -frandom-seed=@var{string} -fsched-verbose=@var{n} @gol
338 -fsel-sched-verbose -fsel-sched-dump-cfg -fsel-sched-pipelining-verbose @gol
339 -fstack-usage  -ftest-coverage  -ftime-report -fvar-tracking @gol
340 -fvar-tracking-assignments  -fvar-tracking-assignments-toggle @gol
341 -g  -g@var{level}  -gtoggle  -gcoff  -gdwarf-@var{version} @gol
342 -ggdb  -grecord-gcc-switches  -gno-record-gcc-switches @gol
343 -gstabs  -gstabs+  -gstrict-dwarf  -gno-strict-dwarf @gol
344 -gvms  -gxcoff  -gxcoff+ @gol
345 -fno-merge-debug-strings -fno-dwarf2-cfi-asm @gol
346 -fdebug-prefix-map=@var{old}=@var{new} @gol
347 -femit-struct-debug-baseonly -femit-struct-debug-reduced @gol
348 -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]} @gol
349 -p  -pg  -print-file-name=@var{library}  -print-libgcc-file-name @gol
350 -print-multi-directory  -print-multi-lib  -print-multi-os-directory @gol
351 -print-prog-name=@var{program}  -print-search-dirs  -Q @gol
352 -print-sysroot -print-sysroot-headers-suffix @gol
353 -save-temps -save-temps=cwd -save-temps=obj -time@r{[}=@var{file}@r{]}}
355 @item Optimization Options
356 @xref{Optimize Options,,Options that Control Optimization}.
357 @gccoptlist{-faggressive-loop-optimizations -falign-functions[=@var{n}] @gol
358 -falign-jumps[=@var{n}] @gol
359 -falign-labels[=@var{n}] -falign-loops[=@var{n}] @gol
360 -fassociative-math -fauto-inc-dec -fbranch-probabilities @gol
361 -fbranch-target-load-optimize -fbranch-target-load-optimize2 @gol
362 -fbtr-bb-exclusive -fcaller-saves @gol
363 -fcheck-data-deps -fcombine-stack-adjustments -fconserve-stack @gol
364 -fcompare-elim -fcprop-registers -fcrossjumping @gol
365 -fcse-follow-jumps -fcse-skip-blocks -fcx-fortran-rules @gol
366 -fcx-limited-range @gol
367 -fdata-sections -fdce -fdelayed-branch @gol
368 -fdelete-null-pointer-checks -fdevirtualize -fdevirtualize-speculatively -fdse @gol
369 -fearly-inlining -fipa-sra -fexpensive-optimizations -ffat-lto-objects @gol
370 -ffast-math -ffinite-math-only -ffloat-store -fexcess-precision=@var{style} @gol
371 -fforward-propagate -ffp-contract=@var{style} -ffunction-sections @gol
372 -fgcse -fgcse-after-reload -fgcse-las -fgcse-lm -fgraphite-identity @gol
373 -fgcse-sm -fhoist-adjacent-loads -fif-conversion @gol
374 -fif-conversion2 -findirect-inlining @gol
375 -finline-functions -finline-functions-called-once -finline-limit=@var{n} @gol
376 -finline-small-functions -fipa-cp -fipa-cp-clone @gol
377 -fipa-pta -fipa-profile -fipa-pure-const -fipa-reference @gol
378 -fira-algorithm=@var{algorithm} @gol
379 -fira-region=@var{region} -fira-hoist-pressure @gol
380 -fira-loop-pressure -fno-ira-share-save-slots @gol
381 -fno-ira-share-spill-slots -fira-verbose=@var{n} @gol
382 -fisolate-erroneous-paths-dereference -fisolate-erroneous-paths-attribute
383 -fivopts -fkeep-inline-functions -fkeep-static-consts -flive-range-shrinkage @gol
384 -floop-block -floop-interchange -floop-strip-mine -floop-nest-optimize @gol
385 -floop-parallelize-all -flto -flto-compression-level @gol
386 -flto-partition=@var{alg} -flto-report -flto-report-wpa -fmerge-all-constants @gol
387 -fmerge-constants -fmodulo-sched -fmodulo-sched-allow-regmoves @gol
388 -fmove-loop-invariants -fno-branch-count-reg @gol
389 -fno-defer-pop -fno-function-cse -fno-guess-branch-probability @gol
390 -fno-inline -fno-math-errno -fno-peephole -fno-peephole2 @gol
391 -fno-sched-interblock -fno-sched-spec -fno-signed-zeros @gol
392 -fno-toplevel-reorder -fno-trapping-math -fno-zero-initialized-in-bss @gol
393 -fomit-frame-pointer -foptimize-sibling-calls @gol
394 -fpartial-inlining -fpeel-loops -fpredictive-commoning @gol
395 -fprefetch-loop-arrays -fprofile-report @gol
396 -fprofile-correction -fprofile-dir=@var{path} -fprofile-generate @gol
397 -fprofile-generate=@var{path} @gol
398 -fprofile-use -fprofile-use=@var{path} -fprofile-values -fprofile-reorder-functions @gol
399 -freciprocal-math -free -frename-registers -freorder-blocks @gol
400 -freorder-blocks-and-partition -freorder-functions @gol
401 -frerun-cse-after-loop -freschedule-modulo-scheduled-loops @gol
402 -frounding-math -fsched2-use-superblocks -fsched-pressure @gol
403 -fsched-spec-load -fsched-spec-load-dangerous @gol
404 -fsched-stalled-insns-dep[=@var{n}] -fsched-stalled-insns[=@var{n}] @gol
405 -fsched-group-heuristic -fsched-critical-path-heuristic @gol
406 -fsched-spec-insn-heuristic -fsched-rank-heuristic @gol
407 -fsched-last-insn-heuristic -fsched-dep-count-heuristic @gol
408 -fschedule-insns -fschedule-insns2 -fsection-anchors @gol
409 -fselective-scheduling -fselective-scheduling2 @gol
410 -fsel-sched-pipelining -fsel-sched-pipelining-outer-loops @gol
411 -fshrink-wrap -fsignaling-nans -fsingle-precision-constant @gol
412 -fsplit-ivs-in-unroller -fsplit-wide-types -fstack-protector @gol
413 -fstack-protector-all -fstack-protector-strong -fstrict-aliasing @gol
414 -fstrict-overflow -fthread-jumps -ftracer -ftree-bit-ccp @gol
415 -ftree-builtin-call-dce -ftree-ccp -ftree-ch @gol
416 -ftree-coalesce-inline-vars -ftree-coalesce-vars -ftree-copy-prop @gol
417 -ftree-copyrename -ftree-dce -ftree-dominator-opts -ftree-dse @gol
418 -ftree-forwprop -ftree-fre -ftree-loop-if-convert @gol
419 -ftree-loop-if-convert-stores -ftree-loop-im @gol
420 -ftree-phiprop -ftree-loop-distribution -ftree-loop-distribute-patterns @gol
421 -ftree-loop-ivcanon -ftree-loop-linear -ftree-loop-optimize @gol
422 -ftree-loop-vectorize @gol
423 -ftree-parallelize-loops=@var{n} -ftree-pre -ftree-partial-pre -ftree-pta @gol
424 -ftree-reassoc -ftree-sink -ftree-slsr -ftree-sra @gol
425 -ftree-switch-conversion -ftree-tail-merge -ftree-ter @gol
426 -ftree-vectorize -ftree-vrp @gol
427 -funit-at-a-time -funroll-all-loops -funroll-loops @gol
428 -funsafe-loop-optimizations -funsafe-math-optimizations -funswitch-loops @gol
429 -fvariable-expansion-in-unroller -fvect-cost-model -fvpt -fweb @gol
430 -fwhole-program -fwpa -fuse-ld=@var{linker} -fuse-linker-plugin @gol
431 --param @var{name}=@var{value}
432 -O  -O0  -O1  -O2  -O3  -Os -Ofast -Og}
434 @item Preprocessor Options
435 @xref{Preprocessor Options,,Options Controlling the Preprocessor}.
436 @gccoptlist{-A@var{question}=@var{answer} @gol
437 -A-@var{question}@r{[}=@var{answer}@r{]} @gol
438 -C  -dD  -dI  -dM  -dN @gol
439 -D@var{macro}@r{[}=@var{defn}@r{]}  -E  -H @gol
440 -idirafter @var{dir} @gol
441 -include @var{file}  -imacros @var{file} @gol
442 -iprefix @var{file}  -iwithprefix @var{dir} @gol
443 -iwithprefixbefore @var{dir}  -isystem @var{dir} @gol
444 -imultilib @var{dir} -isysroot @var{dir} @gol
445 -M  -MM  -MF  -MG  -MP  -MQ  -MT  -nostdinc  @gol
446 -P  -fdebug-cpp -ftrack-macro-expansion -fworking-directory @gol
447 -remap -trigraphs  -undef  -U@var{macro}  @gol
448 -Wp,@var{option} -Xpreprocessor @var{option} -no-integrated-cpp}
450 @item Assembler Option
451 @xref{Assembler Options,,Passing Options to the Assembler}.
452 @gccoptlist{-Wa,@var{option}  -Xassembler @var{option}}
454 @item Linker Options
455 @xref{Link Options,,Options for Linking}.
456 @gccoptlist{@var{object-file-name}  -l@var{library} @gol
457 -nostartfiles  -nodefaultlibs  -nostdlib -pie -rdynamic @gol
458 -s  -static -static-libgcc -static-libstdc++ @gol
459 -static-libasan -static-libtsan -static-liblsan -static-libubsan @gol
460 -shared -shared-libgcc  -symbolic @gol
461 -T @var{script}  -Wl,@var{option}  -Xlinker @var{option} @gol
462 -u @var{symbol}}
464 @item Directory Options
465 @xref{Directory Options,,Options for Directory Search}.
466 @gccoptlist{-B@var{prefix} -I@var{dir} -iplugindir=@var{dir} @gol
467 -iquote@var{dir} -L@var{dir} -specs=@var{file} -I- @gol
468 --sysroot=@var{dir} --no-sysroot-suffix}
470 @item Machine Dependent Options
471 @xref{Submodel Options,,Hardware Models and Configurations}.
472 @c This list is ordered alphanumerically by subsection name.
473 @c Try and put the significant identifier (CPU or system) first,
474 @c so users have a clue at guessing where the ones they want will be.
476 @emph{AArch64 Options}
477 @gccoptlist{-mabi=@var{name}  -mbig-endian  -mlittle-endian @gol
478 -mgeneral-regs-only @gol
479 -mcmodel=tiny  -mcmodel=small  -mcmodel=large @gol
480 -mstrict-align @gol
481 -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
482 -mtls-dialect=desc  -mtls-dialect=traditional @gol
483 -march=@var{name}  -mcpu=@var{name}  -mtune=@var{name}}
485 @emph{Adapteva Epiphany Options}
486 @gccoptlist{-mhalf-reg-file -mprefer-short-insn-regs @gol
487 -mbranch-cost=@var{num} -mcmove -mnops=@var{num} -msoft-cmpsf @gol
488 -msplit-lohi -mpost-inc -mpost-modify -mstack-offset=@var{num} @gol
489 -mround-nearest -mlong-calls -mshort-calls -msmall16 @gol
490 -mfp-mode=@var{mode} -mvect-double -max-vect-align=@var{num} @gol
491 -msplit-vecmove-early -m1reg-@var{reg}}
493 @emph{ARC Options}
494 @gccoptlist{-mbarrel-shifter @gol
495 -mcpu=@var{cpu} -mA6 -mARC600 -mA7 -mARC700 @gol
496 -mdpfp -mdpfp-compact -mdpfp-fast -mno-dpfp-lrsr @gol
497 -mea -mno-mpy -mmul32x16 -mmul64 @gol
498 -mnorm -mspfp -mspfp-compact -mspfp-fast -msimd -msoft-float -mswap @gol
499 -mcrc -mdsp-packa -mdvbf -mlock -mmac-d16 -mmac-24 -mrtsc -mswape @gol
500 -mtelephony -mxy -misize -mannotate-align -marclinux -marclinux_prof @gol
501 -mepilogue-cfi -mlong-calls -mmedium-calls -msdata @gol
502 -mucb-mcount -mvolatile-cache @gol
503 -malign-call -mauto-modify-reg -mbbit-peephole -mno-brcc @gol
504 -mcase-vector-pcrel -mcompact-casesi -mno-cond-exec -mearly-cbranchsi @gol
505 -mexpand-adddi -mindexed-loads -mlra -mlra-priority-none @gol
506 -mlra-priority-compact mlra-priority-noncompact -mno-millicode @gol
507 -mmixed-code -mq-class -mRcq -mRcw -msize-level=@var{level} @gol
508 -mtune=@var{cpu} -mmultcost=@var{num} -munalign-prob-threshold=@var{probability}}
510 @emph{ARM Options}
511 @gccoptlist{-mapcs-frame  -mno-apcs-frame @gol
512 -mabi=@var{name} @gol
513 -mapcs-stack-check  -mno-apcs-stack-check @gol
514 -mapcs-float  -mno-apcs-float @gol
515 -mapcs-reentrant  -mno-apcs-reentrant @gol
516 -msched-prolog  -mno-sched-prolog @gol
517 -mlittle-endian  -mbig-endian  -mwords-little-endian @gol
518 -mfloat-abi=@var{name} @gol
519 -mfp16-format=@var{name}
520 -mthumb-interwork  -mno-thumb-interwork @gol
521 -mcpu=@var{name}  -march=@var{name}  -mfpu=@var{name}  @gol
522 -mstructure-size-boundary=@var{n} @gol
523 -mabort-on-noreturn @gol
524 -mlong-calls  -mno-long-calls @gol
525 -msingle-pic-base  -mno-single-pic-base @gol
526 -mpic-register=@var{reg} @gol
527 -mnop-fun-dllimport @gol
528 -mpoke-function-name @gol
529 -mthumb  -marm @gol
530 -mtpcs-frame  -mtpcs-leaf-frame @gol
531 -mcaller-super-interworking  -mcallee-super-interworking @gol
532 -mtp=@var{name} -mtls-dialect=@var{dialect} @gol
533 -mword-relocations @gol
534 -mfix-cortex-m3-ldrd @gol
535 -munaligned-access @gol
536 -mneon-for-64bits @gol
537 -mslow-flash-data @gol
538 -mrestrict-it}
540 @emph{AVR Options}
541 @gccoptlist{-mmcu=@var{mcu} -maccumulate-args -mbranch-cost=@var{cost} @gol
542 -mcall-prologues -mint8 -mno-interrupts -mrelax @gol
543 -mstrict-X -mtiny-stack -Waddr-space-convert}
545 @emph{Blackfin Options}
546 @gccoptlist{-mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]} @gol
547 -msim -momit-leaf-frame-pointer  -mno-omit-leaf-frame-pointer @gol
548 -mspecld-anomaly  -mno-specld-anomaly  -mcsync-anomaly  -mno-csync-anomaly @gol
549 -mlow-64k -mno-low64k  -mstack-check-l1  -mid-shared-library @gol
550 -mno-id-shared-library  -mshared-library-id=@var{n} @gol
551 -mleaf-id-shared-library  -mno-leaf-id-shared-library @gol
552 -msep-data  -mno-sep-data  -mlong-calls  -mno-long-calls @gol
553 -mfast-fp -minline-plt -mmulticore  -mcorea  -mcoreb  -msdram @gol
554 -micplb}
556 @emph{C6X Options}
557 @gccoptlist{-mbig-endian  -mlittle-endian -march=@var{cpu} @gol
558 -msim -msdata=@var{sdata-type}}
560 @emph{CRIS Options}
561 @gccoptlist{-mcpu=@var{cpu}  -march=@var{cpu}  -mtune=@var{cpu} @gol
562 -mmax-stack-frame=@var{n}  -melinux-stacksize=@var{n} @gol
563 -metrax4  -metrax100  -mpdebug  -mcc-init  -mno-side-effects @gol
564 -mstack-align  -mdata-align  -mconst-align @gol
565 -m32-bit  -m16-bit  -m8-bit  -mno-prologue-epilogue  -mno-gotplt @gol
566 -melf  -maout  -melinux  -mlinux  -sim  -sim2 @gol
567 -mmul-bug-workaround  -mno-mul-bug-workaround}
569 @emph{CR16 Options}
570 @gccoptlist{-mmac @gol
571 -mcr16cplus -mcr16c @gol
572 -msim -mint32 -mbit-ops
573 -mdata-model=@var{model}}
575 @emph{Darwin Options}
576 @gccoptlist{-all_load  -allowable_client  -arch  -arch_errors_fatal @gol
577 -arch_only  -bind_at_load  -bundle  -bundle_loader @gol
578 -client_name  -compatibility_version  -current_version @gol
579 -dead_strip @gol
580 -dependency-file  -dylib_file  -dylinker_install_name @gol
581 -dynamic  -dynamiclib  -exported_symbols_list @gol
582 -filelist  -flat_namespace  -force_cpusubtype_ALL @gol
583 -force_flat_namespace  -headerpad_max_install_names @gol
584 -iframework @gol
585 -image_base  -init  -install_name  -keep_private_externs @gol
586 -multi_module  -multiply_defined  -multiply_defined_unused @gol
587 -noall_load   -no_dead_strip_inits_and_terms @gol
588 -nofixprebinding -nomultidefs  -noprebind  -noseglinkedit @gol
589 -pagezero_size  -prebind  -prebind_all_twolevel_modules @gol
590 -private_bundle  -read_only_relocs  -sectalign @gol
591 -sectobjectsymbols  -whyload  -seg1addr @gol
592 -sectcreate  -sectobjectsymbols  -sectorder @gol
593 -segaddr -segs_read_only_addr -segs_read_write_addr @gol
594 -seg_addr_table  -seg_addr_table_filename  -seglinkedit @gol
595 -segprot  -segs_read_only_addr  -segs_read_write_addr @gol
596 -single_module  -static  -sub_library  -sub_umbrella @gol
597 -twolevel_namespace  -umbrella  -undefined @gol
598 -unexported_symbols_list  -weak_reference_mismatches @gol
599 -whatsloaded -F -gused -gfull -mmacosx-version-min=@var{version} @gol
600 -mkernel -mone-byte-bool}
602 @emph{DEC Alpha Options}
603 @gccoptlist{-mno-fp-regs  -msoft-float @gol
604 -mieee  -mieee-with-inexact  -mieee-conformant @gol
605 -mfp-trap-mode=@var{mode}  -mfp-rounding-mode=@var{mode} @gol
606 -mtrap-precision=@var{mode}  -mbuild-constants @gol
607 -mcpu=@var{cpu-type}  -mtune=@var{cpu-type} @gol
608 -mbwx  -mmax  -mfix  -mcix @gol
609 -mfloat-vax  -mfloat-ieee @gol
610 -mexplicit-relocs  -msmall-data  -mlarge-data @gol
611 -msmall-text  -mlarge-text @gol
612 -mmemory-latency=@var{time}}
614 @emph{FR30 Options}
615 @gccoptlist{-msmall-model -mno-lsim}
617 @emph{FRV Options}
618 @gccoptlist{-mgpr-32  -mgpr-64  -mfpr-32  -mfpr-64 @gol
619 -mhard-float  -msoft-float @gol
620 -malloc-cc  -mfixed-cc  -mdword  -mno-dword @gol
621 -mdouble  -mno-double @gol
622 -mmedia  -mno-media  -mmuladd  -mno-muladd @gol
623 -mfdpic  -minline-plt -mgprel-ro  -multilib-library-pic @gol
624 -mlinked-fp  -mlong-calls  -malign-labels @gol
625 -mlibrary-pic  -macc-4  -macc-8 @gol
626 -mpack  -mno-pack  -mno-eflags  -mcond-move  -mno-cond-move @gol
627 -moptimize-membar -mno-optimize-membar @gol
628 -mscc  -mno-scc  -mcond-exec  -mno-cond-exec @gol
629 -mvliw-branch  -mno-vliw-branch @gol
630 -mmulti-cond-exec  -mno-multi-cond-exec  -mnested-cond-exec @gol
631 -mno-nested-cond-exec  -mtomcat-stats @gol
632 -mTLS -mtls @gol
633 -mcpu=@var{cpu}}
635 @emph{GNU/Linux Options}
636 @gccoptlist{-mglibc -muclibc -mbionic -mandroid @gol
637 -tno-android-cc -tno-android-ld}
639 @emph{H8/300 Options}
640 @gccoptlist{-mrelax  -mh  -ms  -mn  -mexr -mno-exr  -mint32  -malign-300}
642 @emph{HPPA Options}
643 @gccoptlist{-march=@var{architecture-type} @gol
644 -mdisable-fpregs  -mdisable-indexing @gol
645 -mfast-indirect-calls  -mgas  -mgnu-ld   -mhp-ld @gol
646 -mfixed-range=@var{register-range} @gol
647 -mjump-in-delay -mlinker-opt -mlong-calls @gol
648 -mlong-load-store  -mno-disable-fpregs @gol
649 -mno-disable-indexing  -mno-fast-indirect-calls  -mno-gas @gol
650 -mno-jump-in-delay  -mno-long-load-store @gol
651 -mno-portable-runtime  -mno-soft-float @gol
652 -mno-space-regs  -msoft-float  -mpa-risc-1-0 @gol
653 -mpa-risc-1-1  -mpa-risc-2-0  -mportable-runtime @gol
654 -mschedule=@var{cpu-type}  -mspace-regs  -msio  -mwsio @gol
655 -munix=@var{unix-std}  -nolibdld  -static  -threads}
657 @emph{i386 and x86-64 Options}
658 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
659 -mtune-ctrl=@var{feature-list} -mdump-tune-features -mno-default @gol
660 -mfpmath=@var{unit} @gol
661 -masm=@var{dialect}  -mno-fancy-math-387 @gol
662 -mno-fp-ret-in-387  -msoft-float @gol
663 -mno-wide-multiply  -mrtd  -malign-double @gol
664 -mpreferred-stack-boundary=@var{num} @gol
665 -mincoming-stack-boundary=@var{num} @gol
666 -mcld -mcx16 -msahf -mmovbe -mcrc32 @gol
667 -mrecip -mrecip=@var{opt} @gol
668 -mvzeroupper -mprefer-avx128 @gol
669 -mmmx  -msse  -msse2 -msse3 -mssse3 -msse4.1 -msse4.2 -msse4 -mavx @gol
670 -mavx2 -mavx512f -mavx512pf -mavx512er -mavx512cd -msha @gol
671 -maes -mpclmul -mfsgsbase -mrdrnd -mf16c -mfma -mprefetchwt1 @gol
672 -msse4a -m3dnow -mpopcnt -mabm -mbmi -mtbm -mfma4 -mxop -mlzcnt @gol
673 -mbmi2 -mfxsr -mxsave -mxsaveopt -mrtm -mlwp -mthreads @gol
674 -mno-align-stringops  -minline-all-stringops @gol
675 -minline-stringops-dynamically -mstringop-strategy=@var{alg} @gol
676 -mmemcpy-strategy=@var{strategy} -mmemset-strategy=@var{strategy}
677 -mpush-args  -maccumulate-outgoing-args  -m128bit-long-double @gol
678 -m96bit-long-double -mlong-double-64 -mlong-double-80 -mlong-double-128 @gol
679 -mregparm=@var{num}  -msseregparm @gol
680 -mveclibabi=@var{type} -mvect8-ret-in-mem @gol
681 -mpc32 -mpc64 -mpc80 -mstackrealign @gol
682 -momit-leaf-frame-pointer  -mno-red-zone -mno-tls-direct-seg-refs @gol
683 -mcmodel=@var{code-model} -mabi=@var{name} -maddress-mode=@var{mode} @gol
684 -m32 -m64 -mx32 -m16 -mlarge-data-threshold=@var{num} @gol
685 -msse2avx -mfentry -m8bit-idiv @gol
686 -mavx256-split-unaligned-load -mavx256-split-unaligned-store @gol
687 -mstack-protector-guard=@var{guard}}
689 @emph{i386 and x86-64 Windows Options}
690 @gccoptlist{-mconsole -mcygwin -mno-cygwin -mdll @gol
691 -mnop-fun-dllimport -mthread @gol
692 -municode -mwin32 -mwindows -fno-set-stack-executable}
694 @emph{IA-64 Options}
695 @gccoptlist{-mbig-endian  -mlittle-endian  -mgnu-as  -mgnu-ld  -mno-pic @gol
696 -mvolatile-asm-stop  -mregister-names  -msdata -mno-sdata @gol
697 -mconstant-gp  -mauto-pic  -mfused-madd @gol
698 -minline-float-divide-min-latency @gol
699 -minline-float-divide-max-throughput @gol
700 -mno-inline-float-divide @gol
701 -minline-int-divide-min-latency @gol
702 -minline-int-divide-max-throughput  @gol
703 -mno-inline-int-divide @gol
704 -minline-sqrt-min-latency -minline-sqrt-max-throughput @gol
705 -mno-inline-sqrt @gol
706 -mdwarf2-asm -mearly-stop-bits @gol
707 -mfixed-range=@var{register-range} -mtls-size=@var{tls-size} @gol
708 -mtune=@var{cpu-type} -milp32 -mlp64 @gol
709 -msched-br-data-spec -msched-ar-data-spec -msched-control-spec @gol
710 -msched-br-in-data-spec -msched-ar-in-data-spec -msched-in-control-spec @gol
711 -msched-spec-ldc -msched-spec-control-ldc @gol
712 -msched-prefer-non-data-spec-insns -msched-prefer-non-control-spec-insns @gol
713 -msched-stop-bits-after-every-cycle -msched-count-spec-in-critical-path @gol
714 -msel-sched-dont-check-control-spec -msched-fp-mem-deps-zero-cost @gol
715 -msched-max-memory-insns-hard-limit -msched-max-memory-insns=@var{max-insns}}
717 @emph{LM32 Options}
718 @gccoptlist{-mbarrel-shift-enabled -mdivide-enabled -mmultiply-enabled @gol
719 -msign-extend-enabled -muser-enabled}
721 @emph{M32R/D Options}
722 @gccoptlist{-m32r2 -m32rx -m32r @gol
723 -mdebug @gol
724 -malign-loops -mno-align-loops @gol
725 -missue-rate=@var{number} @gol
726 -mbranch-cost=@var{number} @gol
727 -mmodel=@var{code-size-model-type} @gol
728 -msdata=@var{sdata-type} @gol
729 -mno-flush-func -mflush-func=@var{name} @gol
730 -mno-flush-trap -mflush-trap=@var{number} @gol
731 -G @var{num}}
733 @emph{M32C Options}
734 @gccoptlist{-mcpu=@var{cpu} -msim -memregs=@var{number}}
736 @emph{M680x0 Options}
737 @gccoptlist{-march=@var{arch}  -mcpu=@var{cpu}  -mtune=@var{tune}
738 -m68000  -m68020  -m68020-40  -m68020-60  -m68030  -m68040 @gol
739 -m68060  -mcpu32  -m5200  -m5206e  -m528x  -m5307  -m5407 @gol
740 -mcfv4e  -mbitfield  -mno-bitfield  -mc68000  -mc68020 @gol
741 -mnobitfield  -mrtd  -mno-rtd  -mdiv  -mno-div  -mshort @gol
742 -mno-short  -mhard-float  -m68881  -msoft-float  -mpcrel @gol
743 -malign-int  -mstrict-align  -msep-data  -mno-sep-data @gol
744 -mshared-library-id=n  -mid-shared-library  -mno-id-shared-library @gol
745 -mxgot -mno-xgot}
747 @emph{MCore Options}
748 @gccoptlist{-mhardlit  -mno-hardlit  -mdiv  -mno-div  -mrelax-immediates @gol
749 -mno-relax-immediates  -mwide-bitfields  -mno-wide-bitfields @gol
750 -m4byte-functions  -mno-4byte-functions  -mcallgraph-data @gol
751 -mno-callgraph-data  -mslow-bytes  -mno-slow-bytes  -mno-lsim @gol
752 -mlittle-endian  -mbig-endian  -m210  -m340  -mstack-increment}
754 @emph{MeP Options}
755 @gccoptlist{-mabsdiff -mall-opts -maverage -mbased=@var{n} -mbitops @gol
756 -mc=@var{n} -mclip -mconfig=@var{name} -mcop -mcop32 -mcop64 -mivc2 @gol
757 -mdc -mdiv -meb -mel -mio-volatile -ml -mleadz -mm -mminmax @gol
758 -mmult -mno-opts -mrepeat -ms -msatur -msdram -msim -msimnovec -mtf @gol
759 -mtiny=@var{n}}
761 @emph{MicroBlaze Options}
762 @gccoptlist{-msoft-float -mhard-float -msmall-divides -mcpu=@var{cpu} @gol
763 -mmemcpy -mxl-soft-mul -mxl-soft-div -mxl-barrel-shift @gol
764 -mxl-pattern-compare -mxl-stack-check -mxl-gp-opt -mno-clearbss @gol
765 -mxl-multiply-high -mxl-float-convert -mxl-float-sqrt @gol
766 -mbig-endian -mlittle-endian -mxl-reorder -mxl-mode-@var{app-model}}
768 @emph{MIPS Options}
769 @gccoptlist{-EL  -EB  -march=@var{arch}  -mtune=@var{arch} @gol
770 -mips1  -mips2  -mips3  -mips4  -mips32  -mips32r2 @gol
771 -mips64  -mips64r2 @gol
772 -mips16  -mno-mips16  -mflip-mips16 @gol
773 -minterlink-compressed -mno-interlink-compressed @gol
774 -minterlink-mips16  -mno-interlink-mips16 @gol
775 -mabi=@var{abi}  -mabicalls  -mno-abicalls @gol
776 -mshared  -mno-shared  -mplt  -mno-plt  -mxgot  -mno-xgot @gol
777 -mgp32  -mgp64  -mfp32  -mfp64  -mhard-float  -msoft-float @gol
778 -mno-float  -msingle-float  -mdouble-float @gol
779 -mabs=@var{mode}  -mnan=@var{encoding} @gol
780 -mdsp  -mno-dsp  -mdspr2  -mno-dspr2 @gol
781 -mmcu -mmno-mcu @gol
782 -meva -mno-eva @gol
783 -mvirt -mno-virt @gol
784 -mmicromips -mno-micromips @gol
785 -mfpu=@var{fpu-type} @gol
786 -msmartmips  -mno-smartmips @gol
787 -mpaired-single  -mno-paired-single  -mdmx  -mno-mdmx @gol
788 -mips3d  -mno-mips3d  -mmt  -mno-mt  -mllsc  -mno-llsc @gol
789 -mlong64  -mlong32  -msym32  -mno-sym32 @gol
790 -G@var{num}  -mlocal-sdata  -mno-local-sdata @gol
791 -mextern-sdata  -mno-extern-sdata  -mgpopt  -mno-gopt @gol
792 -membedded-data  -mno-embedded-data @gol
793 -muninit-const-in-rodata  -mno-uninit-const-in-rodata @gol
794 -mcode-readable=@var{setting} @gol
795 -msplit-addresses  -mno-split-addresses @gol
796 -mexplicit-relocs  -mno-explicit-relocs @gol
797 -mcheck-zero-division  -mno-check-zero-division @gol
798 -mdivide-traps  -mdivide-breaks @gol
799 -mmemcpy  -mno-memcpy  -mlong-calls  -mno-long-calls @gol
800 -mmad -mno-mad -mimadd -mno-imadd -mfused-madd  -mno-fused-madd  -nocpp @gol
801 -mfix-24k -mno-fix-24k @gol
802 -mfix-r4000  -mno-fix-r4000  -mfix-r4400  -mno-fix-r4400 @gol
803 -mfix-r10000 -mno-fix-r10000  -mfix-rm7000 -mno-fix-rm7000 @gol
804 -mfix-vr4120  -mno-fix-vr4120 @gol
805 -mfix-vr4130  -mno-fix-vr4130  -mfix-sb1  -mno-fix-sb1 @gol
806 -mflush-func=@var{func}  -mno-flush-func @gol
807 -mbranch-cost=@var{num}  -mbranch-likely  -mno-branch-likely @gol
808 -mfp-exceptions -mno-fp-exceptions @gol
809 -mvr4130-align -mno-vr4130-align -msynci -mno-synci @gol
810 -mrelax-pic-calls -mno-relax-pic-calls -mmcount-ra-address}
812 @emph{MMIX Options}
813 @gccoptlist{-mlibfuncs  -mno-libfuncs  -mepsilon  -mno-epsilon  -mabi=gnu @gol
814 -mabi=mmixware  -mzero-extend  -mknuthdiv  -mtoplevel-symbols @gol
815 -melf  -mbranch-predict  -mno-branch-predict  -mbase-addresses @gol
816 -mno-base-addresses  -msingle-exit  -mno-single-exit}
818 @emph{MN10300 Options}
819 @gccoptlist{-mmult-bug  -mno-mult-bug @gol
820 -mno-am33 -mam33 -mam33-2 -mam34 @gol
821 -mtune=@var{cpu-type} @gol
822 -mreturn-pointer-on-d0 @gol
823 -mno-crt0  -mrelax -mliw -msetlb}
825 @emph{Moxie Options}
826 @gccoptlist{-meb -mel -mno-crt0}
828 @emph{MSP430 Options}
829 @gccoptlist{-msim -masm-hex -mmcu= -mcpu= -mlarge -msmall -mrelax @gol
830 -mhwmult=}
832 @emph{NDS32 Options}
833 @gccoptlist{-mbig-endian -mlittle-endian @gol
834 -mreduced-regs -mfull-regs @gol
835 -mcmov -mno-cmov @gol
836 -mperf-ext -mno-perf-ext @gol
837 -mv3push -mno-v3push @gol
838 -m16bit -mno-16bit @gol
839 -mgp-direct -mno-gp-direct @gol
840 -misr-vector-size=@var{num} @gol
841 -mcache-block-size=@var{num} @gol
842 -march=@var{arch} @gol
843 -mforce-fp-as-gp -mforbid-fp-as-gp @gol
844 -mex9 -mctor-dtor -mrelax}
846 @emph{Nios II Options}
847 @gccoptlist{-G @var{num} -mgpopt -mno-gpopt -mel -meb @gol
848 -mno-bypass-cache -mbypass-cache @gol
849 -mno-cache-volatile -mcache-volatile @gol
850 -mno-fast-sw-div -mfast-sw-div @gol
851 -mhw-mul -mno-hw-mul -mhw-mulx -mno-hw-mulx -mno-hw-div -mhw-div @gol
852 -mcustom-@var{insn}=@var{N} -mno-custom-@var{insn} @gol
853 -mcustom-fpu-cfg=@var{name} @gol
854 -mhal -msmallc -msys-crt0=@var{name} -msys-lib=@var{name}}
856 @emph{PDP-11 Options}
857 @gccoptlist{-mfpu  -msoft-float  -mac0  -mno-ac0  -m40  -m45  -m10 @gol
858 -mbcopy  -mbcopy-builtin  -mint32  -mno-int16 @gol
859 -mint16  -mno-int32  -mfloat32  -mno-float64 @gol
860 -mfloat64  -mno-float32  -mabshi  -mno-abshi @gol
861 -mbranch-expensive  -mbranch-cheap @gol
862 -munix-asm  -mdec-asm}
864 @emph{picoChip Options}
865 @gccoptlist{-mae=@var{ae_type} -mvliw-lookahead=@var{N} @gol
866 -msymbol-as-address -mno-inefficient-warnings}
868 @emph{PowerPC Options}
869 See RS/6000 and PowerPC Options.
871 @emph{RL78 Options}
872 @gccoptlist{-msim -mmul=none -mmul=g13 -mmul=rl78}
874 @emph{RS/6000 and PowerPC Options}
875 @gccoptlist{-mcpu=@var{cpu-type} @gol
876 -mtune=@var{cpu-type} @gol
877 -mcmodel=@var{code-model} @gol
878 -mpowerpc64 @gol
879 -maltivec  -mno-altivec @gol
880 -mpowerpc-gpopt  -mno-powerpc-gpopt @gol
881 -mpowerpc-gfxopt  -mno-powerpc-gfxopt @gol
882 -mmfcrf  -mno-mfcrf  -mpopcntb  -mno-popcntb -mpopcntd -mno-popcntd @gol
883 -mfprnd  -mno-fprnd @gol
884 -mcmpb -mno-cmpb -mmfpgpr -mno-mfpgpr -mhard-dfp -mno-hard-dfp @gol
885 -mfull-toc   -mminimal-toc  -mno-fp-in-toc  -mno-sum-in-toc @gol
886 -m64  -m32  -mxl-compat  -mno-xl-compat  -mpe @gol
887 -malign-power  -malign-natural @gol
888 -msoft-float  -mhard-float  -mmultiple  -mno-multiple @gol
889 -msingle-float -mdouble-float -msimple-fpu @gol
890 -mstring  -mno-string  -mupdate  -mno-update @gol
891 -mavoid-indexed-addresses  -mno-avoid-indexed-addresses @gol
892 -mfused-madd  -mno-fused-madd  -mbit-align  -mno-bit-align @gol
893 -mstrict-align  -mno-strict-align  -mrelocatable @gol
894 -mno-relocatable  -mrelocatable-lib  -mno-relocatable-lib @gol
895 -mtoc  -mno-toc  -mlittle  -mlittle-endian  -mbig  -mbig-endian @gol
896 -mdynamic-no-pic  -maltivec -mswdiv  -msingle-pic-base @gol
897 -mprioritize-restricted-insns=@var{priority} @gol
898 -msched-costly-dep=@var{dependence_type} @gol
899 -minsert-sched-nops=@var{scheme} @gol
900 -mcall-sysv  -mcall-netbsd @gol
901 -maix-struct-return  -msvr4-struct-return @gol
902 -mabi=@var{abi-type} -msecure-plt -mbss-plt @gol
903 -mblock-move-inline-limit=@var{num} @gol
904 -misel -mno-isel @gol
905 -misel=yes  -misel=no @gol
906 -mspe -mno-spe @gol
907 -mspe=yes  -mspe=no @gol
908 -mpaired @gol
909 -mgen-cell-microcode -mwarn-cell-microcode @gol
910 -mvrsave -mno-vrsave @gol
911 -mmulhw -mno-mulhw @gol
912 -mdlmzb -mno-dlmzb @gol
913 -mfloat-gprs=yes  -mfloat-gprs=no -mfloat-gprs=single -mfloat-gprs=double @gol
914 -mprototype  -mno-prototype @gol
915 -msim  -mmvme  -mads  -myellowknife  -memb  -msdata @gol
916 -msdata=@var{opt}  -mvxworks  -G @var{num}  -pthread @gol
917 -mrecip -mrecip=@var{opt} -mno-recip -mrecip-precision @gol
918 -mno-recip-precision @gol
919 -mveclibabi=@var{type} -mfriz -mno-friz @gol
920 -mpointers-to-nested-functions -mno-pointers-to-nested-functions @gol
921 -msave-toc-indirect -mno-save-toc-indirect @gol
922 -mpower8-fusion -mno-mpower8-fusion -mpower8-vector -mno-power8-vector @gol
923 -mcrypto -mno-crypto -mdirect-move -mno-direct-move @gol
924 -mquad-memory -mno-quad-memory @gol
925 -mquad-memory-atomic -mno-quad-memory-atomic @gol
926 -mcompat-align-parm -mno-compat-align-parm}
928 @emph{RX Options}
929 @gccoptlist{-m64bit-doubles  -m32bit-doubles  -fpu  -nofpu@gol
930 -mcpu=@gol
931 -mbig-endian-data -mlittle-endian-data @gol
932 -msmall-data @gol
933 -msim  -mno-sim@gol
934 -mas100-syntax -mno-as100-syntax@gol
935 -mrelax@gol
936 -mmax-constant-size=@gol
937 -mint-register=@gol
938 -mpid@gol
939 -mno-warn-multiple-fast-interrupts@gol
940 -msave-acc-in-interrupts}
942 @emph{S/390 and zSeries Options}
943 @gccoptlist{-mtune=@var{cpu-type}  -march=@var{cpu-type} @gol
944 -mhard-float  -msoft-float  -mhard-dfp -mno-hard-dfp @gol
945 -mlong-double-64 -mlong-double-128 @gol
946 -mbackchain  -mno-backchain -mpacked-stack  -mno-packed-stack @gol
947 -msmall-exec  -mno-small-exec  -mmvcle -mno-mvcle @gol
948 -m64  -m31  -mdebug  -mno-debug  -mesa  -mzarch @gol
949 -mtpf-trace -mno-tpf-trace  -mfused-madd  -mno-fused-madd @gol
950 -mwarn-framesize  -mwarn-dynamicstack  -mstack-size -mstack-guard @gol
951 -mhotpatch[=@var{halfwords}] -mno-hotpatch}
953 @emph{Score Options}
954 @gccoptlist{-meb -mel @gol
955 -mnhwloop @gol
956 -muls @gol
957 -mmac @gol
958 -mscore5 -mscore5u -mscore7 -mscore7d}
960 @emph{SH Options}
961 @gccoptlist{-m1  -m2  -m2e @gol
962 -m2a-nofpu -m2a-single-only -m2a-single -m2a @gol
963 -m3  -m3e @gol
964 -m4-nofpu  -m4-single-only  -m4-single  -m4 @gol
965 -m4a-nofpu -m4a-single-only -m4a-single -m4a -m4al @gol
966 -m5-64media  -m5-64media-nofpu @gol
967 -m5-32media  -m5-32media-nofpu @gol
968 -m5-compact  -m5-compact-nofpu @gol
969 -mb  -ml  -mdalign  -mrelax @gol
970 -mbigtable -mfmovd -mhitachi -mrenesas -mno-renesas -mnomacsave @gol
971 -mieee -mno-ieee -mbitops  -misize  -minline-ic_invalidate -mpadstruct @gol
972 -mspace -mprefergot  -musermode -multcost=@var{number} -mdiv=@var{strategy} @gol
973 -mdivsi3_libfunc=@var{name} -mfixed-range=@var{register-range} @gol
974 -mindexed-addressing -mgettrcost=@var{number} -mpt-fixed @gol
975 -maccumulate-outgoing-args -minvalid-symbols @gol
976 -matomic-model=@var{atomic-model} @gol
977 -mbranch-cost=@var{num} -mzdcbranch -mno-zdcbranch @gol
978 -mfused-madd -mno-fused-madd -mfsca -mno-fsca -mfsrra -mno-fsrra @gol
979 -mpretend-cmove -mtas}
981 @emph{Solaris 2 Options}
982 @gccoptlist{-mimpure-text  -mno-impure-text @gol
983 -pthreads -pthread}
985 @emph{SPARC Options}
986 @gccoptlist{-mcpu=@var{cpu-type} @gol
987 -mtune=@var{cpu-type} @gol
988 -mcmodel=@var{code-model} @gol
989 -mmemory-model=@var{mem-model} @gol
990 -m32  -m64  -mapp-regs  -mno-app-regs @gol
991 -mfaster-structs  -mno-faster-structs  -mflat  -mno-flat @gol
992 -mfpu  -mno-fpu  -mhard-float  -msoft-float @gol
993 -mhard-quad-float  -msoft-quad-float @gol
994 -mstack-bias  -mno-stack-bias @gol
995 -munaligned-doubles  -mno-unaligned-doubles @gol
996 -muser-mode  -mno-user-mode @gol
997 -mv8plus  -mno-v8plus  -mvis  -mno-vis @gol
998 -mvis2  -mno-vis2  -mvis3  -mno-vis3 @gol
999 -mcbcond -mno-cbcond @gol
1000 -mfmaf  -mno-fmaf  -mpopc  -mno-popc @gol
1001 -mfix-at697f -mfix-ut699}
1003 @emph{SPU Options}
1004 @gccoptlist{-mwarn-reloc -merror-reloc @gol
1005 -msafe-dma -munsafe-dma @gol
1006 -mbranch-hints @gol
1007 -msmall-mem -mlarge-mem -mstdmain @gol
1008 -mfixed-range=@var{register-range} @gol
1009 -mea32 -mea64 @gol
1010 -maddress-space-conversion -mno-address-space-conversion @gol
1011 -mcache-size=@var{cache-size} @gol
1012 -matomic-updates -mno-atomic-updates}
1014 @emph{System V Options}
1015 @gccoptlist{-Qy  -Qn  -YP,@var{paths}  -Ym,@var{dir}}
1017 @emph{TILE-Gx Options}
1018 @gccoptlist{-mcpu=CPU -m32 -m64 -mbig-endian -mlittle-endian @gol
1019 -mcmodel=@var{code-model}}
1021 @emph{TILEPro Options}
1022 @gccoptlist{-mcpu=@var{cpu} -m32}
1024 @emph{V850 Options}
1025 @gccoptlist{-mlong-calls  -mno-long-calls  -mep  -mno-ep @gol
1026 -mprolog-function  -mno-prolog-function  -mspace @gol
1027 -mtda=@var{n}  -msda=@var{n}  -mzda=@var{n} @gol
1028 -mapp-regs  -mno-app-regs @gol
1029 -mdisable-callt  -mno-disable-callt @gol
1030 -mv850e2v3 -mv850e2 -mv850e1 -mv850es @gol
1031 -mv850e -mv850 -mv850e3v5 @gol
1032 -mloop @gol
1033 -mrelax @gol
1034 -mlong-jumps @gol
1035 -msoft-float @gol
1036 -mhard-float @gol
1037 -mgcc-abi @gol
1038 -mrh850-abi @gol
1039 -mbig-switch}
1041 @emph{VAX Options}
1042 @gccoptlist{-mg  -mgnu  -munix}
1044 @emph{VMS Options}
1045 @gccoptlist{-mvms-return-codes -mdebug-main=@var{prefix} -mmalloc64 @gol
1046 -mpointer-size=@var{size}}
1048 @emph{VxWorks Options}
1049 @gccoptlist{-mrtp  -non-static  -Bstatic  -Bdynamic @gol
1050 -Xbind-lazy  -Xbind-now}
1052 @emph{x86-64 Options}
1053 See i386 and x86-64 Options.
1055 @emph{Xstormy16 Options}
1056 @gccoptlist{-msim}
1058 @emph{Xtensa Options}
1059 @gccoptlist{-mconst16 -mno-const16 @gol
1060 -mfused-madd  -mno-fused-madd @gol
1061 -mforce-no-pic @gol
1062 -mserialize-volatile  -mno-serialize-volatile @gol
1063 -mtext-section-literals  -mno-text-section-literals @gol
1064 -mtarget-align  -mno-target-align @gol
1065 -mlongcalls  -mno-longcalls}
1067 @emph{zSeries Options}
1068 See S/390 and zSeries Options.
1070 @item Code Generation Options
1071 @xref{Code Gen Options,,Options for Code Generation Conventions}.
1072 @gccoptlist{-fcall-saved-@var{reg}  -fcall-used-@var{reg} @gol
1073 -ffixed-@var{reg}  -fexceptions @gol
1074 -fnon-call-exceptions  -fdelete-dead-exceptions  -funwind-tables @gol
1075 -fasynchronous-unwind-tables @gol
1076 -fno-gnu-unique @gol
1077 -finhibit-size-directive  -finstrument-functions @gol
1078 -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{} @gol
1079 -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{} @gol
1080 -fno-common  -fno-ident @gol
1081 -fpcc-struct-return  -fpic  -fPIC -fpie -fPIE @gol
1082 -fno-jump-tables @gol
1083 -frecord-gcc-switches @gol
1084 -freg-struct-return  -fshort-enums @gol
1085 -fshort-double  -fshort-wchar @gol
1086 -fverbose-asm  -fpack-struct[=@var{n}]  -fstack-check @gol
1087 -fstack-limit-register=@var{reg}  -fstack-limit-symbol=@var{sym} @gol
1088 -fno-stack-limit -fsplit-stack @gol
1089 -fleading-underscore  -ftls-model=@var{model} @gol
1090 -fstack-reuse=@var{reuse_level} @gol
1091 -ftrapv  -fwrapv  -fbounds-check @gol
1092 -fvisibility -fstrict-volatile-bitfields -fsync-libcalls}
1093 @end table
1096 @node Overall Options
1097 @section Options Controlling the Kind of Output
1099 Compilation can involve up to four stages: preprocessing, compilation
1100 proper, assembly and linking, always in that order.  GCC is capable of
1101 preprocessing and compiling several files either into several
1102 assembler input files, or into one assembler input file; then each
1103 assembler input file produces an object file, and linking combines all
1104 the object files (those newly compiled, and those specified as input)
1105 into an executable file.
1107 @cindex file name suffix
1108 For any given input file, the file name suffix determines what kind of
1109 compilation is done:
1111 @table @gcctabopt
1112 @item @var{file}.c
1113 C source code that must be preprocessed.
1115 @item @var{file}.i
1116 C source code that should not be preprocessed.
1118 @item @var{file}.ii
1119 C++ source code that should not be preprocessed.
1121 @item @var{file}.m
1122 Objective-C source code.  Note that you must link with the @file{libobjc}
1123 library to make an Objective-C program work.
1125 @item @var{file}.mi
1126 Objective-C source code that should not be preprocessed.
1128 @item @var{file}.mm
1129 @itemx @var{file}.M
1130 Objective-C++ source code.  Note that you must link with the @file{libobjc}
1131 library to make an Objective-C++ program work.  Note that @samp{.M} refers
1132 to a literal capital M@.
1134 @item @var{file}.mii
1135 Objective-C++ source code that should not be preprocessed.
1137 @item @var{file}.h
1138 C, C++, Objective-C or Objective-C++ header file to be turned into a
1139 precompiled header (default), or C, C++ header file to be turned into an
1140 Ada spec (via the @option{-fdump-ada-spec} switch).
1142 @item @var{file}.cc
1143 @itemx @var{file}.cp
1144 @itemx @var{file}.cxx
1145 @itemx @var{file}.cpp
1146 @itemx @var{file}.CPP
1147 @itemx @var{file}.c++
1148 @itemx @var{file}.C
1149 C++ source code that must be preprocessed.  Note that in @samp{.cxx},
1150 the last two letters must both be literally @samp{x}.  Likewise,
1151 @samp{.C} refers to a literal capital C@.
1153 @item @var{file}.mm
1154 @itemx @var{file}.M
1155 Objective-C++ source code that must be preprocessed.
1157 @item @var{file}.mii
1158 Objective-C++ source code that should not be preprocessed.
1160 @item @var{file}.hh
1161 @itemx @var{file}.H
1162 @itemx @var{file}.hp
1163 @itemx @var{file}.hxx
1164 @itemx @var{file}.hpp
1165 @itemx @var{file}.HPP
1166 @itemx @var{file}.h++
1167 @itemx @var{file}.tcc
1168 C++ header file to be turned into a precompiled header or Ada spec.
1170 @item @var{file}.f
1171 @itemx @var{file}.for
1172 @itemx @var{file}.ftn
1173 Fixed form Fortran source code that should not be preprocessed.
1175 @item @var{file}.F
1176 @itemx @var{file}.FOR
1177 @itemx @var{file}.fpp
1178 @itemx @var{file}.FPP
1179 @itemx @var{file}.FTN
1180 Fixed form Fortran source code that must be preprocessed (with the traditional
1181 preprocessor).
1183 @item @var{file}.f90
1184 @itemx @var{file}.f95
1185 @itemx @var{file}.f03
1186 @itemx @var{file}.f08
1187 Free form Fortran source code that should not be preprocessed.
1189 @item @var{file}.F90
1190 @itemx @var{file}.F95
1191 @itemx @var{file}.F03
1192 @itemx @var{file}.F08
1193 Free form Fortran source code that must be preprocessed (with the
1194 traditional preprocessor).
1196 @item @var{file}.go
1197 Go source code.
1199 @c FIXME: Descriptions of Java file types.
1200 @c @var{file}.java
1201 @c @var{file}.class
1202 @c @var{file}.zip
1203 @c @var{file}.jar
1205 @item @var{file}.ads
1206 Ada source code file that contains a library unit declaration (a
1207 declaration of a package, subprogram, or generic, or a generic
1208 instantiation), or a library unit renaming declaration (a package,
1209 generic, or subprogram renaming declaration).  Such files are also
1210 called @dfn{specs}.
1212 @item @var{file}.adb
1213 Ada source code file containing a library unit body (a subprogram or
1214 package body).  Such files are also called @dfn{bodies}.
1216 @c GCC also knows about some suffixes for languages not yet included:
1217 @c Pascal:
1218 @c @var{file}.p
1219 @c @var{file}.pas
1220 @c Ratfor:
1221 @c @var{file}.r
1223 @item @var{file}.s
1224 Assembler code.
1226 @item @var{file}.S
1227 @itemx @var{file}.sx
1228 Assembler code that must be preprocessed.
1230 @item @var{other}
1231 An object file to be fed straight into linking.
1232 Any file name with no recognized suffix is treated this way.
1233 @end table
1235 @opindex x
1236 You can specify the input language explicitly with the @option{-x} option:
1238 @table @gcctabopt
1239 @item -x @var{language}
1240 Specify explicitly the @var{language} for the following input files
1241 (rather than letting the compiler choose a default based on the file
1242 name suffix).  This option applies to all following input files until
1243 the next @option{-x} option.  Possible values for @var{language} are:
1244 @smallexample
1245 c  c-header  cpp-output
1246 c++  c++-header  c++-cpp-output
1247 objective-c  objective-c-header  objective-c-cpp-output
1248 objective-c++ objective-c++-header objective-c++-cpp-output
1249 assembler  assembler-with-cpp
1251 f77  f77-cpp-input f95  f95-cpp-input
1253 java
1254 @end smallexample
1256 @item -x none
1257 Turn off any specification of a language, so that subsequent files are
1258 handled according to their file name suffixes (as they are if @option{-x}
1259 has not been used at all).
1261 @item -pass-exit-codes
1262 @opindex pass-exit-codes
1263 Normally the @command{gcc} program exits with the code of 1 if any
1264 phase of the compiler returns a non-success return code.  If you specify
1265 @option{-pass-exit-codes}, the @command{gcc} program instead returns with
1266 the numerically highest error produced by any phase returning an error
1267 indication.  The C, C++, and Fortran front ends return 4 if an internal
1268 compiler error is encountered.
1269 @end table
1271 If you only want some of the stages of compilation, you can use
1272 @option{-x} (or filename suffixes) to tell @command{gcc} where to start, and
1273 one of the options @option{-c}, @option{-S}, or @option{-E} to say where
1274 @command{gcc} is to stop.  Note that some combinations (for example,
1275 @samp{-x cpp-output -E}) instruct @command{gcc} to do nothing at all.
1277 @table @gcctabopt
1278 @item -c
1279 @opindex c
1280 Compile or assemble the source files, but do not link.  The linking
1281 stage simply is not done.  The ultimate output is in the form of an
1282 object file for each source file.
1284 By default, the object file name for a source file is made by replacing
1285 the suffix @samp{.c}, @samp{.i}, @samp{.s}, etc., with @samp{.o}.
1287 Unrecognized input files, not requiring compilation or assembly, are
1288 ignored.
1290 @item -S
1291 @opindex S
1292 Stop after the stage of compilation proper; do not assemble.  The output
1293 is in the form of an assembler code file for each non-assembler input
1294 file specified.
1296 By default, the assembler file name for a source file is made by
1297 replacing the suffix @samp{.c}, @samp{.i}, etc., with @samp{.s}.
1299 Input files that don't require compilation are ignored.
1301 @item -E
1302 @opindex E
1303 Stop after the preprocessing stage; do not run the compiler proper.  The
1304 output is in the form of preprocessed source code, which is sent to the
1305 standard output.
1307 Input files that don't require preprocessing are ignored.
1309 @cindex output file option
1310 @item -o @var{file}
1311 @opindex o
1312 Place output in file @var{file}.  This applies to whatever
1313 sort of output is being produced, whether it be an executable file,
1314 an object file, an assembler file or preprocessed C code.
1316 If @option{-o} is not specified, the default is to put an executable
1317 file in @file{a.out}, the object file for
1318 @file{@var{source}.@var{suffix}} in @file{@var{source}.o}, its
1319 assembler file in @file{@var{source}.s}, a precompiled header file in
1320 @file{@var{source}.@var{suffix}.gch}, and all preprocessed C source on
1321 standard output.
1323 @item -v
1324 @opindex v
1325 Print (on standard error output) the commands executed to run the stages
1326 of compilation.  Also print the version number of the compiler driver
1327 program and of the preprocessor and the compiler proper.
1329 @item -###
1330 @opindex ###
1331 Like @option{-v} except the commands are not executed and arguments
1332 are quoted unless they contain only alphanumeric characters or @code{./-_}.
1333 This is useful for shell scripts to capture the driver-generated command lines.
1335 @item -pipe
1336 @opindex pipe
1337 Use pipes rather than temporary files for communication between the
1338 various stages of compilation.  This fails to work on some systems where
1339 the assembler is unable to read from a pipe; but the GNU assembler has
1340 no trouble.
1342 @item --help
1343 @opindex help
1344 Print (on the standard output) a description of the command-line options
1345 understood by @command{gcc}.  If the @option{-v} option is also specified
1346 then @option{--help} is also passed on to the various processes
1347 invoked by @command{gcc}, so that they can display the command-line options
1348 they accept.  If the @option{-Wextra} option has also been specified
1349 (prior to the @option{--help} option), then command-line options that
1350 have no documentation associated with them are also displayed.
1352 @item --target-help
1353 @opindex target-help
1354 Print (on the standard output) a description of target-specific command-line
1355 options for each tool.  For some targets extra target-specific
1356 information may also be printed.
1358 @item --help=@{@var{class}@r{|[}^@r{]}@var{qualifier}@}@r{[},@dots{}@r{]}
1359 Print (on the standard output) a description of the command-line
1360 options understood by the compiler that fit into all specified classes
1361 and qualifiers.  These are the supported classes:
1363 @table @asis
1364 @item @samp{optimizers}
1365 Display all of the optimization options supported by the
1366 compiler.
1368 @item @samp{warnings}
1369 Display all of the options controlling warning messages
1370 produced by the compiler.
1372 @item @samp{target}
1373 Display target-specific options.  Unlike the
1374 @option{--target-help} option however, target-specific options of the
1375 linker and assembler are not displayed.  This is because those
1376 tools do not currently support the extended @option{--help=} syntax.
1378 @item @samp{params}
1379 Display the values recognized by the @option{--param}
1380 option.
1382 @item @var{language}
1383 Display the options supported for @var{language}, where
1384 @var{language} is the name of one of the languages supported in this
1385 version of GCC@.
1387 @item @samp{common}
1388 Display the options that are common to all languages.
1389 @end table
1391 These are the supported qualifiers:
1393 @table @asis
1394 @item @samp{undocumented}
1395 Display only those options that are undocumented.
1397 @item @samp{joined}
1398 Display options taking an argument that appears after an equal
1399 sign in the same continuous piece of text, such as:
1400 @samp{--help=target}.
1402 @item @samp{separate}
1403 Display options taking an argument that appears as a separate word
1404 following the original option, such as: @samp{-o output-file}.
1405 @end table
1407 Thus for example to display all the undocumented target-specific
1408 switches supported by the compiler, use:
1410 @smallexample
1411 --help=target,undocumented
1412 @end smallexample
1414 The sense of a qualifier can be inverted by prefixing it with the
1415 @samp{^} character, so for example to display all binary warning
1416 options (i.e., ones that are either on or off and that do not take an
1417 argument) that have a description, use:
1419 @smallexample
1420 --help=warnings,^joined,^undocumented
1421 @end smallexample
1423 The argument to @option{--help=} should not consist solely of inverted
1424 qualifiers.
1426 Combining several classes is possible, although this usually
1427 restricts the output so much that there is nothing to display.  One
1428 case where it does work, however, is when one of the classes is
1429 @var{target}.  For example, to display all the target-specific
1430 optimization options, use:
1432 @smallexample
1433 --help=target,optimizers
1434 @end smallexample
1436 The @option{--help=} option can be repeated on the command line.  Each
1437 successive use displays its requested class of options, skipping
1438 those that have already been displayed.
1440 If the @option{-Q} option appears on the command line before the
1441 @option{--help=} option, then the descriptive text displayed by
1442 @option{--help=} is changed.  Instead of describing the displayed
1443 options, an indication is given as to whether the option is enabled,
1444 disabled or set to a specific value (assuming that the compiler
1445 knows this at the point where the @option{--help=} option is used).
1447 Here is a truncated example from the ARM port of @command{gcc}:
1449 @smallexample
1450   % gcc -Q -mabi=2 --help=target -c
1451   The following options are target specific:
1452   -mabi=                                2
1453   -mabort-on-noreturn                   [disabled]
1454   -mapcs                                [disabled]
1455 @end smallexample
1457 The output is sensitive to the effects of previous command-line
1458 options, so for example it is possible to find out which optimizations
1459 are enabled at @option{-O2} by using:
1461 @smallexample
1462 -Q -O2 --help=optimizers
1463 @end smallexample
1465 Alternatively you can discover which binary optimizations are enabled
1466 by @option{-O3} by using:
1468 @smallexample
1469 gcc -c -Q -O3 --help=optimizers > /tmp/O3-opts
1470 gcc -c -Q -O2 --help=optimizers > /tmp/O2-opts
1471 diff /tmp/O2-opts /tmp/O3-opts | grep enabled
1472 @end smallexample
1474 @item -no-canonical-prefixes
1475 @opindex no-canonical-prefixes
1476 Do not expand any symbolic links, resolve references to @samp{/../}
1477 or @samp{/./}, or make the path absolute when generating a relative
1478 prefix.
1480 @item --version
1481 @opindex version
1482 Display the version number and copyrights of the invoked GCC@.
1484 @item -wrapper
1485 @opindex wrapper
1486 Invoke all subcommands under a wrapper program.  The name of the
1487 wrapper program and its parameters are passed as a comma separated
1488 list.
1490 @smallexample
1491 gcc -c t.c -wrapper gdb,--args
1492 @end smallexample
1494 @noindent
1495 This invokes all subprograms of @command{gcc} under
1496 @samp{gdb --args}, thus the invocation of @command{cc1} is
1497 @samp{gdb --args cc1 @dots{}}.
1499 @item -fplugin=@var{name}.so
1500 @opindex fplugin
1501 Load the plugin code in file @var{name}.so, assumed to be a
1502 shared object to be dlopen'd by the compiler.  The base name of
1503 the shared object file is used to identify the plugin for the
1504 purposes of argument parsing (See
1505 @option{-fplugin-arg-@var{name}-@var{key}=@var{value}} below).
1506 Each plugin should define the callback functions specified in the
1507 Plugins API.
1509 @item -fplugin-arg-@var{name}-@var{key}=@var{value}
1510 @opindex fplugin-arg
1511 Define an argument called @var{key} with a value of @var{value}
1512 for the plugin called @var{name}.
1514 @item -fdump-ada-spec@r{[}-slim@r{]}
1515 @opindex fdump-ada-spec
1516 For C and C++ source and include files, generate corresponding Ada specs.
1517 @xref{Generating Ada Bindings for C and C++ headers,,, gnat_ugn,
1518 GNAT User's Guide}, which provides detailed documentation on this feature.
1520 @item -fada-spec-parent=@var{unit}
1521 @opindex fada-spec-parent
1522 In conjunction with @option{-fdump-ada-spec@r{[}-slim@r{]}} above, generate
1523 Ada specs as child units of parent @var{unit}.
1525 @item -fdump-go-spec=@var{file}
1526 @opindex fdump-go-spec
1527 For input files in any language, generate corresponding Go
1528 declarations in @var{file}.  This generates Go @code{const},
1529 @code{type}, @code{var}, and @code{func} declarations which may be a
1530 useful way to start writing a Go interface to code written in some
1531 other language.
1533 @include @value{srcdir}/../libiberty/at-file.texi
1534 @end table
1536 @node Invoking G++
1537 @section Compiling C++ Programs
1539 @cindex suffixes for C++ source
1540 @cindex C++ source file suffixes
1541 C++ source files conventionally use one of the suffixes @samp{.C},
1542 @samp{.cc}, @samp{.cpp}, @samp{.CPP}, @samp{.c++}, @samp{.cp}, or
1543 @samp{.cxx}; C++ header files often use @samp{.hh}, @samp{.hpp},
1544 @samp{.H}, or (for shared template code) @samp{.tcc}; and
1545 preprocessed C++ files use the suffix @samp{.ii}.  GCC recognizes
1546 files with these names and compiles them as C++ programs even if you
1547 call the compiler the same way as for compiling C programs (usually
1548 with the name @command{gcc}).
1550 @findex g++
1551 @findex c++
1552 However, the use of @command{gcc} does not add the C++ library.
1553 @command{g++} is a program that calls GCC and automatically specifies linking
1554 against the C++ library.  It treats @samp{.c},
1555 @samp{.h} and @samp{.i} files as C++ source files instead of C source
1556 files unless @option{-x} is used.  This program is also useful when
1557 precompiling a C header file with a @samp{.h} extension for use in C++
1558 compilations.  On many systems, @command{g++} is also installed with
1559 the name @command{c++}.
1561 @cindex invoking @command{g++}
1562 When you compile C++ programs, you may specify many of the same
1563 command-line options that you use for compiling programs in any
1564 language; or command-line options meaningful for C and related
1565 languages; or options that are meaningful only for C++ programs.
1566 @xref{C Dialect Options,,Options Controlling C Dialect}, for
1567 explanations of options for languages related to C@.
1568 @xref{C++ Dialect Options,,Options Controlling C++ Dialect}, for
1569 explanations of options that are meaningful only for C++ programs.
1571 @node C Dialect Options
1572 @section Options Controlling C Dialect
1573 @cindex dialect options
1574 @cindex language dialect options
1575 @cindex options, dialect
1577 The following options control the dialect of C (or languages derived
1578 from C, such as C++, Objective-C and Objective-C++) that the compiler
1579 accepts:
1581 @table @gcctabopt
1582 @cindex ANSI support
1583 @cindex ISO support
1584 @item -ansi
1585 @opindex ansi
1586 In C mode, this is equivalent to @option{-std=c90}. In C++ mode, it is
1587 equivalent to @option{-std=c++98}.
1589 This turns off certain features of GCC that are incompatible with ISO
1590 C90 (when compiling C code), or of standard C++ (when compiling C++ code),
1591 such as the @code{asm} and @code{typeof} keywords, and
1592 predefined macros such as @code{unix} and @code{vax} that identify the
1593 type of system you are using.  It also enables the undesirable and
1594 rarely used ISO trigraph feature.  For the C compiler,
1595 it disables recognition of C++ style @samp{//} comments as well as
1596 the @code{inline} keyword.
1598 The alternate keywords @code{__asm__}, @code{__extension__},
1599 @code{__inline__} and @code{__typeof__} continue to work despite
1600 @option{-ansi}.  You would not want to use them in an ISO C program, of
1601 course, but it is useful to put them in header files that might be included
1602 in compilations done with @option{-ansi}.  Alternate predefined macros
1603 such as @code{__unix__} and @code{__vax__} are also available, with or
1604 without @option{-ansi}.
1606 The @option{-ansi} option does not cause non-ISO programs to be
1607 rejected gratuitously.  For that, @option{-Wpedantic} is required in
1608 addition to @option{-ansi}.  @xref{Warning Options}.
1610 The macro @code{__STRICT_ANSI__} is predefined when the @option{-ansi}
1611 option is used.  Some header files may notice this macro and refrain
1612 from declaring certain functions or defining certain macros that the
1613 ISO standard doesn't call for; this is to avoid interfering with any
1614 programs that might use these names for other things.
1616 Functions that are normally built in but do not have semantics
1617 defined by ISO C (such as @code{alloca} and @code{ffs}) are not built-in
1618 functions when @option{-ansi} is used.  @xref{Other Builtins,,Other
1619 built-in functions provided by GCC}, for details of the functions
1620 affected.
1622 @item -std=
1623 @opindex std
1624 Determine the language standard. @xref{Standards,,Language Standards
1625 Supported by GCC}, for details of these standard versions.  This option
1626 is currently only supported when compiling C or C++.
1628 The compiler can accept several base standards, such as @samp{c90} or
1629 @samp{c++98}, and GNU dialects of those standards, such as
1630 @samp{gnu90} or @samp{gnu++98}.  When a base standard is specified, the
1631 compiler accepts all programs following that standard plus those
1632 using GNU extensions that do not contradict it.  For example,
1633 @option{-std=c90} turns off certain features of GCC that are
1634 incompatible with ISO C90, such as the @code{asm} and @code{typeof}
1635 keywords, but not other GNU extensions that do not have a meaning in
1636 ISO C90, such as omitting the middle term of a @code{?:}
1637 expression. On the other hand, when a GNU dialect of a standard is
1638 specified, all features supported by the compiler are enabled, even when
1639 those features change the meaning of the base standard.  As a result, some
1640 strict-conforming programs may be rejected.  The particular standard
1641 is used by @option{-Wpedantic} to identify which features are GNU
1642 extensions given that version of the standard. For example
1643 @option{-std=gnu90 -Wpedantic} warns about C++ style @samp{//}
1644 comments, while @option{-std=gnu99 -Wpedantic} does not.
1646 A value for this option must be provided; possible values are
1648 @table @samp
1649 @item c90
1650 @itemx c89
1651 @itemx iso9899:1990
1652 Support all ISO C90 programs (certain GNU extensions that conflict
1653 with ISO C90 are disabled). Same as @option{-ansi} for C code.
1655 @item iso9899:199409
1656 ISO C90 as modified in amendment 1.
1658 @item c99
1659 @itemx c9x
1660 @itemx iso9899:1999
1661 @itemx iso9899:199x
1662 ISO C99.  This standard is substantially completely supported, modulo
1663 bugs, extended identifiers (supported except for corner cases when
1664 @option{-fextended-identifiers} is used) and floating-point issues
1665 (mainly but not entirely relating to optional C99 features from
1666 Annexes F and G).  See
1667 @w{@uref{http://gcc.gnu.org/c99status.html}} for more information.  The
1668 names @samp{c9x} and @samp{iso9899:199x} are deprecated.
1670 @item c11
1671 @itemx c1x
1672 @itemx iso9899:2011
1673 ISO C11, the 2011 revision of the ISO C standard.  This standard is
1674 substantially completely supported, modulo bugs, extended identifiers
1675 (supported except for corner cases when
1676 @option{-fextended-identifiers} is used), floating-point issues
1677 (mainly but not entirely relating to optional C11 features from
1678 Annexes F and G) and the optional Annexes K (Bounds-checking
1679 interfaces) and L (Analyzability).  The name @samp{c1x} is deprecated.
1681 @item gnu90
1682 @itemx gnu89
1683 GNU dialect of ISO C90 (including some C99 features). This
1684 is the default for C code.
1686 @item gnu99
1687 @itemx gnu9x
1688 GNU dialect of ISO C99.  The name @samp{gnu9x} is deprecated.
1690 @item gnu11
1691 @itemx gnu1x
1692 GNU dialect of ISO C11.  This is intended to become the default in a
1693 future release of GCC.  The name @samp{gnu1x} is deprecated.
1695 @item c++98
1696 @itemx c++03
1697 The 1998 ISO C++ standard plus the 2003 technical corrigendum and some
1698 additional defect reports. Same as @option{-ansi} for C++ code.
1700 @item gnu++98
1701 @itemx gnu++03
1702 GNU dialect of @option{-std=c++98}.  This is the default for
1703 C++ code.
1705 @item c++11
1706 @itemx c++0x
1707 The 2011 ISO C++ standard plus amendments.
1708 The name @samp{c++0x} is deprecated.
1710 @item gnu++11
1711 @itemx gnu++0x
1712 GNU dialect of @option{-std=c++11}.
1713 The name @samp{gnu++0x} is deprecated.
1715 @item c++1y
1716 The next revision of the ISO C++ standard, tentatively planned for
1717 2014.  Support is highly experimental, and will almost certainly
1718 change in incompatible ways in future releases.
1720 @item gnu++1y
1721 GNU dialect of @option{-std=c++1y}.  Support is highly experimental,
1722 and will almost certainly change in incompatible ways in future
1723 releases.
1724 @end table
1726 @item -fgnu89-inline
1727 @opindex fgnu89-inline
1728 The option @option{-fgnu89-inline} tells GCC to use the traditional
1729 GNU semantics for @code{inline} functions when in C99 mode.
1730 @xref{Inline,,An Inline Function is As Fast As a Macro}.  This option
1731 is accepted and ignored by GCC versions 4.1.3 up to but not including
1732 4.3.  In GCC versions 4.3 and later it changes the behavior of GCC in
1733 C99 mode.  Using this option is roughly equivalent to adding the
1734 @code{gnu_inline} function attribute to all inline functions
1735 (@pxref{Function Attributes}).
1737 The option @option{-fno-gnu89-inline} explicitly tells GCC to use the
1738 C99 semantics for @code{inline} when in C99 or gnu99 mode (i.e., it
1739 specifies the default behavior).  This option was first supported in
1740 GCC 4.3.  This option is not supported in @option{-std=c90} or
1741 @option{-std=gnu90} mode.
1743 The preprocessor macros @code{__GNUC_GNU_INLINE__} and
1744 @code{__GNUC_STDC_INLINE__} may be used to check which semantics are
1745 in effect for @code{inline} functions.  @xref{Common Predefined
1746 Macros,,,cpp,The C Preprocessor}.
1748 @item -aux-info @var{filename}
1749 @opindex aux-info
1750 Output to the given filename prototyped declarations for all functions
1751 declared and/or defined in a translation unit, including those in header
1752 files.  This option is silently ignored in any language other than C@.
1754 Besides declarations, the file indicates, in comments, the origin of
1755 each declaration (source file and line), whether the declaration was
1756 implicit, prototyped or unprototyped (@samp{I}, @samp{N} for new or
1757 @samp{O} for old, respectively, in the first character after the line
1758 number and the colon), and whether it came from a declaration or a
1759 definition (@samp{C} or @samp{F}, respectively, in the following
1760 character).  In the case of function definitions, a K&R-style list of
1761 arguments followed by their declarations is also provided, inside
1762 comments, after the declaration.
1764 @item -fallow-parameterless-variadic-functions
1765 @opindex fallow-parameterless-variadic-functions
1766 Accept variadic functions without named parameters.
1768 Although it is possible to define such a function, this is not very
1769 useful as it is not possible to read the arguments.  This is only
1770 supported for C as this construct is allowed by C++.
1772 @item -fno-asm
1773 @opindex fno-asm
1774 Do not recognize @code{asm}, @code{inline} or @code{typeof} as a
1775 keyword, so that code can use these words as identifiers.  You can use
1776 the keywords @code{__asm__}, @code{__inline__} and @code{__typeof__}
1777 instead.  @option{-ansi} implies @option{-fno-asm}.
1779 In C++, this switch only affects the @code{typeof} keyword, since
1780 @code{asm} and @code{inline} are standard keywords.  You may want to
1781 use the @option{-fno-gnu-keywords} flag instead, which has the same
1782 effect.  In C99 mode (@option{-std=c99} or @option{-std=gnu99}), this
1783 switch only affects the @code{asm} and @code{typeof} keywords, since
1784 @code{inline} is a standard keyword in ISO C99.
1786 @item -fno-builtin
1787 @itemx -fno-builtin-@var{function}
1788 @opindex fno-builtin
1789 @cindex built-in functions
1790 Don't recognize built-in functions that do not begin with
1791 @samp{__builtin_} as prefix.  @xref{Other Builtins,,Other built-in
1792 functions provided by GCC}, for details of the functions affected,
1793 including those which are not built-in functions when @option{-ansi} or
1794 @option{-std} options for strict ISO C conformance are used because they
1795 do not have an ISO standard meaning.
1797 GCC normally generates special code to handle certain built-in functions
1798 more efficiently; for instance, calls to @code{alloca} may become single
1799 instructions which adjust the stack directly, and calls to @code{memcpy}
1800 may become inline copy loops.  The resulting code is often both smaller
1801 and faster, but since the function calls no longer appear as such, you
1802 cannot set a breakpoint on those calls, nor can you change the behavior
1803 of the functions by linking with a different library.  In addition,
1804 when a function is recognized as a built-in function, GCC may use
1805 information about that function to warn about problems with calls to
1806 that function, or to generate more efficient code, even if the
1807 resulting code still contains calls to that function.  For example,
1808 warnings are given with @option{-Wformat} for bad calls to
1809 @code{printf} when @code{printf} is built in and @code{strlen} is
1810 known not to modify global memory.
1812 With the @option{-fno-builtin-@var{function}} option
1813 only the built-in function @var{function} is
1814 disabled.  @var{function} must not begin with @samp{__builtin_}.  If a
1815 function is named that is not built-in in this version of GCC, this
1816 option is ignored.  There is no corresponding
1817 @option{-fbuiltin-@var{function}} option; if you wish to enable
1818 built-in functions selectively when using @option{-fno-builtin} or
1819 @option{-ffreestanding}, you may define macros such as:
1821 @smallexample
1822 #define abs(n)          __builtin_abs ((n))
1823 #define strcpy(d, s)    __builtin_strcpy ((d), (s))
1824 @end smallexample
1826 @item -fhosted
1827 @opindex fhosted
1828 @cindex hosted environment
1830 Assert that compilation targets a hosted environment.  This implies
1831 @option{-fbuiltin}.  A hosted environment is one in which the
1832 entire standard library is available, and in which @code{main} has a return
1833 type of @code{int}.  Examples are nearly everything except a kernel.
1834 This is equivalent to @option{-fno-freestanding}.
1836 @item -ffreestanding
1837 @opindex ffreestanding
1838 @cindex hosted environment
1840 Assert that compilation targets a freestanding environment.  This
1841 implies @option{-fno-builtin}.  A freestanding environment
1842 is one in which the standard library may not exist, and program startup may
1843 not necessarily be at @code{main}.  The most obvious example is an OS kernel.
1844 This is equivalent to @option{-fno-hosted}.
1846 @xref{Standards,,Language Standards Supported by GCC}, for details of
1847 freestanding and hosted environments.
1849 @item -fopenmp
1850 @opindex fopenmp
1851 @cindex OpenMP parallel
1852 Enable handling of OpenMP directives @code{#pragma omp} in C/C++ and
1853 @code{!$omp} in Fortran.  When @option{-fopenmp} is specified, the
1854 compiler generates parallel code according to the OpenMP Application
1855 Program Interface v4.0 @w{@uref{http://www.openmp.org/}}.  This option
1856 implies @option{-pthread}, and thus is only supported on targets that
1857 have support for @option{-pthread}. @option{-fopenmp} implies
1858 @option{-fopenmp-simd}.
1860 @item -fopenmp-simd
1861 @opindex fopenmp-simd
1862 @cindex OpenMP SIMD
1863 @cindex SIMD
1864 Enable handling of OpenMP's SIMD directives with @code{#pragma omp}
1865 in C/C++ and @code{!$omp} in Fortran. Other OpenMP directives
1866 are ignored.
1868 @item -fcilkplus
1869 @opindex fcilkplus
1870 @cindex Enable Cilk Plus
1871 Enable the usage of Cilk Plus language extension features for C/C++.
1872 When the option @option{-fcilkplus} is specified, enable the usage of
1873 the Cilk Plus Language extension features for C/C++.  The present
1874 implementation follows ABI version 1.2.  This is an experimental
1875 feature that is only partially complete, and whose interface may
1876 change in future versions of GCC as the official specification
1877 changes.  Currently, all features but @code{_Cilk_for} have been
1878 implemented.
1880 @item -fgnu-tm
1881 @opindex fgnu-tm
1882 When the option @option{-fgnu-tm} is specified, the compiler
1883 generates code for the Linux variant of Intel's current Transactional
1884 Memory ABI specification document (Revision 1.1, May 6 2009).  This is
1885 an experimental feature whose interface may change in future versions
1886 of GCC, as the official specification changes.  Please note that not
1887 all architectures are supported for this feature.
1889 For more information on GCC's support for transactional memory,
1890 @xref{Enabling libitm,,The GNU Transactional Memory Library,libitm,GNU
1891 Transactional Memory Library}.
1893 Note that the transactional memory feature is not supported with
1894 non-call exceptions (@option{-fnon-call-exceptions}).
1896 @item -fms-extensions
1897 @opindex fms-extensions
1898 Accept some non-standard constructs used in Microsoft header files.
1900 In C++ code, this allows member names in structures to be similar
1901 to previous types declarations.
1903 @smallexample
1904 typedef int UOW;
1905 struct ABC @{
1906   UOW UOW;
1908 @end smallexample
1910 Some cases of unnamed fields in structures and unions are only
1911 accepted with this option.  @xref{Unnamed Fields,,Unnamed struct/union
1912 fields within structs/unions}, for details.
1914 Note that this option is off for all targets but i?86 and x86_64
1915 targets using ms-abi.
1916 @item -fplan9-extensions
1917 Accept some non-standard constructs used in Plan 9 code.
1919 This enables @option{-fms-extensions}, permits passing pointers to
1920 structures with anonymous fields to functions that expect pointers to
1921 elements of the type of the field, and permits referring to anonymous
1922 fields declared using a typedef.  @xref{Unnamed Fields,,Unnamed
1923 struct/union fields within structs/unions}, for details.  This is only
1924 supported for C, not C++.
1926 @item -trigraphs
1927 @opindex trigraphs
1928 Support ISO C trigraphs.  The @option{-ansi} option (and @option{-std}
1929 options for strict ISO C conformance) implies @option{-trigraphs}.
1931 @cindex traditional C language
1932 @cindex C language, traditional
1933 @item -traditional
1934 @itemx -traditional-cpp
1935 @opindex traditional-cpp
1936 @opindex traditional
1937 Formerly, these options caused GCC to attempt to emulate a pre-standard
1938 C compiler.  They are now only supported with the @option{-E} switch.
1939 The preprocessor continues to support a pre-standard mode.  See the GNU
1940 CPP manual for details.
1942 @item -fcond-mismatch
1943 @opindex fcond-mismatch
1944 Allow conditional expressions with mismatched types in the second and
1945 third arguments.  The value of such an expression is void.  This option
1946 is not supported for C++.
1948 @item -flax-vector-conversions
1949 @opindex flax-vector-conversions
1950 Allow implicit conversions between vectors with differing numbers of
1951 elements and/or incompatible element types.  This option should not be
1952 used for new code.
1954 @item -funsigned-char
1955 @opindex funsigned-char
1956 Let the type @code{char} be unsigned, like @code{unsigned char}.
1958 Each kind of machine has a default for what @code{char} should
1959 be.  It is either like @code{unsigned char} by default or like
1960 @code{signed char} by default.
1962 Ideally, a portable program should always use @code{signed char} or
1963 @code{unsigned char} when it depends on the signedness of an object.
1964 But many programs have been written to use plain @code{char} and
1965 expect it to be signed, or expect it to be unsigned, depending on the
1966 machines they were written for.  This option, and its inverse, let you
1967 make such a program work with the opposite default.
1969 The type @code{char} is always a distinct type from each of
1970 @code{signed char} or @code{unsigned char}, even though its behavior
1971 is always just like one of those two.
1973 @item -fsigned-char
1974 @opindex fsigned-char
1975 Let the type @code{char} be signed, like @code{signed char}.
1977 Note that this is equivalent to @option{-fno-unsigned-char}, which is
1978 the negative form of @option{-funsigned-char}.  Likewise, the option
1979 @option{-fno-signed-char} is equivalent to @option{-funsigned-char}.
1981 @item -fsigned-bitfields
1982 @itemx -funsigned-bitfields
1983 @itemx -fno-signed-bitfields
1984 @itemx -fno-unsigned-bitfields
1985 @opindex fsigned-bitfields
1986 @opindex funsigned-bitfields
1987 @opindex fno-signed-bitfields
1988 @opindex fno-unsigned-bitfields
1989 These options control whether a bit-field is signed or unsigned, when the
1990 declaration does not use either @code{signed} or @code{unsigned}.  By
1991 default, such a bit-field is signed, because this is consistent: the
1992 basic integer types such as @code{int} are signed types.
1993 @end table
1995 @node C++ Dialect Options
1996 @section Options Controlling C++ Dialect
1998 @cindex compiler options, C++
1999 @cindex C++ options, command-line
2000 @cindex options, C++
2001 This section describes the command-line options that are only meaningful
2002 for C++ programs.  You can also use most of the GNU compiler options
2003 regardless of what language your program is in.  For example, you
2004 might compile a file @code{firstClass.C} like this:
2006 @smallexample
2007 g++ -g -frepo -O -c firstClass.C
2008 @end smallexample
2010 @noindent
2011 In this example, only @option{-frepo} is an option meant
2012 only for C++ programs; you can use the other options with any
2013 language supported by GCC@.
2015 Here is a list of options that are @emph{only} for compiling C++ programs:
2017 @table @gcctabopt
2019 @item -fabi-version=@var{n}
2020 @opindex fabi-version
2021 Use version @var{n} of the C++ ABI@.  The default is version 2.
2023 Version 0 refers to the version conforming most closely to
2024 the C++ ABI specification.  Therefore, the ABI obtained using version 0
2025 will change in different versions of G++ as ABI bugs are fixed.
2027 Version 1 is the version of the C++ ABI that first appeared in G++ 3.2.  
2029 Version 2 is the version of the C++ ABI that first appeared in G++ 3.4.  
2031 Version 3 corrects an error in mangling a constant address as a
2032 template argument.
2034 Version 4, which first appeared in G++ 4.5, implements a standard
2035 mangling for vector types.
2037 Version 5, which first appeared in G++ 4.6, corrects the mangling of
2038 attribute const/volatile on function pointer types, decltype of a
2039 plain decl, and use of a function parameter in the declaration of
2040 another parameter.
2042 Version 6, which first appeared in G++ 4.7, corrects the promotion
2043 behavior of C++11 scoped enums and the mangling of template argument
2044 packs, const/static_cast, prefix ++ and --, and a class scope function
2045 used as a template argument.
2047 See also @option{-Wabi}.
2049 @item -fno-access-control
2050 @opindex fno-access-control
2051 Turn off all access checking.  This switch is mainly useful for working
2052 around bugs in the access control code.
2054 @item -fcheck-new
2055 @opindex fcheck-new
2056 Check that the pointer returned by @code{operator new} is non-null
2057 before attempting to modify the storage allocated.  This check is
2058 normally unnecessary because the C++ standard specifies that
2059 @code{operator new} only returns @code{0} if it is declared
2060 @samp{throw()}, in which case the compiler always checks the
2061 return value even without this option.  In all other cases, when
2062 @code{operator new} has a non-empty exception specification, memory
2063 exhaustion is signalled by throwing @code{std::bad_alloc}.  See also
2064 @samp{new (nothrow)}.
2066 @item -fconstexpr-depth=@var{n}
2067 @opindex fconstexpr-depth
2068 Set the maximum nested evaluation depth for C++11 constexpr functions
2069 to @var{n}.  A limit is needed to detect endless recursion during
2070 constant expression evaluation.  The minimum specified by the standard
2071 is 512.
2073 @item -fdeduce-init-list
2074 @opindex fdeduce-init-list
2075 Enable deduction of a template type parameter as
2076 @code{std::initializer_list} from a brace-enclosed initializer list, i.e.@:
2078 @smallexample
2079 template <class T> auto forward(T t) -> decltype (realfn (t))
2081   return realfn (t);
2084 void f()
2086   forward(@{1,2@}); // call forward<std::initializer_list<int>>
2088 @end smallexample
2090 This deduction was implemented as a possible extension to the
2091 originally proposed semantics for the C++11 standard, but was not part
2092 of the final standard, so it is disabled by default.  This option is
2093 deprecated, and may be removed in a future version of G++.
2095 @item -ffriend-injection
2096 @opindex ffriend-injection
2097 Inject friend functions into the enclosing namespace, so that they are
2098 visible outside the scope of the class in which they are declared.
2099 Friend functions were documented to work this way in the old Annotated
2100 C++ Reference Manual, and versions of G++ before 4.1 always worked
2101 that way.  However, in ISO C++ a friend function that is not declared
2102 in an enclosing scope can only be found using argument dependent
2103 lookup.  This option causes friends to be injected as they were in
2104 earlier releases.
2106 This option is for compatibility, and may be removed in a future
2107 release of G++.
2109 @item -fno-elide-constructors
2110 @opindex fno-elide-constructors
2111 The C++ standard allows an implementation to omit creating a temporary
2112 that is only used to initialize another object of the same type.
2113 Specifying this option disables that optimization, and forces G++ to
2114 call the copy constructor in all cases.
2116 @item -fno-enforce-eh-specs
2117 @opindex fno-enforce-eh-specs
2118 Don't generate code to check for violation of exception specifications
2119 at run time.  This option violates the C++ standard, but may be useful
2120 for reducing code size in production builds, much like defining
2121 @samp{NDEBUG}.  This does not give user code permission to throw
2122 exceptions in violation of the exception specifications; the compiler
2123 still optimizes based on the specifications, so throwing an
2124 unexpected exception results in undefined behavior at run time.
2126 @item -fextern-tls-init
2127 @itemx -fno-extern-tls-init
2128 @opindex fextern-tls-init
2129 @opindex fno-extern-tls-init
2130 The C++11 and OpenMP standards allow @samp{thread_local} and
2131 @samp{threadprivate} variables to have dynamic (runtime)
2132 initialization.  To support this, any use of such a variable goes
2133 through a wrapper function that performs any necessary initialization.
2134 When the use and definition of the variable are in the same
2135 translation unit, this overhead can be optimized away, but when the
2136 use is in a different translation unit there is significant overhead
2137 even if the variable doesn't actually need dynamic initialization.  If
2138 the programmer can be sure that no use of the variable in a
2139 non-defining TU needs to trigger dynamic initialization (either
2140 because the variable is statically initialized, or a use of the
2141 variable in the defining TU will be executed before any uses in
2142 another TU), they can avoid this overhead with the
2143 @option{-fno-extern-tls-init} option.
2145 On targets that support symbol aliases, the default is
2146 @option{-fextern-tls-init}.  On targets that do not support symbol
2147 aliases, the default is @option{-fno-extern-tls-init}.
2149 @item -ffor-scope
2150 @itemx -fno-for-scope
2151 @opindex ffor-scope
2152 @opindex fno-for-scope
2153 If @option{-ffor-scope} is specified, the scope of variables declared in
2154 a @i{for-init-statement} is limited to the @samp{for} loop itself,
2155 as specified by the C++ standard.
2156 If @option{-fno-for-scope} is specified, the scope of variables declared in
2157 a @i{for-init-statement} extends to the end of the enclosing scope,
2158 as was the case in old versions of G++, and other (traditional)
2159 implementations of C++.
2161 If neither flag is given, the default is to follow the standard,
2162 but to allow and give a warning for old-style code that would
2163 otherwise be invalid, or have different behavior.
2165 @item -fno-gnu-keywords
2166 @opindex fno-gnu-keywords
2167 Do not recognize @code{typeof} as a keyword, so that code can use this
2168 word as an identifier.  You can use the keyword @code{__typeof__} instead.
2169 @option{-ansi} implies @option{-fno-gnu-keywords}.
2171 @item -fno-implicit-templates
2172 @opindex fno-implicit-templates
2173 Never emit code for non-inline templates that are instantiated
2174 implicitly (i.e.@: by use); only emit code for explicit instantiations.
2175 @xref{Template Instantiation}, for more information.
2177 @item -fno-implicit-inline-templates
2178 @opindex fno-implicit-inline-templates
2179 Don't emit code for implicit instantiations of inline templates, either.
2180 The default is to handle inlines differently so that compiles with and
2181 without optimization need the same set of explicit instantiations.
2183 @item -fno-implement-inlines
2184 @opindex fno-implement-inlines
2185 To save space, do not emit out-of-line copies of inline functions
2186 controlled by @samp{#pragma implementation}.  This causes linker
2187 errors if these functions are not inlined everywhere they are called.
2189 @item -fms-extensions
2190 @opindex fms-extensions
2191 Disable Wpedantic warnings about constructs used in MFC, such as implicit
2192 int and getting a pointer to member function via non-standard syntax.
2194 @item -fno-nonansi-builtins
2195 @opindex fno-nonansi-builtins
2196 Disable built-in declarations of functions that are not mandated by
2197 ANSI/ISO C@.  These include @code{ffs}, @code{alloca}, @code{_exit},
2198 @code{index}, @code{bzero}, @code{conjf}, and other related functions.
2200 @item -fnothrow-opt
2201 @opindex fnothrow-opt
2202 Treat a @code{throw()} exception specification as if it were a
2203 @code{noexcept} specification to reduce or eliminate the text size
2204 overhead relative to a function with no exception specification.  If
2205 the function has local variables of types with non-trivial
2206 destructors, the exception specification actually makes the
2207 function smaller because the EH cleanups for those variables can be
2208 optimized away.  The semantic effect is that an exception thrown out of
2209 a function with such an exception specification results in a call
2210 to @code{terminate} rather than @code{unexpected}.
2212 @item -fno-operator-names
2213 @opindex fno-operator-names
2214 Do not treat the operator name keywords @code{and}, @code{bitand},
2215 @code{bitor}, @code{compl}, @code{not}, @code{or} and @code{xor} as
2216 synonyms as keywords.
2218 @item -fno-optional-diags
2219 @opindex fno-optional-diags
2220 Disable diagnostics that the standard says a compiler does not need to
2221 issue.  Currently, the only such diagnostic issued by G++ is the one for
2222 a name having multiple meanings within a class.
2224 @item -fpermissive
2225 @opindex fpermissive
2226 Downgrade some diagnostics about nonconformant code from errors to
2227 warnings.  Thus, using @option{-fpermissive} allows some
2228 nonconforming code to compile.
2230 @item -fno-pretty-templates
2231 @opindex fno-pretty-templates
2232 When an error message refers to a specialization of a function
2233 template, the compiler normally prints the signature of the
2234 template followed by the template arguments and any typedefs or
2235 typenames in the signature (e.g. @code{void f(T) [with T = int]}
2236 rather than @code{void f(int)}) so that it's clear which template is
2237 involved.  When an error message refers to a specialization of a class
2238 template, the compiler omits any template arguments that match
2239 the default template arguments for that template.  If either of these
2240 behaviors make it harder to understand the error message rather than
2241 easier, you can use @option{-fno-pretty-templates} to disable them.
2243 @item -frepo
2244 @opindex frepo
2245 Enable automatic template instantiation at link time.  This option also
2246 implies @option{-fno-implicit-templates}.  @xref{Template
2247 Instantiation}, for more information.
2249 @item -fno-rtti
2250 @opindex fno-rtti
2251 Disable generation of information about every class with virtual
2252 functions for use by the C++ run-time type identification features
2253 (@samp{dynamic_cast} and @samp{typeid}).  If you don't use those parts
2254 of the language, you can save some space by using this flag.  Note that
2255 exception handling uses the same information, but G++ generates it as
2256 needed. The @samp{dynamic_cast} operator can still be used for casts that
2257 do not require run-time type information, i.e.@: casts to @code{void *} or to
2258 unambiguous base classes.
2260 @item -fstats
2261 @opindex fstats
2262 Emit statistics about front-end processing at the end of the compilation.
2263 This information is generally only useful to the G++ development team.
2265 @item -fstrict-enums
2266 @opindex fstrict-enums
2267 Allow the compiler to optimize using the assumption that a value of
2268 enumerated type can only be one of the values of the enumeration (as
2269 defined in the C++ standard; basically, a value that can be
2270 represented in the minimum number of bits needed to represent all the
2271 enumerators).  This assumption may not be valid if the program uses a
2272 cast to convert an arbitrary integer value to the enumerated type.
2274 @item -ftemplate-backtrace-limit=@var{n}
2275 @opindex ftemplate-backtrace-limit
2276 Set the maximum number of template instantiation notes for a single
2277 warning or error to @var{n}.  The default value is 10.
2279 @item -ftemplate-depth=@var{n}
2280 @opindex ftemplate-depth
2281 Set the maximum instantiation depth for template classes to @var{n}.
2282 A limit on the template instantiation depth is needed to detect
2283 endless recursions during template class instantiation.  ANSI/ISO C++
2284 conforming programs must not rely on a maximum depth greater than 17
2285 (changed to 1024 in C++11).  The default value is 900, as the compiler
2286 can run out of stack space before hitting 1024 in some situations.
2288 @item -fno-threadsafe-statics
2289 @opindex fno-threadsafe-statics
2290 Do not emit the extra code to use the routines specified in the C++
2291 ABI for thread-safe initialization of local statics.  You can use this
2292 option to reduce code size slightly in code that doesn't need to be
2293 thread-safe.
2295 @item -fuse-cxa-atexit
2296 @opindex fuse-cxa-atexit
2297 Register destructors for objects with static storage duration with the
2298 @code{__cxa_atexit} function rather than the @code{atexit} function.
2299 This option is required for fully standards-compliant handling of static
2300 destructors, but only works if your C library supports
2301 @code{__cxa_atexit}.
2303 @item -fno-use-cxa-get-exception-ptr
2304 @opindex fno-use-cxa-get-exception-ptr
2305 Don't use the @code{__cxa_get_exception_ptr} runtime routine.  This
2306 causes @code{std::uncaught_exception} to be incorrect, but is necessary
2307 if the runtime routine is not available.
2309 @item -fvisibility-inlines-hidden
2310 @opindex fvisibility-inlines-hidden
2311 This switch declares that the user does not attempt to compare
2312 pointers to inline functions or methods where the addresses of the two functions
2313 are taken in different shared objects.
2315 The effect of this is that GCC may, effectively, mark inline methods with
2316 @code{__attribute__ ((visibility ("hidden")))} so that they do not
2317 appear in the export table of a DSO and do not require a PLT indirection
2318 when used within the DSO@.  Enabling this option can have a dramatic effect
2319 on load and link times of a DSO as it massively reduces the size of the
2320 dynamic export table when the library makes heavy use of templates.
2322 The behavior of this switch is not quite the same as marking the
2323 methods as hidden directly, because it does not affect static variables
2324 local to the function or cause the compiler to deduce that
2325 the function is defined in only one shared object.
2327 You may mark a method as having a visibility explicitly to negate the
2328 effect of the switch for that method.  For example, if you do want to
2329 compare pointers to a particular inline method, you might mark it as
2330 having default visibility.  Marking the enclosing class with explicit
2331 visibility has no effect.
2333 Explicitly instantiated inline methods are unaffected by this option
2334 as their linkage might otherwise cross a shared library boundary.
2335 @xref{Template Instantiation}.
2337 @item -fvisibility-ms-compat
2338 @opindex fvisibility-ms-compat
2339 This flag attempts to use visibility settings to make GCC's C++
2340 linkage model compatible with that of Microsoft Visual Studio.
2342 The flag makes these changes to GCC's linkage model:
2344 @enumerate
2345 @item
2346 It sets the default visibility to @code{hidden}, like
2347 @option{-fvisibility=hidden}.
2349 @item
2350 Types, but not their members, are not hidden by default.
2352 @item
2353 The One Definition Rule is relaxed for types without explicit
2354 visibility specifications that are defined in more than one
2355 shared object: those declarations are permitted if they are
2356 permitted when this option is not used.
2357 @end enumerate
2359 In new code it is better to use @option{-fvisibility=hidden} and
2360 export those classes that are intended to be externally visible.
2361 Unfortunately it is possible for code to rely, perhaps accidentally,
2362 on the Visual Studio behavior.
2364 Among the consequences of these changes are that static data members
2365 of the same type with the same name but defined in different shared
2366 objects are different, so changing one does not change the other;
2367 and that pointers to function members defined in different shared
2368 objects may not compare equal.  When this flag is given, it is a
2369 violation of the ODR to define types with the same name differently.
2371 @item -fvtable-verify=@var{std|preinit|none}
2372 @opindex fvtable-verify
2373 Turn on (or off, if using @option{-fvtable-verify=none}) the security
2374 feature that verifies at runtime, for every virtual call that is made, that
2375 the vtable pointer through which the call is made is valid for the type of
2376 the object, and has not been corrupted or overwritten.  If an invalid vtable
2377 pointer is detected (at runtime), an error is reported and execution of the
2378 program is immediately halted.
2380 This option causes runtime data structures to be built, at program start up,
2381 for verifying the vtable pointers.  The options @code{std} and @code{preinit}
2382 control the timing of when these data structures are built.  In both cases the
2383 data structures are built before execution reaches 'main'.  The
2384 @option{-fvtable-verify=std} causes these data structure to be built after the
2385 shared libraries have been loaded and initialized.
2386 @option{-fvtable-verify=preinit} causes them to be built before the shared
2387 libraries have been loaded and initialized.
2389 If this option appears multiple times in the compiler line, with different
2390 values specified, 'none' will take highest priority over both 'std' and
2391 'preinit'; 'preinit' will take priority over 'std'.
2393 @item -fvtv-debug
2394 @opindex (fvtv-debug)
2395 Causes debug versions of the runtime functions for the vtable verification 
2396 feature to be called.  This assumes the @option{-fvtable-verify=std} or
2397 @option{-fvtable-verify=preinit} has been used.  This flag will also cause the
2398 compiler to keep track of which vtable pointers it found for each class, and
2399 record that information in the file ``vtv_set_ptr_data.log'', in the dump
2400 file directory on the user's machine.
2402 Note:  This feature APPENDS data to the log file. If you want a fresh log
2403 file, be sure to delete any existing one.
2405 @item -fvtv-counts
2406 @opindex fvtv-counts
2407 This is a debugging flag.  When used in conjunction with
2408 @option{-fvtable-verify=std} or @option{-fvtable-verify=preinit}, this
2409 causes the compiler to keep track of the total number of virtual calls
2410 it encountered and the number of verifications it inserted.  It also
2411 counts the number of calls to certain runtime library functions
2412 that it inserts.  This information, for each compilation unit, is written
2413 to a file named ``vtv_count_data.log'', in the dump_file directory on
2414 the user's machine.   It also counts the size of the vtable pointer sets
2415 for each class, and writes this information to ``vtv_class_set_sizes.log''
2416 in the same directory.
2418 Note:  This feature APPENDS data to the log files.  To get a fresh log
2419 files, be sure to delete any existing ones.
2421 @item -fno-weak
2422 @opindex fno-weak
2423 Do not use weak symbol support, even if it is provided by the linker.
2424 By default, G++ uses weak symbols if they are available.  This
2425 option exists only for testing, and should not be used by end-users;
2426 it results in inferior code and has no benefits.  This option may
2427 be removed in a future release of G++.
2429 @item -nostdinc++
2430 @opindex nostdinc++
2431 Do not search for header files in the standard directories specific to
2432 C++, but do still search the other standard directories.  (This option
2433 is used when building the C++ library.)
2434 @end table
2436 In addition, these optimization, warning, and code generation options
2437 have meanings only for C++ programs:
2439 @table @gcctabopt
2440 @item -Wabi @r{(C, Objective-C, C++ and Objective-C++ only)}
2441 @opindex Wabi
2442 @opindex Wno-abi
2443 Warn when G++ generates code that is probably not compatible with the
2444 vendor-neutral C++ ABI@.  Although an effort has been made to warn about
2445 all such cases, there are probably some cases that are not warned about,
2446 even though G++ is generating incompatible code.  There may also be
2447 cases where warnings are emitted even though the code that is generated
2448 is compatible.
2450 You should rewrite your code to avoid these warnings if you are
2451 concerned about the fact that code generated by G++ may not be binary
2452 compatible with code generated by other compilers.
2454 The known incompatibilities in @option{-fabi-version=2} (the default) include:
2456 @itemize @bullet
2458 @item
2459 A template with a non-type template parameter of reference type is
2460 mangled incorrectly:
2461 @smallexample
2462 extern int N;
2463 template <int &> struct S @{@};
2464 void n (S<N>) @{2@}
2465 @end smallexample
2467 This is fixed in @option{-fabi-version=3}.
2469 @item
2470 SIMD vector types declared using @code{__attribute ((vector_size))} are
2471 mangled in a non-standard way that does not allow for overloading of
2472 functions taking vectors of different sizes.
2474 The mangling is changed in @option{-fabi-version=4}.
2475 @end itemize
2477 The known incompatibilities in @option{-fabi-version=1} include:
2479 @itemize @bullet
2481 @item
2482 Incorrect handling of tail-padding for bit-fields.  G++ may attempt to
2483 pack data into the same byte as a base class.  For example:
2485 @smallexample
2486 struct A @{ virtual void f(); int f1 : 1; @};
2487 struct B : public A @{ int f2 : 1; @};
2488 @end smallexample
2490 @noindent
2491 In this case, G++ places @code{B::f2} into the same byte
2492 as @code{A::f1}; other compilers do not.  You can avoid this problem
2493 by explicitly padding @code{A} so that its size is a multiple of the
2494 byte size on your platform; that causes G++ and other compilers to
2495 lay out @code{B} identically.
2497 @item
2498 Incorrect handling of tail-padding for virtual bases.  G++ does not use
2499 tail padding when laying out virtual bases.  For example:
2501 @smallexample
2502 struct A @{ virtual void f(); char c1; @};
2503 struct B @{ B(); char c2; @};
2504 struct C : public A, public virtual B @{@};
2505 @end smallexample
2507 @noindent
2508 In this case, G++ does not place @code{B} into the tail-padding for
2509 @code{A}; other compilers do.  You can avoid this problem by
2510 explicitly padding @code{A} so that its size is a multiple of its
2511 alignment (ignoring virtual base classes); that causes G++ and other
2512 compilers to lay out @code{C} identically.
2514 @item
2515 Incorrect handling of bit-fields with declared widths greater than that
2516 of their underlying types, when the bit-fields appear in a union.  For
2517 example:
2519 @smallexample
2520 union U @{ int i : 4096; @};
2521 @end smallexample
2523 @noindent
2524 Assuming that an @code{int} does not have 4096 bits, G++ makes the
2525 union too small by the number of bits in an @code{int}.
2527 @item
2528 Empty classes can be placed at incorrect offsets.  For example:
2530 @smallexample
2531 struct A @{@};
2533 struct B @{
2534   A a;
2535   virtual void f ();
2538 struct C : public B, public A @{@};
2539 @end smallexample
2541 @noindent
2542 G++ places the @code{A} base class of @code{C} at a nonzero offset;
2543 it should be placed at offset zero.  G++ mistakenly believes that the
2544 @code{A} data member of @code{B} is already at offset zero.
2546 @item
2547 Names of template functions whose types involve @code{typename} or
2548 template template parameters can be mangled incorrectly.
2550 @smallexample
2551 template <typename Q>
2552 void f(typename Q::X) @{@}
2554 template <template <typename> class Q>
2555 void f(typename Q<int>::X) @{@}
2556 @end smallexample
2558 @noindent
2559 Instantiations of these templates may be mangled incorrectly.
2561 @end itemize
2563 It also warns about psABI-related changes.  The known psABI changes at this
2564 point include:
2566 @itemize @bullet
2568 @item
2569 For SysV/x86-64, unions with @code{long double} members are 
2570 passed in memory as specified in psABI.  For example:
2572 @smallexample
2573 union U @{
2574   long double ld;
2575   int i;
2577 @end smallexample
2579 @noindent
2580 @code{union U} is always passed in memory.
2582 @end itemize
2584 @item -Wctor-dtor-privacy @r{(C++ and Objective-C++ only)}
2585 @opindex Wctor-dtor-privacy
2586 @opindex Wno-ctor-dtor-privacy
2587 Warn when a class seems unusable because all the constructors or
2588 destructors in that class are private, and it has neither friends nor
2589 public static member functions.  Also warn if there are no non-private
2590 methods, and there's at least one private member function that isn't
2591 a constructor or destructor.
2593 @item -Wdelete-non-virtual-dtor @r{(C++ and Objective-C++ only)}
2594 @opindex Wdelete-non-virtual-dtor
2595 @opindex Wno-delete-non-virtual-dtor
2596 Warn when @samp{delete} is used to destroy an instance of a class that
2597 has virtual functions and non-virtual destructor. It is unsafe to delete
2598 an instance of a derived class through a pointer to a base class if the
2599 base class does not have a virtual destructor.  This warning is enabled
2600 by @option{-Wall}.
2602 @item -Wliteral-suffix @r{(C++ and Objective-C++ only)}
2603 @opindex Wliteral-suffix
2604 @opindex Wno-literal-suffix
2605 Warn when a string or character literal is followed by a ud-suffix which does
2606 not begin with an underscore.  As a conforming extension, GCC treats such
2607 suffixes as separate preprocessing tokens in order to maintain backwards
2608 compatibility with code that uses formatting macros from @code{<inttypes.h>}.
2609 For example:
2611 @smallexample
2612 #define __STDC_FORMAT_MACROS
2613 #include <inttypes.h>
2614 #include <stdio.h>
2616 int main() @{
2617   int64_t i64 = 123;
2618   printf("My int64: %"PRId64"\n", i64);
2620 @end smallexample
2622 In this case, @code{PRId64} is treated as a separate preprocessing token.
2624 This warning is enabled by default.
2626 @item -Wnarrowing @r{(C++ and Objective-C++ only)}
2627 @opindex Wnarrowing
2628 @opindex Wno-narrowing
2629 Warn when a narrowing conversion prohibited by C++11 occurs within
2630 @samp{@{ @}}, e.g.
2632 @smallexample
2633 int i = @{ 2.2 @}; // error: narrowing from double to int
2634 @end smallexample
2636 This flag is included in @option{-Wall} and @option{-Wc++11-compat}.
2638 With @option{-std=c++11}, @option{-Wno-narrowing} suppresses the diagnostic
2639 required by the standard.  Note that this does not affect the meaning
2640 of well-formed code; narrowing conversions are still considered
2641 ill-formed in SFINAE context.
2643 @item -Wnoexcept @r{(C++ and Objective-C++ only)}
2644 @opindex Wnoexcept
2645 @opindex Wno-noexcept
2646 Warn when a noexcept-expression evaluates to false because of a call
2647 to a function that does not have a non-throwing exception
2648 specification (i.e. @samp{throw()} or @samp{noexcept}) but is known by
2649 the compiler to never throw an exception.
2651 @item -Wnon-virtual-dtor @r{(C++ and Objective-C++ only)}
2652 @opindex Wnon-virtual-dtor
2653 @opindex Wno-non-virtual-dtor
2654 Warn when a class has virtual functions and an accessible non-virtual
2655 destructor itself or in an accessible polymorphic base class, in which
2656 case it is possible but unsafe to delete an instance of a derived
2657 class through a pointer to the class itself or base class.  This
2658 warning is automatically enabled if @option{-Weffc++} is specified.
2660 @item -Wreorder @r{(C++ and Objective-C++ only)}
2661 @opindex Wreorder
2662 @opindex Wno-reorder
2663 @cindex reordering, warning
2664 @cindex warning for reordering of member initializers
2665 Warn when the order of member initializers given in the code does not
2666 match the order in which they must be executed.  For instance:
2668 @smallexample
2669 struct A @{
2670   int i;
2671   int j;
2672   A(): j (0), i (1) @{ @}
2674 @end smallexample
2676 @noindent
2677 The compiler rearranges the member initializers for @samp{i}
2678 and @samp{j} to match the declaration order of the members, emitting
2679 a warning to that effect.  This warning is enabled by @option{-Wall}.
2681 @item -fext-numeric-literals @r{(C++ and Objective-C++ only)}
2682 @opindex fext-numeric-literals
2683 @opindex fno-ext-numeric-literals
2684 Accept imaginary, fixed-point, or machine-defined
2685 literal number suffixes as GNU extensions.
2686 When this option is turned off these suffixes are treated
2687 as C++11 user-defined literal numeric suffixes.
2688 This is on by default for all pre-C++11 dialects and all GNU dialects:
2689 @option{-std=c++98}, @option{-std=gnu++98}, @option{-std=gnu++11},
2690 @option{-std=gnu++1y}.
2691 This option is off by default
2692 for ISO C++11 onwards (@option{-std=c++11}, ...).
2693 @end table
2695 The following @option{-W@dots{}} options are not affected by @option{-Wall}.
2697 @table @gcctabopt
2698 @item -Weffc++ @r{(C++ and Objective-C++ only)}
2699 @opindex Weffc++
2700 @opindex Wno-effc++
2701 Warn about violations of the following style guidelines from Scott Meyers'
2702 @cite{Effective C++} series of books:
2704 @itemize @bullet
2705 @item
2706 Define a copy constructor and an assignment operator for classes
2707 with dynamically-allocated memory.
2709 @item
2710 Prefer initialization to assignment in constructors.
2712 @item
2713 Have @code{operator=} return a reference to @code{*this}.
2715 @item
2716 Don't try to return a reference when you must return an object.
2718 @item
2719 Distinguish between prefix and postfix forms of increment and
2720 decrement operators.
2722 @item
2723 Never overload @code{&&}, @code{||}, or @code{,}.
2725 @end itemize
2727 This option also enables @option{-Wnon-virtual-dtor}, which is also
2728 one of the effective C++ recommendations.  However, the check is
2729 extended to warn about the lack of virtual destructor in accessible
2730 non-polymorphic bases classes too.
2732 When selecting this option, be aware that the standard library
2733 headers do not obey all of these guidelines; use @samp{grep -v}
2734 to filter out those warnings.
2736 @item -Wstrict-null-sentinel @r{(C++ and Objective-C++ only)}
2737 @opindex Wstrict-null-sentinel
2738 @opindex Wno-strict-null-sentinel
2739 Warn about the use of an uncasted @code{NULL} as sentinel.  When
2740 compiling only with GCC this is a valid sentinel, as @code{NULL} is defined
2741 to @code{__null}.  Although it is a null pointer constant rather than a
2742 null pointer, it is guaranteed to be of the same size as a pointer.
2743 But this use is not portable across different compilers.
2745 @item -Wno-non-template-friend @r{(C++ and Objective-C++ only)}
2746 @opindex Wno-non-template-friend
2747 @opindex Wnon-template-friend
2748 Disable warnings when non-templatized friend functions are declared
2749 within a template.  Since the advent of explicit template specification
2750 support in G++, if the name of the friend is an unqualified-id (i.e.,
2751 @samp{friend foo(int)}), the C++ language specification demands that the
2752 friend declare or define an ordinary, nontemplate function.  (Section
2753 14.5.3).  Before G++ implemented explicit specification, unqualified-ids
2754 could be interpreted as a particular specialization of a templatized
2755 function.  Because this non-conforming behavior is no longer the default
2756 behavior for G++, @option{-Wnon-template-friend} allows the compiler to
2757 check existing code for potential trouble spots and is on by default.
2758 This new compiler behavior can be turned off with
2759 @option{-Wno-non-template-friend}, which keeps the conformant compiler code
2760 but disables the helpful warning.
2762 @item -Wold-style-cast @r{(C++ and Objective-C++ only)}
2763 @opindex Wold-style-cast
2764 @opindex Wno-old-style-cast
2765 Warn if an old-style (C-style) cast to a non-void type is used within
2766 a C++ program.  The new-style casts (@samp{dynamic_cast},
2767 @samp{static_cast}, @samp{reinterpret_cast}, and @samp{const_cast}) are
2768 less vulnerable to unintended effects and much easier to search for.
2770 @item -Woverloaded-virtual @r{(C++ and Objective-C++ only)}
2771 @opindex Woverloaded-virtual
2772 @opindex Wno-overloaded-virtual
2773 @cindex overloaded virtual function, warning
2774 @cindex warning for overloaded virtual function
2775 Warn when a function declaration hides virtual functions from a
2776 base class.  For example, in:
2778 @smallexample
2779 struct A @{
2780   virtual void f();
2783 struct B: public A @{
2784   void f(int);
2786 @end smallexample
2788 the @code{A} class version of @code{f} is hidden in @code{B}, and code
2789 like:
2791 @smallexample
2792 B* b;
2793 b->f();
2794 @end smallexample
2796 @noindent
2797 fails to compile.
2799 @item -Wno-pmf-conversions @r{(C++ and Objective-C++ only)}
2800 @opindex Wno-pmf-conversions
2801 @opindex Wpmf-conversions
2802 Disable the diagnostic for converting a bound pointer to member function
2803 to a plain pointer.
2805 @item -Wsign-promo @r{(C++ and Objective-C++ only)}
2806 @opindex Wsign-promo
2807 @opindex Wno-sign-promo
2808 Warn when overload resolution chooses a promotion from unsigned or
2809 enumerated type to a signed type, over a conversion to an unsigned type of
2810 the same size.  Previous versions of G++ tried to preserve
2811 unsignedness, but the standard mandates the current behavior.
2812 @end table
2814 @node Objective-C and Objective-C++ Dialect Options
2815 @section Options Controlling Objective-C and Objective-C++ Dialects
2817 @cindex compiler options, Objective-C and Objective-C++
2818 @cindex Objective-C and Objective-C++ options, command-line
2819 @cindex options, Objective-C and Objective-C++
2820 (NOTE: This manual does not describe the Objective-C and Objective-C++
2821 languages themselves.  @xref{Standards,,Language Standards
2822 Supported by GCC}, for references.)
2824 This section describes the command-line options that are only meaningful
2825 for Objective-C and Objective-C++ programs.  You can also use most of
2826 the language-independent GNU compiler options.
2827 For example, you might compile a file @code{some_class.m} like this:
2829 @smallexample
2830 gcc -g -fgnu-runtime -O -c some_class.m
2831 @end smallexample
2833 @noindent
2834 In this example, @option{-fgnu-runtime} is an option meant only for
2835 Objective-C and Objective-C++ programs; you can use the other options with
2836 any language supported by GCC@.
2838 Note that since Objective-C is an extension of the C language, Objective-C
2839 compilations may also use options specific to the C front-end (e.g.,
2840 @option{-Wtraditional}).  Similarly, Objective-C++ compilations may use
2841 C++-specific options (e.g., @option{-Wabi}).
2843 Here is a list of options that are @emph{only} for compiling Objective-C
2844 and Objective-C++ programs:
2846 @table @gcctabopt
2847 @item -fconstant-string-class=@var{class-name}
2848 @opindex fconstant-string-class
2849 Use @var{class-name} as the name of the class to instantiate for each
2850 literal string specified with the syntax @code{@@"@dots{}"}.  The default
2851 class name is @code{NXConstantString} if the GNU runtime is being used, and
2852 @code{NSConstantString} if the NeXT runtime is being used (see below).  The
2853 @option{-fconstant-cfstrings} option, if also present, overrides the
2854 @option{-fconstant-string-class} setting and cause @code{@@"@dots{}"} literals
2855 to be laid out as constant CoreFoundation strings.
2857 @item -fgnu-runtime
2858 @opindex fgnu-runtime
2859 Generate object code compatible with the standard GNU Objective-C
2860 runtime.  This is the default for most types of systems.
2862 @item -fnext-runtime
2863 @opindex fnext-runtime
2864 Generate output compatible with the NeXT runtime.  This is the default
2865 for NeXT-based systems, including Darwin and Mac OS X@.  The macro
2866 @code{__NEXT_RUNTIME__} is predefined if (and only if) this option is
2867 used.
2869 @item -fno-nil-receivers
2870 @opindex fno-nil-receivers
2871 Assume that all Objective-C message dispatches (@code{[receiver
2872 message:arg]}) in this translation unit ensure that the receiver is
2873 not @code{nil}.  This allows for more efficient entry points in the
2874 runtime to be used.  This option is only available in conjunction with
2875 the NeXT runtime and ABI version 0 or 1.
2877 @item -fobjc-abi-version=@var{n}
2878 @opindex fobjc-abi-version
2879 Use version @var{n} of the Objective-C ABI for the selected runtime.
2880 This option is currently supported only for the NeXT runtime.  In that
2881 case, Version 0 is the traditional (32-bit) ABI without support for
2882 properties and other Objective-C 2.0 additions.  Version 1 is the
2883 traditional (32-bit) ABI with support for properties and other
2884 Objective-C 2.0 additions.  Version 2 is the modern (64-bit) ABI.  If
2885 nothing is specified, the default is Version 0 on 32-bit target
2886 machines, and Version 2 on 64-bit target machines.
2888 @item -fobjc-call-cxx-cdtors
2889 @opindex fobjc-call-cxx-cdtors
2890 For each Objective-C class, check if any of its instance variables is a
2891 C++ object with a non-trivial default constructor.  If so, synthesize a
2892 special @code{- (id) .cxx_construct} instance method which runs
2893 non-trivial default constructors on any such instance variables, in order,
2894 and then return @code{self}.  Similarly, check if any instance variable
2895 is a C++ object with a non-trivial destructor, and if so, synthesize a
2896 special @code{- (void) .cxx_destruct} method which runs
2897 all such default destructors, in reverse order.
2899 The @code{- (id) .cxx_construct} and @code{- (void) .cxx_destruct}
2900 methods thusly generated only operate on instance variables
2901 declared in the current Objective-C class, and not those inherited
2902 from superclasses.  It is the responsibility of the Objective-C
2903 runtime to invoke all such methods in an object's inheritance
2904 hierarchy.  The @code{- (id) .cxx_construct} methods are invoked
2905 by the runtime immediately after a new object instance is allocated;
2906 the @code{- (void) .cxx_destruct} methods are invoked immediately
2907 before the runtime deallocates an object instance.
2909 As of this writing, only the NeXT runtime on Mac OS X 10.4 and later has
2910 support for invoking the @code{- (id) .cxx_construct} and
2911 @code{- (void) .cxx_destruct} methods.
2913 @item -fobjc-direct-dispatch
2914 @opindex fobjc-direct-dispatch
2915 Allow fast jumps to the message dispatcher.  On Darwin this is
2916 accomplished via the comm page.
2918 @item -fobjc-exceptions
2919 @opindex fobjc-exceptions
2920 Enable syntactic support for structured exception handling in
2921 Objective-C, similar to what is offered by C++ and Java.  This option
2922 is required to use the Objective-C keywords @code{@@try},
2923 @code{@@throw}, @code{@@catch}, @code{@@finally} and
2924 @code{@@synchronized}.  This option is available with both the GNU
2925 runtime and the NeXT runtime (but not available in conjunction with
2926 the NeXT runtime on Mac OS X 10.2 and earlier).
2928 @item -fobjc-gc
2929 @opindex fobjc-gc
2930 Enable garbage collection (GC) in Objective-C and Objective-C++
2931 programs.  This option is only available with the NeXT runtime; the
2932 GNU runtime has a different garbage collection implementation that
2933 does not require special compiler flags.
2935 @item -fobjc-nilcheck
2936 @opindex fobjc-nilcheck
2937 For the NeXT runtime with version 2 of the ABI, check for a nil
2938 receiver in method invocations before doing the actual method call.
2939 This is the default and can be disabled using
2940 @option{-fno-objc-nilcheck}.  Class methods and super calls are never
2941 checked for nil in this way no matter what this flag is set to.
2942 Currently this flag does nothing when the GNU runtime, or an older
2943 version of the NeXT runtime ABI, is used.
2945 @item -fobjc-std=objc1
2946 @opindex fobjc-std
2947 Conform to the language syntax of Objective-C 1.0, the language
2948 recognized by GCC 4.0.  This only affects the Objective-C additions to
2949 the C/C++ language; it does not affect conformance to C/C++ standards,
2950 which is controlled by the separate C/C++ dialect option flags.  When
2951 this option is used with the Objective-C or Objective-C++ compiler,
2952 any Objective-C syntax that is not recognized by GCC 4.0 is rejected.
2953 This is useful if you need to make sure that your Objective-C code can
2954 be compiled with older versions of GCC@.
2956 @item -freplace-objc-classes
2957 @opindex freplace-objc-classes
2958 Emit a special marker instructing @command{ld(1)} not to statically link in
2959 the resulting object file, and allow @command{dyld(1)} to load it in at
2960 run time instead.  This is used in conjunction with the Fix-and-Continue
2961 debugging mode, where the object file in question may be recompiled and
2962 dynamically reloaded in the course of program execution, without the need
2963 to restart the program itself.  Currently, Fix-and-Continue functionality
2964 is only available in conjunction with the NeXT runtime on Mac OS X 10.3
2965 and later.
2967 @item -fzero-link
2968 @opindex fzero-link
2969 When compiling for the NeXT runtime, the compiler ordinarily replaces calls
2970 to @code{objc_getClass("@dots{}")} (when the name of the class is known at
2971 compile time) with static class references that get initialized at load time,
2972 which improves run-time performance.  Specifying the @option{-fzero-link} flag
2973 suppresses this behavior and causes calls to @code{objc_getClass("@dots{}")}
2974 to be retained.  This is useful in Zero-Link debugging mode, since it allows
2975 for individual class implementations to be modified during program execution.
2976 The GNU runtime currently always retains calls to @code{objc_get_class("@dots{}")}
2977 regardless of command-line options.
2979 @item -gen-decls
2980 @opindex gen-decls
2981 Dump interface declarations for all classes seen in the source file to a
2982 file named @file{@var{sourcename}.decl}.
2984 @item -Wassign-intercept @r{(Objective-C and Objective-C++ only)}
2985 @opindex Wassign-intercept
2986 @opindex Wno-assign-intercept
2987 Warn whenever an Objective-C assignment is being intercepted by the
2988 garbage collector.
2990 @item -Wno-protocol @r{(Objective-C and Objective-C++ only)}
2991 @opindex Wno-protocol
2992 @opindex Wprotocol
2993 If a class is declared to implement a protocol, a warning is issued for
2994 every method in the protocol that is not implemented by the class.  The
2995 default behavior is to issue a warning for every method not explicitly
2996 implemented in the class, even if a method implementation is inherited
2997 from the superclass.  If you use the @option{-Wno-protocol} option, then
2998 methods inherited from the superclass are considered to be implemented,
2999 and no warning is issued for them.
3001 @item -Wselector @r{(Objective-C and Objective-C++ only)}
3002 @opindex Wselector
3003 @opindex Wno-selector
3004 Warn if multiple methods of different types for the same selector are
3005 found during compilation.  The check is performed on the list of methods
3006 in the final stage of compilation.  Additionally, a check is performed
3007 for each selector appearing in a @code{@@selector(@dots{})}
3008 expression, and a corresponding method for that selector has been found
3009 during compilation.  Because these checks scan the method table only at
3010 the end of compilation, these warnings are not produced if the final
3011 stage of compilation is not reached, for example because an error is
3012 found during compilation, or because the @option{-fsyntax-only} option is
3013 being used.
3015 @item -Wstrict-selector-match @r{(Objective-C and Objective-C++ only)}
3016 @opindex Wstrict-selector-match
3017 @opindex Wno-strict-selector-match
3018 Warn if multiple methods with differing argument and/or return types are
3019 found for a given selector when attempting to send a message using this
3020 selector to a receiver of type @code{id} or @code{Class}.  When this flag
3021 is off (which is the default behavior), the compiler omits such warnings
3022 if any differences found are confined to types that share the same size
3023 and alignment.
3025 @item -Wundeclared-selector @r{(Objective-C and Objective-C++ only)}
3026 @opindex Wundeclared-selector
3027 @opindex Wno-undeclared-selector
3028 Warn if a @code{@@selector(@dots{})} expression referring to an
3029 undeclared selector is found.  A selector is considered undeclared if no
3030 method with that name has been declared before the
3031 @code{@@selector(@dots{})} expression, either explicitly in an
3032 @code{@@interface} or @code{@@protocol} declaration, or implicitly in
3033 an @code{@@implementation} section.  This option always performs its
3034 checks as soon as a @code{@@selector(@dots{})} expression is found,
3035 while @option{-Wselector} only performs its checks in the final stage of
3036 compilation.  This also enforces the coding style convention
3037 that methods and selectors must be declared before being used.
3039 @item -print-objc-runtime-info
3040 @opindex print-objc-runtime-info
3041 Generate C header describing the largest structure that is passed by
3042 value, if any.
3044 @end table
3046 @node Language Independent Options
3047 @section Options to Control Diagnostic Messages Formatting
3048 @cindex options to control diagnostics formatting
3049 @cindex diagnostic messages
3050 @cindex message formatting
3052 Traditionally, diagnostic messages have been formatted irrespective of
3053 the output device's aspect (e.g.@: its width, @dots{}).  You can use the
3054 options described below
3055 to control the formatting algorithm for diagnostic messages, 
3056 e.g.@: how many characters per line, how often source location
3057 information should be reported.  Note that some language front ends may not
3058 honor these options.
3060 @table @gcctabopt
3061 @item -fmessage-length=@var{n}
3062 @opindex fmessage-length
3063 Try to format error messages so that they fit on lines of about @var{n}
3064 characters.  The default is 72 characters for @command{g++} and 0 for the rest of
3065 the front ends supported by GCC@.  If @var{n} is zero, then no
3066 line-wrapping is done; each error message appears on a single
3067 line.
3069 @item -fdiagnostics-show-location=once
3070 @opindex fdiagnostics-show-location
3071 Only meaningful in line-wrapping mode.  Instructs the diagnostic messages
3072 reporter to emit source location information @emph{once}; that is, in
3073 case the message is too long to fit on a single physical line and has to
3074 be wrapped, the source location won't be emitted (as prefix) again,
3075 over and over, in subsequent continuation lines.  This is the default
3076 behavior.
3078 @item -fdiagnostics-show-location=every-line
3079 Only meaningful in line-wrapping mode.  Instructs the diagnostic
3080 messages reporter to emit the same source location information (as
3081 prefix) for physical lines that result from the process of breaking
3082 a message which is too long to fit on a single line.
3084 @item -fdiagnostics-color[=@var{WHEN}]
3085 @itemx -fno-diagnostics-color
3086 @opindex fdiagnostics-color
3087 @cindex highlight, color, colour
3088 @vindex GCC_COLORS @r{environment variable}
3089 Use color in diagnostics.  @var{WHEN} is @samp{never}, @samp{always},
3090 or @samp{auto}.  The default is @samp{never} if @env{GCC_COLORS} environment
3091 variable isn't present in the environment, and @samp{auto} otherwise.
3092 @samp{auto} means to use color only when the standard error is a terminal.
3093 The forms @option{-fdiagnostics-color} and @option{-fno-diagnostics-color} are
3094 aliases for @option{-fdiagnostics-color=always} and
3095 @option{-fdiagnostics-color=never}, respectively.
3097 The colors are defined by the environment variable @env{GCC_COLORS}.
3098 Its value is a colon-separated list of capabilities and Select Graphic
3099 Rendition (SGR) substrings. SGR commands are interpreted by the
3100 terminal or terminal emulator.  (See the section in the documentation
3101 of your text terminal for permitted values and their meanings as
3102 character attributes.)  These substring values are integers in decimal
3103 representation and can be concatenated with semicolons.
3104 Common values to concatenate include
3105 @samp{1} for bold,
3106 @samp{4} for underline,
3107 @samp{5} for blink,
3108 @samp{7} for inverse,
3109 @samp{39} for default foreground color,
3110 @samp{30} to @samp{37} for foreground colors,
3111 @samp{90} to @samp{97} for 16-color mode foreground colors,
3112 @samp{38;5;0} to @samp{38;5;255}
3113 for 88-color and 256-color modes foreground colors,
3114 @samp{49} for default background color,
3115 @samp{40} to @samp{47} for background colors,
3116 @samp{100} to @samp{107} for 16-color mode background colors,
3117 and @samp{48;5;0} to @samp{48;5;255}
3118 for 88-color and 256-color modes background colors.
3120 The default @env{GCC_COLORS} is
3121 @samp{error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01}
3122 where @samp{01;31} is bold red, @samp{01;35} is bold magenta,
3123 @samp{01;36} is bold cyan, @samp{01;32} is bold green and
3124 @samp{01} is bold. Setting @env{GCC_COLORS} to the empty
3125 string disables colors.
3126 Supported capabilities are as follows.
3128 @table @code
3129 @item error=
3130 @vindex error GCC_COLORS @r{capability}
3131 SGR substring for error: markers.
3133 @item warning=
3134 @vindex warning GCC_COLORS @r{capability}
3135 SGR substring for warning: markers.
3137 @item note=
3138 @vindex note GCC_COLORS @r{capability}
3139 SGR substring for note: markers.
3141 @item caret=
3142 @vindex caret GCC_COLORS @r{capability}
3143 SGR substring for caret line.
3145 @item locus=
3146 @vindex locus GCC_COLORS @r{capability}
3147 SGR substring for location information, @samp{file:line} or
3148 @samp{file:line:column} etc.
3150 @item quote=
3151 @vindex quote GCC_COLORS @r{capability}
3152 SGR substring for information printed within quotes.
3153 @end table
3155 @item -fno-diagnostics-show-option
3156 @opindex fno-diagnostics-show-option
3157 @opindex fdiagnostics-show-option
3158 By default, each diagnostic emitted includes text indicating the
3159 command-line option that directly controls the diagnostic (if such an
3160 option is known to the diagnostic machinery).  Specifying the
3161 @option{-fno-diagnostics-show-option} flag suppresses that behavior.
3163 @item -fno-diagnostics-show-caret
3164 @opindex fno-diagnostics-show-caret
3165 @opindex fdiagnostics-show-caret
3166 By default, each diagnostic emitted includes the original source line
3167 and a caret '^' indicating the column.  This option suppresses this
3168 information.
3170 @end table
3172 @node Warning Options
3173 @section Options to Request or Suppress Warnings
3174 @cindex options to control warnings
3175 @cindex warning messages
3176 @cindex messages, warning
3177 @cindex suppressing warnings
3179 Warnings are diagnostic messages that report constructions that
3180 are not inherently erroneous but that are risky or suggest there
3181 may have been an error.
3183 The following language-independent options do not enable specific
3184 warnings but control the kinds of diagnostics produced by GCC@.
3186 @table @gcctabopt
3187 @cindex syntax checking
3188 @item -fsyntax-only
3189 @opindex fsyntax-only
3190 Check the code for syntax errors, but don't do anything beyond that.
3192 @item -fmax-errors=@var{n}
3193 @opindex fmax-errors
3194 Limits the maximum number of error messages to @var{n}, at which point
3195 GCC bails out rather than attempting to continue processing the source
3196 code.  If @var{n} is 0 (the default), there is no limit on the number
3197 of error messages produced.  If @option{-Wfatal-errors} is also
3198 specified, then @option{-Wfatal-errors} takes precedence over this
3199 option.
3201 @item -w
3202 @opindex w
3203 Inhibit all warning messages.
3205 @item -Werror
3206 @opindex Werror
3207 @opindex Wno-error
3208 Make all warnings into errors.
3210 @item -Werror=
3211 @opindex Werror=
3212 @opindex Wno-error=
3213 Make the specified warning into an error.  The specifier for a warning
3214 is appended; for example @option{-Werror=switch} turns the warnings
3215 controlled by @option{-Wswitch} into errors.  This switch takes a
3216 negative form, to be used to negate @option{-Werror} for specific
3217 warnings; for example @option{-Wno-error=switch} makes
3218 @option{-Wswitch} warnings not be errors, even when @option{-Werror}
3219 is in effect.
3221 The warning message for each controllable warning includes the
3222 option that controls the warning.  That option can then be used with
3223 @option{-Werror=} and @option{-Wno-error=} as described above.
3224 (Printing of the option in the warning message can be disabled using the
3225 @option{-fno-diagnostics-show-option} flag.)
3227 Note that specifying @option{-Werror=}@var{foo} automatically implies
3228 @option{-W}@var{foo}.  However, @option{-Wno-error=}@var{foo} does not
3229 imply anything.
3231 @item -Wfatal-errors
3232 @opindex Wfatal-errors
3233 @opindex Wno-fatal-errors
3234 This option causes the compiler to abort compilation on the first error
3235 occurred rather than trying to keep going and printing further error
3236 messages.
3238 @end table
3240 You can request many specific warnings with options beginning with
3241 @samp{-W}, for example @option{-Wimplicit} to request warnings on
3242 implicit declarations.  Each of these specific warning options also
3243 has a negative form beginning @samp{-Wno-} to turn off warnings; for
3244 example, @option{-Wno-implicit}.  This manual lists only one of the
3245 two forms, whichever is not the default.  For further
3246 language-specific options also refer to @ref{C++ Dialect Options} and
3247 @ref{Objective-C and Objective-C++ Dialect Options}.
3249 When an unrecognized warning option is requested (e.g.,
3250 @option{-Wunknown-warning}), GCC emits a diagnostic stating
3251 that the option is not recognized.  However, if the @option{-Wno-} form
3252 is used, the behavior is slightly different: no diagnostic is
3253 produced for @option{-Wno-unknown-warning} unless other diagnostics
3254 are being produced.  This allows the use of new @option{-Wno-} options
3255 with old compilers, but if something goes wrong, the compiler
3256 warns that an unrecognized option is present.
3258 @table @gcctabopt
3259 @item -Wpedantic
3260 @itemx -pedantic
3261 @opindex pedantic
3262 @opindex Wpedantic
3263 Issue all the warnings demanded by strict ISO C and ISO C++;
3264 reject all programs that use forbidden extensions, and some other
3265 programs that do not follow ISO C and ISO C++.  For ISO C, follows the
3266 version of the ISO C standard specified by any @option{-std} option used.
3268 Valid ISO C and ISO C++ programs should compile properly with or without
3269 this option (though a rare few require @option{-ansi} or a
3270 @option{-std} option specifying the required version of ISO C)@.  However,
3271 without this option, certain GNU extensions and traditional C and C++
3272 features are supported as well.  With this option, they are rejected.
3274 @option{-Wpedantic} does not cause warning messages for use of the
3275 alternate keywords whose names begin and end with @samp{__}.  Pedantic
3276 warnings are also disabled in the expression that follows
3277 @code{__extension__}.  However, only system header files should use
3278 these escape routes; application programs should avoid them.
3279 @xref{Alternate Keywords}.
3281 Some users try to use @option{-Wpedantic} to check programs for strict ISO
3282 C conformance.  They soon find that it does not do quite what they want:
3283 it finds some non-ISO practices, but not all---only those for which
3284 ISO C @emph{requires} a diagnostic, and some others for which
3285 diagnostics have been added.
3287 A feature to report any failure to conform to ISO C might be useful in
3288 some instances, but would require considerable additional work and would
3289 be quite different from @option{-Wpedantic}.  We don't have plans to
3290 support such a feature in the near future.
3292 Where the standard specified with @option{-std} represents a GNU
3293 extended dialect of C, such as @samp{gnu90} or @samp{gnu99}, there is a
3294 corresponding @dfn{base standard}, the version of ISO C on which the GNU
3295 extended dialect is based.  Warnings from @option{-Wpedantic} are given
3296 where they are required by the base standard.  (It does not make sense
3297 for such warnings to be given only for features not in the specified GNU
3298 C dialect, since by definition the GNU dialects of C include all
3299 features the compiler supports with the given option, and there would be
3300 nothing to warn about.)
3302 @item -pedantic-errors
3303 @opindex pedantic-errors
3304 Like @option{-Wpedantic}, except that errors are produced rather than
3305 warnings.
3307 @item -Wall
3308 @opindex Wall
3309 @opindex Wno-all
3310 This enables all the warnings about constructions that some users
3311 consider questionable, and that are easy to avoid (or modify to
3312 prevent the warning), even in conjunction with macros.  This also
3313 enables some language-specific warnings described in @ref{C++ Dialect
3314 Options} and @ref{Objective-C and Objective-C++ Dialect Options}.
3316 @option{-Wall} turns on the following warning flags:
3318 @gccoptlist{-Waddress   @gol
3319 -Warray-bounds @r{(only with} @option{-O2}@r{)}  @gol
3320 -Wc++11-compat  @gol
3321 -Wchar-subscripts  @gol
3322 -Wenum-compare @r{(in C/ObjC; this is on by default in C++)} @gol
3323 -Wimplicit-int @r{(C and Objective-C only)} @gol
3324 -Wimplicit-function-declaration @r{(C and Objective-C only)} @gol
3325 -Wcomment  @gol
3326 -Wformat   @gol
3327 -Wmain @r{(only for C/ObjC and unless} @option{-ffreestanding}@r{)}  @gol
3328 -Wmaybe-uninitialized @gol
3329 -Wmissing-braces @r{(only for C/ObjC)} @gol
3330 -Wnonnull  @gol
3331 -Wopenmp-simd @gol
3332 -Wparentheses  @gol
3333 -Wpointer-sign  @gol
3334 -Wreorder   @gol
3335 -Wreturn-type  @gol
3336 -Wsequence-point  @gol
3337 -Wsign-compare @r{(only in C++)}  @gol
3338 -Wstrict-aliasing  @gol
3339 -Wstrict-overflow=1  @gol
3340 -Wswitch  @gol
3341 -Wtrigraphs  @gol
3342 -Wuninitialized  @gol
3343 -Wunknown-pragmas  @gol
3344 -Wunused-function  @gol
3345 -Wunused-label     @gol
3346 -Wunused-value     @gol
3347 -Wunused-variable  @gol
3348 -Wvolatile-register-var @gol
3351 Note that some warning flags are not implied by @option{-Wall}.  Some of
3352 them warn about constructions that users generally do not consider
3353 questionable, but which occasionally you might wish to check for;
3354 others warn about constructions that are necessary or hard to avoid in
3355 some cases, and there is no simple way to modify the code to suppress
3356 the warning. Some of them are enabled by @option{-Wextra} but many of
3357 them must be enabled individually.
3359 @item -Wextra
3360 @opindex W
3361 @opindex Wextra
3362 @opindex Wno-extra
3363 This enables some extra warning flags that are not enabled by
3364 @option{-Wall}. (This option used to be called @option{-W}.  The older
3365 name is still supported, but the newer name is more descriptive.)
3367 @gccoptlist{-Wclobbered  @gol
3368 -Wempty-body  @gol
3369 -Wignored-qualifiers @gol
3370 -Wmissing-field-initializers  @gol
3371 -Wmissing-parameter-type @r{(C only)}  @gol
3372 -Wold-style-declaration @r{(C only)}  @gol
3373 -Woverride-init  @gol
3374 -Wsign-compare  @gol
3375 -Wtype-limits  @gol
3376 -Wuninitialized  @gol
3377 -Wunused-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)} @gol
3378 -Wunused-but-set-parameter @r{(only with} @option{-Wunused} @r{or} @option{-Wall}@r{)}  @gol
3381 The option @option{-Wextra} also prints warning messages for the
3382 following cases:
3384 @itemize @bullet
3386 @item
3387 A pointer is compared against integer zero with @samp{<}, @samp{<=},
3388 @samp{>}, or @samp{>=}.
3390 @item
3391 (C++ only) An enumerator and a non-enumerator both appear in a
3392 conditional expression.
3394 @item
3395 (C++ only) Ambiguous virtual bases.
3397 @item
3398 (C++ only) Subscripting an array that has been declared @samp{register}.
3400 @item
3401 (C++ only) Taking the address of a variable that has been declared
3402 @samp{register}.
3404 @item
3405 (C++ only) A base class is not initialized in a derived class's copy
3406 constructor.
3408 @end itemize
3410 @item -Wchar-subscripts
3411 @opindex Wchar-subscripts
3412 @opindex Wno-char-subscripts
3413 Warn if an array subscript has type @code{char}.  This is a common cause
3414 of error, as programmers often forget that this type is signed on some
3415 machines.
3416 This warning is enabled by @option{-Wall}.
3418 @item -Wcomment
3419 @opindex Wcomment
3420 @opindex Wno-comment
3421 Warn whenever a comment-start sequence @samp{/*} appears in a @samp{/*}
3422 comment, or whenever a Backslash-Newline appears in a @samp{//} comment.
3423 This warning is enabled by @option{-Wall}.
3425 @item -Wno-coverage-mismatch
3426 @opindex Wno-coverage-mismatch
3427 Warn if feedback profiles do not match when using the
3428 @option{-fprofile-use} option.
3429 If a source file is changed between compiling with @option{-fprofile-gen} and
3430 with @option{-fprofile-use}, the files with the profile feedback can fail
3431 to match the source file and GCC cannot use the profile feedback
3432 information.  By default, this warning is enabled and is treated as an
3433 error.  @option{-Wno-coverage-mismatch} can be used to disable the
3434 warning or @option{-Wno-error=coverage-mismatch} can be used to
3435 disable the error.  Disabling the error for this warning can result in
3436 poorly optimized code and is useful only in the
3437 case of very minor changes such as bug fixes to an existing code-base.
3438 Completely disabling the warning is not recommended.
3440 @item -Wno-cpp
3441 @r{(C, Objective-C, C++, Objective-C++ and Fortran only)}
3443 Suppress warning messages emitted by @code{#warning} directives.
3445 @item -Wdouble-promotion @r{(C, C++, Objective-C and Objective-C++ only)}
3446 @opindex Wdouble-promotion
3447 @opindex Wno-double-promotion
3448 Give a warning when a value of type @code{float} is implicitly
3449 promoted to @code{double}.  CPUs with a 32-bit ``single-precision''
3450 floating-point unit implement @code{float} in hardware, but emulate
3451 @code{double} in software.  On such a machine, doing computations
3452 using @code{double} values is much more expensive because of the
3453 overhead required for software emulation.
3455 It is easy to accidentally do computations with @code{double} because
3456 floating-point literals are implicitly of type @code{double}.  For
3457 example, in:
3458 @smallexample
3459 @group
3460 float area(float radius)
3462    return 3.14159 * radius * radius;
3464 @end group
3465 @end smallexample
3466 the compiler performs the entire computation with @code{double}
3467 because the floating-point literal is a @code{double}.
3469 @item -Wformat
3470 @itemx -Wformat=@var{n}
3471 @opindex Wformat
3472 @opindex Wno-format
3473 @opindex ffreestanding
3474 @opindex fno-builtin
3475 @opindex Wformat=
3476 Check calls to @code{printf} and @code{scanf}, etc., to make sure that
3477 the arguments supplied have types appropriate to the format string
3478 specified, and that the conversions specified in the format string make
3479 sense.  This includes standard functions, and others specified by format
3480 attributes (@pxref{Function Attributes}), in the @code{printf},
3481 @code{scanf}, @code{strftime} and @code{strfmon} (an X/Open extension,
3482 not in the C standard) families (or other target-specific families).
3483 Which functions are checked without format attributes having been
3484 specified depends on the standard version selected, and such checks of
3485 functions without the attribute specified are disabled by
3486 @option{-ffreestanding} or @option{-fno-builtin}.
3488 The formats are checked against the format features supported by GNU
3489 libc version 2.2.  These include all ISO C90 and C99 features, as well
3490 as features from the Single Unix Specification and some BSD and GNU
3491 extensions.  Other library implementations may not support all these
3492 features; GCC does not support warning about features that go beyond a
3493 particular library's limitations.  However, if @option{-Wpedantic} is used
3494 with @option{-Wformat}, warnings are given about format features not
3495 in the selected standard version (but not for @code{strfmon} formats,
3496 since those are not in any version of the C standard).  @xref{C Dialect
3497 Options,,Options Controlling C Dialect}.
3499 @table @gcctabopt
3500 @item -Wformat=1
3501 @itemx -Wformat
3502 @opindex Wformat
3503 @opindex Wformat=1
3504 Option @option{-Wformat} is equivalent to @option{-Wformat=1}, and
3505 @option{-Wno-format} is equivalent to @option{-Wformat=0}.  Since
3506 @option{-Wformat} also checks for null format arguments for several
3507 functions, @option{-Wformat} also implies @option{-Wnonnull}.  Some
3508 aspects of this level of format checking can be disabled by the
3509 options: @option{-Wno-format-contains-nul},
3510 @option{-Wno-format-extra-args}, and @option{-Wno-format-zero-length}.
3511 @option{-Wformat} is enabled by @option{-Wall}.
3513 @item -Wno-format-contains-nul
3514 @opindex Wno-format-contains-nul
3515 @opindex Wformat-contains-nul
3516 If @option{-Wformat} is specified, do not warn about format strings that
3517 contain NUL bytes.
3519 @item -Wno-format-extra-args
3520 @opindex Wno-format-extra-args
3521 @opindex Wformat-extra-args
3522 If @option{-Wformat} is specified, do not warn about excess arguments to a
3523 @code{printf} or @code{scanf} format function.  The C standard specifies
3524 that such arguments are ignored.
3526 Where the unused arguments lie between used arguments that are
3527 specified with @samp{$} operand number specifications, normally
3528 warnings are still given, since the implementation could not know what
3529 type to pass to @code{va_arg} to skip the unused arguments.  However,
3530 in the case of @code{scanf} formats, this option suppresses the
3531 warning if the unused arguments are all pointers, since the Single
3532 Unix Specification says that such unused arguments are allowed.
3534 @item -Wno-format-zero-length
3535 @opindex Wno-format-zero-length
3536 @opindex Wformat-zero-length
3537 If @option{-Wformat} is specified, do not warn about zero-length formats.
3538 The C standard specifies that zero-length formats are allowed.
3541 @item -Wformat=2
3542 @opindex Wformat=2
3543 Enable @option{-Wformat} plus additional format checks.  Currently
3544 equivalent to @option{-Wformat -Wformat-nonliteral -Wformat-security
3545 -Wformat-signedness -Wformat-y2k}.
3547 @item -Wformat-nonliteral
3548 @opindex Wformat-nonliteral
3549 @opindex Wno-format-nonliteral
3550 If @option{-Wformat} is specified, also warn if the format string is not a
3551 string literal and so cannot be checked, unless the format function
3552 takes its format arguments as a @code{va_list}.
3554 @item -Wformat-security
3555 @opindex Wformat-security
3556 @opindex Wno-format-security
3557 If @option{-Wformat} is specified, also warn about uses of format
3558 functions that represent possible security problems.  At present, this
3559 warns about calls to @code{printf} and @code{scanf} functions where the
3560 format string is not a string literal and there are no format arguments,
3561 as in @code{printf (foo);}.  This may be a security hole if the format
3562 string came from untrusted input and contains @samp{%n}.  (This is
3563 currently a subset of what @option{-Wformat-nonliteral} warns about, but
3564 in future warnings may be added to @option{-Wformat-security} that are not
3565 included in @option{-Wformat-nonliteral}.)
3567 @item -Wformat-signedness
3568 @opindex Wformat-signedness
3569 @opindex Wno-format-signedness
3570 If @option{-Wformat} is specified, also warn if the format string
3571 requires an unsigned argument and the argument is signed and vice versa.
3573 @item -Wformat-y2k
3574 @opindex Wformat-y2k
3575 @opindex Wno-format-y2k
3576 If @option{-Wformat} is specified, also warn about @code{strftime}
3577 formats that may yield only a two-digit year.
3578 @end table
3580 @item -Wnonnull
3581 @opindex Wnonnull
3582 @opindex Wno-nonnull
3583 Warn about passing a null pointer for arguments marked as
3584 requiring a non-null value by the @code{nonnull} function attribute.
3586 @option{-Wnonnull} is included in @option{-Wall} and @option{-Wformat}.  It
3587 can be disabled with the @option{-Wno-nonnull} option.
3589 @item -Winit-self @r{(C, C++, Objective-C and Objective-C++ only)}
3590 @opindex Winit-self
3591 @opindex Wno-init-self
3592 Warn about uninitialized variables that are initialized with themselves.
3593 Note this option can only be used with the @option{-Wuninitialized} option.
3595 For example, GCC warns about @code{i} being uninitialized in the
3596 following snippet only when @option{-Winit-self} has been specified:
3597 @smallexample
3598 @group
3599 int f()
3601   int i = i;
3602   return i;
3604 @end group
3605 @end smallexample
3607 This warning is enabled by @option{-Wall} in C++.
3609 @item -Wimplicit-int @r{(C and Objective-C only)}
3610 @opindex Wimplicit-int
3611 @opindex Wno-implicit-int
3612 Warn when a declaration does not specify a type.
3613 This warning is enabled by @option{-Wall}.
3615 @item -Wimplicit-function-declaration @r{(C and Objective-C only)}
3616 @opindex Wimplicit-function-declaration
3617 @opindex Wno-implicit-function-declaration
3618 Give a warning whenever a function is used before being declared. In
3619 C99 mode (@option{-std=c99} or @option{-std=gnu99}), this warning is
3620 enabled by default and it is made into an error by
3621 @option{-pedantic-errors}. This warning is also enabled by
3622 @option{-Wall}.
3624 @item -Wimplicit @r{(C and Objective-C only)}
3625 @opindex Wimplicit
3626 @opindex Wno-implicit
3627 Same as @option{-Wimplicit-int} and @option{-Wimplicit-function-declaration}.
3628 This warning is enabled by @option{-Wall}.
3630 @item -Wignored-qualifiers @r{(C and C++ only)}
3631 @opindex Wignored-qualifiers
3632 @opindex Wno-ignored-qualifiers
3633 Warn if the return type of a function has a type qualifier
3634 such as @code{const}.  For ISO C such a type qualifier has no effect,
3635 since the value returned by a function is not an lvalue.
3636 For C++, the warning is only emitted for scalar types or @code{void}.
3637 ISO C prohibits qualified @code{void} return types on function
3638 definitions, so such return types always receive a warning
3639 even without this option.
3641 This warning is also enabled by @option{-Wextra}.
3643 @item -Wmain
3644 @opindex Wmain
3645 @opindex Wno-main
3646 Warn if the type of @samp{main} is suspicious.  @samp{main} should be
3647 a function with external linkage, returning int, taking either zero
3648 arguments, two, or three arguments of appropriate types.  This warning
3649 is enabled by default in C++ and is enabled by either @option{-Wall}
3650 or @option{-Wpedantic}.
3652 @item -Wmissing-braces
3653 @opindex Wmissing-braces
3654 @opindex Wno-missing-braces
3655 Warn if an aggregate or union initializer is not fully bracketed.  In
3656 the following example, the initializer for @samp{a} is not fully
3657 bracketed, but that for @samp{b} is fully bracketed.  This warning is
3658 enabled by @option{-Wall} in C.
3660 @smallexample
3661 int a[2][2] = @{ 0, 1, 2, 3 @};
3662 int b[2][2] = @{ @{ 0, 1 @}, @{ 2, 3 @} @};
3663 @end smallexample
3665 This warning is enabled by @option{-Wall}.
3667 @item -Wmissing-include-dirs @r{(C, C++, Objective-C and Objective-C++ only)}
3668 @opindex Wmissing-include-dirs
3669 @opindex Wno-missing-include-dirs
3670 Warn if a user-supplied include directory does not exist.
3672 @item -Wparentheses
3673 @opindex Wparentheses
3674 @opindex Wno-parentheses
3675 Warn if parentheses are omitted in certain contexts, such
3676 as when there is an assignment in a context where a truth value
3677 is expected, or when operators are nested whose precedence people
3678 often get confused about.
3680 Also warn if a comparison like @samp{x<=y<=z} appears; this is
3681 equivalent to @samp{(x<=y ? 1 : 0) <= z}, which is a different
3682 interpretation from that of ordinary mathematical notation.
3684 Also warn about constructions where there may be confusion to which
3685 @code{if} statement an @code{else} branch belongs.  Here is an example of
3686 such a case:
3688 @smallexample
3689 @group
3691   if (a)
3692     if (b)
3693       foo ();
3694   else
3695     bar ();
3697 @end group
3698 @end smallexample
3700 In C/C++, every @code{else} branch belongs to the innermost possible
3701 @code{if} statement, which in this example is @code{if (b)}.  This is
3702 often not what the programmer expected, as illustrated in the above
3703 example by indentation the programmer chose.  When there is the
3704 potential for this confusion, GCC issues a warning when this flag
3705 is specified.  To eliminate the warning, add explicit braces around
3706 the innermost @code{if} statement so there is no way the @code{else}
3707 can belong to the enclosing @code{if}.  The resulting code
3708 looks like this:
3710 @smallexample
3711 @group
3713   if (a)
3714     @{
3715       if (b)
3716         foo ();
3717       else
3718         bar ();
3719     @}
3721 @end group
3722 @end smallexample
3724 Also warn for dangerous uses of the GNU extension to
3725 @code{?:} with omitted middle operand. When the condition
3726 in the @code{?}: operator is a boolean expression, the omitted value is
3727 always 1.  Often programmers expect it to be a value computed
3728 inside the conditional expression instead.
3730 This warning is enabled by @option{-Wall}.
3732 @item -Wsequence-point
3733 @opindex Wsequence-point
3734 @opindex Wno-sequence-point
3735 Warn about code that may have undefined semantics because of violations
3736 of sequence point rules in the C and C++ standards.
3738 The C and C++ standards define the order in which expressions in a C/C++
3739 program are evaluated in terms of @dfn{sequence points}, which represent
3740 a partial ordering between the execution of parts of the program: those
3741 executed before the sequence point, and those executed after it.  These
3742 occur after the evaluation of a full expression (one which is not part
3743 of a larger expression), after the evaluation of the first operand of a
3744 @code{&&}, @code{||}, @code{? :} or @code{,} (comma) operator, before a
3745 function is called (but after the evaluation of its arguments and the
3746 expression denoting the called function), and in certain other places.
3747 Other than as expressed by the sequence point rules, the order of
3748 evaluation of subexpressions of an expression is not specified.  All
3749 these rules describe only a partial order rather than a total order,
3750 since, for example, if two functions are called within one expression
3751 with no sequence point between them, the order in which the functions
3752 are called is not specified.  However, the standards committee have
3753 ruled that function calls do not overlap.
3755 It is not specified when between sequence points modifications to the
3756 values of objects take effect.  Programs whose behavior depends on this
3757 have undefined behavior; the C and C++ standards specify that ``Between
3758 the previous and next sequence point an object shall have its stored
3759 value modified at most once by the evaluation of an expression.
3760 Furthermore, the prior value shall be read only to determine the value
3761 to be stored.''.  If a program breaks these rules, the results on any
3762 particular implementation are entirely unpredictable.
3764 Examples of code with undefined behavior are @code{a = a++;}, @code{a[n]
3765 = b[n++]} and @code{a[i++] = i;}.  Some more complicated cases are not
3766 diagnosed by this option, and it may give an occasional false positive
3767 result, but in general it has been found fairly effective at detecting
3768 this sort of problem in programs.
3770 The standard is worded confusingly, therefore there is some debate
3771 over the precise meaning of the sequence point rules in subtle cases.
3772 Links to discussions of the problem, including proposed formal
3773 definitions, may be found on the GCC readings page, at
3774 @uref{http://gcc.gnu.org/@/readings.html}.
3776 This warning is enabled by @option{-Wall} for C and C++.
3778 @item -Wno-return-local-addr
3779 @opindex Wno-return-local-addr
3780 @opindex Wreturn-local-addr
3781 Do not warn about returning a pointer (or in C++, a reference) to a
3782 variable that goes out of scope after the function returns.
3784 @item -Wreturn-type
3785 @opindex Wreturn-type
3786 @opindex Wno-return-type
3787 Warn whenever a function is defined with a return type that defaults
3788 to @code{int}.  Also warn about any @code{return} statement with no
3789 return value in a function whose return type is not @code{void}
3790 (falling off the end of the function body is considered returning
3791 without a value), and about a @code{return} statement with an
3792 expression in a function whose return type is @code{void}.
3794 For C++, a function without return type always produces a diagnostic
3795 message, even when @option{-Wno-return-type} is specified.  The only
3796 exceptions are @samp{main} and functions defined in system headers.
3798 This warning is enabled by @option{-Wall}.
3800 @item -Wswitch
3801 @opindex Wswitch
3802 @opindex Wno-switch
3803 Warn whenever a @code{switch} statement has an index of enumerated type
3804 and lacks a @code{case} for one or more of the named codes of that
3805 enumeration.  (The presence of a @code{default} label prevents this
3806 warning.)  @code{case} labels outside the enumeration range also
3807 provoke warnings when this option is used (even if there is a
3808 @code{default} label).
3809 This warning is enabled by @option{-Wall}.
3811 @item -Wswitch-default
3812 @opindex Wswitch-default
3813 @opindex Wno-switch-default
3814 Warn whenever a @code{switch} statement does not have a @code{default}
3815 case.
3817 @item -Wswitch-enum
3818 @opindex Wswitch-enum
3819 @opindex Wno-switch-enum
3820 Warn whenever a @code{switch} statement has an index of enumerated type
3821 and lacks a @code{case} for one or more of the named codes of that
3822 enumeration.  @code{case} labels outside the enumeration range also
3823 provoke warnings when this option is used.  The only difference
3824 between @option{-Wswitch} and this option is that this option gives a
3825 warning about an omitted enumeration code even if there is a
3826 @code{default} label.
3828 @item -Wsync-nand @r{(C and C++ only)}
3829 @opindex Wsync-nand
3830 @opindex Wno-sync-nand
3831 Warn when @code{__sync_fetch_and_nand} and @code{__sync_nand_and_fetch}
3832 built-in functions are used.  These functions changed semantics in GCC 4.4.
3834 @item -Wtrigraphs
3835 @opindex Wtrigraphs
3836 @opindex Wno-trigraphs
3837 Warn if any trigraphs are encountered that might change the meaning of
3838 the program (trigraphs within comments are not warned about).
3839 This warning is enabled by @option{-Wall}.
3841 @item -Wunused-but-set-parameter
3842 @opindex Wunused-but-set-parameter
3843 @opindex Wno-unused-but-set-parameter
3844 Warn whenever a function parameter is assigned to, but otherwise unused
3845 (aside from its declaration).
3847 To suppress this warning use the @samp{unused} attribute
3848 (@pxref{Variable Attributes}).
3850 This warning is also enabled by @option{-Wunused} together with
3851 @option{-Wextra}.
3853 @item -Wunused-but-set-variable
3854 @opindex Wunused-but-set-variable
3855 @opindex Wno-unused-but-set-variable
3856 Warn whenever a local variable is assigned to, but otherwise unused
3857 (aside from its declaration).
3858 This warning is enabled by @option{-Wall}.
3860 To suppress this warning use the @samp{unused} attribute
3861 (@pxref{Variable Attributes}).
3863 This warning is also enabled by @option{-Wunused}, which is enabled
3864 by @option{-Wall}.
3866 @item -Wunused-function
3867 @opindex Wunused-function
3868 @opindex Wno-unused-function
3869 Warn whenever a static function is declared but not defined or a
3870 non-inline static function is unused.
3871 This warning is enabled by @option{-Wall}.
3873 @item -Wunused-label
3874 @opindex Wunused-label
3875 @opindex Wno-unused-label
3876 Warn whenever a label is declared but not used.
3877 This warning is enabled by @option{-Wall}.
3879 To suppress this warning use the @samp{unused} attribute
3880 (@pxref{Variable Attributes}).
3882 @item -Wunused-local-typedefs @r{(C, Objective-C, C++ and Objective-C++ only)}
3883 @opindex Wunused-local-typedefs
3884 Warn when a typedef locally defined in a function is not used.
3885 This warning is enabled by @option{-Wall}.
3887 @item -Wunused-parameter
3888 @opindex Wunused-parameter
3889 @opindex Wno-unused-parameter
3890 Warn whenever a function parameter is unused aside from its declaration.
3892 To suppress this warning use the @samp{unused} attribute
3893 (@pxref{Variable Attributes}).
3895 @item -Wno-unused-result
3896 @opindex Wunused-result
3897 @opindex Wno-unused-result
3898 Do not warn if a caller of a function marked with attribute
3899 @code{warn_unused_result} (@pxref{Function Attributes}) does not use
3900 its return value. The default is @option{-Wunused-result}.
3902 @item -Wunused-variable
3903 @opindex Wunused-variable
3904 @opindex Wno-unused-variable
3905 Warn whenever a local variable or non-constant static variable is unused
3906 aside from its declaration.
3907 This warning is enabled by @option{-Wall}.
3909 To suppress this warning use the @samp{unused} attribute
3910 (@pxref{Variable Attributes}).
3912 @item -Wunused-value
3913 @opindex Wunused-value
3914 @opindex Wno-unused-value
3915 Warn whenever a statement computes a result that is explicitly not
3916 used. To suppress this warning cast the unused expression to
3917 @samp{void}. This includes an expression-statement or the left-hand
3918 side of a comma expression that contains no side effects. For example,
3919 an expression such as @samp{x[i,j]} causes a warning, while
3920 @samp{x[(void)i,j]} does not.
3922 This warning is enabled by @option{-Wall}.
3924 @item -Wunused
3925 @opindex Wunused
3926 @opindex Wno-unused
3927 All the above @option{-Wunused} options combined.
3929 In order to get a warning about an unused function parameter, you must
3930 either specify @option{-Wextra -Wunused} (note that @option{-Wall} implies
3931 @option{-Wunused}), or separately specify @option{-Wunused-parameter}.
3933 @item -Wuninitialized
3934 @opindex Wuninitialized
3935 @opindex Wno-uninitialized
3936 Warn if an automatic variable is used without first being initialized
3937 or if a variable may be clobbered by a @code{setjmp} call. In C++,
3938 warn if a non-static reference or non-static @samp{const} member
3939 appears in a class without constructors.
3941 If you want to warn about code that uses the uninitialized value of the
3942 variable in its own initializer, use the @option{-Winit-self} option.
3944 These warnings occur for individual uninitialized or clobbered
3945 elements of structure, union or array variables as well as for
3946 variables that are uninitialized or clobbered as a whole.  They do
3947 not occur for variables or elements declared @code{volatile}.  Because
3948 these warnings depend on optimization, the exact variables or elements
3949 for which there are warnings depends on the precise optimization
3950 options and version of GCC used.
3952 Note that there may be no warning about a variable that is used only
3953 to compute a value that itself is never used, because such
3954 computations may be deleted by data flow analysis before the warnings
3955 are printed.
3957 @item -Wmaybe-uninitialized
3958 @opindex Wmaybe-uninitialized
3959 @opindex Wno-maybe-uninitialized
3960 For an automatic variable, if there exists a path from the function
3961 entry to a use of the variable that is initialized, but there exist
3962 some other paths for which the variable is not initialized, the compiler
3963 emits a warning if it cannot prove the uninitialized paths are not
3964 executed at run time. These warnings are made optional because GCC is
3965 not smart enough to see all the reasons why the code might be correct
3966 in spite of appearing to have an error.  Here is one example of how
3967 this can happen:
3969 @smallexample
3970 @group
3972   int x;
3973   switch (y)
3974     @{
3975     case 1: x = 1;
3976       break;
3977     case 2: x = 4;
3978       break;
3979     case 3: x = 5;
3980     @}
3981   foo (x);
3983 @end group
3984 @end smallexample
3986 @noindent
3987 If the value of @code{y} is always 1, 2 or 3, then @code{x} is
3988 always initialized, but GCC doesn't know this. To suppress the
3989 warning, you need to provide a default case with assert(0) or
3990 similar code.
3992 @cindex @code{longjmp} warnings
3993 This option also warns when a non-volatile automatic variable might be
3994 changed by a call to @code{longjmp}.  These warnings as well are possible
3995 only in optimizing compilation.
3997 The compiler sees only the calls to @code{setjmp}.  It cannot know
3998 where @code{longjmp} will be called; in fact, a signal handler could
3999 call it at any point in the code.  As a result, you may get a warning
4000 even when there is in fact no problem because @code{longjmp} cannot
4001 in fact be called at the place that would cause a problem.
4003 Some spurious warnings can be avoided if you declare all the functions
4004 you use that never return as @code{noreturn}.  @xref{Function
4005 Attributes}.
4007 This warning is enabled by @option{-Wall} or @option{-Wextra}.
4009 @item -Wunknown-pragmas
4010 @opindex Wunknown-pragmas
4011 @opindex Wno-unknown-pragmas
4012 @cindex warning for unknown pragmas
4013 @cindex unknown pragmas, warning
4014 @cindex pragmas, warning of unknown
4015 Warn when a @code{#pragma} directive is encountered that is not understood by 
4016 GCC@.  If this command-line option is used, warnings are even issued
4017 for unknown pragmas in system header files.  This is not the case if
4018 the warnings are only enabled by the @option{-Wall} command-line option.
4020 @item -Wno-pragmas
4021 @opindex Wno-pragmas
4022 @opindex Wpragmas
4023 Do not warn about misuses of pragmas, such as incorrect parameters,
4024 invalid syntax, or conflicts between pragmas.  See also
4025 @option{-Wunknown-pragmas}.
4027 @item -Wstrict-aliasing
4028 @opindex Wstrict-aliasing
4029 @opindex Wno-strict-aliasing
4030 This option is only active when @option{-fstrict-aliasing} is active.
4031 It warns about code that might break the strict aliasing rules that the
4032 compiler is using for optimization.  The warning does not catch all
4033 cases, but does attempt to catch the more common pitfalls.  It is
4034 included in @option{-Wall}.
4035 It is equivalent to @option{-Wstrict-aliasing=3}
4037 @item -Wstrict-aliasing=n
4038 @opindex Wstrict-aliasing=n
4039 This option is only active when @option{-fstrict-aliasing} is active.
4040 It warns about code that might break the strict aliasing rules that the
4041 compiler is using for optimization.
4042 Higher levels correspond to higher accuracy (fewer false positives).
4043 Higher levels also correspond to more effort, similar to the way @option{-O} 
4044 works.
4045 @option{-Wstrict-aliasing} is equivalent to @option{-Wstrict-aliasing=3}.
4047 Level 1: Most aggressive, quick, least accurate.
4048 Possibly useful when higher levels
4049 do not warn but @option{-fstrict-aliasing} still breaks the code, as it has very few
4050 false negatives.  However, it has many false positives.
4051 Warns for all pointer conversions between possibly incompatible types,
4052 even if never dereferenced.  Runs in the front end only.
4054 Level 2: Aggressive, quick, not too precise.
4055 May still have many false positives (not as many as level 1 though),
4056 and few false negatives (but possibly more than level 1).
4057 Unlike level 1, it only warns when an address is taken.  Warns about
4058 incomplete types.  Runs in the front end only.
4060 Level 3 (default for @option{-Wstrict-aliasing}):
4061 Should have very few false positives and few false
4062 negatives.  Slightly slower than levels 1 or 2 when optimization is enabled.
4063 Takes care of the common pun+dereference pattern in the front end:
4064 @code{*(int*)&some_float}.
4065 If optimization is enabled, it also runs in the back end, where it deals
4066 with multiple statement cases using flow-sensitive points-to information.
4067 Only warns when the converted pointer is dereferenced.
4068 Does not warn about incomplete types.
4070 @item -Wstrict-overflow
4071 @itemx -Wstrict-overflow=@var{n}
4072 @opindex Wstrict-overflow
4073 @opindex Wno-strict-overflow
4074 This option is only active when @option{-fstrict-overflow} is active.
4075 It warns about cases where the compiler optimizes based on the
4076 assumption that signed overflow does not occur.  Note that it does not
4077 warn about all cases where the code might overflow: it only warns
4078 about cases where the compiler implements some optimization.  Thus
4079 this warning depends on the optimization level.
4081 An optimization that assumes that signed overflow does not occur is
4082 perfectly safe if the values of the variables involved are such that
4083 overflow never does, in fact, occur.  Therefore this warning can
4084 easily give a false positive: a warning about code that is not
4085 actually a problem.  To help focus on important issues, several
4086 warning levels are defined.  No warnings are issued for the use of
4087 undefined signed overflow when estimating how many iterations a loop
4088 requires, in particular when determining whether a loop will be
4089 executed at all.
4091 @table @gcctabopt
4092 @item -Wstrict-overflow=1
4093 Warn about cases that are both questionable and easy to avoid.  For
4094 example,  with @option{-fstrict-overflow}, the compiler simplifies
4095 @code{x + 1 > x} to @code{1}.  This level of
4096 @option{-Wstrict-overflow} is enabled by @option{-Wall}; higher levels
4097 are not, and must be explicitly requested.
4099 @item -Wstrict-overflow=2
4100 Also warn about other cases where a comparison is simplified to a
4101 constant.  For example: @code{abs (x) >= 0}.  This can only be
4102 simplified when @option{-fstrict-overflow} is in effect, because
4103 @code{abs (INT_MIN)} overflows to @code{INT_MIN}, which is less than
4104 zero.  @option{-Wstrict-overflow} (with no level) is the same as
4105 @option{-Wstrict-overflow=2}.
4107 @item -Wstrict-overflow=3
4108 Also warn about other cases where a comparison is simplified.  For
4109 example: @code{x + 1 > 1} is simplified to @code{x > 0}.
4111 @item -Wstrict-overflow=4
4112 Also warn about other simplifications not covered by the above cases.
4113 For example: @code{(x * 10) / 5} is simplified to @code{x * 2}.
4115 @item -Wstrict-overflow=5
4116 Also warn about cases where the compiler reduces the magnitude of a
4117 constant involved in a comparison.  For example: @code{x + 2 > y} is
4118 simplified to @code{x + 1 >= y}.  This is reported only at the
4119 highest warning level because this simplification applies to many
4120 comparisons, so this warning level gives a very large number of
4121 false positives.
4122 @end table
4124 @item -Wsuggest-attribute=@r{[}pure@r{|}const@r{|}noreturn@r{|}format@r{]}
4125 @opindex Wsuggest-attribute=
4126 @opindex Wno-suggest-attribute=
4127 Warn for cases where adding an attribute may be beneficial. The
4128 attributes currently supported are listed below.
4130 @table @gcctabopt
4131 @item -Wsuggest-attribute=pure
4132 @itemx -Wsuggest-attribute=const
4133 @itemx -Wsuggest-attribute=noreturn
4134 @opindex Wsuggest-attribute=pure
4135 @opindex Wno-suggest-attribute=pure
4136 @opindex Wsuggest-attribute=const
4137 @opindex Wno-suggest-attribute=const
4138 @opindex Wsuggest-attribute=noreturn
4139 @opindex Wno-suggest-attribute=noreturn
4141 Warn about functions that might be candidates for attributes
4142 @code{pure}, @code{const} or @code{noreturn}.  The compiler only warns for
4143 functions visible in other compilation units or (in the case of @code{pure} and
4144 @code{const}) if it cannot prove that the function returns normally. A function
4145 returns normally if it doesn't contain an infinite loop or return abnormally
4146 by throwing, calling @code{abort()} or trapping.  This analysis requires option
4147 @option{-fipa-pure-const}, which is enabled by default at @option{-O} and
4148 higher.  Higher optimization levels improve the accuracy of the analysis.
4150 @item -Wsuggest-attribute=format
4151 @itemx -Wmissing-format-attribute
4152 @opindex Wsuggest-attribute=format
4153 @opindex Wmissing-format-attribute
4154 @opindex Wno-suggest-attribute=format
4155 @opindex Wno-missing-format-attribute
4156 @opindex Wformat
4157 @opindex Wno-format
4159 Warn about function pointers that might be candidates for @code{format}
4160 attributes.  Note these are only possible candidates, not absolute ones.
4161 GCC guesses that function pointers with @code{format} attributes that
4162 are used in assignment, initialization, parameter passing or return
4163 statements should have a corresponding @code{format} attribute in the
4164 resulting type.  I.e.@: the left-hand side of the assignment or
4165 initialization, the type of the parameter variable, or the return type
4166 of the containing function respectively should also have a @code{format}
4167 attribute to avoid the warning.
4169 GCC also warns about function definitions that might be
4170 candidates for @code{format} attributes.  Again, these are only
4171 possible candidates.  GCC guesses that @code{format} attributes
4172 might be appropriate for any function that calls a function like
4173 @code{vprintf} or @code{vscanf}, but this might not always be the
4174 case, and some functions for which @code{format} attributes are
4175 appropriate may not be detected.
4176 @end table
4178 @item -Warray-bounds
4179 @opindex Wno-array-bounds
4180 @opindex Warray-bounds
4181 This option is only active when @option{-ftree-vrp} is active
4182 (default for @option{-O2} and above). It warns about subscripts to arrays
4183 that are always out of bounds. This warning is enabled by @option{-Wall}.
4185 @item -Wno-div-by-zero
4186 @opindex Wno-div-by-zero
4187 @opindex Wdiv-by-zero
4188 Do not warn about compile-time integer division by zero.  Floating-point
4189 division by zero is not warned about, as it can be a legitimate way of
4190 obtaining infinities and NaNs.
4192 @item -Wsystem-headers
4193 @opindex Wsystem-headers
4194 @opindex Wno-system-headers
4195 @cindex warnings from system headers
4196 @cindex system headers, warnings from
4197 Print warning messages for constructs found in system header files.
4198 Warnings from system headers are normally suppressed, on the assumption
4199 that they usually do not indicate real problems and would only make the
4200 compiler output harder to read.  Using this command-line option tells
4201 GCC to emit warnings from system headers as if they occurred in user
4202 code.  However, note that using @option{-Wall} in conjunction with this
4203 option does @emph{not} warn about unknown pragmas in system
4204 headers---for that, @option{-Wunknown-pragmas} must also be used.
4206 @item -Wtrampolines
4207 @opindex Wtrampolines
4208 @opindex Wno-trampolines
4209  Warn about trampolines generated for pointers to nested functions.
4211  A trampoline is a small piece of data or code that is created at run
4212  time on the stack when the address of a nested function is taken, and
4213  is used to call the nested function indirectly.  For some targets, it
4214  is made up of data only and thus requires no special treatment.  But,
4215  for most targets, it is made up of code and thus requires the stack
4216  to be made executable in order for the program to work properly.
4218 @item -Wfloat-equal
4219 @opindex Wfloat-equal
4220 @opindex Wno-float-equal
4221 Warn if floating-point values are used in equality comparisons.
4223 The idea behind this is that sometimes it is convenient (for the
4224 programmer) to consider floating-point values as approximations to
4225 infinitely precise real numbers.  If you are doing this, then you need
4226 to compute (by analyzing the code, or in some other way) the maximum or
4227 likely maximum error that the computation introduces, and allow for it
4228 when performing comparisons (and when producing output, but that's a
4229 different problem).  In particular, instead of testing for equality, you
4230 should check to see whether the two values have ranges that overlap; and
4231 this is done with the relational operators, so equality comparisons are
4232 probably mistaken.
4234 @item -Wtraditional @r{(C and Objective-C only)}
4235 @opindex Wtraditional
4236 @opindex Wno-traditional
4237 Warn about certain constructs that behave differently in traditional and
4238 ISO C@.  Also warn about ISO C constructs that have no traditional C
4239 equivalent, and/or problematic constructs that should be avoided.
4241 @itemize @bullet
4242 @item
4243 Macro parameters that appear within string literals in the macro body.
4244 In traditional C macro replacement takes place within string literals,
4245 but in ISO C it does not.
4247 @item
4248 In traditional C, some preprocessor directives did not exist.
4249 Traditional preprocessors only considered a line to be a directive
4250 if the @samp{#} appeared in column 1 on the line.  Therefore
4251 @option{-Wtraditional} warns about directives that traditional C
4252 understands but ignores because the @samp{#} does not appear as the
4253 first character on the line.  It also suggests you hide directives like
4254 @samp{#pragma} not understood by traditional C by indenting them.  Some
4255 traditional implementations do not recognize @samp{#elif}, so this option
4256 suggests avoiding it altogether.
4258 @item
4259 A function-like macro that appears without arguments.
4261 @item
4262 The unary plus operator.
4264 @item
4265 The @samp{U} integer constant suffix, or the @samp{F} or @samp{L} floating-point
4266 constant suffixes.  (Traditional C does support the @samp{L} suffix on integer
4267 constants.)  Note, these suffixes appear in macros defined in the system
4268 headers of most modern systems, e.g.@: the @samp{_MIN}/@samp{_MAX} macros in @code{<limits.h>}.
4269 Use of these macros in user code might normally lead to spurious
4270 warnings, however GCC's integrated preprocessor has enough context to
4271 avoid warning in these cases.
4273 @item
4274 A function declared external in one block and then used after the end of
4275 the block.
4277 @item
4278 A @code{switch} statement has an operand of type @code{long}.
4280 @item
4281 A non-@code{static} function declaration follows a @code{static} one.
4282 This construct is not accepted by some traditional C compilers.
4284 @item
4285 The ISO type of an integer constant has a different width or
4286 signedness from its traditional type.  This warning is only issued if
4287 the base of the constant is ten.  I.e.@: hexadecimal or octal values, which
4288 typically represent bit patterns, are not warned about.
4290 @item
4291 Usage of ISO string concatenation is detected.
4293 @item
4294 Initialization of automatic aggregates.
4296 @item
4297 Identifier conflicts with labels.  Traditional C lacks a separate
4298 namespace for labels.
4300 @item
4301 Initialization of unions.  If the initializer is zero, the warning is
4302 omitted.  This is done under the assumption that the zero initializer in
4303 user code appears conditioned on e.g.@: @code{__STDC__} to avoid missing
4304 initializer warnings and relies on default initialization to zero in the
4305 traditional C case.
4307 @item
4308 Conversions by prototypes between fixed/floating-point values and vice
4309 versa.  The absence of these prototypes when compiling with traditional
4310 C causes serious problems.  This is a subset of the possible
4311 conversion warnings; for the full set use @option{-Wtraditional-conversion}.
4313 @item
4314 Use of ISO C style function definitions.  This warning intentionally is
4315 @emph{not} issued for prototype declarations or variadic functions
4316 because these ISO C features appear in your code when using
4317 libiberty's traditional C compatibility macros, @code{PARAMS} and
4318 @code{VPARAMS}.  This warning is also bypassed for nested functions
4319 because that feature is already a GCC extension and thus not relevant to
4320 traditional C compatibility.
4321 @end itemize
4323 @item -Wtraditional-conversion @r{(C and Objective-C only)}
4324 @opindex Wtraditional-conversion
4325 @opindex Wno-traditional-conversion
4326 Warn if a prototype causes a type conversion that is different from what
4327 would happen to the same argument in the absence of a prototype.  This
4328 includes conversions of fixed point to floating and vice versa, and
4329 conversions changing the width or signedness of a fixed-point argument
4330 except when the same as the default promotion.
4332 @item -Wdeclaration-after-statement @r{(C and Objective-C only)}
4333 @opindex Wdeclaration-after-statement
4334 @opindex Wno-declaration-after-statement
4335 Warn when a declaration is found after a statement in a block.  This
4336 construct, known from C++, was introduced with ISO C99 and is by default
4337 allowed in GCC@.  It is not supported by ISO C90 and was not supported by
4338 GCC versions before GCC 3.0.  @xref{Mixed Declarations}.
4340 @item -Wundef
4341 @opindex Wundef
4342 @opindex Wno-undef
4343 Warn if an undefined identifier is evaluated in an @samp{#if} directive.
4345 @item -Wno-endif-labels
4346 @opindex Wno-endif-labels
4347 @opindex Wendif-labels
4348 Do not warn whenever an @samp{#else} or an @samp{#endif} are followed by text.
4350 @item -Wshadow
4351 @opindex Wshadow
4352 @opindex Wno-shadow
4353 Warn whenever a local variable or type declaration shadows another variable,
4354 parameter, type, or class member (in C++), or whenever a built-in function
4355 is shadowed. Note that in C++, the compiler warns if a local variable
4356 shadows an explicit typedef, but not if it shadows a struct/class/enum.
4358 @item -Wlarger-than=@var{len}
4359 @opindex Wlarger-than=@var{len}
4360 @opindex Wlarger-than-@var{len}
4361 Warn whenever an object of larger than @var{len} bytes is defined.
4363 @item -Wframe-larger-than=@var{len}
4364 @opindex Wframe-larger-than
4365 Warn if the size of a function frame is larger than @var{len} bytes.
4366 The computation done to determine the stack frame size is approximate
4367 and not conservative.
4368 The actual requirements may be somewhat greater than @var{len}
4369 even if you do not get a warning.  In addition, any space allocated
4370 via @code{alloca}, variable-length arrays, or related constructs
4371 is not included by the compiler when determining
4372 whether or not to issue a warning.
4374 @item -Wno-free-nonheap-object
4375 @opindex Wno-free-nonheap-object
4376 @opindex Wfree-nonheap-object
4377 Do not warn when attempting to free an object that was not allocated
4378 on the heap.
4380 @item -Wstack-usage=@var{len}
4381 @opindex Wstack-usage
4382 Warn if the stack usage of a function might be larger than @var{len} bytes.
4383 The computation done to determine the stack usage is conservative.
4384 Any space allocated via @code{alloca}, variable-length arrays, or related
4385 constructs is included by the compiler when determining whether or not to
4386 issue a warning.
4388 The message is in keeping with the output of @option{-fstack-usage}.
4390 @itemize
4391 @item
4392 If the stack usage is fully static but exceeds the specified amount, it's:
4394 @smallexample
4395   warning: stack usage is 1120 bytes
4396 @end smallexample
4397 @item
4398 If the stack usage is (partly) dynamic but bounded, it's:
4400 @smallexample
4401   warning: stack usage might be 1648 bytes
4402 @end smallexample
4403 @item
4404 If the stack usage is (partly) dynamic and not bounded, it's:
4406 @smallexample
4407   warning: stack usage might be unbounded
4408 @end smallexample
4409 @end itemize
4411 @item -Wunsafe-loop-optimizations
4412 @opindex Wunsafe-loop-optimizations
4413 @opindex Wno-unsafe-loop-optimizations
4414 Warn if the loop cannot be optimized because the compiler cannot
4415 assume anything on the bounds of the loop indices.  With
4416 @option{-funsafe-loop-optimizations} warn if the compiler makes
4417 such assumptions.
4419 @item -Wno-pedantic-ms-format @r{(MinGW targets only)}
4420 @opindex Wno-pedantic-ms-format
4421 @opindex Wpedantic-ms-format
4422 When used in combination with @option{-Wformat}
4423 and @option{-pedantic} without GNU extensions, this option
4424 disables the warnings about non-ISO @code{printf} / @code{scanf} format
4425 width specifiers @code{I32}, @code{I64}, and @code{I} used on Windows targets,
4426 which depend on the MS runtime.
4428 @item -Wpointer-arith
4429 @opindex Wpointer-arith
4430 @opindex Wno-pointer-arith
4431 Warn about anything that depends on the ``size of'' a function type or
4432 of @code{void}.  GNU C assigns these types a size of 1, for
4433 convenience in calculations with @code{void *} pointers and pointers
4434 to functions.  In C++, warn also when an arithmetic operation involves
4435 @code{NULL}.  This warning is also enabled by @option{-Wpedantic}.
4437 @item -Wtype-limits
4438 @opindex Wtype-limits
4439 @opindex Wno-type-limits
4440 Warn if a comparison is always true or always false due to the limited
4441 range of the data type, but do not warn for constant expressions.  For
4442 example, warn if an unsigned variable is compared against zero with
4443 @samp{<} or @samp{>=}.  This warning is also enabled by
4444 @option{-Wextra}.
4446 @item -Wbad-function-cast @r{(C and Objective-C only)}
4447 @opindex Wbad-function-cast
4448 @opindex Wno-bad-function-cast
4449 Warn whenever a function call is cast to a non-matching type.
4450 For example, warn if @code{int malloc()} is cast to @code{anything *}.
4452 @item -Wc++-compat @r{(C and Objective-C only)}
4453 Warn about ISO C constructs that are outside of the common subset of
4454 ISO C and ISO C++, e.g.@: request for implicit conversion from
4455 @code{void *} to a pointer to non-@code{void} type.
4457 @item -Wc++11-compat @r{(C++ and Objective-C++ only)}
4458 Warn about C++ constructs whose meaning differs between ISO C++ 1998
4459 and ISO C++ 2011, e.g., identifiers in ISO C++ 1998 that are keywords
4460 in ISO C++ 2011.  This warning turns on @option{-Wnarrowing} and is
4461 enabled by @option{-Wall}.
4463 @item -Wcast-qual
4464 @opindex Wcast-qual
4465 @opindex Wno-cast-qual
4466 Warn whenever a pointer is cast so as to remove a type qualifier from
4467 the target type.  For example, warn if a @code{const char *} is cast
4468 to an ordinary @code{char *}.
4470 Also warn when making a cast that introduces a type qualifier in an
4471 unsafe way.  For example, casting @code{char **} to @code{const char **}
4472 is unsafe, as in this example:
4474 @smallexample
4475   /* p is char ** value.  */
4476   const char **q = (const char **) p;
4477   /* Assignment of readonly string to const char * is OK.  */
4478   *q = "string";
4479   /* Now char** pointer points to read-only memory.  */
4480   **p = 'b';
4481 @end smallexample
4483 @item -Wcast-align
4484 @opindex Wcast-align
4485 @opindex Wno-cast-align
4486 Warn whenever a pointer is cast such that the required alignment of the
4487 target is increased.  For example, warn if a @code{char *} is cast to
4488 an @code{int *} on machines where integers can only be accessed at
4489 two- or four-byte boundaries.
4491 @item -Wwrite-strings
4492 @opindex Wwrite-strings
4493 @opindex Wno-write-strings
4494 When compiling C, give string constants the type @code{const
4495 char[@var{length}]} so that copying the address of one into a
4496 non-@code{const} @code{char *} pointer produces a warning.  These
4497 warnings help you find at compile time code that can try to write
4498 into a string constant, but only if you have been very careful about
4499 using @code{const} in declarations and prototypes.  Otherwise, it is
4500 just a nuisance. This is why we did not make @option{-Wall} request
4501 these warnings.
4503 When compiling C++, warn about the deprecated conversion from string
4504 literals to @code{char *}.  This warning is enabled by default for C++
4505 programs.
4507 @item -Wclobbered
4508 @opindex Wclobbered
4509 @opindex Wno-clobbered
4510 Warn for variables that might be changed by @samp{longjmp} or
4511 @samp{vfork}.  This warning is also enabled by @option{-Wextra}.
4513 @item -Wconditionally-supported @r{(C++ and Objective-C++ only)}
4514 @opindex Wconditionally-supported
4515 @opindex Wno-conditionally-supported
4516 Warn for conditionally-supported (C++11 [intro.defs]) constructs.
4518 @item -Wconversion
4519 @opindex Wconversion
4520 @opindex Wno-conversion
4521 Warn for implicit conversions that may alter a value. This includes
4522 conversions between real and integer, like @code{abs (x)} when
4523 @code{x} is @code{double}; conversions between signed and unsigned,
4524 like @code{unsigned ui = -1}; and conversions to smaller types, like
4525 @code{sqrtf (M_PI)}. Do not warn for explicit casts like @code{abs
4526 ((int) x)} and @code{ui = (unsigned) -1}, or if the value is not
4527 changed by the conversion like in @code{abs (2.0)}.  Warnings about
4528 conversions between signed and unsigned integers can be disabled by
4529 using @option{-Wno-sign-conversion}.
4531 For C++, also warn for confusing overload resolution for user-defined
4532 conversions; and conversions that never use a type conversion
4533 operator: conversions to @code{void}, the same type, a base class or a
4534 reference to them. Warnings about conversions between signed and
4535 unsigned integers are disabled by default in C++ unless
4536 @option{-Wsign-conversion} is explicitly enabled.
4538 @item -Wno-conversion-null @r{(C++ and Objective-C++ only)}
4539 @opindex Wconversion-null
4540 @opindex Wno-conversion-null
4541 Do not warn for conversions between @code{NULL} and non-pointer
4542 types. @option{-Wconversion-null} is enabled by default.
4544 @item -Wzero-as-null-pointer-constant @r{(C++ and Objective-C++ only)}
4545 @opindex Wzero-as-null-pointer-constant
4546 @opindex Wno-zero-as-null-pointer-constant
4547 Warn when a literal '0' is used as null pointer constant.  This can
4548 be useful to facilitate the conversion to @code{nullptr} in C++11.
4550 @item -Wdate-time
4551 @opindex Wdate-time
4552 @opindex Wno-date-time
4553 Warn when macros @code{__TIME__}, @code{__DATE__} or @code{__TIMESTAMP__}
4554 are encountered as they might prevent bit-wise-identical reproducible
4555 compilations.
4557 @item -Wdelete-incomplete @r{(C++ and Objective-C++ only)}
4558 @opindex Wdelete-incomplete
4559 @opindex Wno-delete-incomplete
4560 Warn when deleting a pointer to incomplete type, which may cause
4561 undefined behavior at runtime.  This warning is enabled by default.
4563 @item -Wuseless-cast @r{(C++ and Objective-C++ only)}
4564 @opindex Wuseless-cast
4565 @opindex Wno-useless-cast
4566 Warn when an expression is casted to its own type.
4568 @item -Wempty-body
4569 @opindex Wempty-body
4570 @opindex Wno-empty-body
4571 Warn if an empty body occurs in an @samp{if}, @samp{else} or @samp{do
4572 while} statement.  This warning is also enabled by @option{-Wextra}.
4574 @item -Wenum-compare
4575 @opindex Wenum-compare
4576 @opindex Wno-enum-compare
4577 Warn about a comparison between values of different enumerated types.
4578 In C++ enumeral mismatches in conditional expressions are also
4579 diagnosed and the warning is enabled by default.  In C this warning is 
4580 enabled by @option{-Wall}.
4582 @item -Wjump-misses-init @r{(C, Objective-C only)}
4583 @opindex Wjump-misses-init
4584 @opindex Wno-jump-misses-init
4585 Warn if a @code{goto} statement or a @code{switch} statement jumps
4586 forward across the initialization of a variable, or jumps backward to a
4587 label after the variable has been initialized.  This only warns about
4588 variables that are initialized when they are declared.  This warning is
4589 only supported for C and Objective-C; in C++ this sort of branch is an
4590 error in any case.
4592 @option{-Wjump-misses-init} is included in @option{-Wc++-compat}.  It
4593 can be disabled with the @option{-Wno-jump-misses-init} option.
4595 @item -Wsign-compare
4596 @opindex Wsign-compare
4597 @opindex Wno-sign-compare
4598 @cindex warning for comparison of signed and unsigned values
4599 @cindex comparison of signed and unsigned values, warning
4600 @cindex signed and unsigned values, comparison warning
4601 Warn when a comparison between signed and unsigned values could produce
4602 an incorrect result when the signed value is converted to unsigned.
4603 This warning is also enabled by @option{-Wextra}; to get the other warnings
4604 of @option{-Wextra} without this warning, use @option{-Wextra -Wno-sign-compare}.
4606 @item -Wsign-conversion
4607 @opindex Wsign-conversion
4608 @opindex Wno-sign-conversion
4609 Warn for implicit conversions that may change the sign of an integer
4610 value, like assigning a signed integer expression to an unsigned
4611 integer variable. An explicit cast silences the warning. In C, this
4612 option is enabled also by @option{-Wconversion}.
4614 @item -Wfloat-conversion
4615 @opindex Wfloat-conversion
4616 @opindex Wno-float-conversion
4617 Warn for implicit conversions that reduce the precision of a real value.
4618 This includes conversions from real to integer, and from higher precision
4619 real to lower precision real values.  This option is also enabled by
4620 @option{-Wconversion}.
4622 @item -Wsizeof-pointer-memaccess
4623 @opindex Wsizeof-pointer-memaccess
4624 @opindex Wno-sizeof-pointer-memaccess
4625 Warn for suspicious length parameters to certain string and memory built-in
4626 functions if the argument uses @code{sizeof}.  This warning warns e.g.@:
4627 about @code{memset (ptr, 0, sizeof (ptr));} if @code{ptr} is not an array,
4628 but a pointer, and suggests a possible fix, or about
4629 @code{memcpy (&foo, ptr, sizeof (&foo));}.  This warning is enabled by
4630 @option{-Wall}.
4632 @item -Waddress
4633 @opindex Waddress
4634 @opindex Wno-address
4635 Warn about suspicious uses of memory addresses. These include using
4636 the address of a function in a conditional expression, such as
4637 @code{void func(void); if (func)}, and comparisons against the memory
4638 address of a string literal, such as @code{if (x == "abc")}.  Such
4639 uses typically indicate a programmer error: the address of a function
4640 always evaluates to true, so their use in a conditional usually
4641 indicate that the programmer forgot the parentheses in a function
4642 call; and comparisons against string literals result in unspecified
4643 behavior and are not portable in C, so they usually indicate that the
4644 programmer intended to use @code{strcmp}.  This warning is enabled by
4645 @option{-Wall}.
4647 @item -Wlogical-op
4648 @opindex Wlogical-op
4649 @opindex Wno-logical-op
4650 Warn about suspicious uses of logical operators in expressions.
4651 This includes using logical operators in contexts where a
4652 bit-wise operator is likely to be expected.
4654 @item -Waggregate-return
4655 @opindex Waggregate-return
4656 @opindex Wno-aggregate-return
4657 Warn if any functions that return structures or unions are defined or
4658 called.  (In languages where you can return an array, this also elicits
4659 a warning.)
4661 @item -Wno-aggressive-loop-optimizations
4662 @opindex Wno-aggressive-loop-optimizations
4663 @opindex Waggressive-loop-optimizations
4664 Warn if in a loop with constant number of iterations the compiler detects
4665 undefined behavior in some statement during one or more of the iterations.
4667 @item -Wno-attributes
4668 @opindex Wno-attributes
4669 @opindex Wattributes
4670 Do not warn if an unexpected @code{__attribute__} is used, such as
4671 unrecognized attributes, function attributes applied to variables,
4672 etc.  This does not stop errors for incorrect use of supported
4673 attributes.
4675 @item -Wno-builtin-macro-redefined
4676 @opindex Wno-builtin-macro-redefined
4677 @opindex Wbuiltin-macro-redefined
4678 Do not warn if certain built-in macros are redefined.  This suppresses
4679 warnings for redefinition of @code{__TIMESTAMP__}, @code{__TIME__},
4680 @code{__DATE__}, @code{__FILE__}, and @code{__BASE_FILE__}.
4682 @item -Wstrict-prototypes @r{(C and Objective-C only)}
4683 @opindex Wstrict-prototypes
4684 @opindex Wno-strict-prototypes
4685 Warn if a function is declared or defined without specifying the
4686 argument types.  (An old-style function definition is permitted without
4687 a warning if preceded by a declaration that specifies the argument
4688 types.)
4690 @item -Wold-style-declaration @r{(C and Objective-C only)}
4691 @opindex Wold-style-declaration
4692 @opindex Wno-old-style-declaration
4693 Warn for obsolescent usages, according to the C Standard, in a
4694 declaration. For example, warn if storage-class specifiers like
4695 @code{static} are not the first things in a declaration.  This warning
4696 is also enabled by @option{-Wextra}.
4698 @item -Wold-style-definition @r{(C and Objective-C only)}
4699 @opindex Wold-style-definition
4700 @opindex Wno-old-style-definition
4701 Warn if an old-style function definition is used.  A warning is given
4702 even if there is a previous prototype.
4704 @item -Wmissing-parameter-type @r{(C and Objective-C only)}
4705 @opindex Wmissing-parameter-type
4706 @opindex Wno-missing-parameter-type
4707 A function parameter is declared without a type specifier in K&R-style
4708 functions:
4710 @smallexample
4711 void foo(bar) @{ @}
4712 @end smallexample
4714 This warning is also enabled by @option{-Wextra}.
4716 @item -Wmissing-prototypes @r{(C and Objective-C only)}
4717 @opindex Wmissing-prototypes
4718 @opindex Wno-missing-prototypes
4719 Warn if a global function is defined without a previous prototype
4720 declaration.  This warning is issued even if the definition itself
4721 provides a prototype.  Use this option to detect global functions
4722 that do not have a matching prototype declaration in a header file.
4723 This option is not valid for C++ because all function declarations
4724 provide prototypes and a non-matching declaration will declare an
4725 overload rather than conflict with an earlier declaration.
4726 Use @option{-Wmissing-declarations} to detect missing declarations in C++.
4728 @item -Wmissing-declarations
4729 @opindex Wmissing-declarations
4730 @opindex Wno-missing-declarations
4731 Warn if a global function is defined without a previous declaration.
4732 Do so even if the definition itself provides a prototype.
4733 Use this option to detect global functions that are not declared in
4734 header files.  In C, no warnings are issued for functions with previous
4735 non-prototype declarations; use @option{-Wmissing-prototype} to detect
4736 missing prototypes.  In C++, no warnings are issued for function templates,
4737 or for inline functions, or for functions in anonymous namespaces.
4739 @item -Wmissing-field-initializers
4740 @opindex Wmissing-field-initializers
4741 @opindex Wno-missing-field-initializers
4742 @opindex W
4743 @opindex Wextra
4744 @opindex Wno-extra
4745 Warn if a structure's initializer has some fields missing.  For
4746 example, the following code causes such a warning, because
4747 @code{x.h} is implicitly zero:
4749 @smallexample
4750 struct s @{ int f, g, h; @};
4751 struct s x = @{ 3, 4 @};
4752 @end smallexample
4754 This option does not warn about designated initializers, so the following
4755 modification does not trigger a warning:
4757 @smallexample
4758 struct s @{ int f, g, h; @};
4759 struct s x = @{ .f = 3, .g = 4 @};
4760 @end smallexample
4762 This warning is included in @option{-Wextra}.  To get other @option{-Wextra}
4763 warnings without this one, use @option{-Wextra -Wno-missing-field-initializers}.
4765 @item -Wno-multichar
4766 @opindex Wno-multichar
4767 @opindex Wmultichar
4768 Do not warn if a multicharacter constant (@samp{'FOOF'}) is used.
4769 Usually they indicate a typo in the user's code, as they have
4770 implementation-defined values, and should not be used in portable code.
4772 @item -Wnormalized=<none|id|nfc|nfkc>
4773 @opindex Wnormalized=
4774 @cindex NFC
4775 @cindex NFKC
4776 @cindex character set, input normalization
4777 In ISO C and ISO C++, two identifiers are different if they are
4778 different sequences of characters.  However, sometimes when characters
4779 outside the basic ASCII character set are used, you can have two
4780 different character sequences that look the same.  To avoid confusion,
4781 the ISO 10646 standard sets out some @dfn{normalization rules} which
4782 when applied ensure that two sequences that look the same are turned into
4783 the same sequence.  GCC can warn you if you are using identifiers that
4784 have not been normalized; this option controls that warning.
4786 There are four levels of warning supported by GCC@.  The default is
4787 @option{-Wnormalized=nfc}, which warns about any identifier that is
4788 not in the ISO 10646 ``C'' normalized form, @dfn{NFC}.  NFC is the
4789 recommended form for most uses.
4791 Unfortunately, there are some characters allowed in identifiers by
4792 ISO C and ISO C++ that, when turned into NFC, are not allowed in 
4793 identifiers.  That is, there's no way to use these symbols in portable
4794 ISO C or C++ and have all your identifiers in NFC@.
4795 @option{-Wnormalized=id} suppresses the warning for these characters.
4796 It is hoped that future versions of the standards involved will correct
4797 this, which is why this option is not the default.
4799 You can switch the warning off for all characters by writing
4800 @option{-Wnormalized=none}.  You should only do this if you
4801 are using some other normalization scheme (like ``D''), because
4802 otherwise you can easily create bugs that are literally impossible to see.
4804 Some characters in ISO 10646 have distinct meanings but look identical
4805 in some fonts or display methodologies, especially once formatting has
4806 been applied.  For instance @code{\u207F}, ``SUPERSCRIPT LATIN SMALL
4807 LETTER N'', displays just like a regular @code{n} that has been
4808 placed in a superscript.  ISO 10646 defines the @dfn{NFKC}
4809 normalization scheme to convert all these into a standard form as
4810 well, and GCC warns if your code is not in NFKC if you use
4811 @option{-Wnormalized=nfkc}.  This warning is comparable to warning
4812 about every identifier that contains the letter O because it might be
4813 confused with the digit 0, and so is not the default, but may be
4814 useful as a local coding convention if the programming environment 
4815 cannot be fixed to display these characters distinctly.
4817 @item -Wno-deprecated
4818 @opindex Wno-deprecated
4819 @opindex Wdeprecated
4820 Do not warn about usage of deprecated features.  @xref{Deprecated Features}.
4822 @item -Wno-deprecated-declarations
4823 @opindex Wno-deprecated-declarations
4824 @opindex Wdeprecated-declarations
4825 Do not warn about uses of functions (@pxref{Function Attributes}),
4826 variables (@pxref{Variable Attributes}), and types (@pxref{Type
4827 Attributes}) marked as deprecated by using the @code{deprecated}
4828 attribute.
4830 @item -Wno-overflow
4831 @opindex Wno-overflow
4832 @opindex Woverflow
4833 Do not warn about compile-time overflow in constant expressions.
4835 @item -Wopenmp-simd
4836 @opindex Wopenm-simd
4837 Warn if the vectorizer cost model overrides the OpenMP or the Cilk Plus
4838 simd directive set by user.  The @option{-fsimd-cost-model=unlimited} can
4839 be used to relax the cost model.
4841 @item -Woverride-init @r{(C and Objective-C only)}
4842 @opindex Woverride-init
4843 @opindex Wno-override-init
4844 @opindex W
4845 @opindex Wextra
4846 @opindex Wno-extra
4847 Warn if an initialized field without side effects is overridden when
4848 using designated initializers (@pxref{Designated Inits, , Designated
4849 Initializers}).
4851 This warning is included in @option{-Wextra}.  To get other
4852 @option{-Wextra} warnings without this one, use @option{-Wextra
4853 -Wno-override-init}.
4855 @item -Wpacked
4856 @opindex Wpacked
4857 @opindex Wno-packed
4858 Warn if a structure is given the packed attribute, but the packed
4859 attribute has no effect on the layout or size of the structure.
4860 Such structures may be mis-aligned for little benefit.  For
4861 instance, in this code, the variable @code{f.x} in @code{struct bar}
4862 is misaligned even though @code{struct bar} does not itself
4863 have the packed attribute:
4865 @smallexample
4866 @group
4867 struct foo @{
4868   int x;
4869   char a, b, c, d;
4870 @} __attribute__((packed));
4871 struct bar @{
4872   char z;
4873   struct foo f;
4875 @end group
4876 @end smallexample
4878 @item -Wpacked-bitfield-compat
4879 @opindex Wpacked-bitfield-compat
4880 @opindex Wno-packed-bitfield-compat
4881 The 4.1, 4.2 and 4.3 series of GCC ignore the @code{packed} attribute
4882 on bit-fields of type @code{char}.  This has been fixed in GCC 4.4 but
4883 the change can lead to differences in the structure layout.  GCC
4884 informs you when the offset of such a field has changed in GCC 4.4.
4885 For example there is no longer a 4-bit padding between field @code{a}
4886 and @code{b} in this structure:
4888 @smallexample
4889 struct foo
4891   char a:4;
4892   char b:8;
4893 @} __attribute__ ((packed));
4894 @end smallexample
4896 This warning is enabled by default.  Use
4897 @option{-Wno-packed-bitfield-compat} to disable this warning.
4899 @item -Wpadded
4900 @opindex Wpadded
4901 @opindex Wno-padded
4902 Warn if padding is included in a structure, either to align an element
4903 of the structure or to align the whole structure.  Sometimes when this
4904 happens it is possible to rearrange the fields of the structure to
4905 reduce the padding and so make the structure smaller.
4907 @item -Wredundant-decls
4908 @opindex Wredundant-decls
4909 @opindex Wno-redundant-decls
4910 Warn if anything is declared more than once in the same scope, even in
4911 cases where multiple declaration is valid and changes nothing.
4913 @item -Wnested-externs @r{(C and Objective-C only)}
4914 @opindex Wnested-externs
4915 @opindex Wno-nested-externs
4916 Warn if an @code{extern} declaration is encountered within a function.
4918 @item -Wno-inherited-variadic-ctor
4919 @opindex Winherited-variadic-ctor
4920 @opindex Wno-inherited-variadic-ctor
4921 Suppress warnings about use of C++11 inheriting constructors when the
4922 base class inherited from has a C variadic constructor; the warning is
4923 on by default because the ellipsis is not inherited.
4925 @item -Winline
4926 @opindex Winline
4927 @opindex Wno-inline
4928 Warn if a function that is declared as inline cannot be inlined.
4929 Even with this option, the compiler does not warn about failures to
4930 inline functions declared in system headers.
4932 The compiler uses a variety of heuristics to determine whether or not
4933 to inline a function.  For example, the compiler takes into account
4934 the size of the function being inlined and the amount of inlining
4935 that has already been done in the current function.  Therefore,
4936 seemingly insignificant changes in the source program can cause the
4937 warnings produced by @option{-Winline} to appear or disappear.
4939 @item -Wno-invalid-offsetof @r{(C++ and Objective-C++ only)}
4940 @opindex Wno-invalid-offsetof
4941 @opindex Winvalid-offsetof
4942 Suppress warnings from applying the @samp{offsetof} macro to a non-POD
4943 type.  According to the 1998 ISO C++ standard, applying @samp{offsetof}
4944 to a non-POD type is undefined.  In existing C++ implementations,
4945 however, @samp{offsetof} typically gives meaningful results even when
4946 applied to certain kinds of non-POD types (such as a simple
4947 @samp{struct} that fails to be a POD type only by virtue of having a
4948 constructor).  This flag is for users who are aware that they are
4949 writing nonportable code and who have deliberately chosen to ignore the
4950 warning about it.
4952 The restrictions on @samp{offsetof} may be relaxed in a future version
4953 of the C++ standard.
4955 @item -Wno-int-to-pointer-cast
4956 @opindex Wno-int-to-pointer-cast
4957 @opindex Wint-to-pointer-cast
4958 Suppress warnings from casts to pointer type of an integer of a
4959 different size. In C++, casting to a pointer type of smaller size is
4960 an error. @option{Wint-to-pointer-cast} is enabled by default.
4963 @item -Wno-pointer-to-int-cast @r{(C and Objective-C only)}
4964 @opindex Wno-pointer-to-int-cast
4965 @opindex Wpointer-to-int-cast
4966 Suppress warnings from casts from a pointer to an integer type of a
4967 different size.
4969 @item -Winvalid-pch
4970 @opindex Winvalid-pch
4971 @opindex Wno-invalid-pch
4972 Warn if a precompiled header (@pxref{Precompiled Headers}) is found in
4973 the search path but can't be used.
4975 @item -Wlong-long
4976 @opindex Wlong-long
4977 @opindex Wno-long-long
4978 Warn if @samp{long long} type is used.  This is enabled by either
4979 @option{-Wpedantic} or @option{-Wtraditional} in ISO C90 and C++98
4980 modes.  To inhibit the warning messages, use @option{-Wno-long-long}.
4982 @item -Wvariadic-macros
4983 @opindex Wvariadic-macros
4984 @opindex Wno-variadic-macros
4985 Warn if variadic macros are used in pedantic ISO C90 mode, or the GNU
4986 alternate syntax when in pedantic ISO C99 mode.  This is default.
4987 To inhibit the warning messages, use @option{-Wno-variadic-macros}.
4989 @item -Wvarargs
4990 @opindex Wvarargs
4991 @opindex Wno-varargs
4992 Warn upon questionable usage of the macros used to handle variable
4993 arguments like @samp{va_start}.  This is default.  To inhibit the
4994 warning messages, use @option{-Wno-varargs}.
4996 @item -Wvector-operation-performance
4997 @opindex Wvector-operation-performance
4998 @opindex Wno-vector-operation-performance
4999 Warn if vector operation is not implemented via SIMD capabilities of the
5000 architecture.  Mainly useful for the performance tuning.
5001 Vector operation can be implemented @code{piecewise}, which means that the
5002 scalar operation is performed on every vector element; 
5003 @code{in parallel}, which means that the vector operation is implemented
5004 using scalars of wider type, which normally is more performance efficient;
5005 and @code{as a single scalar}, which means that vector fits into a
5006 scalar type.
5008 @item -Wno-virtual-move-assign
5009 @opindex Wvirtual-move-assign
5010 @opindex Wno-virtual-move-assign
5011 Suppress warnings about inheriting from a virtual base with a
5012 non-trivial C++11 move assignment operator.  This is dangerous because
5013 if the virtual base is reachable along more than one path, it will be
5014 moved multiple times, which can mean both objects end up in the
5015 moved-from state.  If the move assignment operator is written to avoid
5016 moving from a moved-from object, this warning can be disabled.
5018 @item -Wvla
5019 @opindex Wvla
5020 @opindex Wno-vla
5021 Warn if variable length array is used in the code.
5022 @option{-Wno-vla} prevents the @option{-Wpedantic} warning of
5023 the variable length array.
5025 @item -Wvolatile-register-var
5026 @opindex Wvolatile-register-var
5027 @opindex Wno-volatile-register-var
5028 Warn if a register variable is declared volatile.  The volatile
5029 modifier does not inhibit all optimizations that may eliminate reads
5030 and/or writes to register variables.  This warning is enabled by
5031 @option{-Wall}.
5033 @item -Wdisabled-optimization
5034 @opindex Wdisabled-optimization
5035 @opindex Wno-disabled-optimization
5036 Warn if a requested optimization pass is disabled.  This warning does
5037 not generally indicate that there is anything wrong with your code; it
5038 merely indicates that GCC's optimizers are unable to handle the code
5039 effectively.  Often, the problem is that your code is too big or too
5040 complex; GCC refuses to optimize programs when the optimization
5041 itself is likely to take inordinate amounts of time.
5043 @item -Wpointer-sign @r{(C and Objective-C only)}
5044 @opindex Wpointer-sign
5045 @opindex Wno-pointer-sign
5046 Warn for pointer argument passing or assignment with different signedness.
5047 This option is only supported for C and Objective-C@.  It is implied by
5048 @option{-Wall} and by @option{-Wpedantic}, which can be disabled with
5049 @option{-Wno-pointer-sign}.
5051 @item -Wstack-protector
5052 @opindex Wstack-protector
5053 @opindex Wno-stack-protector
5054 This option is only active when @option{-fstack-protector} is active.  It
5055 warns about functions that are not protected against stack smashing.
5057 @item -Woverlength-strings
5058 @opindex Woverlength-strings
5059 @opindex Wno-overlength-strings
5060 Warn about string constants that are longer than the ``minimum
5061 maximum'' length specified in the C standard.  Modern compilers
5062 generally allow string constants that are much longer than the
5063 standard's minimum limit, but very portable programs should avoid
5064 using longer strings.
5066 The limit applies @emph{after} string constant concatenation, and does
5067 not count the trailing NUL@.  In C90, the limit was 509 characters; in
5068 C99, it was raised to 4095.  C++98 does not specify a normative
5069 minimum maximum, so we do not diagnose overlength strings in C++@.
5071 This option is implied by @option{-Wpedantic}, and can be disabled with
5072 @option{-Wno-overlength-strings}.
5074 @item -Wunsuffixed-float-constants @r{(C and Objective-C only)}
5075 @opindex Wunsuffixed-float-constants
5077 Issue a warning for any floating constant that does not have
5078 a suffix.  When used together with @option{-Wsystem-headers} it
5079 warns about such constants in system header files.  This can be useful
5080 when preparing code to use with the @code{FLOAT_CONST_DECIMAL64} pragma
5081 from the decimal floating-point extension to C99.
5082 @end table
5084 @node Debugging Options
5085 @section Options for Debugging Your Program or GCC
5086 @cindex options, debugging
5087 @cindex debugging information options
5089 GCC has various special options that are used for debugging
5090 either your program or GCC:
5092 @table @gcctabopt
5093 @item -g
5094 @opindex g
5095 Produce debugging information in the operating system's native format
5096 (stabs, COFF, XCOFF, or DWARF 2)@.  GDB can work with this debugging
5097 information.
5099 On most systems that use stabs format, @option{-g} enables use of extra
5100 debugging information that only GDB can use; this extra information
5101 makes debugging work better in GDB but probably makes other debuggers
5102 crash or
5103 refuse to read the program.  If you want to control for certain whether
5104 to generate the extra information, use @option{-gstabs+}, @option{-gstabs},
5105 @option{-gxcoff+}, @option{-gxcoff}, or @option{-gvms} (see below).
5107 GCC allows you to use @option{-g} with
5108 @option{-O}.  The shortcuts taken by optimized code may occasionally
5109 produce surprising results: some variables you declared may not exist
5110 at all; flow of control may briefly move where you did not expect it;
5111 some statements may not be executed because they compute constant
5112 results or their values are already at hand; some statements may
5113 execute in different places because they have been moved out of loops.
5115 Nevertheless it proves possible to debug optimized output.  This makes
5116 it reasonable to use the optimizer for programs that might have bugs.
5118 The following options are useful when GCC is generated with the
5119 capability for more than one debugging format.
5121 @item -gsplit-dwarf
5122 @opindex gsplit-dwarf
5123 Separate as much dwarf debugging information as possible into a
5124 separate output file with the extension .dwo.  This option allows
5125 the build system to avoid linking files with debug information.  To
5126 be useful, this option requires a debugger capable of reading .dwo
5127 files.
5129 @item -ggdb
5130 @opindex ggdb
5131 Produce debugging information for use by GDB@.  This means to use the
5132 most expressive format available (DWARF 2, stabs, or the native format
5133 if neither of those are supported), including GDB extensions if at all
5134 possible.
5136 @item -gpubnames
5137 @opindex gpubnames
5138 Generate dwarf .debug_pubnames and .debug_pubtypes sections.
5140 @item -ggnu-pubnames
5141 @opindex ggnu-pubnames
5142 Generate .debug_pubnames and .debug_pubtypes sections in a format
5143 suitable for conversion into a GDB@ index.  This option is only useful
5144 with a linker that can produce GDB@ index version 7.
5146 @item -gstabs
5147 @opindex gstabs
5148 Produce debugging information in stabs format (if that is supported),
5149 without GDB extensions.  This is the format used by DBX on most BSD
5150 systems.  On MIPS, Alpha and System V Release 4 systems this option
5151 produces stabs debugging output that is not understood by DBX or SDB@.
5152 On System V Release 4 systems this option requires the GNU assembler.
5154 @item -feliminate-unused-debug-symbols
5155 @opindex feliminate-unused-debug-symbols
5156 Produce debugging information in stabs format (if that is supported),
5157 for only symbols that are actually used.
5159 @item -femit-class-debug-always
5160 Instead of emitting debugging information for a C++ class in only one
5161 object file, emit it in all object files using the class.  This option
5162 should be used only with debuggers that are unable to handle the way GCC
5163 normally emits debugging information for classes because using this
5164 option increases the size of debugging information by as much as a
5165 factor of two.
5167 @item -fdebug-types-section
5168 @opindex fdebug-types-section
5169 @opindex fno-debug-types-section
5170 When using DWARF Version 4 or higher, type DIEs can be put into
5171 their own @code{.debug_types} section instead of making them part of the
5172 @code{.debug_info} section.  It is more efficient to put them in a separate
5173 comdat sections since the linker can then remove duplicates.
5174 But not all DWARF consumers support @code{.debug_types} sections yet
5175 and on some objects @code{.debug_types} produces larger instead of smaller
5176 debugging information.
5178 @item -gstabs+
5179 @opindex gstabs+
5180 Produce debugging information in stabs format (if that is supported),
5181 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5182 use of these extensions is likely to make other debuggers crash or
5183 refuse to read the program.
5185 @item -gcoff
5186 @opindex gcoff
5187 Produce debugging information in COFF format (if that is supported).
5188 This is the format used by SDB on most System V systems prior to
5189 System V Release 4.
5191 @item -gxcoff
5192 @opindex gxcoff
5193 Produce debugging information in XCOFF format (if that is supported).
5194 This is the format used by the DBX debugger on IBM RS/6000 systems.
5196 @item -gxcoff+
5197 @opindex gxcoff+
5198 Produce debugging information in XCOFF format (if that is supported),
5199 using GNU extensions understood only by the GNU debugger (GDB)@.  The
5200 use of these extensions is likely to make other debuggers crash or
5201 refuse to read the program, and may cause assemblers other than the GNU
5202 assembler (GAS) to fail with an error.
5204 @item -gdwarf-@var{version}
5205 @opindex gdwarf-@var{version}
5206 Produce debugging information in DWARF format (if that is supported).
5207 The value of @var{version} may be either 2, 3 or 4; the default version
5208 for most targets is 4.
5210 Note that with DWARF Version 2, some ports require and always
5211 use some non-conflicting DWARF 3 extensions in the unwind tables.
5213 Version 4 may require GDB 7.0 and @option{-fvar-tracking-assignments}
5214 for maximum benefit.
5216 @item -grecord-gcc-switches
5217 @opindex grecord-gcc-switches
5218 This switch causes the command-line options used to invoke the
5219 compiler that may affect code generation to be appended to the
5220 DW_AT_producer attribute in DWARF debugging information.  The options
5221 are concatenated with spaces separating them from each other and from
5222 the compiler version.  See also @option{-frecord-gcc-switches} for another
5223 way of storing compiler options into the object file.  This is the default.
5225 @item -gno-record-gcc-switches
5226 @opindex gno-record-gcc-switches
5227 Disallow appending command-line options to the DW_AT_producer attribute
5228 in DWARF debugging information.
5230 @item -gstrict-dwarf
5231 @opindex gstrict-dwarf
5232 Disallow using extensions of later DWARF standard version than selected
5233 with @option{-gdwarf-@var{version}}.  On most targets using non-conflicting
5234 DWARF extensions from later standard versions is allowed.
5236 @item -gno-strict-dwarf
5237 @opindex gno-strict-dwarf
5238 Allow using extensions of later DWARF standard version than selected with
5239 @option{-gdwarf-@var{version}}.
5241 @item -gvms
5242 @opindex gvms
5243 Produce debugging information in Alpha/VMS debug format (if that is
5244 supported).  This is the format used by DEBUG on Alpha/VMS systems.
5246 @item -g@var{level}
5247 @itemx -ggdb@var{level}
5248 @itemx -gstabs@var{level}
5249 @itemx -gcoff@var{level}
5250 @itemx -gxcoff@var{level}
5251 @itemx -gvms@var{level}
5252 Request debugging information and also use @var{level} to specify how
5253 much information.  The default level is 2.
5255 Level 0 produces no debug information at all.  Thus, @option{-g0} negates
5256 @option{-g}.
5258 Level 1 produces minimal information, enough for making backtraces in
5259 parts of the program that you don't plan to debug.  This includes
5260 descriptions of functions and external variables, and line number
5261 tables, but no information about local variables.
5263 Level 3 includes extra information, such as all the macro definitions
5264 present in the program.  Some debuggers support macro expansion when
5265 you use @option{-g3}.
5267 @option{-gdwarf-2} does not accept a concatenated debug level, because
5268 GCC used to support an option @option{-gdwarf} that meant to generate
5269 debug information in version 1 of the DWARF format (which is very
5270 different from version 2), and it would have been too confusing.  That
5271 debug format is long obsolete, but the option cannot be changed now.
5272 Instead use an additional @option{-g@var{level}} option to change the
5273 debug level for DWARF.
5275 @item -gtoggle
5276 @opindex gtoggle
5277 Turn off generation of debug info, if leaving out this option
5278 generates it, or turn it on at level 2 otherwise.  The position of this
5279 argument in the command line does not matter; it takes effect after all
5280 other options are processed, and it does so only once, no matter how
5281 many times it is given.  This is mainly intended to be used with
5282 @option{-fcompare-debug}.
5284 @item -fsanitize=address
5285 @opindex fsanitize=address
5286 Enable AddressSanitizer, a fast memory error detector.
5287 Memory access instructions will be instrumented to detect
5288 out-of-bounds and use-after-free bugs.
5289 See @uref{http://code.google.com/p/address-sanitizer/} for
5290 more details.  The run-time behavior can be influenced using the
5291 @env{ASAN_OPTIONS} environment variable; see
5292 @url{https://code.google.com/p/address-sanitizer/wiki/Flags#Run-time_flags} for
5293 a list of supported options.
5295 @item -fsanitize=thread
5296 @opindex fsanitize=thread
5297 Enable ThreadSanitizer, a fast data race detector.
5298 Memory access instructions will be instrumented to detect
5299 data race bugs.  See @uref{http://code.google.com/p/thread-sanitizer/} for more
5300 details. The run-time behavior can be influenced using the @env{TSAN_OPTIONS}
5301 environment variable; see
5302 @url{https://code.google.com/p/thread-sanitizer/wiki/Flags} for a list of
5303 supported options.
5305 @item -fsanitize=leak
5306 @opindex fsanitize=leak
5307 Enable LeakSanitizer, a memory leak detector.
5308 This option only matters for linking of executables and if neither
5309 @option{-fsanitize=address} nor @option{-fsanitize=thread} is used.  In that
5310 case it will link the executable against a library that overrides @code{malloc}
5311 and other allocator functions.  See
5312 @uref{https://code.google.com/p/address-sanitizer/wiki/LeakSanitizer} for more
5313 details.  The run-time behavior can be influenced using the
5314 @env{LSAN_OPTIONS} environment variable.
5316 @item -fsanitize=undefined
5317 @opindex fsanitize=undefined
5318 Enable UndefinedBehaviorSanitizer, a fast undefined behavior detector.
5319 Various computations will be instrumented to detect undefined behavior
5320 at runtime.  Current suboptions are:
5322 @table @gcctabopt
5324 @item -fsanitize=shift
5325 @opindex fsanitize=shift
5327 This option enables checking that the result of a shift operation is
5328 not undefined.  Note that what exactly is considered undefined differs
5329 slightly between C and C++, as well as between ISO C90 and C99, etc.
5331 @item -fsanitize=integer-divide-by-zero
5332 @opindex fsanitize=integer-divide-by-zero
5334 Detect integer division by zero as well as @code{INT_MIN / -1} division.
5336 @item -fsanitize=unreachable
5337 @opindex fsanitize=unreachable
5339 With this option, the compiler will turn the @code{__builtin_unreachable}
5340 call into a diagnostics message call instead.  When reaching the
5341 @code{__builtin_unreachable} call, the behavior is undefined.
5343 @item -fsanitize=vla-bound
5344 @opindex fsanitize=vla-bound
5346 This option instructs the compiler to check that the size of a variable
5347 length array is positive.  This option does not have any effect in
5348 @option{-std=c++1y} mode, as the standard requires the exception be thrown
5349 instead.
5351 @item -fsanitize=null
5352 @opindex fsanitize=null
5354 This option enables pointer checking.  Particularly, the application
5355 built with this option turned on will issue an error message when it
5356 tries to dereference a NULL pointer, or if a reference (possibly an
5357 rvalue reference) is bound to a NULL pointer.
5359 @item -fsanitize=return
5360 @opindex fsanitize=return
5362 This option enables return statement checking.  Programs
5363 built with this option turned on will issue an error message
5364 when the end of a non-void function is reached without actually
5365 returning a value.  This option works in C++ only.
5367 @item -fsanitize=signed-integer-overflow
5368 @opindex fsanitize=signed-integer-overflow
5370 This option enables signed integer overflow checking.  We check that
5371 the result of @code{+}, @code{*}, and both unary and binary @code{-}
5372 does not overflow in the signed arithmetics.  Note, integer promotion
5373 rules must be taken into account.  That is, the following is not an
5374 overflow:
5375 @smallexample
5376 signed char a = SCHAR_MAX;
5377 a++;
5378 @end smallexample
5380 @end table
5382 While @option{-ftrapv} causes traps for signed overflows to be emitted,
5383 @option{-fsanitize=undefined} gives a diagnostic message.
5384 This currently works only for the C family of languages.
5386 @item -fsanitize-recover
5387 @opindex fsanitize-recover
5388 By default @option{-fsanitize=undefined} sanitization (and its suboptions
5389 except for @option{-fsanitize=unreachable} and @option{-fsanitize=return})
5390 after reporting undefined behavior attempts to continue running the
5391 program as if no undefined behavior happened.  This means multiple undefined
5392 behavior runtime errors can be reported in a single program run, and the exit
5393 code of the program may indicate success even when undefined behavior
5394 has been reported.  The @option{-fno-sanitize-recover} can be used to alter
5395 this behavior, only the first detected undefined behavior will be reported
5396 and program will exit after that with non-zero exit code.
5398 @item -fsanitize-undefined-trap-on-error
5399 @opindex fsanitize-undefined-trap-on-error
5400 The @option{-fsanitize-undefined-trap-on-error} instructs the compiler to
5401 report undefined behavior using @code{__builtin_trap ()} rather than
5402 a @code{libubsan} library routine.  The advantage of this is that the
5403 @code{libubsan} library is not needed and will not be linked in, so this
5404 is usable even for use in freestanding environments.
5406 @item -fdump-final-insns@r{[}=@var{file}@r{]}
5407 @opindex fdump-final-insns
5408 Dump the final internal representation (RTL) to @var{file}.  If the
5409 optional argument is omitted (or if @var{file} is @code{.}), the name
5410 of the dump file is determined by appending @code{.gkd} to the
5411 compilation output file name.
5413 @item -fcompare-debug@r{[}=@var{opts}@r{]}
5414 @opindex fcompare-debug
5415 @opindex fno-compare-debug
5416 If no error occurs during compilation, run the compiler a second time,
5417 adding @var{opts} and @option{-fcompare-debug-second} to the arguments
5418 passed to the second compilation.  Dump the final internal
5419 representation in both compilations, and print an error if they differ.
5421 If the equal sign is omitted, the default @option{-gtoggle} is used.
5423 The environment variable @env{GCC_COMPARE_DEBUG}, if defined, non-empty
5424 and nonzero, implicitly enables @option{-fcompare-debug}.  If
5425 @env{GCC_COMPARE_DEBUG} is defined to a string starting with a dash,
5426 then it is used for @var{opts}, otherwise the default @option{-gtoggle}
5427 is used.
5429 @option{-fcompare-debug=}, with the equal sign but without @var{opts},
5430 is equivalent to @option{-fno-compare-debug}, which disables the dumping
5431 of the final representation and the second compilation, preventing even
5432 @env{GCC_COMPARE_DEBUG} from taking effect.
5434 To verify full coverage during @option{-fcompare-debug} testing, set
5435 @env{GCC_COMPARE_DEBUG} to say @samp{-fcompare-debug-not-overridden},
5436 which GCC rejects as an invalid option in any actual compilation
5437 (rather than preprocessing, assembly or linking).  To get just a
5438 warning, setting @env{GCC_COMPARE_DEBUG} to @samp{-w%n-fcompare-debug
5439 not overridden} will do.
5441 @item -fcompare-debug-second
5442 @opindex fcompare-debug-second
5443 This option is implicitly passed to the compiler for the second
5444 compilation requested by @option{-fcompare-debug}, along with options to
5445 silence warnings, and omitting other options that would cause
5446 side-effect compiler outputs to files or to the standard output.  Dump
5447 files and preserved temporary files are renamed so as to contain the
5448 @code{.gk} additional extension during the second compilation, to avoid
5449 overwriting those generated by the first.
5451 When this option is passed to the compiler driver, it causes the
5452 @emph{first} compilation to be skipped, which makes it useful for little
5453 other than debugging the compiler proper.
5455 @item -feliminate-dwarf2-dups
5456 @opindex feliminate-dwarf2-dups
5457 Compress DWARF 2 debugging information by eliminating duplicated
5458 information about each symbol.  This option only makes sense when
5459 generating DWARF 2 debugging information with @option{-gdwarf-2}.
5461 @item -femit-struct-debug-baseonly
5462 @opindex femit-struct-debug-baseonly
5463 Emit debug information for struct-like types
5464 only when the base name of the compilation source file
5465 matches the base name of file in which the struct is defined.
5467 This option substantially reduces the size of debugging information,
5468 but at significant potential loss in type information to the debugger.
5469 See @option{-femit-struct-debug-reduced} for a less aggressive option.
5470 See @option{-femit-struct-debug-detailed} for more detailed control.
5472 This option works only with DWARF 2.
5474 @item -femit-struct-debug-reduced
5475 @opindex femit-struct-debug-reduced
5476 Emit debug information for struct-like types
5477 only when the base name of the compilation source file
5478 matches the base name of file in which the type is defined,
5479 unless the struct is a template or defined in a system header.
5481 This option significantly reduces the size of debugging information,
5482 with some potential loss in type information to the debugger.
5483 See @option{-femit-struct-debug-baseonly} for a more aggressive option.
5484 See @option{-femit-struct-debug-detailed} for more detailed control.
5486 This option works only with DWARF 2.
5488 @item -femit-struct-debug-detailed@r{[}=@var{spec-list}@r{]}
5489 Specify the struct-like types
5490 for which the compiler generates debug information.
5491 The intent is to reduce duplicate struct debug information
5492 between different object files within the same program.
5494 This option is a detailed version of
5495 @option{-femit-struct-debug-reduced} and @option{-femit-struct-debug-baseonly},
5496 which serves for most needs.
5498 A specification has the syntax@*
5499 [@samp{dir:}|@samp{ind:}][@samp{ord:}|@samp{gen:}](@samp{any}|@samp{sys}|@samp{base}|@samp{none})
5501 The optional first word limits the specification to
5502 structs that are used directly (@samp{dir:}) or used indirectly (@samp{ind:}).
5503 A struct type is used directly when it is the type of a variable, member.
5504 Indirect uses arise through pointers to structs.
5505 That is, when use of an incomplete struct is valid, the use is indirect.
5506 An example is
5507 @samp{struct one direct; struct two * indirect;}.
5509 The optional second word limits the specification to
5510 ordinary structs (@samp{ord:}) or generic structs (@samp{gen:}).
5511 Generic structs are a bit complicated to explain.
5512 For C++, these are non-explicit specializations of template classes,
5513 or non-template classes within the above.
5514 Other programming languages have generics,
5515 but @option{-femit-struct-debug-detailed} does not yet implement them.
5517 The third word specifies the source files for those
5518 structs for which the compiler should emit debug information.
5519 The values @samp{none} and @samp{any} have the normal meaning.
5520 The value @samp{base} means that
5521 the base of name of the file in which the type declaration appears
5522 must match the base of the name of the main compilation file.
5523 In practice, this means that when compiling @file{foo.c}, debug information
5524 is generated for types declared in that file and @file{foo.h},
5525 but not other header files.
5526 The value @samp{sys} means those types satisfying @samp{base}
5527 or declared in system or compiler headers.
5529 You may need to experiment to determine the best settings for your application.
5531 The default is @option{-femit-struct-debug-detailed=all}.
5533 This option works only with DWARF 2.
5535 @item -fno-merge-debug-strings
5536 @opindex fmerge-debug-strings
5537 @opindex fno-merge-debug-strings
5538 Direct the linker to not merge together strings in the debugging
5539 information that are identical in different object files.  Merging is
5540 not supported by all assemblers or linkers.  Merging decreases the size
5541 of the debug information in the output file at the cost of increasing
5542 link processing time.  Merging is enabled by default.
5544 @item -fdebug-prefix-map=@var{old}=@var{new}
5545 @opindex fdebug-prefix-map
5546 When compiling files in directory @file{@var{old}}, record debugging
5547 information describing them as in @file{@var{new}} instead.
5549 @item -fno-dwarf2-cfi-asm
5550 @opindex fdwarf2-cfi-asm
5551 @opindex fno-dwarf2-cfi-asm
5552 Emit DWARF 2 unwind info as compiler generated @code{.eh_frame} section
5553 instead of using GAS @code{.cfi_*} directives.
5555 @cindex @command{prof}
5556 @item -p
5557 @opindex p
5558 Generate extra code to write profile information suitable for the
5559 analysis program @command{prof}.  You must use this option when compiling
5560 the source files you want data about, and you must also use it when
5561 linking.
5563 @cindex @command{gprof}
5564 @item -pg
5565 @opindex pg
5566 Generate extra code to write profile information suitable for the
5567 analysis program @command{gprof}.  You must use this option when compiling
5568 the source files you want data about, and you must also use it when
5569 linking.
5571 @item -Q
5572 @opindex Q
5573 Makes the compiler print out each function name as it is compiled, and
5574 print some statistics about each pass when it finishes.
5576 @item -ftime-report
5577 @opindex ftime-report
5578 Makes the compiler print some statistics about the time consumed by each
5579 pass when it finishes.
5581 @item -fmem-report
5582 @opindex fmem-report
5583 Makes the compiler print some statistics about permanent memory
5584 allocation when it finishes.
5586 @item -fmem-report-wpa
5587 @opindex fmem-report-wpa
5588 Makes the compiler print some statistics about permanent memory
5589 allocation for the WPA phase only.
5591 @item -fpre-ipa-mem-report
5592 @opindex fpre-ipa-mem-report
5593 @item -fpost-ipa-mem-report
5594 @opindex fpost-ipa-mem-report
5595 Makes the compiler print some statistics about permanent memory
5596 allocation before or after interprocedural optimization.
5598 @item -fprofile-report
5599 @opindex fprofile-report
5600 Makes the compiler print some statistics about consistency of the
5601 (estimated) profile and effect of individual passes.
5603 @item -fstack-usage
5604 @opindex fstack-usage
5605 Makes the compiler output stack usage information for the program, on a
5606 per-function basis.  The filename for the dump is made by appending
5607 @file{.su} to the @var{auxname}.  @var{auxname} is generated from the name of
5608 the output file, if explicitly specified and it is not an executable,
5609 otherwise it is the basename of the source file.  An entry is made up
5610 of three fields:
5612 @itemize
5613 @item
5614 The name of the function.
5615 @item
5616 A number of bytes.
5617 @item
5618 One or more qualifiers: @code{static}, @code{dynamic}, @code{bounded}.
5619 @end itemize
5621 The qualifier @code{static} means that the function manipulates the stack
5622 statically: a fixed number of bytes are allocated for the frame on function
5623 entry and released on function exit; no stack adjustments are otherwise made
5624 in the function.  The second field is this fixed number of bytes.
5626 The qualifier @code{dynamic} means that the function manipulates the stack
5627 dynamically: in addition to the static allocation described above, stack
5628 adjustments are made in the body of the function, for example to push/pop
5629 arguments around function calls.  If the qualifier @code{bounded} is also
5630 present, the amount of these adjustments is bounded at compile time and
5631 the second field is an upper bound of the total amount of stack used by
5632 the function.  If it is not present, the amount of these adjustments is
5633 not bounded at compile time and the second field only represents the
5634 bounded part.
5636 @item -fprofile-arcs
5637 @opindex fprofile-arcs
5638 Add code so that program flow @dfn{arcs} are instrumented.  During
5639 execution the program records how many times each branch and call is
5640 executed and how many times it is taken or returns.  When the compiled
5641 program exits it saves this data to a file called
5642 @file{@var{auxname}.gcda} for each source file.  The data may be used for
5643 profile-directed optimizations (@option{-fbranch-probabilities}), or for
5644 test coverage analysis (@option{-ftest-coverage}).  Each object file's
5645 @var{auxname} is generated from the name of the output file, if
5646 explicitly specified and it is not the final executable, otherwise it is
5647 the basename of the source file.  In both cases any suffix is removed
5648 (e.g.@: @file{foo.gcda} for input file @file{dir/foo.c}, or
5649 @file{dir/foo.gcda} for output file specified as @option{-o dir/foo.o}).
5650 @xref{Cross-profiling}.
5652 @cindex @command{gcov}
5653 @item --coverage
5654 @opindex coverage
5656 This option is used to compile and link code instrumented for coverage
5657 analysis.  The option is a synonym for @option{-fprofile-arcs}
5658 @option{-ftest-coverage} (when compiling) and @option{-lgcov} (when
5659 linking).  See the documentation for those options for more details.
5661 @itemize
5663 @item
5664 Compile the source files with @option{-fprofile-arcs} plus optimization
5665 and code generation options.  For test coverage analysis, use the
5666 additional @option{-ftest-coverage} option.  You do not need to profile
5667 every source file in a program.
5669 @item
5670 Link your object files with @option{-lgcov} or @option{-fprofile-arcs}
5671 (the latter implies the former).
5673 @item
5674 Run the program on a representative workload to generate the arc profile
5675 information.  This may be repeated any number of times.  You can run
5676 concurrent instances of your program, and provided that the file system
5677 supports locking, the data files will be correctly updated.  Also
5678 @code{fork} calls are detected and correctly handled (double counting
5679 will not happen).
5681 @item
5682 For profile-directed optimizations, compile the source files again with
5683 the same optimization and code generation options plus
5684 @option{-fbranch-probabilities} (@pxref{Optimize Options,,Options that
5685 Control Optimization}).
5687 @item
5688 For test coverage analysis, use @command{gcov} to produce human readable
5689 information from the @file{.gcno} and @file{.gcda} files.  Refer to the
5690 @command{gcov} documentation for further information.
5692 @end itemize
5694 With @option{-fprofile-arcs}, for each function of your program GCC
5695 creates a program flow graph, then finds a spanning tree for the graph.
5696 Only arcs that are not on the spanning tree have to be instrumented: the
5697 compiler adds code to count the number of times that these arcs are
5698 executed.  When an arc is the only exit or only entrance to a block, the
5699 instrumentation code can be added to the block; otherwise, a new basic
5700 block must be created to hold the instrumentation code.
5702 @need 2000
5703 @item -ftest-coverage
5704 @opindex ftest-coverage
5705 Produce a notes file that the @command{gcov} code-coverage utility
5706 (@pxref{Gcov,, @command{gcov}---a Test Coverage Program}) can use to
5707 show program coverage.  Each source file's note file is called
5708 @file{@var{auxname}.gcno}.  Refer to the @option{-fprofile-arcs} option
5709 above for a description of @var{auxname} and instructions on how to
5710 generate test coverage data.  Coverage data matches the source files
5711 more closely if you do not optimize.
5713 @item -fdbg-cnt-list
5714 @opindex fdbg-cnt-list
5715 Print the name and the counter upper bound for all debug counters.
5718 @item -fdbg-cnt=@var{counter-value-list}
5719 @opindex fdbg-cnt
5720 Set the internal debug counter upper bound.  @var{counter-value-list}
5721 is a comma-separated list of @var{name}:@var{value} pairs
5722 which sets the upper bound of each debug counter @var{name} to @var{value}.
5723 All debug counters have the initial upper bound of @code{UINT_MAX};
5724 thus @code{dbg_cnt()} returns true always unless the upper bound
5725 is set by this option.
5726 For example, with @option{-fdbg-cnt=dce:10,tail_call:0},
5727 @code{dbg_cnt(dce)} returns true only for first 10 invocations.
5729 @item -fenable-@var{kind}-@var{pass}
5730 @itemx -fdisable-@var{kind}-@var{pass}=@var{range-list}
5731 @opindex fdisable-
5732 @opindex fenable-
5734 This is a set of options that are used to explicitly disable/enable
5735 optimization passes.  These options are intended for use for debugging GCC.
5736 Compiler users should use regular options for enabling/disabling
5737 passes instead.
5739 @table @gcctabopt
5741 @item -fdisable-ipa-@var{pass}
5742 Disable IPA pass @var{pass}. @var{pass} is the pass name.  If the same pass is
5743 statically invoked in the compiler multiple times, the pass name should be
5744 appended with a sequential number starting from 1.
5746 @item -fdisable-rtl-@var{pass}
5747 @itemx -fdisable-rtl-@var{pass}=@var{range-list}
5748 Disable RTL pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5749 statically invoked in the compiler multiple times, the pass name should be
5750 appended with a sequential number starting from 1.  @var{range-list} is a 
5751 comma-separated list of function ranges or assembler names.  Each range is a number
5752 pair separated by a colon.  The range is inclusive in both ends.  If the range
5753 is trivial, the number pair can be simplified as a single number.  If the
5754 function's call graph node's @var{uid} falls within one of the specified ranges,
5755 the @var{pass} is disabled for that function.  The @var{uid} is shown in the
5756 function header of a dump file, and the pass names can be dumped by using
5757 option @option{-fdump-passes}.
5759 @item -fdisable-tree-@var{pass}
5760 @itemx -fdisable-tree-@var{pass}=@var{range-list}
5761 Disable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description of
5762 option arguments.
5764 @item -fenable-ipa-@var{pass}
5765 Enable IPA pass @var{pass}.  @var{pass} is the pass name.  If the same pass is
5766 statically invoked in the compiler multiple times, the pass name should be
5767 appended with a sequential number starting from 1.
5769 @item -fenable-rtl-@var{pass}
5770 @itemx -fenable-rtl-@var{pass}=@var{range-list}
5771 Enable RTL pass @var{pass}.  See @option{-fdisable-rtl} for option argument
5772 description and examples.
5774 @item -fenable-tree-@var{pass}
5775 @itemx -fenable-tree-@var{pass}=@var{range-list}
5776 Enable tree pass @var{pass}.  See @option{-fdisable-rtl} for the description
5777 of option arguments.
5779 @end table
5781 Here are some examples showing uses of these options.
5783 @smallexample
5785 # disable ccp1 for all functions
5786    -fdisable-tree-ccp1
5787 # disable complete unroll for function whose cgraph node uid is 1
5788    -fenable-tree-cunroll=1
5789 # disable gcse2 for functions at the following ranges [1,1],
5790 # [300,400], and [400,1000]
5791 # disable gcse2 for functions foo and foo2
5792    -fdisable-rtl-gcse2=foo,foo2
5793 # disable early inlining
5794    -fdisable-tree-einline
5795 # disable ipa inlining
5796    -fdisable-ipa-inline
5797 # enable tree full unroll
5798    -fenable-tree-unroll
5800 @end smallexample
5802 @item -d@var{letters}
5803 @itemx -fdump-rtl-@var{pass}
5804 @itemx -fdump-rtl-@var{pass}=@var{filename}
5805 @opindex d
5806 @opindex fdump-rtl-@var{pass}
5807 Says to make debugging dumps during compilation at times specified by
5808 @var{letters}.  This is used for debugging the RTL-based passes of the
5809 compiler.  The file names for most of the dumps are made by appending
5810 a pass number and a word to the @var{dumpname}, and the files are
5811 created in the directory of the output file. In case of
5812 @option{=@var{filename}} option, the dump is output on the given file
5813 instead of the pass numbered dump files. Note that the pass number is
5814 computed statically as passes get registered into the pass manager.
5815 Thus the numbering is not related to the dynamic order of execution of
5816 passes.  In particular, a pass installed by a plugin could have a
5817 number over 200 even if it executed quite early.  @var{dumpname} is
5818 generated from the name of the output file, if explicitly specified
5819 and it is not an executable, otherwise it is the basename of the
5820 source file. These switches may have different effects when
5821 @option{-E} is used for preprocessing.
5823 Debug dumps can be enabled with a @option{-fdump-rtl} switch or some
5824 @option{-d} option @var{letters}.  Here are the possible
5825 letters for use in @var{pass} and @var{letters}, and their meanings:
5827 @table @gcctabopt
5829 @item -fdump-rtl-alignments
5830 @opindex fdump-rtl-alignments
5831 Dump after branch alignments have been computed.
5833 @item -fdump-rtl-asmcons
5834 @opindex fdump-rtl-asmcons
5835 Dump after fixing rtl statements that have unsatisfied in/out constraints.
5837 @item -fdump-rtl-auto_inc_dec
5838 @opindex fdump-rtl-auto_inc_dec
5839 Dump after auto-inc-dec discovery.  This pass is only run on
5840 architectures that have auto inc or auto dec instructions.
5842 @item -fdump-rtl-barriers
5843 @opindex fdump-rtl-barriers
5844 Dump after cleaning up the barrier instructions.
5846 @item -fdump-rtl-bbpart
5847 @opindex fdump-rtl-bbpart
5848 Dump after partitioning hot and cold basic blocks.
5850 @item -fdump-rtl-bbro
5851 @opindex fdump-rtl-bbro
5852 Dump after block reordering.
5854 @item -fdump-rtl-btl1
5855 @itemx -fdump-rtl-btl2
5856 @opindex fdump-rtl-btl2
5857 @opindex fdump-rtl-btl2
5858 @option{-fdump-rtl-btl1} and @option{-fdump-rtl-btl2} enable dumping
5859 after the two branch
5860 target load optimization passes.
5862 @item -fdump-rtl-bypass
5863 @opindex fdump-rtl-bypass
5864 Dump after jump bypassing and control flow optimizations.
5866 @item -fdump-rtl-combine
5867 @opindex fdump-rtl-combine
5868 Dump after the RTL instruction combination pass.
5870 @item -fdump-rtl-compgotos
5871 @opindex fdump-rtl-compgotos
5872 Dump after duplicating the computed gotos.
5874 @item -fdump-rtl-ce1
5875 @itemx -fdump-rtl-ce2
5876 @itemx -fdump-rtl-ce3
5877 @opindex fdump-rtl-ce1
5878 @opindex fdump-rtl-ce2
5879 @opindex fdump-rtl-ce3
5880 @option{-fdump-rtl-ce1}, @option{-fdump-rtl-ce2}, and
5881 @option{-fdump-rtl-ce3} enable dumping after the three
5882 if conversion passes.
5884 @item -fdump-rtl-cprop_hardreg
5885 @opindex fdump-rtl-cprop_hardreg
5886 Dump after hard register copy propagation.
5888 @item -fdump-rtl-csa
5889 @opindex fdump-rtl-csa
5890 Dump after combining stack adjustments.
5892 @item -fdump-rtl-cse1
5893 @itemx -fdump-rtl-cse2
5894 @opindex fdump-rtl-cse1
5895 @opindex fdump-rtl-cse2
5896 @option{-fdump-rtl-cse1} and @option{-fdump-rtl-cse2} enable dumping after
5897 the two common subexpression elimination passes.
5899 @item -fdump-rtl-dce
5900 @opindex fdump-rtl-dce
5901 Dump after the standalone dead code elimination passes.
5903 @item -fdump-rtl-dbr
5904 @opindex fdump-rtl-dbr
5905 Dump after delayed branch scheduling.
5907 @item -fdump-rtl-dce1
5908 @itemx -fdump-rtl-dce2
5909 @opindex fdump-rtl-dce1
5910 @opindex fdump-rtl-dce2
5911 @option{-fdump-rtl-dce1} and @option{-fdump-rtl-dce2} enable dumping after
5912 the two dead store elimination passes.
5914 @item -fdump-rtl-eh
5915 @opindex fdump-rtl-eh
5916 Dump after finalization of EH handling code.
5918 @item -fdump-rtl-eh_ranges
5919 @opindex fdump-rtl-eh_ranges
5920 Dump after conversion of EH handling range regions.
5922 @item -fdump-rtl-expand
5923 @opindex fdump-rtl-expand
5924 Dump after RTL generation.
5926 @item -fdump-rtl-fwprop1
5927 @itemx -fdump-rtl-fwprop2
5928 @opindex fdump-rtl-fwprop1
5929 @opindex fdump-rtl-fwprop2
5930 @option{-fdump-rtl-fwprop1} and @option{-fdump-rtl-fwprop2} enable
5931 dumping after the two forward propagation passes.
5933 @item -fdump-rtl-gcse1
5934 @itemx -fdump-rtl-gcse2
5935 @opindex fdump-rtl-gcse1
5936 @opindex fdump-rtl-gcse2
5937 @option{-fdump-rtl-gcse1} and @option{-fdump-rtl-gcse2} enable dumping
5938 after global common subexpression elimination.
5940 @item -fdump-rtl-init-regs
5941 @opindex fdump-rtl-init-regs
5942 Dump after the initialization of the registers.
5944 @item -fdump-rtl-initvals
5945 @opindex fdump-rtl-initvals
5946 Dump after the computation of the initial value sets.
5948 @item -fdump-rtl-into_cfglayout
5949 @opindex fdump-rtl-into_cfglayout
5950 Dump after converting to cfglayout mode.
5952 @item -fdump-rtl-ira
5953 @opindex fdump-rtl-ira
5954 Dump after iterated register allocation.
5956 @item -fdump-rtl-jump
5957 @opindex fdump-rtl-jump
5958 Dump after the second jump optimization.
5960 @item -fdump-rtl-loop2
5961 @opindex fdump-rtl-loop2
5962 @option{-fdump-rtl-loop2} enables dumping after the rtl
5963 loop optimization passes.
5965 @item -fdump-rtl-mach
5966 @opindex fdump-rtl-mach
5967 Dump after performing the machine dependent reorganization pass, if that
5968 pass exists.
5970 @item -fdump-rtl-mode_sw
5971 @opindex fdump-rtl-mode_sw
5972 Dump after removing redundant mode switches.
5974 @item -fdump-rtl-rnreg
5975 @opindex fdump-rtl-rnreg
5976 Dump after register renumbering.
5978 @item -fdump-rtl-outof_cfglayout
5979 @opindex fdump-rtl-outof_cfglayout
5980 Dump after converting from cfglayout mode.
5982 @item -fdump-rtl-peephole2
5983 @opindex fdump-rtl-peephole2
5984 Dump after the peephole pass.
5986 @item -fdump-rtl-postreload
5987 @opindex fdump-rtl-postreload
5988 Dump after post-reload optimizations.
5990 @item -fdump-rtl-pro_and_epilogue
5991 @opindex fdump-rtl-pro_and_epilogue
5992 Dump after generating the function prologues and epilogues.
5994 @item -fdump-rtl-sched1
5995 @itemx -fdump-rtl-sched2
5996 @opindex fdump-rtl-sched1
5997 @opindex fdump-rtl-sched2
5998 @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2} enable dumping
5999 after the basic block scheduling passes.
6001 @item -fdump-rtl-ree
6002 @opindex fdump-rtl-ree
6003 Dump after sign/zero extension elimination.
6005 @item -fdump-rtl-seqabstr
6006 @opindex fdump-rtl-seqabstr
6007 Dump after common sequence discovery.
6009 @item -fdump-rtl-shorten
6010 @opindex fdump-rtl-shorten
6011 Dump after shortening branches.
6013 @item -fdump-rtl-sibling
6014 @opindex fdump-rtl-sibling
6015 Dump after sibling call optimizations.
6017 @item -fdump-rtl-split1
6018 @itemx -fdump-rtl-split2
6019 @itemx -fdump-rtl-split3
6020 @itemx -fdump-rtl-split4
6021 @itemx -fdump-rtl-split5
6022 @opindex fdump-rtl-split1
6023 @opindex fdump-rtl-split2
6024 @opindex fdump-rtl-split3
6025 @opindex fdump-rtl-split4
6026 @opindex fdump-rtl-split5
6027 @option{-fdump-rtl-split1}, @option{-fdump-rtl-split2},
6028 @option{-fdump-rtl-split3}, @option{-fdump-rtl-split4} and
6029 @option{-fdump-rtl-split5} enable dumping after five rounds of
6030 instruction splitting.
6032 @item -fdump-rtl-sms
6033 @opindex fdump-rtl-sms
6034 Dump after modulo scheduling.  This pass is only run on some
6035 architectures.
6037 @item -fdump-rtl-stack
6038 @opindex fdump-rtl-stack
6039 Dump after conversion from GCC's ``flat register file'' registers to the
6040 x87's stack-like registers.  This pass is only run on x86 variants.
6042 @item -fdump-rtl-subreg1
6043 @itemx -fdump-rtl-subreg2
6044 @opindex fdump-rtl-subreg1
6045 @opindex fdump-rtl-subreg2
6046 @option{-fdump-rtl-subreg1} and @option{-fdump-rtl-subreg2} enable dumping after
6047 the two subreg expansion passes.
6049 @item -fdump-rtl-unshare
6050 @opindex fdump-rtl-unshare
6051 Dump after all rtl has been unshared.
6053 @item -fdump-rtl-vartrack
6054 @opindex fdump-rtl-vartrack
6055 Dump after variable tracking.
6057 @item -fdump-rtl-vregs
6058 @opindex fdump-rtl-vregs
6059 Dump after converting virtual registers to hard registers.
6061 @item -fdump-rtl-web
6062 @opindex fdump-rtl-web
6063 Dump after live range splitting.
6065 @item -fdump-rtl-regclass
6066 @itemx -fdump-rtl-subregs_of_mode_init
6067 @itemx -fdump-rtl-subregs_of_mode_finish
6068 @itemx -fdump-rtl-dfinit
6069 @itemx -fdump-rtl-dfinish
6070 @opindex fdump-rtl-regclass
6071 @opindex fdump-rtl-subregs_of_mode_init
6072 @opindex fdump-rtl-subregs_of_mode_finish
6073 @opindex fdump-rtl-dfinit
6074 @opindex fdump-rtl-dfinish
6075 These dumps are defined but always produce empty files.
6077 @item -da
6078 @itemx -fdump-rtl-all
6079 @opindex da
6080 @opindex fdump-rtl-all
6081 Produce all the dumps listed above.
6083 @item -dA
6084 @opindex dA
6085 Annotate the assembler output with miscellaneous debugging information.
6087 @item -dD
6088 @opindex dD
6089 Dump all macro definitions, at the end of preprocessing, in addition to
6090 normal output.
6092 @item -dH
6093 @opindex dH
6094 Produce a core dump whenever an error occurs.
6096 @item -dp
6097 @opindex dp
6098 Annotate the assembler output with a comment indicating which
6099 pattern and alternative is used.  The length of each instruction is
6100 also printed.
6102 @item -dP
6103 @opindex dP
6104 Dump the RTL in the assembler output as a comment before each instruction.
6105 Also turns on @option{-dp} annotation.
6107 @item -dx
6108 @opindex dx
6109 Just generate RTL for a function instead of compiling it.  Usually used
6110 with @option{-fdump-rtl-expand}.
6111 @end table
6113 @item -fdump-noaddr
6114 @opindex fdump-noaddr
6115 When doing debugging dumps, suppress address output.  This makes it more
6116 feasible to use diff on debugging dumps for compiler invocations with
6117 different compiler binaries and/or different
6118 text / bss / data / heap / stack / dso start locations.
6120 @item -fdump-unnumbered
6121 @opindex fdump-unnumbered
6122 When doing debugging dumps, suppress instruction numbers and address output.
6123 This makes it more feasible to use diff on debugging dumps for compiler
6124 invocations with different options, in particular with and without
6125 @option{-g}.
6127 @item -fdump-unnumbered-links
6128 @opindex fdump-unnumbered-links
6129 When doing debugging dumps (see @option{-d} option above), suppress
6130 instruction numbers for the links to the previous and next instructions
6131 in a sequence.
6133 @item -fdump-translation-unit @r{(C++ only)}
6134 @itemx -fdump-translation-unit-@var{options} @r{(C++ only)}
6135 @opindex fdump-translation-unit
6136 Dump a representation of the tree structure for the entire translation
6137 unit to a file.  The file name is made by appending @file{.tu} to the
6138 source file name, and the file is created in the same directory as the
6139 output file.  If the @samp{-@var{options}} form is used, @var{options}
6140 controls the details of the dump as described for the
6141 @option{-fdump-tree} options.
6143 @item -fdump-class-hierarchy @r{(C++ only)}
6144 @itemx -fdump-class-hierarchy-@var{options} @r{(C++ only)}
6145 @opindex fdump-class-hierarchy
6146 Dump a representation of each class's hierarchy and virtual function
6147 table layout to a file.  The file name is made by appending
6148 @file{.class} to the source file name, and the file is created in the
6149 same directory as the output file.  If the @samp{-@var{options}} form
6150 is used, @var{options} controls the details of the dump as described
6151 for the @option{-fdump-tree} options.
6153 @item -fdump-ipa-@var{switch}
6154 @opindex fdump-ipa
6155 Control the dumping at various stages of inter-procedural analysis
6156 language tree to a file.  The file name is generated by appending a
6157 switch specific suffix to the source file name, and the file is created
6158 in the same directory as the output file.  The following dumps are
6159 possible:
6161 @table @samp
6162 @item all
6163 Enables all inter-procedural analysis dumps.
6165 @item cgraph
6166 Dumps information about call-graph optimization, unused function removal,
6167 and inlining decisions.
6169 @item inline
6170 Dump after function inlining.
6172 @end table
6174 @item -fdump-passes
6175 @opindex fdump-passes
6176 Dump the list of optimization passes that are turned on and off by
6177 the current command-line options.
6179 @item -fdump-statistics-@var{option}
6180 @opindex fdump-statistics
6181 Enable and control dumping of pass statistics in a separate file.  The
6182 file name is generated by appending a suffix ending in
6183 @samp{.statistics} to the source file name, and the file is created in
6184 the same directory as the output file.  If the @samp{-@var{option}}
6185 form is used, @samp{-stats} causes counters to be summed over the
6186 whole compilation unit while @samp{-details} dumps every event as
6187 the passes generate them.  The default with no option is to sum
6188 counters for each function compiled.
6190 @item -fdump-tree-@var{switch}
6191 @itemx -fdump-tree-@var{switch}-@var{options}
6192 @itemx -fdump-tree-@var{switch}-@var{options}=@var{filename}
6193 @opindex fdump-tree
6194 Control the dumping at various stages of processing the intermediate
6195 language tree to a file.  The file name is generated by appending a
6196 switch-specific suffix to the source file name, and the file is
6197 created in the same directory as the output file. In case of
6198 @option{=@var{filename}} option, the dump is output on the given file
6199 instead of the auto named dump files.  If the @samp{-@var{options}}
6200 form is used, @var{options} is a list of @samp{-} separated options
6201 which control the details of the dump.  Not all options are applicable
6202 to all dumps; those that are not meaningful are ignored.  The
6203 following options are available
6205 @table @samp
6206 @item address
6207 Print the address of each node.  Usually this is not meaningful as it
6208 changes according to the environment and source file.  Its primary use
6209 is for tying up a dump file with a debug environment.
6210 @item asmname
6211 If @code{DECL_ASSEMBLER_NAME} has been set for a given decl, use that
6212 in the dump instead of @code{DECL_NAME}.  Its primary use is ease of
6213 use working backward from mangled names in the assembly file.
6214 @item slim
6215 When dumping front-end intermediate representations, inhibit dumping
6216 of members of a scope or body of a function merely because that scope
6217 has been reached.  Only dump such items when they are directly reachable
6218 by some other path.
6220 When dumping pretty-printed trees, this option inhibits dumping the
6221 bodies of control structures.
6223 When dumping RTL, print the RTL in slim (condensed) form instead of
6224 the default LISP-like representation.
6225 @item raw
6226 Print a raw representation of the tree.  By default, trees are
6227 pretty-printed into a C-like representation.
6228 @item details
6229 Enable more detailed dumps (not honored by every dump option). Also
6230 include information from the optimization passes.
6231 @item stats
6232 Enable dumping various statistics about the pass (not honored by every dump
6233 option).
6234 @item blocks
6235 Enable showing basic block boundaries (disabled in raw dumps).
6236 @item graph
6237 For each of the other indicated dump files (@option{-fdump-rtl-@var{pass}}),
6238 dump a representation of the control flow graph suitable for viewing with
6239 GraphViz to @file{@var{file}.@var{passid}.@var{pass}.dot}.  Each function in
6240 the file is pretty-printed as a subgraph, so that GraphViz can render them
6241 all in a single plot.
6243 This option currently only works for RTL dumps, and the RTL is always
6244 dumped in slim form.
6245 @item vops
6246 Enable showing virtual operands for every statement.
6247 @item lineno
6248 Enable showing line numbers for statements.
6249 @item uid
6250 Enable showing the unique ID (@code{DECL_UID}) for each variable.
6251 @item verbose
6252 Enable showing the tree dump for each statement.
6253 @item eh
6254 Enable showing the EH region number holding each statement.
6255 @item scev
6256 Enable showing scalar evolution analysis details.
6257 @item optimized
6258 Enable showing optimization information (only available in certain
6259 passes).
6260 @item missed
6261 Enable showing missed optimization information (only available in certain
6262 passes).
6263 @item notes
6264 Enable other detailed optimization information (only available in
6265 certain passes).
6266 @item =@var{filename}
6267 Instead of an auto named dump file, output into the given file
6268 name. The file names @file{stdout} and @file{stderr} are treated
6269 specially and are considered already open standard streams. For
6270 example,
6272 @smallexample
6273 gcc -O2 -ftree-vectorize -fdump-tree-vect-blocks=foo.dump
6274      -fdump-tree-pre=stderr file.c
6275 @end smallexample
6277 outputs vectorizer dump into @file{foo.dump}, while the PRE dump is
6278 output on to @file{stderr}. If two conflicting dump filenames are
6279 given for the same pass, then the latter option overrides the earlier
6280 one.
6282 @item all
6283 Turn on all options, except @option{raw}, @option{slim}, @option{verbose}
6284 and @option{lineno}.
6286 @item optall
6287 Turn on all optimization options, i.e., @option{optimized},
6288 @option{missed}, and @option{note}.
6289 @end table
6291 The following tree dumps are possible:
6292 @table @samp
6294 @item original
6295 @opindex fdump-tree-original
6296 Dump before any tree based optimization, to @file{@var{file}.original}.
6298 @item optimized
6299 @opindex fdump-tree-optimized
6300 Dump after all tree based optimization, to @file{@var{file}.optimized}.
6302 @item gimple
6303 @opindex fdump-tree-gimple
6304 Dump each function before and after the gimplification pass to a file.  The
6305 file name is made by appending @file{.gimple} to the source file name.
6307 @item cfg
6308 @opindex fdump-tree-cfg
6309 Dump the control flow graph of each function to a file.  The file name is
6310 made by appending @file{.cfg} to the source file name.
6312 @item ch
6313 @opindex fdump-tree-ch
6314 Dump each function after copying loop headers.  The file name is made by
6315 appending @file{.ch} to the source file name.
6317 @item ssa
6318 @opindex fdump-tree-ssa
6319 Dump SSA related information to a file.  The file name is made by appending
6320 @file{.ssa} to the source file name.
6322 @item alias
6323 @opindex fdump-tree-alias
6324 Dump aliasing information for each function.  The file name is made by
6325 appending @file{.alias} to the source file name.
6327 @item ccp
6328 @opindex fdump-tree-ccp
6329 Dump each function after CCP@.  The file name is made by appending
6330 @file{.ccp} to the source file name.
6332 @item storeccp
6333 @opindex fdump-tree-storeccp
6334 Dump each function after STORE-CCP@.  The file name is made by appending
6335 @file{.storeccp} to the source file name.
6337 @item pre
6338 @opindex fdump-tree-pre
6339 Dump trees after partial redundancy elimination.  The file name is made
6340 by appending @file{.pre} to the source file name.
6342 @item fre
6343 @opindex fdump-tree-fre
6344 Dump trees after full redundancy elimination.  The file name is made
6345 by appending @file{.fre} to the source file name.
6347 @item copyprop
6348 @opindex fdump-tree-copyprop
6349 Dump trees after copy propagation.  The file name is made
6350 by appending @file{.copyprop} to the source file name.
6352 @item store_copyprop
6353 @opindex fdump-tree-store_copyprop
6354 Dump trees after store copy-propagation.  The file name is made
6355 by appending @file{.store_copyprop} to the source file name.
6357 @item dce
6358 @opindex fdump-tree-dce
6359 Dump each function after dead code elimination.  The file name is made by
6360 appending @file{.dce} to the source file name.
6362 @item sra
6363 @opindex fdump-tree-sra
6364 Dump each function after performing scalar replacement of aggregates.  The
6365 file name is made by appending @file{.sra} to the source file name.
6367 @item sink
6368 @opindex fdump-tree-sink
6369 Dump each function after performing code sinking.  The file name is made
6370 by appending @file{.sink} to the source file name.
6372 @item dom
6373 @opindex fdump-tree-dom
6374 Dump each function after applying dominator tree optimizations.  The file
6375 name is made by appending @file{.dom} to the source file name.
6377 @item dse
6378 @opindex fdump-tree-dse
6379 Dump each function after applying dead store elimination.  The file
6380 name is made by appending @file{.dse} to the source file name.
6382 @item phiopt
6383 @opindex fdump-tree-phiopt
6384 Dump each function after optimizing PHI nodes into straightline code.  The file
6385 name is made by appending @file{.phiopt} to the source file name.
6387 @item forwprop
6388 @opindex fdump-tree-forwprop
6389 Dump each function after forward propagating single use variables.  The file
6390 name is made by appending @file{.forwprop} to the source file name.
6392 @item copyrename
6393 @opindex fdump-tree-copyrename
6394 Dump each function after applying the copy rename optimization.  The file
6395 name is made by appending @file{.copyrename} to the source file name.
6397 @item nrv
6398 @opindex fdump-tree-nrv
6399 Dump each function after applying the named return value optimization on
6400 generic trees.  The file name is made by appending @file{.nrv} to the source
6401 file name.
6403 @item vect
6404 @opindex fdump-tree-vect
6405 Dump each function after applying vectorization of loops.  The file name is
6406 made by appending @file{.vect} to the source file name.
6408 @item slp
6409 @opindex fdump-tree-slp
6410 Dump each function after applying vectorization of basic blocks.  The file name
6411 is made by appending @file{.slp} to the source file name.
6413 @item vrp
6414 @opindex fdump-tree-vrp
6415 Dump each function after Value Range Propagation (VRP).  The file name
6416 is made by appending @file{.vrp} to the source file name.
6418 @item all
6419 @opindex fdump-tree-all
6420 Enable all the available tree dumps with the flags provided in this option.
6421 @end table
6423 @item -fopt-info
6424 @itemx -fopt-info-@var{options}
6425 @itemx -fopt-info-@var{options}=@var{filename}
6426 @opindex fopt-info
6427 Controls optimization dumps from various optimization passes. If the
6428 @samp{-@var{options}} form is used, @var{options} is a list of
6429 @samp{-} separated options to select the dump details and
6430 optimizations.  If @var{options} is not specified, it defaults to
6431 @option{optimized} for details and @option{optall} for optimization
6432 groups. If the @var{filename} is not specified, it defaults to
6433 @file{stderr}. Note that the output @var{filename} will be overwritten
6434 in case of multiple translation units. If a combined output from
6435 multiple translation units is desired, @file{stderr} should be used
6436 instead.
6438 The options can be divided into two groups, 1) options describing the
6439 verbosity of the dump, and 2) options describing which optimizations
6440 should be included. The options from both the groups can be freely
6441 mixed as they are non-overlapping. However, in case of any conflicts,
6442 the latter options override the earlier options on the command
6443 line. Though multiple -fopt-info options are accepted, only one of
6444 them can have @option{=filename}. If other filenames are provided then
6445 all but the first one are ignored.
6447 The dump verbosity has the following options
6449 @table @samp
6450 @item optimized
6451 Print information when an optimization is successfully applied. It is
6452 up to a pass to decide which information is relevant. For example, the
6453 vectorizer passes print the source location of loops which got
6454 successfully vectorized.
6455 @item missed
6456 Print information about missed optimizations. Individual passes
6457 control which information to include in the output. For example,
6459 @smallexample
6460 gcc -O2 -ftree-vectorize -fopt-info-vec-missed
6461 @end smallexample
6463 will print information about missed optimization opportunities from
6464 vectorization passes on stderr.
6465 @item note
6466 Print verbose information about optimizations, such as certain
6467 transformations, more detailed messages about decisions etc.
6468 @item all
6469 Print detailed optimization information. This includes
6470 @var{optimized}, @var{missed}, and @var{note}.
6471 @end table
6473 The second set of options describes a group of optimizations and may
6474 include one or more of the following.
6476 @table @samp
6477 @item ipa
6478 Enable dumps from all interprocedural optimizations.
6479 @item loop
6480 Enable dumps from all loop optimizations.
6481 @item inline
6482 Enable dumps from all inlining optimizations.
6483 @item vec
6484 Enable dumps from all vectorization optimizations.
6485 @item optall
6486 Enable dumps from all optimizations. This is a superset of
6487 the optimization groups listed above.
6488 @end table
6490 For example,
6491 @smallexample
6492 gcc -O3 -fopt-info-missed=missed.all
6493 @end smallexample
6495 outputs missed optimization report from all the passes into
6496 @file{missed.all}.
6498 As another example,
6499 @smallexample
6500 gcc -O3 -fopt-info-inline-optimized-missed=inline.txt
6501 @end smallexample
6503 will output information about missed optimizations as well as
6504 optimized locations from all the inlining passes into
6505 @file{inline.txt}.
6507 If the @var{filename} is provided, then the dumps from all the
6508 applicable optimizations are concatenated into the @file{filename}.
6509 Otherwise the dump is output onto @file{stderr}. If @var{options} is
6510 omitted, it defaults to @option{all-optall}, which means dump all
6511 available optimization info from all the passes. In the following
6512 example, all optimization info is output on to @file{stderr}.
6514 @smallexample
6515 gcc -O3 -fopt-info
6516 @end smallexample
6518 Note that @option{-fopt-info-vec-missed} behaves the same as
6519 @option{-fopt-info-missed-vec}.
6521 As another example, consider
6523 @smallexample
6524 gcc -fopt-info-vec-missed=vec.miss -fopt-info-loop-optimized=loop.opt
6525 @end smallexample
6527 Here the two output filenames @file{vec.miss} and @file{loop.opt} are
6528 in conflict since only one output file is allowed. In this case, only
6529 the first option takes effect and the subsequent options are
6530 ignored. Thus only the @file{vec.miss} is produced which contains
6531 dumps from the vectorizer about missed opportunities.
6533 @item -frandom-seed=@var{string}
6534 @opindex frandom-seed
6535 This option provides a seed that GCC uses in place of
6536 random numbers in generating certain symbol names
6537 that have to be different in every compiled file.  It is also used to
6538 place unique stamps in coverage data files and the object files that
6539 produce them.  You can use the @option{-frandom-seed} option to produce
6540 reproducibly identical object files.
6542 The @var{string} should be different for every file you compile.
6544 @item -fsched-verbose=@var{n}
6545 @opindex fsched-verbose
6546 On targets that use instruction scheduling, this option controls the
6547 amount of debugging output the scheduler prints.  This information is
6548 written to standard error, unless @option{-fdump-rtl-sched1} or
6549 @option{-fdump-rtl-sched2} is specified, in which case it is output
6550 to the usual dump listing file, @file{.sched1} or @file{.sched2}
6551 respectively.  However for @var{n} greater than nine, the output is
6552 always printed to standard error.
6554 For @var{n} greater than zero, @option{-fsched-verbose} outputs the
6555 same information as @option{-fdump-rtl-sched1} and @option{-fdump-rtl-sched2}.
6556 For @var{n} greater than one, it also output basic block probabilities,
6557 detailed ready list information and unit/insn info.  For @var{n} greater
6558 than two, it includes RTL at abort point, control-flow and regions info.
6559 And for @var{n} over four, @option{-fsched-verbose} also includes
6560 dependence info.
6562 @item -save-temps
6563 @itemx -save-temps=cwd
6564 @opindex save-temps
6565 Store the usual ``temporary'' intermediate files permanently; place them
6566 in the current directory and name them based on the source file.  Thus,
6567 compiling @file{foo.c} with @option{-c -save-temps} produces files
6568 @file{foo.i} and @file{foo.s}, as well as @file{foo.o}.  This creates a
6569 preprocessed @file{foo.i} output file even though the compiler now
6570 normally uses an integrated preprocessor.
6572 When used in combination with the @option{-x} command-line option,
6573 @option{-save-temps} is sensible enough to avoid over writing an
6574 input source file with the same extension as an intermediate file.
6575 The corresponding intermediate file may be obtained by renaming the
6576 source file before using @option{-save-temps}.
6578 If you invoke GCC in parallel, compiling several different source
6579 files that share a common base name in different subdirectories or the
6580 same source file compiled for multiple output destinations, it is
6581 likely that the different parallel compilers will interfere with each
6582 other, and overwrite the temporary files.  For instance:
6584 @smallexample
6585 gcc -save-temps -o outdir1/foo.o indir1/foo.c&
6586 gcc -save-temps -o outdir2/foo.o indir2/foo.c&
6587 @end smallexample
6589 may result in @file{foo.i} and @file{foo.o} being written to
6590 simultaneously by both compilers.
6592 @item -save-temps=obj
6593 @opindex save-temps=obj
6594 Store the usual ``temporary'' intermediate files permanently.  If the
6595 @option{-o} option is used, the temporary files are based on the
6596 object file.  If the @option{-o} option is not used, the
6597 @option{-save-temps=obj} switch behaves like @option{-save-temps}.
6599 For example:
6601 @smallexample
6602 gcc -save-temps=obj -c foo.c
6603 gcc -save-temps=obj -c bar.c -o dir/xbar.o
6604 gcc -save-temps=obj foobar.c -o dir2/yfoobar
6605 @end smallexample
6607 @noindent
6608 creates @file{foo.i}, @file{foo.s}, @file{dir/xbar.i},
6609 @file{dir/xbar.s}, @file{dir2/yfoobar.i}, @file{dir2/yfoobar.s}, and
6610 @file{dir2/yfoobar.o}.
6612 @item -time@r{[}=@var{file}@r{]}
6613 @opindex time
6614 Report the CPU time taken by each subprocess in the compilation
6615 sequence.  For C source files, this is the compiler proper and assembler
6616 (plus the linker if linking is done).
6618 Without the specification of an output file, the output looks like this:
6620 @smallexample
6621 # cc1 0.12 0.01
6622 # as 0.00 0.01
6623 @end smallexample
6625 The first number on each line is the ``user time'', that is time spent
6626 executing the program itself.  The second number is ``system time'',
6627 time spent executing operating system routines on behalf of the program.
6628 Both numbers are in seconds.
6630 With the specification of an output file, the output is appended to the
6631 named file, and it looks like this:
6633 @smallexample
6634 0.12 0.01 cc1 @var{options}
6635 0.00 0.01 as @var{options}
6636 @end smallexample
6638 The ``user time'' and the ``system time'' are moved before the program
6639 name, and the options passed to the program are displayed, so that one
6640 can later tell what file was being compiled, and with which options.
6642 @item -fvar-tracking
6643 @opindex fvar-tracking
6644 Run variable tracking pass.  It computes where variables are stored at each
6645 position in code.  Better debugging information is then generated
6646 (if the debugging information format supports this information).
6648 It is enabled by default when compiling with optimization (@option{-Os},
6649 @option{-O}, @option{-O2}, @dots{}), debugging information (@option{-g}) and
6650 the debug info format supports it.
6652 @item -fvar-tracking-assignments
6653 @opindex fvar-tracking-assignments
6654 @opindex fno-var-tracking-assignments
6655 Annotate assignments to user variables early in the compilation and
6656 attempt to carry the annotations over throughout the compilation all the
6657 way to the end, in an attempt to improve debug information while
6658 optimizing.  Use of @option{-gdwarf-4} is recommended along with it.
6660 It can be enabled even if var-tracking is disabled, in which case
6661 annotations are created and maintained, but discarded at the end.
6663 @item -fvar-tracking-assignments-toggle
6664 @opindex fvar-tracking-assignments-toggle
6665 @opindex fno-var-tracking-assignments-toggle
6666 Toggle @option{-fvar-tracking-assignments}, in the same way that
6667 @option{-gtoggle} toggles @option{-g}.
6669 @item -print-file-name=@var{library}
6670 @opindex print-file-name
6671 Print the full absolute name of the library file @var{library} that
6672 would be used when linking---and don't do anything else.  With this
6673 option, GCC does not compile or link anything; it just prints the
6674 file name.
6676 @item -print-multi-directory
6677 @opindex print-multi-directory
6678 Print the directory name corresponding to the multilib selected by any
6679 other switches present in the command line.  This directory is supposed
6680 to exist in @env{GCC_EXEC_PREFIX}.
6682 @item -print-multi-lib
6683 @opindex print-multi-lib
6684 Print the mapping from multilib directory names to compiler switches
6685 that enable them.  The directory name is separated from the switches by
6686 @samp{;}, and each switch starts with an @samp{@@} instead of the
6687 @samp{-}, without spaces between multiple switches.  This is supposed to
6688 ease shell processing.
6690 @item -print-multi-os-directory
6691 @opindex print-multi-os-directory
6692 Print the path to OS libraries for the selected
6693 multilib, relative to some @file{lib} subdirectory.  If OS libraries are
6694 present in the @file{lib} subdirectory and no multilibs are used, this is
6695 usually just @file{.}, if OS libraries are present in @file{lib@var{suffix}}
6696 sibling directories this prints e.g.@: @file{../lib64}, @file{../lib} or
6697 @file{../lib32}, or if OS libraries are present in @file{lib/@var{subdir}}
6698 subdirectories it prints e.g.@: @file{amd64}, @file{sparcv9} or @file{ev6}.
6700 @item -print-multiarch
6701 @opindex print-multiarch
6702 Print the path to OS libraries for the selected multiarch,
6703 relative to some @file{lib} subdirectory.
6705 @item -print-prog-name=@var{program}
6706 @opindex print-prog-name
6707 Like @option{-print-file-name}, but searches for a program such as @samp{cpp}.
6709 @item -print-libgcc-file-name
6710 @opindex print-libgcc-file-name
6711 Same as @option{-print-file-name=libgcc.a}.
6713 This is useful when you use @option{-nostdlib} or @option{-nodefaultlibs}
6714 but you do want to link with @file{libgcc.a}.  You can do:
6716 @smallexample
6717 gcc -nostdlib @var{files}@dots{} `gcc -print-libgcc-file-name`
6718 @end smallexample
6720 @item -print-search-dirs
6721 @opindex print-search-dirs
6722 Print the name of the configured installation directory and a list of
6723 program and library directories @command{gcc} searches---and don't do anything else.
6725 This is useful when @command{gcc} prints the error message
6726 @samp{installation problem, cannot exec cpp0: No such file or directory}.
6727 To resolve this you either need to put @file{cpp0} and the other compiler
6728 components where @command{gcc} expects to find them, or you can set the environment
6729 variable @env{GCC_EXEC_PREFIX} to the directory where you installed them.
6730 Don't forget the trailing @samp{/}.
6731 @xref{Environment Variables}.
6733 @item -print-sysroot
6734 @opindex print-sysroot
6735 Print the target sysroot directory that is used during
6736 compilation.  This is the target sysroot specified either at configure
6737 time or using the @option{--sysroot} option, possibly with an extra
6738 suffix that depends on compilation options.  If no target sysroot is
6739 specified, the option prints nothing.
6741 @item -print-sysroot-headers-suffix
6742 @opindex print-sysroot-headers-suffix
6743 Print the suffix added to the target sysroot when searching for
6744 headers, or give an error if the compiler is not configured with such
6745 a suffix---and don't do anything else.
6747 @item -dumpmachine
6748 @opindex dumpmachine
6749 Print the compiler's target machine (for example,
6750 @samp{i686-pc-linux-gnu})---and don't do anything else.
6752 @item -dumpversion
6753 @opindex dumpversion
6754 Print the compiler version (for example, @samp{3.0})---and don't do
6755 anything else.
6757 @item -dumpspecs
6758 @opindex dumpspecs
6759 Print the compiler's built-in specs---and don't do anything else.  (This
6760 is used when GCC itself is being built.)  @xref{Spec Files}.
6762 @item -fno-eliminate-unused-debug-types
6763 @opindex feliminate-unused-debug-types
6764 @opindex fno-eliminate-unused-debug-types
6765 Normally, when producing DWARF 2 output, GCC avoids producing debug symbol 
6766 output for types that are nowhere used in the source file being compiled.
6767 Sometimes it is useful to have GCC emit debugging
6768 information for all types declared in a compilation
6769 unit, regardless of whether or not they are actually used
6770 in that compilation unit, for example 
6771 if, in the debugger, you want to cast a value to a type that is
6772 not actually used in your program (but is declared).  More often,
6773 however, this results in a significant amount of wasted space.
6774 @end table
6776 @node Optimize Options
6777 @section Options That Control Optimization
6778 @cindex optimize options
6779 @cindex options, optimization
6781 These options control various sorts of optimizations.
6783 Without any optimization option, the compiler's goal is to reduce the
6784 cost of compilation and to make debugging produce the expected
6785 results.  Statements are independent: if you stop the program with a
6786 breakpoint between statements, you can then assign a new value to any
6787 variable or change the program counter to any other statement in the
6788 function and get exactly the results you expect from the source
6789 code.
6791 Turning on optimization flags makes the compiler attempt to improve
6792 the performance and/or code size at the expense of compilation time
6793 and possibly the ability to debug the program.
6795 The compiler performs optimization based on the knowledge it has of the
6796 program.  Compiling multiple files at once to a single output file mode allows
6797 the compiler to use information gained from all of the files when compiling
6798 each of them.
6800 Not all optimizations are controlled directly by a flag.  Only
6801 optimizations that have a flag are listed in this section.
6803 Most optimizations are only enabled if an @option{-O} level is set on
6804 the command line.  Otherwise they are disabled, even if individual
6805 optimization flags are specified.
6807 Depending on the target and how GCC was configured, a slightly different
6808 set of optimizations may be enabled at each @option{-O} level than
6809 those listed here.  You can invoke GCC with @option{-Q --help=optimizers}
6810 to find out the exact set of optimizations that are enabled at each level.
6811 @xref{Overall Options}, for examples.
6813 @table @gcctabopt
6814 @item -O
6815 @itemx -O1
6816 @opindex O
6817 @opindex O1
6818 Optimize.  Optimizing compilation takes somewhat more time, and a lot
6819 more memory for a large function.
6821 With @option{-O}, the compiler tries to reduce code size and execution
6822 time, without performing any optimizations that take a great deal of
6823 compilation time.
6825 @option{-O} turns on the following optimization flags:
6826 @gccoptlist{
6827 -fauto-inc-dec @gol
6828 -fcompare-elim @gol
6829 -fcprop-registers @gol
6830 -fdce @gol
6831 -fdefer-pop @gol
6832 -fdelayed-branch @gol
6833 -fdse @gol
6834 -fguess-branch-probability @gol
6835 -fif-conversion2 @gol
6836 -fif-conversion @gol
6837 -fipa-pure-const @gol
6838 -fipa-profile @gol
6839 -fipa-reference @gol
6840 -fmerge-constants
6841 -fsplit-wide-types @gol
6842 -ftree-bit-ccp @gol
6843 -ftree-builtin-call-dce @gol
6844 -ftree-ccp @gol
6845 -ftree-ch @gol
6846 -ftree-copyrename @gol
6847 -ftree-dce @gol
6848 -ftree-dominator-opts @gol
6849 -ftree-dse @gol
6850 -ftree-forwprop @gol
6851 -ftree-fre @gol
6852 -ftree-phiprop @gol
6853 -ftree-slsr @gol
6854 -ftree-sra @gol
6855 -ftree-pta @gol
6856 -ftree-ter @gol
6857 -funit-at-a-time}
6859 @option{-O} also turns on @option{-fomit-frame-pointer} on machines
6860 where doing so does not interfere with debugging.
6862 @item -O2
6863 @opindex O2
6864 Optimize even more.  GCC performs nearly all supported optimizations
6865 that do not involve a space-speed tradeoff.
6866 As compared to @option{-O}, this option increases both compilation time
6867 and the performance of the generated code.
6869 @option{-O2} turns on all optimization flags specified by @option{-O}.  It
6870 also turns on the following optimization flags:
6871 @gccoptlist{-fthread-jumps @gol
6872 -falign-functions  -falign-jumps @gol
6873 -falign-loops  -falign-labels @gol
6874 -fcaller-saves @gol
6875 -fcrossjumping @gol
6876 -fcse-follow-jumps  -fcse-skip-blocks @gol
6877 -fdelete-null-pointer-checks @gol
6878 -fdevirtualize -fdevirtualize-speculatively @gol
6879 -fexpensive-optimizations @gol
6880 -fgcse  -fgcse-lm  @gol
6881 -fhoist-adjacent-loads @gol
6882 -finline-small-functions @gol
6883 -findirect-inlining @gol
6884 -fipa-sra @gol
6885 -fisolate-erroneous-paths-dereference @gol
6886 -foptimize-sibling-calls @gol
6887 -fpartial-inlining @gol
6888 -fpeephole2 @gol
6889 -freorder-blocks  -freorder-functions @gol
6890 -frerun-cse-after-loop  @gol
6891 -fsched-interblock  -fsched-spec @gol
6892 -fschedule-insns  -fschedule-insns2 @gol
6893 -fstrict-aliasing -fstrict-overflow @gol
6894 -ftree-switch-conversion -ftree-tail-merge @gol
6895 -ftree-pre @gol
6896 -ftree-vrp}
6898 Please note the warning under @option{-fgcse} about
6899 invoking @option{-O2} on programs that use computed gotos.
6901 @item -O3
6902 @opindex O3
6903 Optimize yet more.  @option{-O3} turns on all optimizations specified
6904 by @option{-O2} and also turns on the @option{-finline-functions},
6905 @option{-funswitch-loops}, @option{-fpredictive-commoning},
6906 @option{-fgcse-after-reload}, @option{-ftree-loop-vectorize},
6907 @option{-ftree-slp-vectorize}, @option{-fvect-cost-model},
6908 @option{-ftree-partial-pre} and @option{-fipa-cp-clone} options.
6910 @item -O0
6911 @opindex O0
6912 Reduce compilation time and make debugging produce the expected
6913 results.  This is the default.
6915 @item -Os
6916 @opindex Os
6917 Optimize for size.  @option{-Os} enables all @option{-O2} optimizations that
6918 do not typically increase code size.  It also performs further
6919 optimizations designed to reduce code size.
6921 @option{-Os} disables the following optimization flags:
6922 @gccoptlist{-falign-functions  -falign-jumps  -falign-loops @gol
6923 -falign-labels  -freorder-blocks  -freorder-blocks-and-partition @gol
6924 -fprefetch-loop-arrays}
6926 @item -Ofast
6927 @opindex Ofast
6928 Disregard strict standards compliance.  @option{-Ofast} enables all
6929 @option{-O3} optimizations.  It also enables optimizations that are not
6930 valid for all standard-compliant programs.
6931 It turns on @option{-ffast-math} and the Fortran-specific
6932 @option{-fno-protect-parens} and @option{-fstack-arrays}.
6934 @item -Og
6935 @opindex Og
6936 Optimize debugging experience.  @option{-Og} enables optimizations
6937 that do not interfere with debugging. It should be the optimization
6938 level of choice for the standard edit-compile-debug cycle, offering
6939 a reasonable level of optimization while maintaining fast compilation
6940 and a good debugging experience.
6942 If you use multiple @option{-O} options, with or without level numbers,
6943 the last such option is the one that is effective.
6944 @end table
6946 Options of the form @option{-f@var{flag}} specify machine-independent
6947 flags.  Most flags have both positive and negative forms; the negative
6948 form of @option{-ffoo} is @option{-fno-foo}.  In the table
6949 below, only one of the forms is listed---the one you typically 
6950 use.  You can figure out the other form by either removing @samp{no-}
6951 or adding it.
6953 The following options control specific optimizations.  They are either
6954 activated by @option{-O} options or are related to ones that are.  You
6955 can use the following flags in the rare cases when ``fine-tuning'' of
6956 optimizations to be performed is desired.
6958 @table @gcctabopt
6959 @item -fno-defer-pop
6960 @opindex fno-defer-pop
6961 Always pop the arguments to each function call as soon as that function
6962 returns.  For machines that must pop arguments after a function call,
6963 the compiler normally lets arguments accumulate on the stack for several
6964 function calls and pops them all at once.
6966 Disabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
6968 @item -fforward-propagate
6969 @opindex fforward-propagate
6970 Perform a forward propagation pass on RTL@.  The pass tries to combine two
6971 instructions and checks if the result can be simplified.  If loop unrolling
6972 is active, two passes are performed and the second is scheduled after
6973 loop unrolling.
6975 This option is enabled by default at optimization levels @option{-O},
6976 @option{-O2}, @option{-O3}, @option{-Os}.
6978 @item -ffp-contract=@var{style}
6979 @opindex ffp-contract
6980 @option{-ffp-contract=off} disables floating-point expression contraction.
6981 @option{-ffp-contract=fast} enables floating-point expression contraction
6982 such as forming of fused multiply-add operations if the target has
6983 native support for them.
6984 @option{-ffp-contract=on} enables floating-point expression contraction
6985 if allowed by the language standard.  This is currently not implemented
6986 and treated equal to @option{-ffp-contract=off}.
6988 The default is @option{-ffp-contract=fast}.
6990 @item -fomit-frame-pointer
6991 @opindex fomit-frame-pointer
6992 Don't keep the frame pointer in a register for functions that
6993 don't need one.  This avoids the instructions to save, set up and
6994 restore frame pointers; it also makes an extra register available
6995 in many functions.  @strong{It also makes debugging impossible on
6996 some machines.}
6998 On some machines, such as the VAX, this flag has no effect, because
6999 the standard calling sequence automatically handles the frame pointer
7000 and nothing is saved by pretending it doesn't exist.  The
7001 machine-description macro @code{FRAME_POINTER_REQUIRED} controls
7002 whether a target machine supports this flag.  @xref{Registers,,Register
7003 Usage, gccint, GNU Compiler Collection (GCC) Internals}.
7005 Starting with GCC version 4.6, the default setting (when not optimizing for
7006 size) for 32-bit GNU/Linux x86 and 32-bit Darwin x86 targets has been changed to
7007 @option{-fomit-frame-pointer}.  The default can be reverted to
7008 @option{-fno-omit-frame-pointer} by configuring GCC with the
7009 @option{--enable-frame-pointer} configure option.
7011 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7013 @item -foptimize-sibling-calls
7014 @opindex foptimize-sibling-calls
7015 Optimize sibling and tail recursive calls.
7017 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7019 @item -fno-inline
7020 @opindex fno-inline
7021 Do not expand any functions inline apart from those marked with
7022 the @code{always_inline} attribute.  This is the default when not
7023 optimizing.
7025 Single functions can be exempted from inlining by marking them
7026 with the @code{noinline} attribute.
7028 @item -finline-small-functions
7029 @opindex finline-small-functions
7030 Integrate functions into their callers when their body is smaller than expected
7031 function call code (so overall size of program gets smaller).  The compiler
7032 heuristically decides which functions are simple enough to be worth integrating
7033 in this way.  This inlining applies to all functions, even those not declared
7034 inline.
7036 Enabled at level @option{-O2}.
7038 @item -findirect-inlining
7039 @opindex findirect-inlining
7040 Inline also indirect calls that are discovered to be known at compile
7041 time thanks to previous inlining.  This option has any effect only
7042 when inlining itself is turned on by the @option{-finline-functions}
7043 or @option{-finline-small-functions} options.
7045 Enabled at level @option{-O2}.
7047 @item -finline-functions
7048 @opindex finline-functions
7049 Consider all functions for inlining, even if they are not declared inline.
7050 The compiler heuristically decides which functions are worth integrating
7051 in this way.
7053 If all calls to a given function are integrated, and the function is
7054 declared @code{static}, then the function is normally not output as
7055 assembler code in its own right.
7057 Enabled at level @option{-O3}.
7059 @item -finline-functions-called-once
7060 @opindex finline-functions-called-once
7061 Consider all @code{static} functions called once for inlining into their
7062 caller even if they are not marked @code{inline}.  If a call to a given
7063 function is integrated, then the function is not output as assembler code
7064 in its own right.
7066 Enabled at levels @option{-O1}, @option{-O2}, @option{-O3} and @option{-Os}.
7068 @item -fearly-inlining
7069 @opindex fearly-inlining
7070 Inline functions marked by @code{always_inline} and functions whose body seems
7071 smaller than the function call overhead early before doing
7072 @option{-fprofile-generate} instrumentation and real inlining pass.  Doing so
7073 makes profiling significantly cheaper and usually inlining faster on programs
7074 having large chains of nested wrapper functions.
7076 Enabled by default.
7078 @item -fipa-sra
7079 @opindex fipa-sra
7080 Perform interprocedural scalar replacement of aggregates, removal of
7081 unused parameters and replacement of parameters passed by reference
7082 by parameters passed by value.
7084 Enabled at levels @option{-O2}, @option{-O3} and @option{-Os}.
7086 @item -finline-limit=@var{n}
7087 @opindex finline-limit
7088 By default, GCC limits the size of functions that can be inlined.  This flag
7089 allows coarse control of this limit.  @var{n} is the size of functions that
7090 can be inlined in number of pseudo instructions.
7092 Inlining is actually controlled by a number of parameters, which may be
7093 specified individually by using @option{--param @var{name}=@var{value}}.
7094 The @option{-finline-limit=@var{n}} option sets some of these parameters
7095 as follows:
7097 @table @gcctabopt
7098 @item max-inline-insns-single
7099 is set to @var{n}/2.
7100 @item max-inline-insns-auto
7101 is set to @var{n}/2.
7102 @end table
7104 See below for a documentation of the individual
7105 parameters controlling inlining and for the defaults of these parameters.
7107 @emph{Note:} there may be no value to @option{-finline-limit} that results
7108 in default behavior.
7110 @emph{Note:} pseudo instruction represents, in this particular context, an
7111 abstract measurement of function's size.  In no way does it represent a count
7112 of assembly instructions and as such its exact meaning might change from one
7113 release to an another.
7115 @item -fno-keep-inline-dllexport
7116 @opindex -fno-keep-inline-dllexport
7117 This is a more fine-grained version of @option{-fkeep-inline-functions},
7118 which applies only to functions that are declared using the @code{dllexport}
7119 attribute or declspec (@xref{Function Attributes,,Declaring Attributes of
7120 Functions}.)
7122 @item -fkeep-inline-functions
7123 @opindex fkeep-inline-functions
7124 In C, emit @code{static} functions that are declared @code{inline}
7125 into the object file, even if the function has been inlined into all
7126 of its callers.  This switch does not affect functions using the
7127 @code{extern inline} extension in GNU C90@.  In C++, emit any and all
7128 inline functions into the object file.
7130 @item -fkeep-static-consts
7131 @opindex fkeep-static-consts
7132 Emit variables declared @code{static const} when optimization isn't turned
7133 on, even if the variables aren't referenced.
7135 GCC enables this option by default.  If you want to force the compiler to
7136 check if a variable is referenced, regardless of whether or not
7137 optimization is turned on, use the @option{-fno-keep-static-consts} option.
7139 @item -fmerge-constants
7140 @opindex fmerge-constants
7141 Attempt to merge identical constants (string constants and floating-point
7142 constants) across compilation units.
7144 This option is the default for optimized compilation if the assembler and
7145 linker support it.  Use @option{-fno-merge-constants} to inhibit this
7146 behavior.
7148 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7150 @item -fmerge-all-constants
7151 @opindex fmerge-all-constants
7152 Attempt to merge identical constants and identical variables.
7154 This option implies @option{-fmerge-constants}.  In addition to
7155 @option{-fmerge-constants} this considers e.g.@: even constant initialized
7156 arrays or initialized constant variables with integral or floating-point
7157 types.  Languages like C or C++ require each variable, including multiple
7158 instances of the same variable in recursive calls, to have distinct locations,
7159 so using this option results in non-conforming
7160 behavior.
7162 @item -fmodulo-sched
7163 @opindex fmodulo-sched
7164 Perform swing modulo scheduling immediately before the first scheduling
7165 pass.  This pass looks at innermost loops and reorders their
7166 instructions by overlapping different iterations.
7168 @item -fmodulo-sched-allow-regmoves
7169 @opindex fmodulo-sched-allow-regmoves
7170 Perform more aggressive SMS-based modulo scheduling with register moves
7171 allowed.  By setting this flag certain anti-dependences edges are
7172 deleted, which triggers the generation of reg-moves based on the
7173 life-range analysis.  This option is effective only with
7174 @option{-fmodulo-sched} enabled.
7176 @item -fno-branch-count-reg
7177 @opindex fno-branch-count-reg
7178 Do not use ``decrement and branch'' instructions on a count register,
7179 but instead generate a sequence of instructions that decrement a
7180 register, compare it against zero, then branch based upon the result.
7181 This option is only meaningful on architectures that support such
7182 instructions, which include x86, PowerPC, IA-64 and S/390.
7184 The default is @option{-fbranch-count-reg}.
7186 @item -fno-function-cse
7187 @opindex fno-function-cse
7188 Do not put function addresses in registers; make each instruction that
7189 calls a constant function contain the function's address explicitly.
7191 This option results in less efficient code, but some strange hacks
7192 that alter the assembler output may be confused by the optimizations
7193 performed when this option is not used.
7195 The default is @option{-ffunction-cse}
7197 @item -fno-zero-initialized-in-bss
7198 @opindex fno-zero-initialized-in-bss
7199 If the target supports a BSS section, GCC by default puts variables that
7200 are initialized to zero into BSS@.  This can save space in the resulting
7201 code.
7203 This option turns off this behavior because some programs explicitly
7204 rely on variables going to the data section---e.g., so that the
7205 resulting executable can find the beginning of that section and/or make
7206 assumptions based on that.
7208 The default is @option{-fzero-initialized-in-bss}.
7210 @item -fthread-jumps
7211 @opindex fthread-jumps
7212 Perform optimizations that check to see if a jump branches to a
7213 location where another comparison subsumed by the first is found.  If
7214 so, the first branch is redirected to either the destination of the
7215 second branch or a point immediately following it, depending on whether
7216 the condition is known to be true or false.
7218 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7220 @item -fsplit-wide-types
7221 @opindex fsplit-wide-types
7222 When using a type that occupies multiple registers, such as @code{long
7223 long} on a 32-bit system, split the registers apart and allocate them
7224 independently.  This normally generates better code for those types,
7225 but may make debugging more difficult.
7227 Enabled at levels @option{-O}, @option{-O2}, @option{-O3},
7228 @option{-Os}.
7230 @item -fcse-follow-jumps
7231 @opindex fcse-follow-jumps
7232 In common subexpression elimination (CSE), scan through jump instructions
7233 when the target of the jump is not reached by any other path.  For
7234 example, when CSE encounters an @code{if} statement with an
7235 @code{else} clause, CSE follows the jump when the condition
7236 tested is false.
7238 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7240 @item -fcse-skip-blocks
7241 @opindex fcse-skip-blocks
7242 This is similar to @option{-fcse-follow-jumps}, but causes CSE to
7243 follow jumps that conditionally skip over blocks.  When CSE
7244 encounters a simple @code{if} statement with no else clause,
7245 @option{-fcse-skip-blocks} causes CSE to follow the jump around the
7246 body of the @code{if}.
7248 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7250 @item -frerun-cse-after-loop
7251 @opindex frerun-cse-after-loop
7252 Re-run common subexpression elimination after loop optimizations are
7253 performed.
7255 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7257 @item -fgcse
7258 @opindex fgcse
7259 Perform a global common subexpression elimination pass.
7260 This pass also performs global constant and copy propagation.
7262 @emph{Note:} When compiling a program using computed gotos, a GCC
7263 extension, you may get better run-time performance if you disable
7264 the global common subexpression elimination pass by adding
7265 @option{-fno-gcse} to the command line.
7267 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7269 @item -fgcse-lm
7270 @opindex fgcse-lm
7271 When @option{-fgcse-lm} is enabled, global common subexpression elimination
7272 attempts to move loads that are only killed by stores into themselves.  This
7273 allows a loop containing a load/store sequence to be changed to a load outside
7274 the loop, and a copy/store within the loop.
7276 Enabled by default when @option{-fgcse} is enabled.
7278 @item -fgcse-sm
7279 @opindex fgcse-sm
7280 When @option{-fgcse-sm} is enabled, a store motion pass is run after
7281 global common subexpression elimination.  This pass attempts to move
7282 stores out of loops.  When used in conjunction with @option{-fgcse-lm},
7283 loops containing a load/store sequence can be changed to a load before
7284 the loop and a store after the loop.
7286 Not enabled at any optimization level.
7288 @item -fgcse-las
7289 @opindex fgcse-las
7290 When @option{-fgcse-las} is enabled, the global common subexpression
7291 elimination pass eliminates redundant loads that come after stores to the
7292 same memory location (both partial and full redundancies).
7294 Not enabled at any optimization level.
7296 @item -fgcse-after-reload
7297 @opindex fgcse-after-reload
7298 When @option{-fgcse-after-reload} is enabled, a redundant load elimination
7299 pass is performed after reload.  The purpose of this pass is to clean up
7300 redundant spilling.
7302 @item -faggressive-loop-optimizations
7303 @opindex faggressive-loop-optimizations
7304 This option tells the loop optimizer to use language constraints to
7305 derive bounds for the number of iterations of a loop.  This assumes that
7306 loop code does not invoke undefined behavior by for example causing signed
7307 integer overflows or out-of-bound array accesses.  The bounds for the
7308 number of iterations of a loop are used to guide loop unrolling and peeling
7309 and loop exit test optimizations.
7310 This option is enabled by default.
7312 @item -funsafe-loop-optimizations
7313 @opindex funsafe-loop-optimizations
7314 This option tells the loop optimizer to assume that loop indices do not
7315 overflow, and that loops with nontrivial exit condition are not
7316 infinite.  This enables a wider range of loop optimizations even if
7317 the loop optimizer itself cannot prove that these assumptions are valid.
7318 If you use @option{-Wunsafe-loop-optimizations}, the compiler warns you
7319 if it finds this kind of loop.
7321 @item -fcrossjumping
7322 @opindex fcrossjumping
7323 Perform cross-jumping transformation.
7324 This transformation unifies equivalent code and saves code size.  The
7325 resulting code may or may not perform better than without cross-jumping.
7327 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7329 @item -fauto-inc-dec
7330 @opindex fauto-inc-dec
7331 Combine increments or decrements of addresses with memory accesses.
7332 This pass is always skipped on architectures that do not have
7333 instructions to support this.  Enabled by default at @option{-O} and
7334 higher on architectures that support this.
7336 @item -fdce
7337 @opindex fdce
7338 Perform dead code elimination (DCE) on RTL@.
7339 Enabled by default at @option{-O} and higher.
7341 @item -fdse
7342 @opindex fdse
7343 Perform dead store elimination (DSE) on RTL@.
7344 Enabled by default at @option{-O} and higher.
7346 @item -fif-conversion
7347 @opindex fif-conversion
7348 Attempt to transform conditional jumps into branch-less equivalents.  This
7349 includes use of conditional moves, min, max, set flags and abs instructions, and
7350 some tricks doable by standard arithmetics.  The use of conditional execution
7351 on chips where it is available is controlled by @code{if-conversion2}.
7353 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7355 @item -fif-conversion2
7356 @opindex fif-conversion2
7357 Use conditional execution (where available) to transform conditional jumps into
7358 branch-less equivalents.
7360 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7362 @item -fdeclone-ctor-dtor
7363 @opindex fdeclone-ctor-dtor
7364 The C++ ABI requires multiple entry points for constructors and
7365 destructors: one for a base subobject, one for a complete object, and
7366 one for a virtual destructor that calls operator delete afterwards.
7367 For a hierarchy with virtual bases, the base and complete variants are
7368 clones, which means two copies of the function.  With this option, the
7369 base and complete variants are changed to be thunks that call a common
7370 implementation.
7372 Enabled by @option{-Os}.
7374 @item -fdelete-null-pointer-checks
7375 @opindex fdelete-null-pointer-checks
7376 Assume that programs cannot safely dereference null pointers, and that
7377 no code or data element resides there.  This enables simple constant
7378 folding optimizations at all optimization levels.  In addition, other
7379 optimization passes in GCC use this flag to control global dataflow
7380 analyses that eliminate useless checks for null pointers; these assume
7381 that if a pointer is checked after it has already been dereferenced,
7382 it cannot be null.
7384 Note however that in some environments this assumption is not true.
7385 Use @option{-fno-delete-null-pointer-checks} to disable this optimization
7386 for programs that depend on that behavior.
7388 Some targets, especially embedded ones, disable this option at all levels.
7389 Otherwise it is enabled at all levels: @option{-O0}, @option{-O1},
7390 @option{-O2}, @option{-O3}, @option{-Os}.  Passes that use the information
7391 are enabled independently at different optimization levels.
7393 @item -fdevirtualize
7394 @opindex fdevirtualize
7395 Attempt to convert calls to virtual functions to direct calls.  This
7396 is done both within a procedure and interprocedurally as part of
7397 indirect inlining (@code{-findirect-inlining}) and interprocedural constant
7398 propagation (@option{-fipa-cp}).
7399 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7401 @item -fdevirtualize-speculatively
7402 @opindex fdevirtualize-speculatively
7403 Attempt to convert calls to virtual functions to speculative direct calls.
7404 Based on the analysis of the type inheritance graph, determine for a given call
7405 the set of likely targets. If the set is small, preferably of size 1, change
7406 the call into an conditional deciding on direct and indirect call.  The
7407 speculative calls enable more optimizations, such as inlining.  When they seem
7408 useless after further optimization, they are converted back into original form.
7410 @item -fexpensive-optimizations
7411 @opindex fexpensive-optimizations
7412 Perform a number of minor optimizations that are relatively expensive.
7414 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7416 @item -free
7417 @opindex free
7418 Attempt to remove redundant extension instructions.  This is especially
7419 helpful for the x86-64 architecture, which implicitly zero-extends in 64-bit
7420 registers after writing to their lower 32-bit half.
7422 Enabled for AArch64 and x86 at levels @option{-O2}, @option{-O3}.
7424 @item -flive-range-shrinkage
7425 @opindex flive-range-shrinkage
7426 Attempt to decrease register pressure through register live range
7427 shrinkage.  This is helpful for fast processors with small or moderate
7428 size register sets.
7430 @item -fira-algorithm=@var{algorithm}
7431 Use the specified coloring algorithm for the integrated register
7432 allocator.  The @var{algorithm} argument can be @samp{priority}, which
7433 specifies Chow's priority coloring, or @samp{CB}, which specifies
7434 Chaitin-Briggs coloring.  Chaitin-Briggs coloring is not implemented
7435 for all architectures, but for those targets that do support it, it is
7436 the default because it generates better code.
7438 @item -fira-region=@var{region}
7439 Use specified regions for the integrated register allocator.  The
7440 @var{region} argument should be one of the following:
7442 @table @samp
7444 @item all
7445 Use all loops as register allocation regions.
7446 This can give the best results for machines with a small and/or
7447 irregular register set.
7449 @item mixed
7450 Use all loops except for loops with small register pressure 
7451 as the regions.  This value usually gives
7452 the best results in most cases and for most architectures,
7453 and is enabled by default when compiling with optimization for speed
7454 (@option{-O}, @option{-O2}, @dots{}).
7456 @item one
7457 Use all functions as a single region.  
7458 This typically results in the smallest code size, and is enabled by default for
7459 @option{-Os} or @option{-O0}.
7461 @end table
7463 @item -fira-hoist-pressure
7464 @opindex fira-hoist-pressure
7465 Use IRA to evaluate register pressure in the code hoisting pass for
7466 decisions to hoist expressions.  This option usually results in smaller
7467 code, but it can slow the compiler down.
7469 This option is enabled at level @option{-Os} for all targets.
7471 @item -fira-loop-pressure
7472 @opindex fira-loop-pressure
7473 Use IRA to evaluate register pressure in loops for decisions to move
7474 loop invariants.  This option usually results in generation
7475 of faster and smaller code on machines with large register files (>= 32
7476 registers), but it can slow the compiler down.
7478 This option is enabled at level @option{-O3} for some targets.
7480 @item -fno-ira-share-save-slots
7481 @opindex fno-ira-share-save-slots
7482 Disable sharing of stack slots used for saving call-used hard
7483 registers living through a call.  Each hard register gets a
7484 separate stack slot, and as a result function stack frames are
7485 larger.
7487 @item -fno-ira-share-spill-slots
7488 @opindex fno-ira-share-spill-slots
7489 Disable sharing of stack slots allocated for pseudo-registers.  Each
7490 pseudo-register that does not get a hard register gets a separate
7491 stack slot, and as a result function stack frames are larger.
7493 @item -fira-verbose=@var{n}
7494 @opindex fira-verbose
7495 Control the verbosity of the dump file for the integrated register allocator.
7496 The default value is 5.  If the value @var{n} is greater or equal to 10,
7497 the dump output is sent to stderr using the same format as @var{n} minus 10.
7499 @item -fdelayed-branch
7500 @opindex fdelayed-branch
7501 If supported for the target machine, attempt to reorder instructions
7502 to exploit instruction slots available after delayed branch
7503 instructions.
7505 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
7507 @item -fschedule-insns
7508 @opindex fschedule-insns
7509 If supported for the target machine, attempt to reorder instructions to
7510 eliminate execution stalls due to required data being unavailable.  This
7511 helps machines that have slow floating point or memory load instructions
7512 by allowing other instructions to be issued until the result of the load
7513 or floating-point instruction is required.
7515 Enabled at levels @option{-O2}, @option{-O3}.
7517 @item -fschedule-insns2
7518 @opindex fschedule-insns2
7519 Similar to @option{-fschedule-insns}, but requests an additional pass of
7520 instruction scheduling after register allocation has been done.  This is
7521 especially useful on machines with a relatively small number of
7522 registers and where memory load instructions take more than one cycle.
7524 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7526 @item -fno-sched-interblock
7527 @opindex fno-sched-interblock
7528 Don't schedule instructions across basic blocks.  This is normally
7529 enabled by default when scheduling before register allocation, i.e.@:
7530 with @option{-fschedule-insns} or at @option{-O2} or higher.
7532 @item -fno-sched-spec
7533 @opindex fno-sched-spec
7534 Don't allow speculative motion of non-load instructions.  This is normally
7535 enabled by default when scheduling before register allocation, i.e.@:
7536 with @option{-fschedule-insns} or at @option{-O2} or higher.
7538 @item -fsched-pressure
7539 @opindex fsched-pressure
7540 Enable register pressure sensitive insn scheduling before register
7541 allocation.  This only makes sense when scheduling before register
7542 allocation is enabled, i.e.@: with @option{-fschedule-insns} or at
7543 @option{-O2} or higher.  Usage of this option can improve the
7544 generated code and decrease its size by preventing register pressure
7545 increase above the number of available hard registers and subsequent
7546 spills in register allocation.
7548 @item -fsched-spec-load
7549 @opindex fsched-spec-load
7550 Allow speculative motion of some load instructions.  This only makes
7551 sense when scheduling before register allocation, i.e.@: with
7552 @option{-fschedule-insns} or at @option{-O2} or higher.
7554 @item -fsched-spec-load-dangerous
7555 @opindex fsched-spec-load-dangerous
7556 Allow speculative motion of more load instructions.  This only makes
7557 sense when scheduling before register allocation, i.e.@: with
7558 @option{-fschedule-insns} or at @option{-O2} or higher.
7560 @item -fsched-stalled-insns
7561 @itemx -fsched-stalled-insns=@var{n}
7562 @opindex fsched-stalled-insns
7563 Define how many insns (if any) can be moved prematurely from the queue
7564 of stalled insns into the ready list during the second scheduling pass.
7565 @option{-fno-sched-stalled-insns} means that no insns are moved
7566 prematurely, @option{-fsched-stalled-insns=0} means there is no limit
7567 on how many queued insns can be moved prematurely.
7568 @option{-fsched-stalled-insns} without a value is equivalent to
7569 @option{-fsched-stalled-insns=1}.
7571 @item -fsched-stalled-insns-dep
7572 @itemx -fsched-stalled-insns-dep=@var{n}
7573 @opindex fsched-stalled-insns-dep
7574 Define how many insn groups (cycles) are examined for a dependency
7575 on a stalled insn that is a candidate for premature removal from the queue
7576 of stalled insns.  This has an effect only during the second scheduling pass,
7577 and only if @option{-fsched-stalled-insns} is used.
7578 @option{-fno-sched-stalled-insns-dep} is equivalent to
7579 @option{-fsched-stalled-insns-dep=0}.
7580 @option{-fsched-stalled-insns-dep} without a value is equivalent to
7581 @option{-fsched-stalled-insns-dep=1}.
7583 @item -fsched2-use-superblocks
7584 @opindex fsched2-use-superblocks
7585 When scheduling after register allocation, use superblock scheduling.
7586 This allows motion across basic block boundaries,
7587 resulting in faster schedules.  This option is experimental, as not all machine
7588 descriptions used by GCC model the CPU closely enough to avoid unreliable
7589 results from the algorithm.
7591 This only makes sense when scheduling after register allocation, i.e.@: with
7592 @option{-fschedule-insns2} or at @option{-O2} or higher.
7594 @item -fsched-group-heuristic
7595 @opindex fsched-group-heuristic
7596 Enable the group heuristic in the scheduler.  This heuristic favors
7597 the instruction that belongs to a schedule group.  This is enabled
7598 by default when scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7599 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7601 @item -fsched-critical-path-heuristic
7602 @opindex fsched-critical-path-heuristic
7603 Enable the critical-path heuristic in the scheduler.  This heuristic favors
7604 instructions on the critical path.  This is enabled by default when
7605 scheduling is enabled, i.e.@: with @option{-fschedule-insns}
7606 or @option{-fschedule-insns2} or at @option{-O2} or higher.
7608 @item -fsched-spec-insn-heuristic
7609 @opindex fsched-spec-insn-heuristic
7610 Enable the speculative instruction heuristic in the scheduler.  This
7611 heuristic favors speculative instructions with greater dependency weakness.
7612 This is enabled by default when scheduling is enabled, i.e.@:
7613 with @option{-fschedule-insns} or @option{-fschedule-insns2}
7614 or at @option{-O2} or higher.
7616 @item -fsched-rank-heuristic
7617 @opindex fsched-rank-heuristic
7618 Enable the rank heuristic in the scheduler.  This heuristic favors
7619 the instruction belonging to a basic block with greater size or frequency.
7620 This is enabled by default when scheduling is enabled, i.e.@:
7621 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7622 at @option{-O2} or higher.
7624 @item -fsched-last-insn-heuristic
7625 @opindex fsched-last-insn-heuristic
7626 Enable the last-instruction heuristic in the scheduler.  This heuristic
7627 favors the instruction that is less dependent on the last instruction
7628 scheduled.  This is enabled by default when scheduling is enabled,
7629 i.e.@: with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7630 at @option{-O2} or higher.
7632 @item -fsched-dep-count-heuristic
7633 @opindex fsched-dep-count-heuristic
7634 Enable the dependent-count heuristic in the scheduler.  This heuristic
7635 favors the instruction that has more instructions depending on it.
7636 This is enabled by default when scheduling is enabled, i.e.@:
7637 with @option{-fschedule-insns} or @option{-fschedule-insns2} or
7638 at @option{-O2} or higher.
7640 @item -freschedule-modulo-scheduled-loops
7641 @opindex freschedule-modulo-scheduled-loops
7642 Modulo scheduling is performed before traditional scheduling.  If a loop
7643 is modulo scheduled, later scheduling passes may change its schedule.  
7644 Use this option to control that behavior.
7646 @item -fselective-scheduling
7647 @opindex fselective-scheduling
7648 Schedule instructions using selective scheduling algorithm.  Selective
7649 scheduling runs instead of the first scheduler pass.
7651 @item -fselective-scheduling2
7652 @opindex fselective-scheduling2
7653 Schedule instructions using selective scheduling algorithm.  Selective
7654 scheduling runs instead of the second scheduler pass.
7656 @item -fsel-sched-pipelining
7657 @opindex fsel-sched-pipelining
7658 Enable software pipelining of innermost loops during selective scheduling.
7659 This option has no effect unless one of @option{-fselective-scheduling} or
7660 @option{-fselective-scheduling2} is turned on.
7662 @item -fsel-sched-pipelining-outer-loops
7663 @opindex fsel-sched-pipelining-outer-loops
7664 When pipelining loops during selective scheduling, also pipeline outer loops.
7665 This option has no effect unless @option{-fsel-sched-pipelining} is turned on.
7667 @item -fshrink-wrap
7668 @opindex fshrink-wrap
7669 Emit function prologues only before parts of the function that need it,
7670 rather than at the top of the function.  This flag is enabled by default at
7671 @option{-O} and higher.
7673 @item -fcaller-saves
7674 @opindex fcaller-saves
7675 Enable allocation of values to registers that are clobbered by
7676 function calls, by emitting extra instructions to save and restore the
7677 registers around such calls.  Such allocation is done only when it
7678 seems to result in better code.
7680 This option is always enabled by default on certain machines, usually
7681 those which have no call-preserved registers to use instead.
7683 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
7685 @item -fcombine-stack-adjustments
7686 @opindex fcombine-stack-adjustments
7687 Tracks stack adjustments (pushes and pops) and stack memory references
7688 and then tries to find ways to combine them.
7690 Enabled by default at @option{-O1} and higher.
7692 @item -fconserve-stack
7693 @opindex fconserve-stack
7694 Attempt to minimize stack usage.  The compiler attempts to use less
7695 stack space, even if that makes the program slower.  This option
7696 implies setting the @option{large-stack-frame} parameter to 100
7697 and the @option{large-stack-frame-growth} parameter to 400.
7699 @item -ftree-reassoc
7700 @opindex ftree-reassoc
7701 Perform reassociation on trees.  This flag is enabled by default
7702 at @option{-O} and higher.
7704 @item -ftree-pre
7705 @opindex ftree-pre
7706 Perform partial redundancy elimination (PRE) on trees.  This flag is
7707 enabled by default at @option{-O2} and @option{-O3}.
7709 @item -ftree-partial-pre
7710 @opindex ftree-partial-pre
7711 Make partial redundancy elimination (PRE) more aggressive.  This flag is
7712 enabled by default at @option{-O3}.
7714 @item -ftree-forwprop
7715 @opindex ftree-forwprop
7716 Perform forward propagation on trees.  This flag is enabled by default
7717 at @option{-O} and higher.
7719 @item -ftree-fre
7720 @opindex ftree-fre
7721 Perform full redundancy elimination (FRE) on trees.  The difference
7722 between FRE and PRE is that FRE only considers expressions
7723 that are computed on all paths leading to the redundant computation.
7724 This analysis is faster than PRE, though it exposes fewer redundancies.
7725 This flag is enabled by default at @option{-O} and higher.
7727 @item -ftree-phiprop
7728 @opindex ftree-phiprop
7729 Perform hoisting of loads from conditional pointers on trees.  This
7730 pass is enabled by default at @option{-O} and higher.
7732 @item -fhoist-adjacent-loads
7733 @opindex hoist-adjacent-loads
7734 Speculatively hoist loads from both branches of an if-then-else if the
7735 loads are from adjacent locations in the same structure and the target
7736 architecture has a conditional move instruction.  This flag is enabled
7737 by default at @option{-O2} and higher.
7739 @item -ftree-copy-prop
7740 @opindex ftree-copy-prop
7741 Perform copy propagation on trees.  This pass eliminates unnecessary
7742 copy operations.  This flag is enabled by default at @option{-O} and
7743 higher.
7745 @item -fipa-pure-const
7746 @opindex fipa-pure-const
7747 Discover which functions are pure or constant.
7748 Enabled by default at @option{-O} and higher.
7750 @item -fipa-reference
7751 @opindex fipa-reference
7752 Discover which static variables do not escape the
7753 compilation unit.
7754 Enabled by default at @option{-O} and higher.
7756 @item -fipa-pta
7757 @opindex fipa-pta
7758 Perform interprocedural pointer analysis and interprocedural modification
7759 and reference analysis.  This option can cause excessive memory and
7760 compile-time usage on large compilation units.  It is not enabled by
7761 default at any optimization level.
7763 @item -fipa-profile
7764 @opindex fipa-profile
7765 Perform interprocedural profile propagation.  The functions called only from
7766 cold functions are marked as cold. Also functions executed once (such as
7767 @code{cold}, @code{noreturn}, static constructors or destructors) are identified. Cold
7768 functions and loop less parts of functions executed once are then optimized for
7769 size.
7770 Enabled by default at @option{-O} and higher.
7772 @item -fipa-cp
7773 @opindex fipa-cp
7774 Perform interprocedural constant propagation.
7775 This optimization analyzes the program to determine when values passed
7776 to functions are constants and then optimizes accordingly.
7777 This optimization can substantially increase performance
7778 if the application has constants passed to functions.
7779 This flag is enabled by default at @option{-O2}, @option{-Os} and @option{-O3}.
7781 @item -fipa-cp-clone
7782 @opindex fipa-cp-clone
7783 Perform function cloning to make interprocedural constant propagation stronger.
7784 When enabled, interprocedural constant propagation performs function cloning
7785 when externally visible function can be called with constant arguments.
7786 Because this optimization can create multiple copies of functions,
7787 it may significantly increase code size
7788 (see @option{--param ipcp-unit-growth=@var{value}}).
7789 This flag is enabled by default at @option{-O3}.
7791 @item -fisolate-erroneous-paths-dereference
7792 Detect paths which trigger erroneous or undefined behaviour due to
7793 dereferencing a NULL pointer.  Isolate those paths from the main control
7794 flow and turn the statement with erroneous or undefined behaviour into a trap.
7796 @item -fisolate-erroneous-paths-attribute
7797 Detect paths which trigger erroneous or undefined behaviour due a NULL value
7798 being used in a way which is forbidden by a @code{returns_nonnull} or @code{nonnull}
7799 attribute.  Isolate those paths from the main control flow and turn the
7800 statement with erroneous or undefined behaviour into a trap.  This is not
7801 currently enabled, but may be enabled by @code{-O2} in the future.
7803 @item -ftree-sink
7804 @opindex ftree-sink
7805 Perform forward store motion  on trees.  This flag is
7806 enabled by default at @option{-O} and higher.
7808 @item -ftree-bit-ccp
7809 @opindex ftree-bit-ccp
7810 Perform sparse conditional bit constant propagation on trees and propagate
7811 pointer alignment information.
7812 This pass only operates on local scalar variables and is enabled by default
7813 at @option{-O} and higher.  It requires that @option{-ftree-ccp} is enabled.
7815 @item -ftree-ccp
7816 @opindex ftree-ccp
7817 Perform sparse conditional constant propagation (CCP) on trees.  This
7818 pass only operates on local scalar variables and is enabled by default
7819 at @option{-O} and higher.
7821 @item -ftree-switch-conversion
7822 Perform conversion of simple initializations in a switch to
7823 initializations from a scalar array.  This flag is enabled by default
7824 at @option{-O2} and higher.
7826 @item -ftree-tail-merge
7827 Look for identical code sequences.  When found, replace one with a jump to the
7828 other.  This optimization is known as tail merging or cross jumping.  This flag
7829 is enabled by default at @option{-O2} and higher.  The compilation time
7830 in this pass can
7831 be limited using @option{max-tail-merge-comparisons} parameter and
7832 @option{max-tail-merge-iterations} parameter.
7834 @item -ftree-dce
7835 @opindex ftree-dce
7836 Perform dead code elimination (DCE) on trees.  This flag is enabled by
7837 default at @option{-O} and higher.
7839 @item -ftree-builtin-call-dce
7840 @opindex ftree-builtin-call-dce
7841 Perform conditional dead code elimination (DCE) for calls to built-in functions
7842 that may set @code{errno} but are otherwise side-effect free.  This flag is
7843 enabled by default at @option{-O2} and higher if @option{-Os} is not also
7844 specified.
7846 @item -ftree-dominator-opts
7847 @opindex ftree-dominator-opts
7848 Perform a variety of simple scalar cleanups (constant/copy
7849 propagation, redundancy elimination, range propagation and expression
7850 simplification) based on a dominator tree traversal.  This also
7851 performs jump threading (to reduce jumps to jumps). This flag is
7852 enabled by default at @option{-O} and higher.
7854 @item -ftree-dse
7855 @opindex ftree-dse
7856 Perform dead store elimination (DSE) on trees.  A dead store is a store into
7857 a memory location that is later overwritten by another store without
7858 any intervening loads.  In this case the earlier store can be deleted.  This
7859 flag is enabled by default at @option{-O} and higher.
7861 @item -ftree-ch
7862 @opindex ftree-ch
7863 Perform loop header copying on trees.  This is beneficial since it increases
7864 effectiveness of code motion optimizations.  It also saves one jump.  This flag
7865 is enabled by default at @option{-O} and higher.  It is not enabled
7866 for @option{-Os}, since it usually increases code size.
7868 @item -ftree-loop-optimize
7869 @opindex ftree-loop-optimize
7870 Perform loop optimizations on trees.  This flag is enabled by default
7871 at @option{-O} and higher.
7873 @item -ftree-loop-linear
7874 @opindex ftree-loop-linear
7875 Perform loop interchange transformations on tree.  Same as
7876 @option{-floop-interchange}.  To use this code transformation, GCC has
7877 to be configured with @option{--with-ppl} and @option{--with-cloog} to
7878 enable the Graphite loop transformation infrastructure.
7880 @item -floop-interchange
7881 @opindex floop-interchange
7882 Perform loop interchange transformations on loops.  Interchanging two
7883 nested loops switches the inner and outer loops.  For example, given a
7884 loop like:
7885 @smallexample
7886 DO J = 1, M
7887   DO I = 1, N
7888     A(J, I) = A(J, I) * C
7889   ENDDO
7890 ENDDO
7891 @end smallexample
7892 loop interchange transforms the loop as if it were written:
7893 @smallexample
7894 DO I = 1, N
7895   DO J = 1, M
7896     A(J, I) = A(J, I) * C
7897   ENDDO
7898 ENDDO
7899 @end smallexample
7900 which can be beneficial when @code{N} is larger than the caches,
7901 because in Fortran, the elements of an array are stored in memory
7902 contiguously by column, and the original loop iterates over rows,
7903 potentially creating at each access a cache miss.  This optimization
7904 applies to all the languages supported by GCC and is not limited to
7905 Fortran.  To use this code transformation, GCC has to be configured
7906 with @option{--with-ppl} and @option{--with-cloog} to enable the
7907 Graphite loop transformation infrastructure.
7909 @item -floop-strip-mine
7910 @opindex floop-strip-mine
7911 Perform loop strip mining transformations on loops.  Strip mining
7912 splits a loop into two nested loops.  The outer loop has strides
7913 equal to the strip size and the inner loop has strides of the
7914 original loop within a strip.  The strip length can be changed
7915 using the @option{loop-block-tile-size} parameter.  For example,
7916 given a loop like:
7917 @smallexample
7918 DO I = 1, N
7919   A(I) = A(I) + C
7920 ENDDO
7921 @end smallexample
7922 loop strip mining transforms the loop as if it were written:
7923 @smallexample
7924 DO II = 1, N, 51
7925   DO I = II, min (II + 50, N)
7926     A(I) = A(I) + C
7927   ENDDO
7928 ENDDO
7929 @end smallexample
7930 This optimization applies to all the languages supported by GCC and is
7931 not limited to Fortran.  To use this code transformation, GCC has to
7932 be configured with @option{--with-ppl} and @option{--with-cloog} to
7933 enable the Graphite loop transformation infrastructure.
7935 @item -floop-block
7936 @opindex floop-block
7937 Perform loop blocking transformations on loops.  Blocking strip mines
7938 each loop in the loop nest such that the memory accesses of the
7939 element loops fit inside caches.  The strip length can be changed
7940 using the @option{loop-block-tile-size} parameter.  For example, given
7941 a loop like:
7942 @smallexample
7943 DO I = 1, N
7944   DO J = 1, M
7945     A(J, I) = B(I) + C(J)
7946   ENDDO
7947 ENDDO
7948 @end smallexample
7949 loop blocking transforms the loop as if it were written:
7950 @smallexample
7951 DO II = 1, N, 51
7952   DO JJ = 1, M, 51
7953     DO I = II, min (II + 50, N)
7954       DO J = JJ, min (JJ + 50, M)
7955         A(J, I) = B(I) + C(J)
7956       ENDDO
7957     ENDDO
7958   ENDDO
7959 ENDDO
7960 @end smallexample
7961 which can be beneficial when @code{M} is larger than the caches,
7962 because the innermost loop iterates over a smaller amount of data
7963 which can be kept in the caches.  This optimization applies to all the
7964 languages supported by GCC and is not limited to Fortran.  To use this
7965 code transformation, GCC has to be configured with @option{--with-ppl}
7966 and @option{--with-cloog} to enable the Graphite loop transformation
7967 infrastructure.
7969 @item -fgraphite-identity
7970 @opindex fgraphite-identity
7971 Enable the identity transformation for graphite.  For every SCoP we generate
7972 the polyhedral representation and transform it back to gimple.  Using
7973 @option{-fgraphite-identity} we can check the costs or benefits of the
7974 GIMPLE -> GRAPHITE -> GIMPLE transformation.  Some minimal optimizations
7975 are also performed by the code generator CLooG, like index splitting and
7976 dead code elimination in loops.
7978 @item -floop-nest-optimize
7979 @opindex floop-nest-optimize
7980 Enable the ISL based loop nest optimizer.  This is a generic loop nest
7981 optimizer based on the Pluto optimization algorithms.  It calculates a loop
7982 structure optimized for data-locality and parallelism.  This option
7983 is experimental.
7985 @item -floop-parallelize-all
7986 @opindex floop-parallelize-all
7987 Use the Graphite data dependence analysis to identify loops that can
7988 be parallelized.  Parallelize all the loops that can be analyzed to
7989 not contain loop carried dependences without checking that it is
7990 profitable to parallelize the loops.
7992 @item -fcheck-data-deps
7993 @opindex fcheck-data-deps
7994 Compare the results of several data dependence analyzers.  This option
7995 is used for debugging the data dependence analyzers.
7997 @item -ftree-loop-if-convert
7998 Attempt to transform conditional jumps in the innermost loops to
7999 branch-less equivalents.  The intent is to remove control-flow from
8000 the innermost loops in order to improve the ability of the
8001 vectorization pass to handle these loops.  This is enabled by default
8002 if vectorization is enabled.
8004 @item -ftree-loop-if-convert-stores
8005 Attempt to also if-convert conditional jumps containing memory writes.
8006 This transformation can be unsafe for multi-threaded programs as it
8007 transforms conditional memory writes into unconditional memory writes.
8008 For example,
8009 @smallexample
8010 for (i = 0; i < N; i++)
8011   if (cond)
8012     A[i] = expr;
8013 @end smallexample
8014 is transformed to
8015 @smallexample
8016 for (i = 0; i < N; i++)
8017   A[i] = cond ? expr : A[i];
8018 @end smallexample
8019 potentially producing data races.
8021 @item -ftree-loop-distribution
8022 Perform loop distribution.  This flag can improve cache performance on
8023 big loop bodies and allow further loop optimizations, like
8024 parallelization or vectorization, to take place.  For example, the loop
8025 @smallexample
8026 DO I = 1, N
8027   A(I) = B(I) + C
8028   D(I) = E(I) * F
8029 ENDDO
8030 @end smallexample
8031 is transformed to
8032 @smallexample
8033 DO I = 1, N
8034    A(I) = B(I) + C
8035 ENDDO
8036 DO I = 1, N
8037    D(I) = E(I) * F
8038 ENDDO
8039 @end smallexample
8041 @item -ftree-loop-distribute-patterns
8042 Perform loop distribution of patterns that can be code generated with
8043 calls to a library.  This flag is enabled by default at @option{-O3}.
8045 This pass distributes the initialization loops and generates a call to
8046 memset zero.  For example, the loop
8047 @smallexample
8048 DO I = 1, N
8049   A(I) = 0
8050   B(I) = A(I) + I
8051 ENDDO
8052 @end smallexample
8053 is transformed to
8054 @smallexample
8055 DO I = 1, N
8056    A(I) = 0
8057 ENDDO
8058 DO I = 1, N
8059    B(I) = A(I) + I
8060 ENDDO
8061 @end smallexample
8062 and the initialization loop is transformed into a call to memset zero.
8064 @item -ftree-loop-im
8065 @opindex ftree-loop-im
8066 Perform loop invariant motion on trees.  This pass moves only invariants that
8067 are hard to handle at RTL level (function calls, operations that expand to
8068 nontrivial sequences of insns).  With @option{-funswitch-loops} it also moves
8069 operands of conditions that are invariant out of the loop, so that we can use
8070 just trivial invariantness analysis in loop unswitching.  The pass also includes
8071 store motion.
8073 @item -ftree-loop-ivcanon
8074 @opindex ftree-loop-ivcanon
8075 Create a canonical counter for number of iterations in loops for which
8076 determining number of iterations requires complicated analysis.  Later
8077 optimizations then may determine the number easily.  Useful especially
8078 in connection with unrolling.
8080 @item -fivopts
8081 @opindex fivopts
8082 Perform induction variable optimizations (strength reduction, induction
8083 variable merging and induction variable elimination) on trees.
8085 @item -ftree-parallelize-loops=n
8086 @opindex ftree-parallelize-loops
8087 Parallelize loops, i.e., split their iteration space to run in n threads.
8088 This is only possible for loops whose iterations are independent
8089 and can be arbitrarily reordered.  The optimization is only
8090 profitable on multiprocessor machines, for loops that are CPU-intensive,
8091 rather than constrained e.g.@: by memory bandwidth.  This option
8092 implies @option{-pthread}, and thus is only supported on targets
8093 that have support for @option{-pthread}.
8095 @item -ftree-pta
8096 @opindex ftree-pta
8097 Perform function-local points-to analysis on trees.  This flag is
8098 enabled by default at @option{-O} and higher.
8100 @item -ftree-sra
8101 @opindex ftree-sra
8102 Perform scalar replacement of aggregates.  This pass replaces structure
8103 references with scalars to prevent committing structures to memory too
8104 early.  This flag is enabled by default at @option{-O} and higher.
8106 @item -ftree-copyrename
8107 @opindex ftree-copyrename
8108 Perform copy renaming on trees.  This pass attempts to rename compiler
8109 temporaries to other variables at copy locations, usually resulting in
8110 variable names which more closely resemble the original variables.  This flag
8111 is enabled by default at @option{-O} and higher.
8113 @item -ftree-coalesce-inlined-vars
8114 @opindex ftree-coalesce-inlined-vars
8115 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8116 combine small user-defined variables too, but only if they were inlined
8117 from other functions.  It is a more limited form of
8118 @option{-ftree-coalesce-vars}.  This may harm debug information of such
8119 inlined variables, but it will keep variables of the inlined-into
8120 function apart from each other, such that they are more likely to
8121 contain the expected values in a debugging session.  This was the
8122 default in GCC versions older than 4.7.
8124 @item -ftree-coalesce-vars
8125 @opindex ftree-coalesce-vars
8126 Tell the copyrename pass (see @option{-ftree-copyrename}) to attempt to
8127 combine small user-defined variables too, instead of just compiler
8128 temporaries.  This may severely limit the ability to debug an optimized
8129 program compiled with @option{-fno-var-tracking-assignments}.  In the
8130 negated form, this flag prevents SSA coalescing of user variables,
8131 including inlined ones.  This option is enabled by default.
8133 @item -ftree-ter
8134 @opindex ftree-ter
8135 Perform temporary expression replacement during the SSA->normal phase.  Single
8136 use/single def temporaries are replaced at their use location with their
8137 defining expression.  This results in non-GIMPLE code, but gives the expanders
8138 much more complex trees to work on resulting in better RTL generation.  This is
8139 enabled by default at @option{-O} and higher.
8141 @item -ftree-slsr
8142 @opindex ftree-slsr
8143 Perform straight-line strength reduction on trees.  This recognizes related
8144 expressions involving multiplications and replaces them by less expensive
8145 calculations when possible.  This is enabled by default at @option{-O} and
8146 higher.
8148 @item -ftree-vectorize
8149 @opindex ftree-vectorize
8150 Perform vectorization on trees. This flag enables @option{-ftree-loop-vectorize}
8151 and @option{-ftree-slp-vectorize} if not explicitly specified.
8153 @item -ftree-loop-vectorize
8154 @opindex ftree-loop-vectorize
8155 Perform loop vectorization on trees. This flag is enabled by default at
8156 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8158 @item -ftree-slp-vectorize
8159 @opindex ftree-slp-vectorize
8160 Perform basic block vectorization on trees. This flag is enabled by default at
8161 @option{-O3} and when @option{-ftree-vectorize} is enabled.
8163 @item -fvect-cost-model=@var{model}
8164 @opindex fvect-cost-model
8165 Alter the cost model used for vectorization.  The @var{model} argument
8166 should be one of @code{unlimited}, @code{dynamic} or @code{cheap}.
8167 With the @code{unlimited} model the vectorized code-path is assumed
8168 to be profitable while with the @code{dynamic} model a runtime check
8169 will guard the vectorized code-path to enable it only for iteration
8170 counts that will likely execute faster than when executing the original
8171 scalar loop.  The @code{cheap} model will disable vectorization of
8172 loops where doing so would be cost prohibitive for example due to
8173 required runtime checks for data dependence or alignment but otherwise
8174 is equal to the @code{dynamic} model.
8175 The default cost model depends on other optimization flags and is
8176 either @code{dynamic} or @code{cheap}.
8178 @item -fsimd-cost-model=@var{model}
8179 @opindex fsimd-cost-model
8180 Alter the cost model used for vectorization of loops marked with the OpenMP
8181 or Cilk Plus simd directive.  The @var{model} argument should be one of
8182 @code{unlimited}, @code{dynamic}, @code{cheap}.  All values of @var{model}
8183 have the same meaning as described in @option{-fvect-cost-model} and by
8184 default a cost model defined with @option{-fvect-cost-model} is used.
8186 @item -ftree-vrp
8187 @opindex ftree-vrp
8188 Perform Value Range Propagation on trees.  This is similar to the
8189 constant propagation pass, but instead of values, ranges of values are
8190 propagated.  This allows the optimizers to remove unnecessary range
8191 checks like array bound checks and null pointer checks.  This is
8192 enabled by default at @option{-O2} and higher.  Null pointer check
8193 elimination is only done if @option{-fdelete-null-pointer-checks} is
8194 enabled.
8196 @item -ftracer
8197 @opindex ftracer
8198 Perform tail duplication to enlarge superblock size.  This transformation
8199 simplifies the control flow of the function allowing other optimizations to do
8200 a better job.
8202 @item -funroll-loops
8203 @opindex funroll-loops
8204 Unroll loops whose number of iterations can be determined at compile
8205 time or upon entry to the loop.  @option{-funroll-loops} implies
8206 @option{-frerun-cse-after-loop}.  This option makes code larger,
8207 and may or may not make it run faster.
8209 @item -funroll-all-loops
8210 @opindex funroll-all-loops
8211 Unroll all loops, even if their number of iterations is uncertain when
8212 the loop is entered.  This usually makes programs run more slowly.
8213 @option{-funroll-all-loops} implies the same options as
8214 @option{-funroll-loops},
8216 @item -fsplit-ivs-in-unroller
8217 @opindex fsplit-ivs-in-unroller
8218 Enables expression of values of induction variables in later iterations
8219 of the unrolled loop using the value in the first iteration.  This breaks
8220 long dependency chains, thus improving efficiency of the scheduling passes.
8222 A combination of @option{-fweb} and CSE is often sufficient to obtain the
8223 same effect.  However, that is not reliable in cases where the loop body
8224 is more complicated than a single basic block.  It also does not work at all
8225 on some architectures due to restrictions in the CSE pass.
8227 This optimization is enabled by default.
8229 @item -fvariable-expansion-in-unroller
8230 @opindex fvariable-expansion-in-unroller
8231 With this option, the compiler creates multiple copies of some
8232 local variables when unrolling a loop, which can result in superior code.
8234 @item -fpartial-inlining
8235 @opindex fpartial-inlining
8236 Inline parts of functions.  This option has any effect only
8237 when inlining itself is turned on by the @option{-finline-functions}
8238 or @option{-finline-small-functions} options.
8240 Enabled at level @option{-O2}.
8242 @item -fpredictive-commoning
8243 @opindex fpredictive-commoning
8244 Perform predictive commoning optimization, i.e., reusing computations
8245 (especially memory loads and stores) performed in previous
8246 iterations of loops.
8248 This option is enabled at level @option{-O3}.
8250 @item -fprefetch-loop-arrays
8251 @opindex fprefetch-loop-arrays
8252 If supported by the target machine, generate instructions to prefetch
8253 memory to improve the performance of loops that access large arrays.
8255 This option may generate better or worse code; results are highly
8256 dependent on the structure of loops within the source code.
8258 Disabled at level @option{-Os}.
8260 @item -fno-peephole
8261 @itemx -fno-peephole2
8262 @opindex fno-peephole
8263 @opindex fno-peephole2
8264 Disable any machine-specific peephole optimizations.  The difference
8265 between @option{-fno-peephole} and @option{-fno-peephole2} is in how they
8266 are implemented in the compiler; some targets use one, some use the
8267 other, a few use both.
8269 @option{-fpeephole} is enabled by default.
8270 @option{-fpeephole2} enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8272 @item -fno-guess-branch-probability
8273 @opindex fno-guess-branch-probability
8274 Do not guess branch probabilities using heuristics.
8276 GCC uses heuristics to guess branch probabilities if they are
8277 not provided by profiling feedback (@option{-fprofile-arcs}).  These
8278 heuristics are based on the control flow graph.  If some branch probabilities
8279 are specified by @samp{__builtin_expect}, then the heuristics are
8280 used to guess branch probabilities for the rest of the control flow graph,
8281 taking the @samp{__builtin_expect} info into account.  The interactions
8282 between the heuristics and @samp{__builtin_expect} can be complex, and in
8283 some cases, it may be useful to disable the heuristics so that the effects
8284 of @samp{__builtin_expect} are easier to understand.
8286 The default is @option{-fguess-branch-probability} at levels
8287 @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8289 @item -freorder-blocks
8290 @opindex freorder-blocks
8291 Reorder basic blocks in the compiled function in order to reduce number of
8292 taken branches and improve code locality.
8294 Enabled at levels @option{-O2}, @option{-O3}.
8296 @item -freorder-blocks-and-partition
8297 @opindex freorder-blocks-and-partition
8298 In addition to reordering basic blocks in the compiled function, in order
8299 to reduce number of taken branches, partitions hot and cold basic blocks
8300 into separate sections of the assembly and .o files, to improve
8301 paging and cache locality performance.
8303 This optimization is automatically turned off in the presence of
8304 exception handling, for linkonce sections, for functions with a user-defined
8305 section attribute and on any architecture that does not support named
8306 sections.
8308 Enabled for x86 at levels @option{-O2}, @option{-O3}.
8310 @item -freorder-functions
8311 @opindex freorder-functions
8312 Reorder functions in the object file in order to
8313 improve code locality.  This is implemented by using special
8314 subsections @code{.text.hot} for most frequently executed functions and
8315 @code{.text.unlikely} for unlikely executed functions.  Reordering is done by
8316 the linker so object file format must support named sections and linker must
8317 place them in a reasonable way.
8319 Also profile feedback must be available to make this option effective.  See
8320 @option{-fprofile-arcs} for details.
8322 Enabled at levels @option{-O2}, @option{-O3}, @option{-Os}.
8324 @item -fstrict-aliasing
8325 @opindex fstrict-aliasing
8326 Allow the compiler to assume the strictest aliasing rules applicable to
8327 the language being compiled.  For C (and C++), this activates
8328 optimizations based on the type of expressions.  In particular, an
8329 object of one type is assumed never to reside at the same address as an
8330 object of a different type, unless the types are almost the same.  For
8331 example, an @code{unsigned int} can alias an @code{int}, but not a
8332 @code{void*} or a @code{double}.  A character type may alias any other
8333 type.
8335 @anchor{Type-punning}Pay special attention to code like this:
8336 @smallexample
8337 union a_union @{
8338   int i;
8339   double d;
8342 int f() @{
8343   union a_union t;
8344   t.d = 3.0;
8345   return t.i;
8347 @end smallexample
8348 The practice of reading from a different union member than the one most
8349 recently written to (called ``type-punning'') is common.  Even with
8350 @option{-fstrict-aliasing}, type-punning is allowed, provided the memory
8351 is accessed through the union type.  So, the code above works as
8352 expected.  @xref{Structures unions enumerations and bit-fields
8353 implementation}.  However, this code might not:
8354 @smallexample
8355 int f() @{
8356   union a_union t;
8357   int* ip;
8358   t.d = 3.0;
8359   ip = &t.i;
8360   return *ip;
8362 @end smallexample
8364 Similarly, access by taking the address, casting the resulting pointer
8365 and dereferencing the result has undefined behavior, even if the cast
8366 uses a union type, e.g.:
8367 @smallexample
8368 int f() @{
8369   double d = 3.0;
8370   return ((union a_union *) &d)->i;
8372 @end smallexample
8374 The @option{-fstrict-aliasing} option is enabled at levels
8375 @option{-O2}, @option{-O3}, @option{-Os}.
8377 @item -fstrict-overflow
8378 @opindex fstrict-overflow
8379 Allow the compiler to assume strict signed overflow rules, depending
8380 on the language being compiled.  For C (and C++) this means that
8381 overflow when doing arithmetic with signed numbers is undefined, which
8382 means that the compiler may assume that it does not happen.  This
8383 permits various optimizations.  For example, the compiler assumes
8384 that an expression like @code{i + 10 > i} is always true for
8385 signed @code{i}.  This assumption is only valid if signed overflow is
8386 undefined, as the expression is false if @code{i + 10} overflows when
8387 using twos complement arithmetic.  When this option is in effect any
8388 attempt to determine whether an operation on signed numbers 
8389 overflows must be written carefully to not actually involve overflow.
8391 This option also allows the compiler to assume strict pointer
8392 semantics: given a pointer to an object, if adding an offset to that
8393 pointer does not produce a pointer to the same object, the addition is
8394 undefined.  This permits the compiler to conclude that @code{p + u >
8395 p} is always true for a pointer @code{p} and unsigned integer
8396 @code{u}.  This assumption is only valid because pointer wraparound is
8397 undefined, as the expression is false if @code{p + u} overflows using
8398 twos complement arithmetic.
8400 See also the @option{-fwrapv} option.  Using @option{-fwrapv} means
8401 that integer signed overflow is fully defined: it wraps.  When
8402 @option{-fwrapv} is used, there is no difference between
8403 @option{-fstrict-overflow} and @option{-fno-strict-overflow} for
8404 integers.  With @option{-fwrapv} certain types of overflow are
8405 permitted.  For example, if the compiler gets an overflow when doing
8406 arithmetic on constants, the overflowed value can still be used with
8407 @option{-fwrapv}, but not otherwise.
8409 The @option{-fstrict-overflow} option is enabled at levels
8410 @option{-O2}, @option{-O3}, @option{-Os}.
8412 @item -falign-functions
8413 @itemx -falign-functions=@var{n}
8414 @opindex falign-functions
8415 Align the start of functions to the next power-of-two greater than
8416 @var{n}, skipping up to @var{n} bytes.  For instance,
8417 @option{-falign-functions=32} aligns functions to the next 32-byte
8418 boundary, but @option{-falign-functions=24} aligns to the next
8419 32-byte boundary only if this can be done by skipping 23 bytes or less.
8421 @option{-fno-align-functions} and @option{-falign-functions=1} are
8422 equivalent and mean that functions are not aligned.
8424 Some assemblers only support this flag when @var{n} is a power of two;
8425 in that case, it is rounded up.
8427 If @var{n} is not specified or is zero, use a machine-dependent default.
8429 Enabled at levels @option{-O2}, @option{-O3}.
8431 @item -falign-labels
8432 @itemx -falign-labels=@var{n}
8433 @opindex falign-labels
8434 Align all branch targets to a power-of-two boundary, skipping up to
8435 @var{n} bytes like @option{-falign-functions}.  This option can easily
8436 make code slower, because it must insert dummy operations for when the
8437 branch target is reached in the usual flow of the code.
8439 @option{-fno-align-labels} and @option{-falign-labels=1} are
8440 equivalent and mean that labels are not aligned.
8442 If @option{-falign-loops} or @option{-falign-jumps} are applicable and
8443 are greater than this value, then their values are used instead.
8445 If @var{n} is not specified or is zero, use a machine-dependent default
8446 which is very likely to be @samp{1}, meaning no alignment.
8448 Enabled at levels @option{-O2}, @option{-O3}.
8450 @item -falign-loops
8451 @itemx -falign-loops=@var{n}
8452 @opindex falign-loops
8453 Align loops to a power-of-two boundary, skipping up to @var{n} bytes
8454 like @option{-falign-functions}.  If the loops are
8455 executed many times, this makes up for any execution of the dummy
8456 operations.
8458 @option{-fno-align-loops} and @option{-falign-loops=1} are
8459 equivalent and mean that loops are not aligned.
8461 If @var{n} is not specified or is zero, use a machine-dependent default.
8463 Enabled at levels @option{-O2}, @option{-O3}.
8465 @item -falign-jumps
8466 @itemx -falign-jumps=@var{n}
8467 @opindex falign-jumps
8468 Align branch targets to a power-of-two boundary, for branch targets
8469 where the targets can only be reached by jumping, skipping up to @var{n}
8470 bytes like @option{-falign-functions}.  In this case, no dummy operations
8471 need be executed.
8473 @option{-fno-align-jumps} and @option{-falign-jumps=1} are
8474 equivalent and mean that loops are not aligned.
8476 If @var{n} is not specified or is zero, use a machine-dependent default.
8478 Enabled at levels @option{-O2}, @option{-O3}.
8480 @item -funit-at-a-time
8481 @opindex funit-at-a-time
8482 This option is left for compatibility reasons. @option{-funit-at-a-time}
8483 has no effect, while @option{-fno-unit-at-a-time} implies
8484 @option{-fno-toplevel-reorder} and @option{-fno-section-anchors}.
8486 Enabled by default.
8488 @item -fno-toplevel-reorder
8489 @opindex fno-toplevel-reorder
8490 Do not reorder top-level functions, variables, and @code{asm}
8491 statements.  Output them in the same order that they appear in the
8492 input file.  When this option is used, unreferenced static variables
8493 are not removed.  This option is intended to support existing code
8494 that relies on a particular ordering.  For new code, it is better to
8495 use attributes when possible.
8497 Enabled at level @option{-O0}.  When disabled explicitly, it also implies
8498 @option{-fno-section-anchors}, which is otherwise enabled at @option{-O0} on some
8499 targets.
8501 @item -fweb
8502 @opindex fweb
8503 Constructs webs as commonly used for register allocation purposes and assign
8504 each web individual pseudo register.  This allows the register allocation pass
8505 to operate on pseudos directly, but also strengthens several other optimization
8506 passes, such as CSE, loop optimizer and trivial dead code remover.  It can,
8507 however, make debugging impossible, since variables no longer stay in a
8508 ``home register''.
8510 Enabled by default with @option{-funroll-loops}.
8512 @item -fwhole-program
8513 @opindex fwhole-program
8514 Assume that the current compilation unit represents the whole program being
8515 compiled.  All public functions and variables with the exception of @code{main}
8516 and those merged by attribute @code{externally_visible} become static functions
8517 and in effect are optimized more aggressively by interprocedural optimizers.
8519 This option should not be used in combination with @code{-flto}.
8520 Instead relying on a linker plugin should provide safer and more precise
8521 information.
8523 @item -flto[=@var{n}]
8524 @opindex flto
8525 This option runs the standard link-time optimizer.  When invoked
8526 with source code, it generates GIMPLE (one of GCC's internal
8527 representations) and writes it to special ELF sections in the object
8528 file.  When the object files are linked together, all the function
8529 bodies are read from these ELF sections and instantiated as if they
8530 had been part of the same translation unit.
8532 To use the link-time optimizer, @option{-flto} and optimization
8533 options should be specified at compile time and during the final link.
8534 For example:
8536 @smallexample
8537 gcc -c -O2 -flto foo.c
8538 gcc -c -O2 -flto bar.c
8539 gcc -o myprog -flto -O2 foo.o bar.o
8540 @end smallexample
8542 The first two invocations to GCC save a bytecode representation
8543 of GIMPLE into special ELF sections inside @file{foo.o} and
8544 @file{bar.o}.  The final invocation reads the GIMPLE bytecode from
8545 @file{foo.o} and @file{bar.o}, merges the two files into a single
8546 internal image, and compiles the result as usual.  Since both
8547 @file{foo.o} and @file{bar.o} are merged into a single image, this
8548 causes all the interprocedural analyses and optimizations in GCC to
8549 work across the two files as if they were a single one.  This means,
8550 for example, that the inliner is able to inline functions in
8551 @file{bar.o} into functions in @file{foo.o} and vice-versa.
8553 Another (simpler) way to enable link-time optimization is:
8555 @smallexample
8556 gcc -o myprog -flto -O2 foo.c bar.c
8557 @end smallexample
8559 The above generates bytecode for @file{foo.c} and @file{bar.c},
8560 merges them together into a single GIMPLE representation and optimizes
8561 them as usual to produce @file{myprog}.
8563 The only important thing to keep in mind is that to enable link-time
8564 optimizations you need to use the GCC driver to perform the link-step.
8565 GCC then automatically performs link-time optimization if any of the
8566 objects involved were compiled with the @option{-flto}.  You generally
8567 should specify the optimization options to be used for link-time
8568 optimization though GCC will try to be clever at guessing an
8569 optimization level to use from the options used at compile-time
8570 if you fail to specify one at link-time.  You can always override
8571 the automatic decision to do link-time optimization at link-time
8572 by passing @option{-fno-lto} to the link command.
8574 To make whole program optimization effective, it is necessary to make
8575 certain whole program assumptions.  The compiler needs to know
8576 what functions and variables can be accessed by libraries and runtime
8577 outside of the link-time optimized unit.  When supported by the linker,
8578 the linker plugin (see @option{-fuse-linker-plugin}) passes information
8579 to the compiler about used and externally visible symbols.  When
8580 the linker plugin is not available, @option{-fwhole-program} should be
8581 used to allow the compiler to make these assumptions, which leads
8582 to more aggressive optimization decisions.
8584 When @option{-fuse-linker-plugin} is not enabled then, when a file is
8585 compiled with @option{-flto}, the generated object file is larger than
8586 a regular object file because it contains GIMPLE bytecodes and the usual
8587 final code (see @option{-ffat-lto-objects}.  This means that
8588 object files with LTO information can be linked as normal object
8589 files; if @option{-fno-lto} is passed to the linker, no
8590 interprocedural optimizations are applied.  Note that when
8591 @option{-fno-fat-lto-objects} is enabled the compile-stage is faster
8592 but you cannot perform a regular, non-LTO link on them.
8594 Additionally, the optimization flags used to compile individual files
8595 are not necessarily related to those used at link time.  For instance,
8597 @smallexample
8598 gcc -c -O0 -ffat-lto-objects -flto foo.c
8599 gcc -c -O0 -ffat-lto-objects -flto bar.c
8600 gcc -o myprog -O3 foo.o bar.o
8601 @end smallexample
8603 This produces individual object files with unoptimized assembler
8604 code, but the resulting binary @file{myprog} is optimized at
8605 @option{-O3}.  If, instead, the final binary is generated with
8606 @option{-fno-lto}, then @file{myprog} is not optimized.
8608 When producing the final binary, GCC only
8609 applies link-time optimizations to those files that contain bytecode.
8610 Therefore, you can mix and match object files and libraries with
8611 GIMPLE bytecodes and final object code.  GCC automatically selects
8612 which files to optimize in LTO mode and which files to link without
8613 further processing.
8615 There are some code generation flags preserved by GCC when
8616 generating bytecodes, as they need to be used during the final link
8617 stage.  Generally options specified at link-time override those
8618 specified at compile-time.
8620 If you do not specify an optimization level option @option{-O} at
8621 link-time then GCC will compute one based on the optimization levels
8622 used when compiling the object files.  The highest optimization
8623 level will win here.
8625 Currently, the following options and their setting are take from
8626 the first object file that explicitely specified it: 
8627 @option{-fPIC}, @option{-fpic}, @option{-fpie}, @option{-fcommon},
8628 @option{-fexceptions}, @option{-fnon-call-exceptions}, @option{-fgnu-tm}
8629 and all the @option{-m} target flags.
8631 Certain ABI changing flags are required to match in all compilation-units
8632 and trying to override this at link-time with a conflicting value
8633 is ignored.  This includes options such as @option{-freg-struct-return}
8634 and @option{-fpcc-struct-return}. 
8636 Other options such as @option{-ffp-contract}, @option{-fno-strict-overflow},
8637 @option{-fwrapv}, @option{-fno-trapv} or @option{-fno-strict-aliasing}
8638 are passed through to the link stage and merged conservatively for
8639 conflicting translation units.  Specifically
8640 @option{-fno-strict-overflow}, @option{-fwrapv} and @option{-fno-trapv} take
8641 precedence and for example @option{-ffp-contract=off} takes precedence
8642 over @option{-ffp-contract=fast}.  You can override them at linke-time.
8644 It is recommended that you compile all the files participating in the
8645 same link with the same options and also specify those options at
8646 link time.
8648 If LTO encounters objects with C linkage declared with incompatible
8649 types in separate translation units to be linked together (undefined
8650 behavior according to ISO C99 6.2.7), a non-fatal diagnostic may be
8651 issued.  The behavior is still undefined at run time.  Similar
8652 diagnostics may be raised for other languages.
8654 Another feature of LTO is that it is possible to apply interprocedural
8655 optimizations on files written in different languages:
8657 @smallexample
8658 gcc -c -flto foo.c
8659 g++ -c -flto bar.cc
8660 gfortran -c -flto baz.f90
8661 g++ -o myprog -flto -O3 foo.o bar.o baz.o -lgfortran
8662 @end smallexample
8664 Notice that the final link is done with @command{g++} to get the C++
8665 runtime libraries and @option{-lgfortran} is added to get the Fortran
8666 runtime libraries.  In general, when mixing languages in LTO mode, you
8667 should use the same link command options as when mixing languages in a
8668 regular (non-LTO) compilation.
8670 If object files containing GIMPLE bytecode are stored in a library archive, say
8671 @file{libfoo.a}, it is possible to extract and use them in an LTO link if you
8672 are using a linker with plugin support.  To create static libraries suitable
8673 for LTO, use @command{gcc-ar} and @command{gcc-ranlib} instead of @command{ar}
8674 and @code{ranlib}; to show the symbols of object files with GIMPLE bytecode, use
8675 @command{gcc-nm}.  Those commands require that @command{ar}, @command{ranlib}
8676 and @command{nm} have been compiled with plugin support.  At link time, use the the
8677 flag @option{-fuse-linker-plugin} to ensure that the library participates in
8678 the LTO optimization process:
8680 @smallexample
8681 gcc -o myprog -O2 -flto -fuse-linker-plugin a.o b.o -lfoo
8682 @end smallexample
8684 With the linker plugin enabled, the linker extracts the needed
8685 GIMPLE files from @file{libfoo.a} and passes them on to the running GCC
8686 to make them part of the aggregated GIMPLE image to be optimized.
8688 If you are not using a linker with plugin support and/or do not
8689 enable the linker plugin, then the objects inside @file{libfoo.a}
8690 are extracted and linked as usual, but they do not participate
8691 in the LTO optimization process.  In order to make a static library suitable
8692 for both LTO optimization and usual linkage, compile its object files with
8693 @option{-flto} @code{-ffat-lto-objects}.
8695 Link-time optimizations do not require the presence of the whole program to
8696 operate.  If the program does not require any symbols to be exported, it is
8697 possible to combine @option{-flto} and @option{-fwhole-program} to allow
8698 the interprocedural optimizers to use more aggressive assumptions which may
8699 lead to improved optimization opportunities.
8700 Use of @option{-fwhole-program} is not needed when linker plugin is
8701 active (see @option{-fuse-linker-plugin}).
8703 The current implementation of LTO makes no
8704 attempt to generate bytecode that is portable between different
8705 types of hosts.  The bytecode files are versioned and there is a
8706 strict version check, so bytecode files generated in one version of
8707 GCC will not work with an older or newer version of GCC.
8709 Link-time optimization does not work well with generation of debugging
8710 information.  Combining @option{-flto} with
8711 @option{-g} is currently experimental and expected to produce unexpected
8712 results.
8714 If you specify the optional @var{n}, the optimization and code
8715 generation done at link time is executed in parallel using @var{n}
8716 parallel jobs by utilizing an installed @command{make} program.  The
8717 environment variable @env{MAKE} may be used to override the program
8718 used.  The default value for @var{n} is 1.
8720 You can also specify @option{-flto=jobserver} to use GNU make's
8721 job server mode to determine the number of parallel jobs. This
8722 is useful when the Makefile calling GCC is already executing in parallel.
8723 You must prepend a @samp{+} to the command recipe in the parent Makefile
8724 for this to work.  This option likely only works if @env{MAKE} is
8725 GNU make.
8727 @item -flto-partition=@var{alg}
8728 @opindex flto-partition
8729 Specify the partitioning algorithm used by the link-time optimizer.
8730 The value is either @code{1to1} to specify a partitioning mirroring
8731 the original source files or @code{balanced} to specify partitioning
8732 into equally sized chunks (whenever possible) or @code{max} to create
8733 new partition for every symbol where possible.  Specifying @code{none}
8734 as an algorithm disables partitioning and streaming completely. 
8735 The default value is @code{balanced}. While @code{1to1} can be used
8736 as an workaround for various code ordering issues, the @code{max}
8737 partitioning is intended for internal testing only.
8739 @item -flto-compression-level=@var{n}
8740 This option specifies the level of compression used for intermediate
8741 language written to LTO object files, and is only meaningful in
8742 conjunction with LTO mode (@option{-flto}).  Valid
8743 values are 0 (no compression) to 9 (maximum compression).  Values
8744 outside this range are clamped to either 0 or 9.  If the option is not
8745 given, a default balanced compression setting is used.
8747 @item -flto-report
8748 Prints a report with internal details on the workings of the link-time
8749 optimizer.  The contents of this report vary from version to version.
8750 It is meant to be useful to GCC developers when processing object
8751 files in LTO mode (via @option{-flto}).
8753 Disabled by default.
8755 @item -flto-report-wpa
8756 Like @option{-flto-report}, but only print for the WPA phase of Link
8757 Time Optimization.
8759 @item -fuse-linker-plugin
8760 Enables the use of a linker plugin during link-time optimization.  This
8761 option relies on plugin support in the linker, which is available in gold
8762 or in GNU ld 2.21 or newer.
8764 This option enables the extraction of object files with GIMPLE bytecode out
8765 of library archives. This improves the quality of optimization by exposing
8766 more code to the link-time optimizer.  This information specifies what
8767 symbols can be accessed externally (by non-LTO object or during dynamic
8768 linking).  Resulting code quality improvements on binaries (and shared
8769 libraries that use hidden visibility) are similar to @code{-fwhole-program}.
8770 See @option{-flto} for a description of the effect of this flag and how to
8771 use it.
8773 This option is enabled by default when LTO support in GCC is enabled
8774 and GCC was configured for use with
8775 a linker supporting plugins (GNU ld 2.21 or newer or gold).
8777 @item -ffat-lto-objects
8778 @opindex ffat-lto-objects
8779 Fat LTO objects are object files that contain both the intermediate language
8780 and the object code. This makes them usable for both LTO linking and normal
8781 linking. This option is effective only when compiling with @option{-flto}
8782 and is ignored at link time.
8784 @option{-fno-fat-lto-objects} improves compilation time over plain LTO, but
8785 requires the complete toolchain to be aware of LTO. It requires a linker with
8786 linker plugin support for basic functionality.  Additionally,
8787 @command{nm}, @command{ar} and @command{ranlib}
8788 need to support linker plugins to allow a full-featured build environment
8789 (capable of building static libraries etc).  GCC provides the @command{gcc-ar},
8790 @command{gcc-nm}, @command{gcc-ranlib} wrappers to pass the right options
8791 to these tools. With non fat LTO makefiles need to be modified to use them.
8793 The default is @option{-fno-fat-lto-objects} on targets with linker plugin
8794 support.
8796 @item -fcompare-elim
8797 @opindex fcompare-elim
8798 After register allocation and post-register allocation instruction splitting,
8799 identify arithmetic instructions that compute processor flags similar to a
8800 comparison operation based on that arithmetic.  If possible, eliminate the
8801 explicit comparison operation.
8803 This pass only applies to certain targets that cannot explicitly represent
8804 the comparison operation before register allocation is complete.
8806 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8808 @item -fuse-ld=bfd
8809 @opindex fuse-ld=bfd
8810 Use the @command{bfd} linker instead of the default linker.
8812 @item -fuse-ld=gold
8813 @opindex fuse-ld=gold
8814 Use the @command{gold} linker instead of the default linker.
8816 @item -fcprop-registers
8817 @opindex fcprop-registers
8818 After register allocation and post-register allocation instruction splitting,
8819 perform a copy-propagation pass to try to reduce scheduling dependencies
8820 and occasionally eliminate the copy.
8822 Enabled at levels @option{-O}, @option{-O2}, @option{-O3}, @option{-Os}.
8824 @item -fprofile-correction
8825 @opindex fprofile-correction
8826 Profiles collected using an instrumented binary for multi-threaded programs may
8827 be inconsistent due to missed counter updates. When this option is specified,
8828 GCC uses heuristics to correct or smooth out such inconsistencies. By
8829 default, GCC emits an error message when an inconsistent profile is detected.
8831 @item -fprofile-dir=@var{path}
8832 @opindex fprofile-dir
8834 Set the directory to search for the profile data files in to @var{path}.
8835 This option affects only the profile data generated by
8836 @option{-fprofile-generate}, @option{-ftest-coverage}, @option{-fprofile-arcs}
8837 and used by @option{-fprofile-use} and @option{-fbranch-probabilities}
8838 and its related options.  Both absolute and relative paths can be used.
8839 By default, GCC uses the current directory as @var{path}, thus the
8840 profile data file appears in the same directory as the object file.
8842 @item -fprofile-generate
8843 @itemx -fprofile-generate=@var{path}
8844 @opindex fprofile-generate
8846 Enable options usually used for instrumenting application to produce
8847 profile useful for later recompilation with profile feedback based
8848 optimization.  You must use @option{-fprofile-generate} both when
8849 compiling and when linking your program.
8851 The following options are enabled: @code{-fprofile-arcs}, @code{-fprofile-values}, @code{-fvpt}.
8853 If @var{path} is specified, GCC looks at the @var{path} to find
8854 the profile feedback data files. See @option{-fprofile-dir}.
8856 @item -fprofile-use
8857 @itemx -fprofile-use=@var{path}
8858 @opindex fprofile-use
8859 Enable profile feedback directed optimizations, and optimizations
8860 generally profitable only with profile feedback available.
8862 The following options are enabled: @code{-fbranch-probabilities}, @code{-fvpt},
8863 @code{-funroll-loops}, @code{-fpeel-loops}, @code{-ftracer}, @code{-ftree-vectorize},
8864 @code{ftree-loop-distribute-patterns}
8866 By default, GCC emits an error message if the feedback profiles do not
8867 match the source code.  This error can be turned into a warning by using
8868 @option{-Wcoverage-mismatch}.  Note this may result in poorly optimized
8869 code.
8871 If @var{path} is specified, GCC looks at the @var{path} to find
8872 the profile feedback data files. See @option{-fprofile-dir}.
8873 @end table
8875 The following options control compiler behavior regarding floating-point 
8876 arithmetic.  These options trade off between speed and
8877 correctness.  All must be specifically enabled.
8879 @table @gcctabopt
8880 @item -ffloat-store
8881 @opindex ffloat-store
8882 Do not store floating-point variables in registers, and inhibit other
8883 options that might change whether a floating-point value is taken from a
8884 register or memory.
8886 @cindex floating-point precision
8887 This option prevents undesirable excess precision on machines such as
8888 the 68000 where the floating registers (of the 68881) keep more
8889 precision than a @code{double} is supposed to have.  Similarly for the
8890 x86 architecture.  For most programs, the excess precision does only
8891 good, but a few programs rely on the precise definition of IEEE floating
8892 point.  Use @option{-ffloat-store} for such programs, after modifying
8893 them to store all pertinent intermediate computations into variables.
8895 @item -fexcess-precision=@var{style}
8896 @opindex fexcess-precision
8897 This option allows further control over excess precision on machines
8898 where floating-point registers have more precision than the IEEE
8899 @code{float} and @code{double} types and the processor does not
8900 support operations rounding to those types.  By default,
8901 @option{-fexcess-precision=fast} is in effect; this means that
8902 operations are carried out in the precision of the registers and that
8903 it is unpredictable when rounding to the types specified in the source
8904 code takes place.  When compiling C, if
8905 @option{-fexcess-precision=standard} is specified then excess
8906 precision follows the rules specified in ISO C99; in particular,
8907 both casts and assignments cause values to be rounded to their
8908 semantic types (whereas @option{-ffloat-store} only affects
8909 assignments).  This option is enabled by default for C if a strict
8910 conformance option such as @option{-std=c99} is used.
8912 @opindex mfpmath
8913 @option{-fexcess-precision=standard} is not implemented for languages
8914 other than C, and has no effect if
8915 @option{-funsafe-math-optimizations} or @option{-ffast-math} is
8916 specified.  On the x86, it also has no effect if @option{-mfpmath=sse}
8917 or @option{-mfpmath=sse+387} is specified; in the former case, IEEE
8918 semantics apply without excess precision, and in the latter, rounding
8919 is unpredictable.
8921 @item -ffast-math
8922 @opindex ffast-math
8923 Sets @option{-fno-math-errno}, @option{-funsafe-math-optimizations},
8924 @option{-ffinite-math-only}, @option{-fno-rounding-math},
8925 @option{-fno-signaling-nans} and @option{-fcx-limited-range}.
8927 This option causes the preprocessor macro @code{__FAST_MATH__} to be defined.
8929 This option is not turned on by any @option{-O} option besides
8930 @option{-Ofast} since it can result in incorrect output for programs
8931 that depend on an exact implementation of IEEE or ISO rules/specifications
8932 for math functions. It may, however, yield faster code for programs
8933 that do not require the guarantees of these specifications.
8935 @item -fno-math-errno
8936 @opindex fno-math-errno
8937 Do not set @code{errno} after calling math functions that are executed
8938 with a single instruction, e.g., @code{sqrt}.  A program that relies on
8939 IEEE exceptions for math error handling may want to use this flag
8940 for speed while maintaining IEEE arithmetic compatibility.
8942 This option is not turned on by any @option{-O} option since
8943 it can result in incorrect output for programs that depend on
8944 an exact implementation of IEEE or ISO rules/specifications for
8945 math functions. It may, however, yield faster code for programs
8946 that do not require the guarantees of these specifications.
8948 The default is @option{-fmath-errno}.
8950 On Darwin systems, the math library never sets @code{errno}.  There is
8951 therefore no reason for the compiler to consider the possibility that
8952 it might, and @option{-fno-math-errno} is the default.
8954 @item -funsafe-math-optimizations
8955 @opindex funsafe-math-optimizations
8957 Allow optimizations for floating-point arithmetic that (a) assume
8958 that arguments and results are valid and (b) may violate IEEE or
8959 ANSI standards.  When used at link-time, it may include libraries
8960 or startup files that change the default FPU control word or other
8961 similar optimizations.
8963 This option is not turned on by any @option{-O} option since
8964 it can result in incorrect output for programs that depend on
8965 an exact implementation of IEEE or ISO rules/specifications for
8966 math functions. It may, however, yield faster code for programs
8967 that do not require the guarantees of these specifications.
8968 Enables @option{-fno-signed-zeros}, @option{-fno-trapping-math},
8969 @option{-fassociative-math} and @option{-freciprocal-math}.
8971 The default is @option{-fno-unsafe-math-optimizations}.
8973 @item -fassociative-math
8974 @opindex fassociative-math
8976 Allow re-association of operands in series of floating-point operations.
8977 This violates the ISO C and C++ language standard by possibly changing
8978 computation result.  NOTE: re-ordering may change the sign of zero as
8979 well as ignore NaNs and inhibit or create underflow or overflow (and
8980 thus cannot be used on code that relies on rounding behavior like
8981 @code{(x + 2**52) - 2**52}.  May also reorder floating-point comparisons
8982 and thus may not be used when ordered comparisons are required.
8983 This option requires that both @option{-fno-signed-zeros} and
8984 @option{-fno-trapping-math} be in effect.  Moreover, it doesn't make
8985 much sense with @option{-frounding-math}. For Fortran the option
8986 is automatically enabled when both @option{-fno-signed-zeros} and
8987 @option{-fno-trapping-math} are in effect.
8989 The default is @option{-fno-associative-math}.
8991 @item -freciprocal-math
8992 @opindex freciprocal-math
8994 Allow the reciprocal of a value to be used instead of dividing by
8995 the value if this enables optimizations.  For example @code{x / y}
8996 can be replaced with @code{x * (1/y)}, which is useful if @code{(1/y)}
8997 is subject to common subexpression elimination.  Note that this loses
8998 precision and increases the number of flops operating on the value.
9000 The default is @option{-fno-reciprocal-math}.
9002 @item -ffinite-math-only
9003 @opindex ffinite-math-only
9004 Allow optimizations for floating-point arithmetic that assume
9005 that arguments and results are not NaNs or +-Infs.
9007 This option is not turned on by any @option{-O} option since
9008 it can result in incorrect output for programs that depend on
9009 an exact implementation of IEEE or ISO rules/specifications for
9010 math functions. It may, however, yield faster code for programs
9011 that do not require the guarantees of these specifications.
9013 The default is @option{-fno-finite-math-only}.
9015 @item -fno-signed-zeros
9016 @opindex fno-signed-zeros
9017 Allow optimizations for floating-point arithmetic that ignore the
9018 signedness of zero.  IEEE arithmetic specifies the behavior of
9019 distinct +0.0 and @minus{}0.0 values, which then prohibits simplification
9020 of expressions such as x+0.0 or 0.0*x (even with @option{-ffinite-math-only}).
9021 This option implies that the sign of a zero result isn't significant.
9023 The default is @option{-fsigned-zeros}.
9025 @item -fno-trapping-math
9026 @opindex fno-trapping-math
9027 Compile code assuming that floating-point operations cannot generate
9028 user-visible traps.  These traps include division by zero, overflow,
9029 underflow, inexact result and invalid operation.  This option requires
9030 that @option{-fno-signaling-nans} be in effect.  Setting this option may
9031 allow faster code if one relies on ``non-stop'' IEEE arithmetic, for example.
9033 This option should never be turned on by any @option{-O} option since
9034 it can result in incorrect output for programs that depend on
9035 an exact implementation of IEEE or ISO rules/specifications for
9036 math functions.
9038 The default is @option{-ftrapping-math}.
9040 @item -frounding-math
9041 @opindex frounding-math
9042 Disable transformations and optimizations that assume default floating-point
9043 rounding behavior.  This is round-to-zero for all floating point
9044 to integer conversions, and round-to-nearest for all other arithmetic
9045 truncations.  This option should be specified for programs that change
9046 the FP rounding mode dynamically, or that may be executed with a
9047 non-default rounding mode.  This option disables constant folding of
9048 floating-point expressions at compile time (which may be affected by
9049 rounding mode) and arithmetic transformations that are unsafe in the
9050 presence of sign-dependent rounding modes.
9052 The default is @option{-fno-rounding-math}.
9054 This option is experimental and does not currently guarantee to
9055 disable all GCC optimizations that are affected by rounding mode.
9056 Future versions of GCC may provide finer control of this setting
9057 using C99's @code{FENV_ACCESS} pragma.  This command-line option
9058 will be used to specify the default state for @code{FENV_ACCESS}.
9060 @item -fsignaling-nans
9061 @opindex fsignaling-nans
9062 Compile code assuming that IEEE signaling NaNs may generate user-visible
9063 traps during floating-point operations.  Setting this option disables
9064 optimizations that may change the number of exceptions visible with
9065 signaling NaNs.  This option implies @option{-ftrapping-math}.
9067 This option causes the preprocessor macro @code{__SUPPORT_SNAN__} to
9068 be defined.
9070 The default is @option{-fno-signaling-nans}.
9072 This option is experimental and does not currently guarantee to
9073 disable all GCC optimizations that affect signaling NaN behavior.
9075 @item -fsingle-precision-constant
9076 @opindex fsingle-precision-constant
9077 Treat floating-point constants as single precision instead of
9078 implicitly converting them to double-precision constants.
9080 @item -fcx-limited-range
9081 @opindex fcx-limited-range
9082 When enabled, this option states that a range reduction step is not
9083 needed when performing complex division.  Also, there is no checking
9084 whether the result of a complex multiplication or division is @code{NaN
9085 + I*NaN}, with an attempt to rescue the situation in that case.  The
9086 default is @option{-fno-cx-limited-range}, but is enabled by
9087 @option{-ffast-math}.
9089 This option controls the default setting of the ISO C99
9090 @code{CX_LIMITED_RANGE} pragma.  Nevertheless, the option applies to
9091 all languages.
9093 @item -fcx-fortran-rules
9094 @opindex fcx-fortran-rules
9095 Complex multiplication and division follow Fortran rules.  Range
9096 reduction is done as part of complex division, but there is no checking
9097 whether the result of a complex multiplication or division is @code{NaN
9098 + I*NaN}, with an attempt to rescue the situation in that case.
9100 The default is @option{-fno-cx-fortran-rules}.
9102 @end table
9104 The following options control optimizations that may improve
9105 performance, but are not enabled by any @option{-O} options.  This
9106 section includes experimental options that may produce broken code.
9108 @table @gcctabopt
9109 @item -fbranch-probabilities
9110 @opindex fbranch-probabilities
9111 After running a program compiled with @option{-fprofile-arcs}
9112 (@pxref{Debugging Options,, Options for Debugging Your Program or
9113 @command{gcc}}), you can compile it a second time using
9114 @option{-fbranch-probabilities}, to improve optimizations based on
9115 the number of times each branch was taken.  When a program
9116 compiled with @option{-fprofile-arcs} exits, it saves arc execution
9117 counts to a file called @file{@var{sourcename}.gcda} for each source
9118 file.  The information in this data file is very dependent on the
9119 structure of the generated code, so you must use the same source code
9120 and the same optimization options for both compilations.
9122 With @option{-fbranch-probabilities}, GCC puts a
9123 @samp{REG_BR_PROB} note on each @samp{JUMP_INSN} and @samp{CALL_INSN}.
9124 These can be used to improve optimization.  Currently, they are only
9125 used in one place: in @file{reorg.c}, instead of guessing which path a
9126 branch is most likely to take, the @samp{REG_BR_PROB} values are used to
9127 exactly determine which path is taken more often.
9129 @item -fprofile-values
9130 @opindex fprofile-values
9131 If combined with @option{-fprofile-arcs}, it adds code so that some
9132 data about values of expressions in the program is gathered.
9134 With @option{-fbranch-probabilities}, it reads back the data gathered
9135 from profiling values of expressions for usage in optimizations.
9137 Enabled with @option{-fprofile-generate} and @option{-fprofile-use}.
9139 @item -fprofile-reorder-functions
9140 @opindex fprofile-reorder-functions
9141 Function reordering based on profile instrumentation collects
9142 first time of execution of a function and orders these functions
9143 in ascending order.
9145 Enabled with @option{-fprofile-use}.
9147 @item -fvpt
9148 @opindex fvpt
9149 If combined with @option{-fprofile-arcs}, this option instructs the compiler
9150 to add code to gather information about values of expressions.
9152 With @option{-fbranch-probabilities}, it reads back the data gathered
9153 and actually performs the optimizations based on them.
9154 Currently the optimizations include specialization of division operations
9155 using the knowledge about the value of the denominator.
9157 @item -frename-registers
9158 @opindex frename-registers
9159 Attempt to avoid false dependencies in scheduled code by making use
9160 of registers left over after register allocation.  This optimization
9161 most benefits processors with lots of registers.  Depending on the
9162 debug information format adopted by the target, however, it can
9163 make debugging impossible, since variables no longer stay in
9164 a ``home register''.
9166 Enabled by default with @option{-funroll-loops} and @option{-fpeel-loops}.
9168 @item -ftracer
9169 @opindex ftracer
9170 Perform tail duplication to enlarge superblock size.  This transformation
9171 simplifies the control flow of the function allowing other optimizations to do
9172 a better job.
9174 Enabled with @option{-fprofile-use}.
9176 @item -funroll-loops
9177 @opindex funroll-loops
9178 Unroll loops whose number of iterations can be determined at compile time or
9179 upon entry to the loop.  @option{-funroll-loops} implies
9180 @option{-frerun-cse-after-loop}, @option{-fweb} and @option{-frename-registers}.
9181 It also turns on complete loop peeling (i.e.@: complete removal of loops with
9182 a small constant number of iterations).  This option makes code larger, and may
9183 or may not make it run faster.
9185 Enabled with @option{-fprofile-use}.
9187 @item -funroll-all-loops
9188 @opindex funroll-all-loops
9189 Unroll all loops, even if their number of iterations is uncertain when
9190 the loop is entered.  This usually makes programs run more slowly.
9191 @option{-funroll-all-loops} implies the same options as
9192 @option{-funroll-loops}.
9194 @item -fpeel-loops
9195 @opindex fpeel-loops
9196 Peels loops for which there is enough information that they do not
9197 roll much (from profile feedback).  It also turns on complete loop peeling
9198 (i.e.@: complete removal of loops with small constant number of iterations).
9200 Enabled with @option{-fprofile-use}.
9202 @item -fmove-loop-invariants
9203 @opindex fmove-loop-invariants
9204 Enables the loop invariant motion pass in the RTL loop optimizer.  Enabled
9205 at level @option{-O1}
9207 @item -funswitch-loops
9208 @opindex funswitch-loops
9209 Move branches with loop invariant conditions out of the loop, with duplicates
9210 of the loop on both branches (modified according to result of the condition).
9212 @item -ffunction-sections
9213 @itemx -fdata-sections
9214 @opindex ffunction-sections
9215 @opindex fdata-sections
9216 Place each function or data item into its own section in the output
9217 file if the target supports arbitrary sections.  The name of the
9218 function or the name of the data item determines the section's name
9219 in the output file.
9221 Use these options on systems where the linker can perform optimizations
9222 to improve locality of reference in the instruction space.  Most systems
9223 using the ELF object format and SPARC processors running Solaris 2 have
9224 linkers with such optimizations.  AIX may have these optimizations in
9225 the future.
9227 Only use these options when there are significant benefits from doing
9228 so.  When you specify these options, the assembler and linker
9229 create larger object and executable files and are also slower.
9230 You cannot use @code{gprof} on all systems if you
9231 specify this option, and you may have problems with debugging if
9232 you specify both this option and @option{-g}.
9234 @item -fbranch-target-load-optimize
9235 @opindex fbranch-target-load-optimize
9236 Perform branch target register load optimization before prologue / epilogue
9237 threading.
9238 The use of target registers can typically be exposed only during reload,
9239 thus hoisting loads out of loops and doing inter-block scheduling needs
9240 a separate optimization pass.
9242 @item -fbranch-target-load-optimize2
9243 @opindex fbranch-target-load-optimize2
9244 Perform branch target register load optimization after prologue / epilogue
9245 threading.
9247 @item -fbtr-bb-exclusive
9248 @opindex fbtr-bb-exclusive
9249 When performing branch target register load optimization, don't reuse
9250 branch target registers within any basic block.
9252 @item -fstack-protector
9253 @opindex fstack-protector
9254 Emit extra code to check for buffer overflows, such as stack smashing
9255 attacks.  This is done by adding a guard variable to functions with
9256 vulnerable objects.  This includes functions that call @code{alloca}, and
9257 functions with buffers larger than 8 bytes.  The guards are initialized
9258 when a function is entered and then checked when the function exits.
9259 If a guard check fails, an error message is printed and the program exits.
9261 @item -fstack-protector-all
9262 @opindex fstack-protector-all
9263 Like @option{-fstack-protector} except that all functions are protected.
9265 @item -fstack-protector-strong
9266 @opindex fstack-protector-strong
9267 Like @option{-fstack-protector} but includes additional functions to
9268 be protected --- those that have local array definitions, or have
9269 references to local frame addresses.
9271 @item -fsection-anchors
9272 @opindex fsection-anchors
9273 Try to reduce the number of symbolic address calculations by using
9274 shared ``anchor'' symbols to address nearby objects.  This transformation
9275 can help to reduce the number of GOT entries and GOT accesses on some
9276 targets.
9278 For example, the implementation of the following function @code{foo}:
9280 @smallexample
9281 static int a, b, c;
9282 int foo (void) @{ return a + b + c; @}
9283 @end smallexample
9285 @noindent
9286 usually calculates the addresses of all three variables, but if you
9287 compile it with @option{-fsection-anchors}, it accesses the variables
9288 from a common anchor point instead.  The effect is similar to the
9289 following pseudocode (which isn't valid C):
9291 @smallexample
9292 int foo (void)
9294   register int *xr = &x;
9295   return xr[&a - &x] + xr[&b - &x] + xr[&c - &x];
9297 @end smallexample
9299 Not all targets support this option.
9301 @item --param @var{name}=@var{value}
9302 @opindex param
9303 In some places, GCC uses various constants to control the amount of
9304 optimization that is done.  For example, GCC does not inline functions
9305 that contain more than a certain number of instructions.  You can
9306 control some of these constants on the command line using the
9307 @option{--param} option.
9309 The names of specific parameters, and the meaning of the values, are
9310 tied to the internals of the compiler, and are subject to change
9311 without notice in future releases.
9313 In each case, the @var{value} is an integer.  The allowable choices for
9314 @var{name} are:
9316 @table @gcctabopt
9317 @item predictable-branch-outcome
9318 When branch is predicted to be taken with probability lower than this threshold
9319 (in percent), then it is considered well predictable. The default is 10.
9321 @item max-crossjump-edges
9322 The maximum number of incoming edges to consider for cross-jumping.
9323 The algorithm used by @option{-fcrossjumping} is @math{O(N^2)} in
9324 the number of edges incoming to each block.  Increasing values mean
9325 more aggressive optimization, making the compilation time increase with
9326 probably small improvement in executable size.
9328 @item min-crossjump-insns
9329 The minimum number of instructions that must be matched at the end
9330 of two blocks before cross-jumping is performed on them.  This
9331 value is ignored in the case where all instructions in the block being
9332 cross-jumped from are matched.  The default value is 5.
9334 @item max-grow-copy-bb-insns
9335 The maximum code size expansion factor when copying basic blocks
9336 instead of jumping.  The expansion is relative to a jump instruction.
9337 The default value is 8.
9339 @item max-goto-duplication-insns
9340 The maximum number of instructions to duplicate to a block that jumps
9341 to a computed goto.  To avoid @math{O(N^2)} behavior in a number of
9342 passes, GCC factors computed gotos early in the compilation process,
9343 and unfactors them as late as possible.  Only computed jumps at the
9344 end of a basic blocks with no more than max-goto-duplication-insns are
9345 unfactored.  The default value is 8.
9347 @item max-delay-slot-insn-search
9348 The maximum number of instructions to consider when looking for an
9349 instruction to fill a delay slot.  If more than this arbitrary number of
9350 instructions are searched, the time savings from filling the delay slot
9351 are minimal, so stop searching.  Increasing values mean more
9352 aggressive optimization, making the compilation time increase with probably
9353 small improvement in execution time.
9355 @item max-delay-slot-live-search
9356 When trying to fill delay slots, the maximum number of instructions to
9357 consider when searching for a block with valid live register
9358 information.  Increasing this arbitrarily chosen value means more
9359 aggressive optimization, increasing the compilation time.  This parameter
9360 should be removed when the delay slot code is rewritten to maintain the
9361 control-flow graph.
9363 @item max-gcse-memory
9364 The approximate maximum amount of memory that can be allocated in
9365 order to perform the global common subexpression elimination
9366 optimization.  If more memory than specified is required, the
9367 optimization is not done.
9369 @item max-gcse-insertion-ratio
9370 If the ratio of expression insertions to deletions is larger than this value
9371 for any expression, then RTL PRE inserts or removes the expression and thus
9372 leaves partially redundant computations in the instruction stream.  The default value is 20.
9374 @item max-pending-list-length
9375 The maximum number of pending dependencies scheduling allows
9376 before flushing the current state and starting over.  Large functions
9377 with few branches or calls can create excessively large lists which
9378 needlessly consume memory and resources.
9380 @item max-modulo-backtrack-attempts
9381 The maximum number of backtrack attempts the scheduler should make
9382 when modulo scheduling a loop.  Larger values can exponentially increase
9383 compilation time.
9385 @item max-inline-insns-single
9386 Several parameters control the tree inliner used in GCC@.
9387 This number sets the maximum number of instructions (counted in GCC's
9388 internal representation) in a single function that the tree inliner
9389 considers for inlining.  This only affects functions declared
9390 inline and methods implemented in a class declaration (C++).
9391 The default value is 400.
9393 @item max-inline-insns-auto
9394 When you use @option{-finline-functions} (included in @option{-O3}),
9395 a lot of functions that would otherwise not be considered for inlining
9396 by the compiler are investigated.  To those functions, a different
9397 (more restrictive) limit compared to functions declared inline can
9398 be applied.
9399 The default value is 40.
9401 @item inline-min-speedup
9402 When estimated performance improvement of caller + callee runtime exceeds this
9403 threshold (in precent), the function can be inlined regardless the limit on
9404 @option{--param max-inline-insns-single} and @option{--param
9405 max-inline-insns-auto}.
9407 @item large-function-insns
9408 The limit specifying really large functions.  For functions larger than this
9409 limit after inlining, inlining is constrained by
9410 @option{--param large-function-growth}.  This parameter is useful primarily
9411 to avoid extreme compilation time caused by non-linear algorithms used by the
9412 back end.
9413 The default value is 2700.
9415 @item large-function-growth
9416 Specifies maximal growth of large function caused by inlining in percents.
9417 The default value is 100 which limits large function growth to 2.0 times
9418 the original size.
9420 @item large-unit-insns
9421 The limit specifying large translation unit.  Growth caused by inlining of
9422 units larger than this limit is limited by @option{--param inline-unit-growth}.
9423 For small units this might be too tight.
9424 For example, consider a unit consisting of function A
9425 that is inline and B that just calls A three times.  If B is small relative to
9426 A, the growth of unit is 300\% and yet such inlining is very sane.  For very
9427 large units consisting of small inlineable functions, however, the overall unit
9428 growth limit is needed to avoid exponential explosion of code size.  Thus for
9429 smaller units, the size is increased to @option{--param large-unit-insns}
9430 before applying @option{--param inline-unit-growth}.  The default is 10000.
9432 @item inline-unit-growth
9433 Specifies maximal overall growth of the compilation unit caused by inlining.
9434 The default value is 30 which limits unit growth to 1.3 times the original
9435 size. Cold functions (either marked cold via an attribibute or by profile
9436 feedback) are not accounted into the unit size.
9438 @item ipcp-unit-growth
9439 Specifies maximal overall growth of the compilation unit caused by
9440 interprocedural constant propagation.  The default value is 10 which limits
9441 unit growth to 1.1 times the original size.
9443 @item large-stack-frame
9444 The limit specifying large stack frames.  While inlining the algorithm is trying
9445 to not grow past this limit too much.  The default value is 256 bytes.
9447 @item large-stack-frame-growth
9448 Specifies maximal growth of large stack frames caused by inlining in percents.
9449 The default value is 1000 which limits large stack frame growth to 11 times
9450 the original size.
9452 @item max-inline-insns-recursive
9453 @itemx max-inline-insns-recursive-auto
9454 Specifies the maximum number of instructions an out-of-line copy of a
9455 self-recursive inline
9456 function can grow into by performing recursive inlining.
9458 For functions declared inline, @option{--param max-inline-insns-recursive} is
9459 taken into account.  For functions not declared inline, recursive inlining
9460 happens only when @option{-finline-functions} (included in @option{-O3}) is
9461 enabled and @option{--param max-inline-insns-recursive-auto} is used.  The
9462 default value is 450.
9464 @item max-inline-recursive-depth
9465 @itemx max-inline-recursive-depth-auto
9466 Specifies the maximum recursion depth used for recursive inlining.
9468 For functions declared inline, @option{--param max-inline-recursive-depth} is
9469 taken into account.  For functions not declared inline, recursive inlining
9470 happens only when @option{-finline-functions} (included in @option{-O3}) is
9471 enabled and @option{--param max-inline-recursive-depth-auto} is used.  The
9472 default value is 8.
9474 @item min-inline-recursive-probability
9475 Recursive inlining is profitable only for function having deep recursion
9476 in average and can hurt for function having little recursion depth by
9477 increasing the prologue size or complexity of function body to other
9478 optimizers.
9480 When profile feedback is available (see @option{-fprofile-generate}) the actual
9481 recursion depth can be guessed from probability that function recurses via a
9482 given call expression.  This parameter limits inlining only to call expressions
9483 whose probability exceeds the given threshold (in percents).
9484 The default value is 10.
9486 @item early-inlining-insns
9487 Specify growth that the early inliner can make.  In effect it increases
9488 the amount of inlining for code having a large abstraction penalty.
9489 The default value is 10.
9491 @item max-early-inliner-iterations
9492 @itemx max-early-inliner-iterations
9493 Limit of iterations of the early inliner.  This basically bounds
9494 the number of nested indirect calls the early inliner can resolve.
9495 Deeper chains are still handled by late inlining.
9497 @item comdat-sharing-probability
9498 @itemx comdat-sharing-probability
9499 Probability (in percent) that C++ inline function with comdat visibility
9500 are shared across multiple compilation units.  The default value is 20.
9502 @item min-vect-loop-bound
9503 The minimum number of iterations under which loops are not vectorized
9504 when @option{-ftree-vectorize} is used.  The number of iterations after
9505 vectorization needs to be greater than the value specified by this option
9506 to allow vectorization.  The default value is 0.
9508 @item gcse-cost-distance-ratio
9509 Scaling factor in calculation of maximum distance an expression
9510 can be moved by GCSE optimizations.  This is currently supported only in the
9511 code hoisting pass.  The bigger the ratio, the more aggressive code hoisting
9512 is with simple expressions, i.e., the expressions that have cost
9513 less than @option{gcse-unrestricted-cost}.  Specifying 0 disables
9514 hoisting of simple expressions.  The default value is 10.
9516 @item gcse-unrestricted-cost
9517 Cost, roughly measured as the cost of a single typical machine
9518 instruction, at which GCSE optimizations do not constrain
9519 the distance an expression can travel.  This is currently
9520 supported only in the code hoisting pass.  The lesser the cost,
9521 the more aggressive code hoisting is.  Specifying 0 
9522 allows all expressions to travel unrestricted distances.
9523 The default value is 3.
9525 @item max-hoist-depth
9526 The depth of search in the dominator tree for expressions to hoist.
9527 This is used to avoid quadratic behavior in hoisting algorithm.
9528 The value of 0 does not limit on the search, but may slow down compilation
9529 of huge functions.  The default value is 30.
9531 @item max-tail-merge-comparisons
9532 The maximum amount of similar bbs to compare a bb with.  This is used to
9533 avoid quadratic behavior in tree tail merging.  The default value is 10.
9535 @item max-tail-merge-iterations
9536 The maximum amount of iterations of the pass over the function.  This is used to
9537 limit compilation time in tree tail merging.  The default value is 2.
9539 @item max-unrolled-insns
9540 The maximum number of instructions that a loop may have to be unrolled.
9541 If a loop is unrolled, this parameter also determines how many times
9542 the loop code is unrolled.
9544 @item max-average-unrolled-insns
9545 The maximum number of instructions biased by probabilities of their execution
9546 that a loop may have to be unrolled.  If a loop is unrolled,
9547 this parameter also determines how many times the loop code is unrolled.
9549 @item max-unroll-times
9550 The maximum number of unrollings of a single loop.
9552 @item max-peeled-insns
9553 The maximum number of instructions that a loop may have to be peeled.
9554 If a loop is peeled, this parameter also determines how many times
9555 the loop code is peeled.
9557 @item max-peel-times
9558 The maximum number of peelings of a single loop.
9560 @item max-peel-branches
9561 The maximum number of branches on the hot path through the peeled sequence.
9563 @item max-completely-peeled-insns
9564 The maximum number of insns of a completely peeled loop.
9566 @item max-completely-peel-times
9567 The maximum number of iterations of a loop to be suitable for complete peeling.
9569 @item max-completely-peel-loop-nest-depth
9570 The maximum depth of a loop nest suitable for complete peeling.
9572 @item max-unswitch-insns
9573 The maximum number of insns of an unswitched loop.
9575 @item max-unswitch-level
9576 The maximum number of branches unswitched in a single loop.
9578 @item lim-expensive
9579 The minimum cost of an expensive expression in the loop invariant motion.
9581 @item iv-consider-all-candidates-bound
9582 Bound on number of candidates for induction variables, below which
9583 all candidates are considered for each use in induction variable
9584 optimizations.  If there are more candidates than this,
9585 only the most relevant ones are considered to avoid quadratic time complexity.
9587 @item iv-max-considered-uses
9588 The induction variable optimizations give up on loops that contain more
9589 induction variable uses.
9591 @item iv-always-prune-cand-set-bound
9592 If the number of candidates in the set is smaller than this value,
9593 always try to remove unnecessary ivs from the set
9594 when adding a new one.
9596 @item scev-max-expr-size
9597 Bound on size of expressions used in the scalar evolutions analyzer.
9598 Large expressions slow the analyzer.
9600 @item scev-max-expr-complexity
9601 Bound on the complexity of the expressions in the scalar evolutions analyzer.
9602 Complex expressions slow the analyzer.
9604 @item omega-max-vars
9605 The maximum number of variables in an Omega constraint system.
9606 The default value is 128.
9608 @item omega-max-geqs
9609 The maximum number of inequalities in an Omega constraint system.
9610 The default value is 256.
9612 @item omega-max-eqs
9613 The maximum number of equalities in an Omega constraint system.
9614 The default value is 128.
9616 @item omega-max-wild-cards
9617 The maximum number of wildcard variables that the Omega solver is
9618 able to insert.  The default value is 18.
9620 @item omega-hash-table-size
9621 The size of the hash table in the Omega solver.  The default value is
9622 550.
9624 @item omega-max-keys
9625 The maximal number of keys used by the Omega solver.  The default
9626 value is 500.
9628 @item omega-eliminate-redundant-constraints
9629 When set to 1, use expensive methods to eliminate all redundant
9630 constraints.  The default value is 0.
9632 @item vect-max-version-for-alignment-checks
9633 The maximum number of run-time checks that can be performed when
9634 doing loop versioning for alignment in the vectorizer. 
9636 @item vect-max-version-for-alias-checks
9637 The maximum number of run-time checks that can be performed when
9638 doing loop versioning for alias in the vectorizer. 
9640 @item vect-max-peeling-for-alignment
9641 The maximum number of loop peels to enhance access alignment
9642 for vectorizer. Value -1 means 'no limit'.
9644 @item max-iterations-to-track
9645 The maximum number of iterations of a loop the brute-force algorithm
9646 for analysis of the number of iterations of the loop tries to evaluate.
9648 @item hot-bb-count-ws-permille
9649 A basic block profile count is considered hot if it contributes to 
9650 the given permillage (i.e. 0...1000) of the entire profiled execution.
9652 @item hot-bb-frequency-fraction
9653 Select fraction of the entry block frequency of executions of basic block in
9654 function given basic block needs to have to be considered hot.
9656 @item max-predicted-iterations
9657 The maximum number of loop iterations we predict statically.  This is useful
9658 in cases where a function contains a single loop with known bound and
9659 another loop with unknown bound.
9660 The known number of iterations is predicted correctly, while
9661 the unknown number of iterations average to roughly 10.  This means that the
9662 loop without bounds appears artificially cold relative to the other one.
9664 @item builtin-expect-probability
9665 Control the probability of the expression having the specified value. This
9666 parameter takes a percentage (i.e. 0 ... 100) as input.
9667 The default probability of 90 is obtained empirically.
9669 @item align-threshold
9671 Select fraction of the maximal frequency of executions of a basic block in
9672 a function to align the basic block.
9674 @item align-loop-iterations
9676 A loop expected to iterate at least the selected number of iterations is
9677 aligned.
9679 @item tracer-dynamic-coverage
9680 @itemx tracer-dynamic-coverage-feedback
9682 This value is used to limit superblock formation once the given percentage of
9683 executed instructions is covered.  This limits unnecessary code size
9684 expansion.
9686 The @option{tracer-dynamic-coverage-feedback} is used only when profile
9687 feedback is available.  The real profiles (as opposed to statically estimated
9688 ones) are much less balanced allowing the threshold to be larger value.
9690 @item tracer-max-code-growth
9691 Stop tail duplication once code growth has reached given percentage.  This is
9692 a rather artificial limit, as most of the duplicates are eliminated later in
9693 cross jumping, so it may be set to much higher values than is the desired code
9694 growth.
9696 @item tracer-min-branch-ratio
9698 Stop reverse growth when the reverse probability of best edge is less than this
9699 threshold (in percent).
9701 @item tracer-min-branch-ratio
9702 @itemx tracer-min-branch-ratio-feedback
9704 Stop forward growth if the best edge has probability lower than this
9705 threshold.
9707 Similarly to @option{tracer-dynamic-coverage} two values are present, one for
9708 compilation for profile feedback and one for compilation without.  The value
9709 for compilation with profile feedback needs to be more conservative (higher) in
9710 order to make tracer effective.
9712 @item max-cse-path-length
9714 The maximum number of basic blocks on path that CSE considers.
9715 The default is 10.
9717 @item max-cse-insns
9718 The maximum number of instructions CSE processes before flushing.
9719 The default is 1000.
9721 @item ggc-min-expand
9723 GCC uses a garbage collector to manage its own memory allocation.  This
9724 parameter specifies the minimum percentage by which the garbage
9725 collector's heap should be allowed to expand between collections.
9726 Tuning this may improve compilation speed; it has no effect on code
9727 generation.
9729 The default is 30% + 70% * (RAM/1GB) with an upper bound of 100% when
9730 RAM >= 1GB@.  If @code{getrlimit} is available, the notion of ``RAM'' is
9731 the smallest of actual RAM and @code{RLIMIT_DATA} or @code{RLIMIT_AS}.  If
9732 GCC is not able to calculate RAM on a particular platform, the lower
9733 bound of 30% is used.  Setting this parameter and
9734 @option{ggc-min-heapsize} to zero causes a full collection to occur at
9735 every opportunity.  This is extremely slow, but can be useful for
9736 debugging.
9738 @item ggc-min-heapsize
9740 Minimum size of the garbage collector's heap before it begins bothering
9741 to collect garbage.  The first collection occurs after the heap expands
9742 by @option{ggc-min-expand}% beyond @option{ggc-min-heapsize}.  Again,
9743 tuning this may improve compilation speed, and has no effect on code
9744 generation.
9746 The default is the smaller of RAM/8, RLIMIT_RSS, or a limit that
9747 tries to ensure that RLIMIT_DATA or RLIMIT_AS are not exceeded, but
9748 with a lower bound of 4096 (four megabytes) and an upper bound of
9749 131072 (128 megabytes).  If GCC is not able to calculate RAM on a
9750 particular platform, the lower bound is used.  Setting this parameter
9751 very large effectively disables garbage collection.  Setting this
9752 parameter and @option{ggc-min-expand} to zero causes a full collection
9753 to occur at every opportunity.
9755 @item max-reload-search-insns
9756 The maximum number of instruction reload should look backward for equivalent
9757 register.  Increasing values mean more aggressive optimization, making the
9758 compilation time increase with probably slightly better performance.
9759 The default value is 100.
9761 @item max-cselib-memory-locations
9762 The maximum number of memory locations cselib should take into account.
9763 Increasing values mean more aggressive optimization, making the compilation time
9764 increase with probably slightly better performance.  The default value is 500.
9766 @item reorder-blocks-duplicate
9767 @itemx reorder-blocks-duplicate-feedback
9769 Used by the basic block reordering pass to decide whether to use unconditional
9770 branch or duplicate the code on its destination.  Code is duplicated when its
9771 estimated size is smaller than this value multiplied by the estimated size of
9772 unconditional jump in the hot spots of the program.
9774 The @option{reorder-block-duplicate-feedback} is used only when profile
9775 feedback is available.  It may be set to higher values than
9776 @option{reorder-block-duplicate} since information about the hot spots is more
9777 accurate.
9779 @item max-sched-ready-insns
9780 The maximum number of instructions ready to be issued the scheduler should
9781 consider at any given time during the first scheduling pass.  Increasing
9782 values mean more thorough searches, making the compilation time increase
9783 with probably little benefit.  The default value is 100.
9785 @item max-sched-region-blocks
9786 The maximum number of blocks in a region to be considered for
9787 interblock scheduling.  The default value is 10.
9789 @item max-pipeline-region-blocks
9790 The maximum number of blocks in a region to be considered for
9791 pipelining in the selective scheduler.  The default value is 15.
9793 @item max-sched-region-insns
9794 The maximum number of insns in a region to be considered for
9795 interblock scheduling.  The default value is 100.
9797 @item max-pipeline-region-insns
9798 The maximum number of insns in a region to be considered for
9799 pipelining in the selective scheduler.  The default value is 200.
9801 @item min-spec-prob
9802 The minimum probability (in percents) of reaching a source block
9803 for interblock speculative scheduling.  The default value is 40.
9805 @item max-sched-extend-regions-iters
9806 The maximum number of iterations through CFG to extend regions.
9807 A value of 0 (the default) disables region extensions.
9809 @item max-sched-insn-conflict-delay
9810 The maximum conflict delay for an insn to be considered for speculative motion.
9811 The default value is 3.
9813 @item sched-spec-prob-cutoff
9814 The minimal probability of speculation success (in percents), so that
9815 speculative insns are scheduled.
9816 The default value is 40.
9818 @item sched-spec-state-edge-prob-cutoff
9819 The minimum probability an edge must have for the scheduler to save its
9820 state across it.
9821 The default value is 10.
9823 @item sched-mem-true-dep-cost
9824 Minimal distance (in CPU cycles) between store and load targeting same
9825 memory locations.  The default value is 1.
9827 @item selsched-max-lookahead
9828 The maximum size of the lookahead window of selective scheduling.  It is a
9829 depth of search for available instructions.
9830 The default value is 50.
9832 @item selsched-max-sched-times
9833 The maximum number of times that an instruction is scheduled during
9834 selective scheduling.  This is the limit on the number of iterations
9835 through which the instruction may be pipelined.  The default value is 2.
9837 @item selsched-max-insns-to-rename
9838 The maximum number of best instructions in the ready list that are considered
9839 for renaming in the selective scheduler.  The default value is 2.
9841 @item sms-min-sc
9842 The minimum value of stage count that swing modulo scheduler
9843 generates.  The default value is 2.
9845 @item max-last-value-rtl
9846 The maximum size measured as number of RTLs that can be recorded in an expression
9847 in combiner for a pseudo register as last known value of that register.  The default
9848 is 10000.
9850 @item integer-share-limit
9851 Small integer constants can use a shared data structure, reducing the
9852 compiler's memory usage and increasing its speed.  This sets the maximum
9853 value of a shared integer constant.  The default value is 256.
9855 @item ssp-buffer-size
9856 The minimum size of buffers (i.e.@: arrays) that receive stack smashing
9857 protection when @option{-fstack-protection} is used.
9859 @item min-size-for-stack-sharing
9860 The minimum size of variables taking part in stack slot sharing when not
9861 optimizing. The default value is 32.
9863 @item max-jump-thread-duplication-stmts
9864 Maximum number of statements allowed in a block that needs to be
9865 duplicated when threading jumps.
9867 @item max-fields-for-field-sensitive
9868 Maximum number of fields in a structure treated in
9869 a field sensitive manner during pointer analysis.  The default is zero
9870 for @option{-O0} and @option{-O1},
9871 and 100 for @option{-Os}, @option{-O2}, and @option{-O3}.
9873 @item prefetch-latency
9874 Estimate on average number of instructions that are executed before
9875 prefetch finishes.  The distance prefetched ahead is proportional
9876 to this constant.  Increasing this number may also lead to less
9877 streams being prefetched (see @option{simultaneous-prefetches}).
9879 @item simultaneous-prefetches
9880 Maximum number of prefetches that can run at the same time.
9882 @item l1-cache-line-size
9883 The size of cache line in L1 cache, in bytes.
9885 @item l1-cache-size
9886 The size of L1 cache, in kilobytes.
9888 @item l2-cache-size
9889 The size of L2 cache, in kilobytes.
9891 @item min-insn-to-prefetch-ratio
9892 The minimum ratio between the number of instructions and the
9893 number of prefetches to enable prefetching in a loop.
9895 @item prefetch-min-insn-to-mem-ratio
9896 The minimum ratio between the number of instructions and the
9897 number of memory references to enable prefetching in a loop.
9899 @item use-canonical-types
9900 Whether the compiler should use the ``canonical'' type system.  By
9901 default, this should always be 1, which uses a more efficient internal
9902 mechanism for comparing types in C++ and Objective-C++.  However, if
9903 bugs in the canonical type system are causing compilation failures,
9904 set this value to 0 to disable canonical types.
9906 @item switch-conversion-max-branch-ratio
9907 Switch initialization conversion refuses to create arrays that are
9908 bigger than @option{switch-conversion-max-branch-ratio} times the number of
9909 branches in the switch.
9911 @item max-partial-antic-length
9912 Maximum length of the partial antic set computed during the tree
9913 partial redundancy elimination optimization (@option{-ftree-pre}) when
9914 optimizing at @option{-O3} and above.  For some sorts of source code
9915 the enhanced partial redundancy elimination optimization can run away,
9916 consuming all of the memory available on the host machine.  This
9917 parameter sets a limit on the length of the sets that are computed,
9918 which prevents the runaway behavior.  Setting a value of 0 for
9919 this parameter allows an unlimited set length.
9921 @item sccvn-max-scc-size
9922 Maximum size of a strongly connected component (SCC) during SCCVN
9923 processing.  If this limit is hit, SCCVN processing for the whole
9924 function is not done and optimizations depending on it are
9925 disabled.  The default maximum SCC size is 10000.
9927 @item sccvn-max-alias-queries-per-access
9928 Maximum number of alias-oracle queries we perform when looking for
9929 redundancies for loads and stores.  If this limit is hit the search
9930 is aborted and the load or store is not considered redundant.  The
9931 number of queries is algorithmically limited to the number of
9932 stores on all paths from the load to the function entry.
9933 The default maxmimum number of queries is 1000.
9935 @item ira-max-loops-num
9936 IRA uses regional register allocation by default.  If a function
9937 contains more loops than the number given by this parameter, only at most
9938 the given number of the most frequently-executed loops form regions
9939 for regional register allocation.  The default value of the
9940 parameter is 100.
9942 @item ira-max-conflict-table-size 
9943 Although IRA uses a sophisticated algorithm to compress the conflict
9944 table, the table can still require excessive amounts of memory for
9945 huge functions.  If the conflict table for a function could be more
9946 than the size in MB given by this parameter, the register allocator
9947 instead uses a faster, simpler, and lower-quality
9948 algorithm that does not require building a pseudo-register conflict table.  
9949 The default value of the parameter is 2000.
9951 @item ira-loop-reserved-regs
9952 IRA can be used to evaluate more accurate register pressure in loops
9953 for decisions to move loop invariants (see @option{-O3}).  The number
9954 of available registers reserved for some other purposes is given
9955 by this parameter.  The default value of the parameter is 2, which is
9956 the minimal number of registers needed by typical instructions.
9957 This value is the best found from numerous experiments.
9959 @item loop-invariant-max-bbs-in-loop
9960 Loop invariant motion can be very expensive, both in compilation time and
9961 in amount of needed compile-time memory, with very large loops.  Loops
9962 with more basic blocks than this parameter won't have loop invariant
9963 motion optimization performed on them.  The default value of the
9964 parameter is 1000 for @option{-O1} and 10000 for @option{-O2} and above.
9966 @item loop-max-datarefs-for-datadeps
9967 Building data dapendencies is expensive for very large loops.  This
9968 parameter limits the number of data references in loops that are
9969 considered for data dependence analysis.  These large loops are no
9970 handled by the optimizations using loop data dependencies.
9971 The default value is 1000.
9973 @item max-vartrack-size
9974 Sets a maximum number of hash table slots to use during variable
9975 tracking dataflow analysis of any function.  If this limit is exceeded
9976 with variable tracking at assignments enabled, analysis for that
9977 function is retried without it, after removing all debug insns from
9978 the function.  If the limit is exceeded even without debug insns, var
9979 tracking analysis is completely disabled for the function.  Setting
9980 the parameter to zero makes it unlimited.
9982 @item max-vartrack-expr-depth
9983 Sets a maximum number of recursion levels when attempting to map
9984 variable names or debug temporaries to value expressions.  This trades
9985 compilation time for more complete debug information.  If this is set too
9986 low, value expressions that are available and could be represented in
9987 debug information may end up not being used; setting this higher may
9988 enable the compiler to find more complex debug expressions, but compile
9989 time and memory use may grow.  The default is 12.
9991 @item min-nondebug-insn-uid
9992 Use uids starting at this parameter for nondebug insns.  The range below
9993 the parameter is reserved exclusively for debug insns created by
9994 @option{-fvar-tracking-assignments}, but debug insns may get
9995 (non-overlapping) uids above it if the reserved range is exhausted.
9997 @item ipa-sra-ptr-growth-factor
9998 IPA-SRA replaces a pointer to an aggregate with one or more new
9999 parameters only when their cumulative size is less or equal to
10000 @option{ipa-sra-ptr-growth-factor} times the size of the original
10001 pointer parameter.
10003 @item tm-max-aggregate-size
10004 When making copies of thread-local variables in a transaction, this
10005 parameter specifies the size in bytes after which variables are
10006 saved with the logging functions as opposed to save/restore code
10007 sequence pairs.  This option only applies when using
10008 @option{-fgnu-tm}.
10010 @item graphite-max-nb-scop-params
10011 To avoid exponential effects in the Graphite loop transforms, the
10012 number of parameters in a Static Control Part (SCoP) is bounded.  The
10013 default value is 10 parameters.  A variable whose value is unknown at
10014 compilation time and defined outside a SCoP is a parameter of the SCoP.
10016 @item graphite-max-bbs-per-function
10017 To avoid exponential effects in the detection of SCoPs, the size of
10018 the functions analyzed by Graphite is bounded.  The default value is
10019 100 basic blocks.
10021 @item loop-block-tile-size
10022 Loop blocking or strip mining transforms, enabled with
10023 @option{-floop-block} or @option{-floop-strip-mine}, strip mine each
10024 loop in the loop nest by a given number of iterations.  The strip
10025 length can be changed using the @option{loop-block-tile-size}
10026 parameter.  The default value is 51 iterations.
10028 @item ipa-cp-value-list-size
10029 IPA-CP attempts to track all possible values and types passed to a function's
10030 parameter in order to propagate them and perform devirtualization.
10031 @option{ipa-cp-value-list-size} is the maximum number of values and types it
10032 stores per one formal parameter of a function.
10034 @item lto-partitions
10035 Specify desired number of partitions produced during WHOPR compilation.
10036 The number of partitions should exceed the number of CPUs used for compilation.
10037 The default value is 32.
10039 @item lto-minpartition
10040 Size of minimal partition for WHOPR (in estimated instructions).
10041 This prevents expenses of splitting very small programs into too many
10042 partitions.
10044 @item cxx-max-namespaces-for-diagnostic-help
10045 The maximum number of namespaces to consult for suggestions when C++
10046 name lookup fails for an identifier.  The default is 1000.
10048 @item sink-frequency-threshold
10049 The maximum relative execution frequency (in percents) of the target block
10050 relative to a statement's original block to allow statement sinking of a
10051 statement.  Larger numbers result in more aggressive statement sinking.
10052 The default value is 75.  A small positive adjustment is applied for
10053 statements with memory operands as those are even more profitable so sink.
10055 @item max-stores-to-sink
10056 The maximum number of conditional stores paires that can be sunk.  Set to 0
10057 if either vectorization (@option{-ftree-vectorize}) or if-conversion
10058 (@option{-ftree-loop-if-convert}) is disabled.  The default is 2.
10060 @item allow-load-data-races
10061 Allow optimizers to introduce new data races on loads.
10062 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10063 unless implicitly set by the @option{-fmemory-model=} option.
10065 @item allow-store-data-races
10066 Allow optimizers to introduce new data races on stores.
10067 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10068 unless implicitly set by the @option{-fmemory-model=} option.
10070 @item allow-packed-load-data-races
10071 Allow optimizers to introduce new data races on packed data loads.
10072 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10073 unless implicitly set by the @option{-fmemory-model=} option.
10075 @item allow-packed-store-data-races
10076 Allow optimizers to introduce new data races on packed data stores.
10077 Set to 1 to allow, otherwise to 0.  This option is enabled by default
10078 unless implicitly set by the @option{-fmemory-model=} option.
10080 @item case-values-threshold
10081 The smallest number of different values for which it is best to use a
10082 jump-table instead of a tree of conditional branches.  If the value is
10083 0, use the default for the machine.  The default is 0.
10085 @item tree-reassoc-width
10086 Set the maximum number of instructions executed in parallel in
10087 reassociated tree. This parameter overrides target dependent
10088 heuristics used by default if has non zero value.
10090 @item sched-pressure-algorithm
10091 Choose between the two available implementations of
10092 @option{-fsched-pressure}.  Algorithm 1 is the original implementation
10093 and is the more likely to prevent instructions from being reordered.
10094 Algorithm 2 was designed to be a compromise between the relatively
10095 conservative approach taken by algorithm 1 and the rather aggressive
10096 approach taken by the default scheduler.  It relies more heavily on
10097 having a regular register file and accurate register pressure classes.
10098 See @file{haifa-sched.c} in the GCC sources for more details.
10100 The default choice depends on the target.
10102 @item max-slsr-cand-scan
10103 Set the maximum number of existing candidates that will be considered when
10104 seeking a basis for a new straight-line strength reduction candidate.
10106 @item asan-globals
10107 Enable buffer overflow detection for global objects.  This kind
10108 of protection is enabled by default if you are using
10109 @option{-fsanitize=address} option.
10110 To disable global objects protection use @option{--param asan-globals=0}.
10112 @item asan-stack
10113 Enable buffer overflow detection for stack objects.  This kind of
10114 protection is enabled by default when using@option{-fsanitize=address}.
10115 To disable stack protection use @option{--param asan-stack=0} option.
10117 @item asan-instrument-reads
10118 Enable buffer overflow detection for memory reads.  This kind of
10119 protection is enabled by default when using @option{-fsanitize=address}.
10120 To disable memory reads protection use
10121 @option{--param asan-instrument-reads=0}.
10123 @item asan-instrument-writes
10124 Enable buffer overflow detection for memory writes.  This kind of
10125 protection is enabled by default when using @option{-fsanitize=address}.
10126 To disable memory writes protection use
10127 @option{--param asan-instrument-writes=0} option.
10129 @item asan-memintrin
10130 Enable detection for built-in functions.  This kind of protection
10131 is enabled by default when using @option{-fsanitize=address}.
10132 To disable built-in functions protection use
10133 @option{--param asan-memintrin=0}.
10135 @item asan-use-after-return
10136 Enable detection of use-after-return.  This kind of protection
10137 is enabled by default when using @option{-fsanitize=address} option.
10138 To disable use-after-return detection use 
10139 @option{--param asan-use-after-return=0}.
10141 @end table
10142 @end table
10144 @node Preprocessor Options
10145 @section Options Controlling the Preprocessor
10146 @cindex preprocessor options
10147 @cindex options, preprocessor
10149 These options control the C preprocessor, which is run on each C source
10150 file before actual compilation.
10152 If you use the @option{-E} option, nothing is done except preprocessing.
10153 Some of these options make sense only together with @option{-E} because
10154 they cause the preprocessor output to be unsuitable for actual
10155 compilation.
10157 @table @gcctabopt
10158 @item -Wp,@var{option}
10159 @opindex Wp
10160 You can use @option{-Wp,@var{option}} to bypass the compiler driver
10161 and pass @var{option} directly through to the preprocessor.  If
10162 @var{option} contains commas, it is split into multiple options at the
10163 commas.  However, many options are modified, translated or interpreted
10164 by the compiler driver before being passed to the preprocessor, and
10165 @option{-Wp} forcibly bypasses this phase.  The preprocessor's direct
10166 interface is undocumented and subject to change, so whenever possible
10167 you should avoid using @option{-Wp} and let the driver handle the
10168 options instead.
10170 @item -Xpreprocessor @var{option}
10171 @opindex Xpreprocessor
10172 Pass @var{option} as an option to the preprocessor.  You can use this to
10173 supply system-specific preprocessor options that GCC does not 
10174 recognize.
10176 If you want to pass an option that takes an argument, you must use
10177 @option{-Xpreprocessor} twice, once for the option and once for the argument.
10179 @item -no-integrated-cpp
10180 @opindex no-integrated-cpp
10181 Perform preprocessing as a separate pass before compilation.
10182 By default, GCC performs preprocessing as an integrated part of
10183 input tokenization and parsing.
10184 If this option is provided, the appropriate language front end
10185 (@command{cc1}, @command{cc1plus}, or @command{cc1obj} for C, C++,
10186 and Objective-C, respectively) is instead invoked twice,
10187 once for preprocessing only and once for actual compilation
10188 of the preprocessed input.
10189 This option may be useful in conjunction with the @option{-B} or
10190 @option{-wrapper} options to specify an alternate preprocessor or
10191 perform additional processing of the program source between
10192 normal preprocessing and compilation.
10193 @end table
10195 @include cppopts.texi
10197 @node Assembler Options
10198 @section Passing Options to the Assembler
10200 @c prevent bad page break with this line
10201 You can pass options to the assembler.
10203 @table @gcctabopt
10204 @item -Wa,@var{option}
10205 @opindex Wa
10206 Pass @var{option} as an option to the assembler.  If @var{option}
10207 contains commas, it is split into multiple options at the commas.
10209 @item -Xassembler @var{option}
10210 @opindex Xassembler
10211 Pass @var{option} as an option to the assembler.  You can use this to
10212 supply system-specific assembler options that GCC does not
10213 recognize.
10215 If you want to pass an option that takes an argument, you must use
10216 @option{-Xassembler} twice, once for the option and once for the argument.
10218 @end table
10220 @node Link Options
10221 @section Options for Linking
10222 @cindex link options
10223 @cindex options, linking
10225 These options come into play when the compiler links object files into
10226 an executable output file.  They are meaningless if the compiler is
10227 not doing a link step.
10229 @table @gcctabopt
10230 @cindex file names
10231 @item @var{object-file-name}
10232 A file name that does not end in a special recognized suffix is
10233 considered to name an object file or library.  (Object files are
10234 distinguished from libraries by the linker according to the file
10235 contents.)  If linking is done, these object files are used as input
10236 to the linker.
10238 @item -c
10239 @itemx -S
10240 @itemx -E
10241 @opindex c
10242 @opindex S
10243 @opindex E
10244 If any of these options is used, then the linker is not run, and
10245 object file names should not be used as arguments.  @xref{Overall
10246 Options}.
10248 @cindex Libraries
10249 @item -l@var{library}
10250 @itemx -l @var{library}
10251 @opindex l
10252 Search the library named @var{library} when linking.  (The second
10253 alternative with the library as a separate argument is only for
10254 POSIX compliance and is not recommended.)
10256 It makes a difference where in the command you write this option; the
10257 linker searches and processes libraries and object files in the order they
10258 are specified.  Thus, @samp{foo.o -lz bar.o} searches library @samp{z}
10259 after file @file{foo.o} but before @file{bar.o}.  If @file{bar.o} refers
10260 to functions in @samp{z}, those functions may not be loaded.
10262 The linker searches a standard list of directories for the library,
10263 which is actually a file named @file{lib@var{library}.a}.  The linker
10264 then uses this file as if it had been specified precisely by name.
10266 The directories searched include several standard system directories
10267 plus any that you specify with @option{-L}.
10269 Normally the files found this way are library files---archive files
10270 whose members are object files.  The linker handles an archive file by
10271 scanning through it for members which define symbols that have so far
10272 been referenced but not defined.  But if the file that is found is an
10273 ordinary object file, it is linked in the usual fashion.  The only
10274 difference between using an @option{-l} option and specifying a file name
10275 is that @option{-l} surrounds @var{library} with @samp{lib} and @samp{.a}
10276 and searches several directories.
10278 @item -lobjc
10279 @opindex lobjc
10280 You need this special case of the @option{-l} option in order to
10281 link an Objective-C or Objective-C++ program.
10283 @item -nostartfiles
10284 @opindex nostartfiles
10285 Do not use the standard system startup files when linking.
10286 The standard system libraries are used normally, unless @option{-nostdlib}
10287 or @option{-nodefaultlibs} is used.
10289 @item -nodefaultlibs
10290 @opindex nodefaultlibs
10291 Do not use the standard system libraries when linking.
10292 Only the libraries you specify are passed to the linker, and options
10293 specifying linkage of the system libraries, such as @code{-static-libgcc}
10294 or @code{-shared-libgcc}, are ignored.  
10295 The standard startup files are used normally, unless @option{-nostartfiles}
10296 is used.  
10298 The compiler may generate calls to @code{memcmp},
10299 @code{memset}, @code{memcpy} and @code{memmove}.
10300 These entries are usually resolved by entries in
10301 libc.  These entry points should be supplied through some other
10302 mechanism when this option is specified.
10304 @item -nostdlib
10305 @opindex nostdlib
10306 Do not use the standard system startup files or libraries when linking.
10307 No startup files and only the libraries you specify are passed to
10308 the linker, and options specifying linkage of the system libraries, such as
10309 @code{-static-libgcc} or @code{-shared-libgcc}, are ignored.
10311 The compiler may generate calls to @code{memcmp}, @code{memset},
10312 @code{memcpy} and @code{memmove}.
10313 These entries are usually resolved by entries in
10314 libc.  These entry points should be supplied through some other
10315 mechanism when this option is specified.
10317 @cindex @option{-lgcc}, use with @option{-nostdlib}
10318 @cindex @option{-nostdlib} and unresolved references
10319 @cindex unresolved references and @option{-nostdlib}
10320 @cindex @option{-lgcc}, use with @option{-nodefaultlibs}
10321 @cindex @option{-nodefaultlibs} and unresolved references
10322 @cindex unresolved references and @option{-nodefaultlibs}
10323 One of the standard libraries bypassed by @option{-nostdlib} and
10324 @option{-nodefaultlibs} is @file{libgcc.a}, a library of internal subroutines
10325 which GCC uses to overcome shortcomings of particular machines, or special
10326 needs for some languages.
10327 (@xref{Interface,,Interfacing to GCC Output,gccint,GNU Compiler
10328 Collection (GCC) Internals},
10329 for more discussion of @file{libgcc.a}.)
10330 In most cases, you need @file{libgcc.a} even when you want to avoid
10331 other standard libraries.  In other words, when you specify @option{-nostdlib}
10332 or @option{-nodefaultlibs} you should usually specify @option{-lgcc} as well.
10333 This ensures that you have no unresolved references to internal GCC
10334 library subroutines.
10335 (An example of such an internal subroutine is @samp{__main}, used to ensure C++
10336 constructors are called; @pxref{Collect2,,@code{collect2}, gccint,
10337 GNU Compiler Collection (GCC) Internals}.)
10339 @item -pie
10340 @opindex pie
10341 Produce a position independent executable on targets that support it.
10342 For predictable results, you must also specify the same set of options
10343 used for compilation (@option{-fpie}, @option{-fPIE},
10344 or model suboptions) when you specify this linker option.
10346 @item -rdynamic
10347 @opindex rdynamic
10348 Pass the flag @option{-export-dynamic} to the ELF linker, on targets
10349 that support it. This instructs the linker to add all symbols, not
10350 only used ones, to the dynamic symbol table. This option is needed
10351 for some uses of @code{dlopen} or to allow obtaining backtraces
10352 from within a program.
10354 @item -s
10355 @opindex s
10356 Remove all symbol table and relocation information from the executable.
10358 @item -static
10359 @opindex static
10360 On systems that support dynamic linking, this prevents linking with the shared
10361 libraries.  On other systems, this option has no effect.
10363 @item -shared
10364 @opindex shared
10365 Produce a shared object which can then be linked with other objects to
10366 form an executable.  Not all systems support this option.  For predictable
10367 results, you must also specify the same set of options used for compilation
10368 (@option{-fpic}, @option{-fPIC}, or model suboptions) when
10369 you specify this linker option.@footnote{On some systems, @samp{gcc -shared}
10370 needs to build supplementary stub code for constructors to work.  On
10371 multi-libbed systems, @samp{gcc -shared} must select the correct support
10372 libraries to link against.  Failing to supply the correct flags may lead
10373 to subtle defects.  Supplying them in cases where they are not necessary
10374 is innocuous.}
10376 @item -shared-libgcc
10377 @itemx -static-libgcc
10378 @opindex shared-libgcc
10379 @opindex static-libgcc
10380 On systems that provide @file{libgcc} as a shared library, these options
10381 force the use of either the shared or static version, respectively.
10382 If no shared version of @file{libgcc} was built when the compiler was
10383 configured, these options have no effect.
10385 There are several situations in which an application should use the
10386 shared @file{libgcc} instead of the static version.  The most common
10387 of these is when the application wishes to throw and catch exceptions
10388 across different shared libraries.  In that case, each of the libraries
10389 as well as the application itself should use the shared @file{libgcc}.
10391 Therefore, the G++ and GCJ drivers automatically add
10392 @option{-shared-libgcc} whenever you build a shared library or a main
10393 executable, because C++ and Java programs typically use exceptions, so
10394 this is the right thing to do.
10396 If, instead, you use the GCC driver to create shared libraries, you may
10397 find that they are not always linked with the shared @file{libgcc}.
10398 If GCC finds, at its configuration time, that you have a non-GNU linker
10399 or a GNU linker that does not support option @option{--eh-frame-hdr},
10400 it links the shared version of @file{libgcc} into shared libraries
10401 by default.  Otherwise, it takes advantage of the linker and optimizes
10402 away the linking with the shared version of @file{libgcc}, linking with
10403 the static version of libgcc by default.  This allows exceptions to
10404 propagate through such shared libraries, without incurring relocation
10405 costs at library load time.
10407 However, if a library or main executable is supposed to throw or catch
10408 exceptions, you must link it using the G++ or GCJ driver, as appropriate
10409 for the languages used in the program, or using the option
10410 @option{-shared-libgcc}, such that it is linked with the shared
10411 @file{libgcc}.
10413 @item -static-libasan
10414 @opindex static-libasan
10415 When the @option{-fsanitize=address} option is used to link a program,
10416 the GCC driver automatically links against @option{libasan}.  If
10417 @file{libasan} is available as a shared library, and the @option{-static}
10418 option is not used, then this links against the shared version of
10419 @file{libasan}.  The @option{-static-libasan} option directs the GCC
10420 driver to link @file{libasan} statically, without necessarily linking
10421 other libraries statically.
10423 @item -static-libtsan
10424 @opindex static-libtsan
10425 When the @option{-fsanitize=thread} option is used to link a program,
10426 the GCC driver automatically links against @option{libtsan}.  If
10427 @file{libtsan} is available as a shared library, and the @option{-static}
10428 option is not used, then this links against the shared version of
10429 @file{libtsan}.  The @option{-static-libtsan} option directs the GCC
10430 driver to link @file{libtsan} statically, without necessarily linking
10431 other libraries statically.
10433 @item -static-liblsan
10434 @opindex static-liblsan
10435 When the @option{-fsanitize=leak} option is used to link a program,
10436 the GCC driver automatically links against @option{liblsan}.  If
10437 @file{liblsan} is available as a shared library, and the @option{-static}
10438 option is not used, then this links against the shared version of
10439 @file{liblsan}.  The @option{-static-liblsan} option directs the GCC
10440 driver to link @file{liblsan} statically, without necessarily linking
10441 other libraries statically.
10443 @item -static-libubsan
10444 @opindex static-libubsan
10445 When the @option{-fsanitize=undefined} option is used to link a program,
10446 the GCC driver automatically links against @option{libubsan}.  If
10447 @file{libubsan} is available as a shared library, and the @option{-static}
10448 option is not used, then this links against the shared version of
10449 @file{libubsan}.  The @option{-static-libubsan} option directs the GCC
10450 driver to link @file{libubsan} statically, without necessarily linking
10451 other libraries statically.
10453 @item -static-libstdc++
10454 @opindex static-libstdc++
10455 When the @command{g++} program is used to link a C++ program, it
10456 normally automatically links against @option{libstdc++}.  If
10457 @file{libstdc++} is available as a shared library, and the
10458 @option{-static} option is not used, then this links against the
10459 shared version of @file{libstdc++}.  That is normally fine.  However, it
10460 is sometimes useful to freeze the version of @file{libstdc++} used by
10461 the program without going all the way to a fully static link.  The
10462 @option{-static-libstdc++} option directs the @command{g++} driver to
10463 link @file{libstdc++} statically, without necessarily linking other
10464 libraries statically.
10466 @item -symbolic
10467 @opindex symbolic
10468 Bind references to global symbols when building a shared object.  Warn
10469 about any unresolved references (unless overridden by the link editor
10470 option @option{-Xlinker -z -Xlinker defs}).  Only a few systems support
10471 this option.
10473 @item -T @var{script}
10474 @opindex T
10475 @cindex linker script
10476 Use @var{script} as the linker script.  This option is supported by most
10477 systems using the GNU linker.  On some targets, such as bare-board
10478 targets without an operating system, the @option{-T} option may be required
10479 when linking to avoid references to undefined symbols.
10481 @item -Xlinker @var{option}
10482 @opindex Xlinker
10483 Pass @var{option} as an option to the linker.  You can use this to
10484 supply system-specific linker options that GCC does not recognize.
10486 If you want to pass an option that takes a separate argument, you must use
10487 @option{-Xlinker} twice, once for the option and once for the argument.
10488 For example, to pass @option{-assert definitions}, you must write
10489 @option{-Xlinker -assert -Xlinker definitions}.  It does not work to write
10490 @option{-Xlinker "-assert definitions"}, because this passes the entire
10491 string as a single argument, which is not what the linker expects.
10493 When using the GNU linker, it is usually more convenient to pass
10494 arguments to linker options using the @option{@var{option}=@var{value}}
10495 syntax than as separate arguments.  For example, you can specify
10496 @option{-Xlinker -Map=output.map} rather than
10497 @option{-Xlinker -Map -Xlinker output.map}.  Other linkers may not support
10498 this syntax for command-line options.
10500 @item -Wl,@var{option}
10501 @opindex Wl
10502 Pass @var{option} as an option to the linker.  If @var{option} contains
10503 commas, it is split into multiple options at the commas.  You can use this
10504 syntax to pass an argument to the option.
10505 For example, @option{-Wl,-Map,output.map} passes @option{-Map output.map} to the
10506 linker.  When using the GNU linker, you can also get the same effect with
10507 @option{-Wl,-Map=output.map}.
10509 @item -u @var{symbol}
10510 @opindex u
10511 Pretend the symbol @var{symbol} is undefined, to force linking of
10512 library modules to define it.  You can use @option{-u} multiple times with
10513 different symbols to force loading of additional library modules.
10514 @end table
10516 @node Directory Options
10517 @section Options for Directory Search
10518 @cindex directory options
10519 @cindex options, directory search
10520 @cindex search path
10522 These options specify directories to search for header files, for
10523 libraries and for parts of the compiler:
10525 @table @gcctabopt
10526 @item -I@var{dir}
10527 @opindex I
10528 Add the directory @var{dir} to the head of the list of directories to be
10529 searched for header files.  This can be used to override a system header
10530 file, substituting your own version, since these directories are
10531 searched before the system header file directories.  However, you should
10532 not use this option to add directories that contain vendor-supplied
10533 system header files (use @option{-isystem} for that).  If you use more than
10534 one @option{-I} option, the directories are scanned in left-to-right
10535 order; the standard system directories come after.
10537 If a standard system include directory, or a directory specified with
10538 @option{-isystem}, is also specified with @option{-I}, the @option{-I}
10539 option is ignored.  The directory is still searched but as a
10540 system directory at its normal position in the system include chain.
10541 This is to ensure that GCC's procedure to fix buggy system headers and
10542 the ordering for the @code{include_next} directive are not inadvertently changed.
10543 If you really need to change the search order for system directories,
10544 use the @option{-nostdinc} and/or @option{-isystem} options.
10546 @item -iplugindir=@var{dir}
10547 @opindex iplugindir=
10548 Set the directory to search for plugins that are passed
10549 by @option{-fplugin=@var{name}} instead of
10550 @option{-fplugin=@var{path}/@var{name}.so}.  This option is not meant
10551 to be used by the user, but only passed by the driver.
10553 @item -iquote@var{dir}
10554 @opindex iquote
10555 Add the directory @var{dir} to the head of the list of directories to
10556 be searched for header files only for the case of @samp{#include
10557 "@var{file}"}; they are not searched for @samp{#include <@var{file}>},
10558 otherwise just like @option{-I}.
10560 @item -L@var{dir}
10561 @opindex L
10562 Add directory @var{dir} to the list of directories to be searched
10563 for @option{-l}.
10565 @item -B@var{prefix}
10566 @opindex B
10567 This option specifies where to find the executables, libraries,
10568 include files, and data files of the compiler itself.
10570 The compiler driver program runs one or more of the subprograms
10571 @command{cpp}, @command{cc1}, @command{as} and @command{ld}.  It tries
10572 @var{prefix} as a prefix for each program it tries to run, both with and
10573 without @samp{@var{machine}/@var{version}/} (@pxref{Target Options}).
10575 For each subprogram to be run, the compiler driver first tries the
10576 @option{-B} prefix, if any.  If that name is not found, or if @option{-B}
10577 is not specified, the driver tries two standard prefixes, 
10578 @file{/usr/lib/gcc/} and @file{/usr/local/lib/gcc/}.  If neither of
10579 those results in a file name that is found, the unmodified program
10580 name is searched for using the directories specified in your
10581 @env{PATH} environment variable.
10583 The compiler checks to see if the path provided by the @option{-B}
10584 refers to a directory, and if necessary it adds a directory
10585 separator character at the end of the path.
10587 @option{-B} prefixes that effectively specify directory names also apply
10588 to libraries in the linker, because the compiler translates these
10589 options into @option{-L} options for the linker.  They also apply to
10590 include files in the preprocessor, because the compiler translates these
10591 options into @option{-isystem} options for the preprocessor.  In this case,
10592 the compiler appends @samp{include} to the prefix.
10594 The runtime support file @file{libgcc.a} can also be searched for using
10595 the @option{-B} prefix, if needed.  If it is not found there, the two
10596 standard prefixes above are tried, and that is all.  The file is left
10597 out of the link if it is not found by those means.
10599 Another way to specify a prefix much like the @option{-B} prefix is to use
10600 the environment variable @env{GCC_EXEC_PREFIX}.  @xref{Environment
10601 Variables}.
10603 As a special kludge, if the path provided by @option{-B} is
10604 @file{[dir/]stage@var{N}/}, where @var{N} is a number in the range 0 to
10605 9, then it is replaced by @file{[dir/]include}.  This is to help
10606 with boot-strapping the compiler.
10608 @item -specs=@var{file}
10609 @opindex specs
10610 Process @var{file} after the compiler reads in the standard @file{specs}
10611 file, in order to override the defaults which the @command{gcc} driver
10612 program uses when determining what switches to pass to @command{cc1},
10613 @command{cc1plus}, @command{as}, @command{ld}, etc.  More than one
10614 @option{-specs=@var{file}} can be specified on the command line, and they
10615 are processed in order, from left to right.
10617 @item --sysroot=@var{dir}
10618 @opindex sysroot
10619 Use @var{dir} as the logical root directory for headers and libraries.
10620 For example, if the compiler normally searches for headers in
10621 @file{/usr/include} and libraries in @file{/usr/lib}, it instead
10622 searches @file{@var{dir}/usr/include} and @file{@var{dir}/usr/lib}.
10624 If you use both this option and the @option{-isysroot} option, then
10625 the @option{--sysroot} option applies to libraries, but the
10626 @option{-isysroot} option applies to header files.
10628 The GNU linker (beginning with version 2.16) has the necessary support
10629 for this option.  If your linker does not support this option, the
10630 header file aspect of @option{--sysroot} still works, but the
10631 library aspect does not.
10633 @item --no-sysroot-suffix
10634 @opindex no-sysroot-suffix
10635 For some targets, a suffix is added to the root directory specified
10636 with @option{--sysroot}, depending on the other options used, so that
10637 headers may for example be found in
10638 @file{@var{dir}/@var{suffix}/usr/include} instead of
10639 @file{@var{dir}/usr/include}.  This option disables the addition of
10640 such a suffix.
10642 @item -I-
10643 @opindex I-
10644 This option has been deprecated.  Please use @option{-iquote} instead for
10645 @option{-I} directories before the @option{-I-} and remove the @option{-I-}.
10646 Any directories you specify with @option{-I} options before the @option{-I-}
10647 option are searched only for the case of @samp{#include "@var{file}"};
10648 they are not searched for @samp{#include <@var{file}>}.
10650 If additional directories are specified with @option{-I} options after
10651 the @option{-I-}, these directories are searched for all @samp{#include}
10652 directives.  (Ordinarily @emph{all} @option{-I} directories are used
10653 this way.)
10655 In addition, the @option{-I-} option inhibits the use of the current
10656 directory (where the current input file came from) as the first search
10657 directory for @samp{#include "@var{file}"}.  There is no way to
10658 override this effect of @option{-I-}.  With @option{-I.} you can specify
10659 searching the directory that is current when the compiler is
10660 invoked.  That is not exactly the same as what the preprocessor does
10661 by default, but it is often satisfactory.
10663 @option{-I-} does not inhibit the use of the standard system directories
10664 for header files.  Thus, @option{-I-} and @option{-nostdinc} are
10665 independent.
10666 @end table
10668 @c man end
10670 @node Spec Files
10671 @section Specifying subprocesses and the switches to pass to them
10672 @cindex Spec Files
10674 @command{gcc} is a driver program.  It performs its job by invoking a
10675 sequence of other programs to do the work of compiling, assembling and
10676 linking.  GCC interprets its command-line parameters and uses these to
10677 deduce which programs it should invoke, and which command-line options
10678 it ought to place on their command lines.  This behavior is controlled
10679 by @dfn{spec strings}.  In most cases there is one spec string for each
10680 program that GCC can invoke, but a few programs have multiple spec
10681 strings to control their behavior.  The spec strings built into GCC can
10682 be overridden by using the @option{-specs=} command-line switch to specify
10683 a spec file.
10685 @dfn{Spec files} are plaintext files that are used to construct spec
10686 strings.  They consist of a sequence of directives separated by blank
10687 lines.  The type of directive is determined by the first non-whitespace
10688 character on the line, which can be one of the following:
10690 @table @code
10691 @item %@var{command}
10692 Issues a @var{command} to the spec file processor.  The commands that can
10693 appear here are:
10695 @table @code
10696 @item %include <@var{file}>
10697 @cindex @code{%include}
10698 Search for @var{file} and insert its text at the current point in the
10699 specs file.
10701 @item %include_noerr <@var{file}>
10702 @cindex @code{%include_noerr}
10703 Just like @samp{%include}, but do not generate an error message if the include
10704 file cannot be found.
10706 @item %rename @var{old_name} @var{new_name}
10707 @cindex @code{%rename}
10708 Rename the spec string @var{old_name} to @var{new_name}.
10710 @end table
10712 @item *[@var{spec_name}]:
10713 This tells the compiler to create, override or delete the named spec
10714 string.  All lines after this directive up to the next directive or
10715 blank line are considered to be the text for the spec string.  If this
10716 results in an empty string then the spec is deleted.  (Or, if the
10717 spec did not exist, then nothing happens.)  Otherwise, if the spec
10718 does not currently exist a new spec is created.  If the spec does
10719 exist then its contents are overridden by the text of this
10720 directive, unless the first character of that text is the @samp{+}
10721 character, in which case the text is appended to the spec.
10723 @item [@var{suffix}]:
10724 Creates a new @samp{[@var{suffix}] spec} pair.  All lines after this directive
10725 and up to the next directive or blank line are considered to make up the
10726 spec string for the indicated suffix.  When the compiler encounters an
10727 input file with the named suffix, it processes the spec string in
10728 order to work out how to compile that file.  For example:
10730 @smallexample
10731 .ZZ:
10732 z-compile -input %i
10733 @end smallexample
10735 This says that any input file whose name ends in @samp{.ZZ} should be
10736 passed to the program @samp{z-compile}, which should be invoked with the
10737 command-line switch @option{-input} and with the result of performing the
10738 @samp{%i} substitution.  (See below.)
10740 As an alternative to providing a spec string, the text following a
10741 suffix directive can be one of the following:
10743 @table @code
10744 @item @@@var{language}
10745 This says that the suffix is an alias for a known @var{language}.  This is
10746 similar to using the @option{-x} command-line switch to GCC to specify a
10747 language explicitly.  For example:
10749 @smallexample
10750 .ZZ:
10751 @@c++
10752 @end smallexample
10754 Says that .ZZ files are, in fact, C++ source files.
10756 @item #@var{name}
10757 This causes an error messages saying:
10759 @smallexample
10760 @var{name} compiler not installed on this system.
10761 @end smallexample
10762 @end table
10764 GCC already has an extensive list of suffixes built into it.
10765 This directive adds an entry to the end of the list of suffixes, but
10766 since the list is searched from the end backwards, it is effectively
10767 possible to override earlier entries using this technique.
10769 @end table
10771 GCC has the following spec strings built into it.  Spec files can
10772 override these strings or create their own.  Note that individual
10773 targets can also add their own spec strings to this list.
10775 @smallexample
10776 asm          Options to pass to the assembler
10777 asm_final    Options to pass to the assembler post-processor
10778 cpp          Options to pass to the C preprocessor
10779 cc1          Options to pass to the C compiler
10780 cc1plus      Options to pass to the C++ compiler
10781 endfile      Object files to include at the end of the link
10782 link         Options to pass to the linker
10783 lib          Libraries to include on the command line to the linker
10784 libgcc       Decides which GCC support library to pass to the linker
10785 linker       Sets the name of the linker
10786 predefines   Defines to be passed to the C preprocessor
10787 signed_char  Defines to pass to CPP to say whether @code{char} is signed
10788              by default
10789 startfile    Object files to include at the start of the link
10790 @end smallexample
10792 Here is a small example of a spec file:
10794 @smallexample
10795 %rename lib                 old_lib
10797 *lib:
10798 --start-group -lgcc -lc -leval1 --end-group %(old_lib)
10799 @end smallexample
10801 This example renames the spec called @samp{lib} to @samp{old_lib} and
10802 then overrides the previous definition of @samp{lib} with a new one.
10803 The new definition adds in some extra command-line options before
10804 including the text of the old definition.
10806 @dfn{Spec strings} are a list of command-line options to be passed to their
10807 corresponding program.  In addition, the spec strings can contain
10808 @samp{%}-prefixed sequences to substitute variable text or to
10809 conditionally insert text into the command line.  Using these constructs
10810 it is possible to generate quite complex command lines.
10812 Here is a table of all defined @samp{%}-sequences for spec
10813 strings.  Note that spaces are not generated automatically around the
10814 results of expanding these sequences.  Therefore you can concatenate them
10815 together or combine them with constant text in a single argument.
10817 @table @code
10818 @item %%
10819 Substitute one @samp{%} into the program name or argument.
10821 @item %i
10822 Substitute the name of the input file being processed.
10824 @item %b
10825 Substitute the basename of the input file being processed.
10826 This is the substring up to (and not including) the last period
10827 and not including the directory.
10829 @item %B
10830 This is the same as @samp{%b}, but include the file suffix (text after
10831 the last period).
10833 @item %d
10834 Marks the argument containing or following the @samp{%d} as a
10835 temporary file name, so that that file is deleted if GCC exits
10836 successfully.  Unlike @samp{%g}, this contributes no text to the
10837 argument.
10839 @item %g@var{suffix}
10840 Substitute a file name that has suffix @var{suffix} and is chosen
10841 once per compilation, and mark the argument in the same way as
10842 @samp{%d}.  To reduce exposure to denial-of-service attacks, the file
10843 name is now chosen in a way that is hard to predict even when previously
10844 chosen file names are known.  For example, @samp{%g.s @dots{} %g.o @dots{} %g.s}
10845 might turn into @samp{ccUVUUAU.s ccXYAXZ12.o ccUVUUAU.s}.  @var{suffix} matches
10846 the regexp @samp{[.A-Za-z]*} or the special string @samp{%O}, which is
10847 treated exactly as if @samp{%O} had been preprocessed.  Previously, @samp{%g}
10848 was simply substituted with a file name chosen once per compilation,
10849 without regard to any appended suffix (which was therefore treated
10850 just like ordinary text), making such attacks more likely to succeed.
10852 @item %u@var{suffix}
10853 Like @samp{%g}, but generates a new temporary file name
10854 each time it appears instead of once per compilation.
10856 @item %U@var{suffix}
10857 Substitutes the last file name generated with @samp{%u@var{suffix}}, generating a
10858 new one if there is no such last file name.  In the absence of any
10859 @samp{%u@var{suffix}}, this is just like @samp{%g@var{suffix}}, except they don't share
10860 the same suffix @emph{space}, so @samp{%g.s @dots{} %U.s @dots{} %g.s @dots{} %U.s}
10861 involves the generation of two distinct file names, one
10862 for each @samp{%g.s} and another for each @samp{%U.s}.  Previously, @samp{%U} was
10863 simply substituted with a file name chosen for the previous @samp{%u},
10864 without regard to any appended suffix.
10866 @item %j@var{suffix}
10867 Substitutes the name of the @code{HOST_BIT_BUCKET}, if any, and if it is
10868 writable, and if @option{-save-temps} is not used; 
10869 otherwise, substitute the name
10870 of a temporary file, just like @samp{%u}.  This temporary file is not
10871 meant for communication between processes, but rather as a junk
10872 disposal mechanism.
10874 @item %|@var{suffix}
10875 @itemx %m@var{suffix}
10876 Like @samp{%g}, except if @option{-pipe} is in effect.  In that case
10877 @samp{%|} substitutes a single dash and @samp{%m} substitutes nothing at
10878 all.  These are the two most common ways to instruct a program that it
10879 should read from standard input or write to standard output.  If you
10880 need something more elaborate you can use an @samp{%@{pipe:@code{X}@}}
10881 construct: see for example @file{f/lang-specs.h}.
10883 @item %.@var{SUFFIX}
10884 Substitutes @var{.SUFFIX} for the suffixes of a matched switch's args
10885 when it is subsequently output with @samp{%*}.  @var{SUFFIX} is
10886 terminated by the next space or %.
10888 @item %w
10889 Marks the argument containing or following the @samp{%w} as the
10890 designated output file of this compilation.  This puts the argument
10891 into the sequence of arguments that @samp{%o} substitutes.
10893 @item %o
10894 Substitutes the names of all the output files, with spaces
10895 automatically placed around them.  You should write spaces
10896 around the @samp{%o} as well or the results are undefined.
10897 @samp{%o} is for use in the specs for running the linker.
10898 Input files whose names have no recognized suffix are not compiled
10899 at all, but they are included among the output files, so they are
10900 linked.
10902 @item %O
10903 Substitutes the suffix for object files.  Note that this is
10904 handled specially when it immediately follows @samp{%g, %u, or %U},
10905 because of the need for those to form complete file names.  The
10906 handling is such that @samp{%O} is treated exactly as if it had already
10907 been substituted, except that @samp{%g, %u, and %U} do not currently
10908 support additional @var{suffix} characters following @samp{%O} as they do
10909 following, for example, @samp{.o}.
10911 @item %p
10912 Substitutes the standard macro predefinitions for the
10913 current target machine.  Use this when running @code{cpp}.
10915 @item %P
10916 Like @samp{%p}, but puts @samp{__} before and after the name of each
10917 predefined macro, except for macros that start with @samp{__} or with
10918 @samp{_@var{L}}, where @var{L} is an uppercase letter.  This is for ISO
10921 @item %I
10922 Substitute any of @option{-iprefix} (made from @env{GCC_EXEC_PREFIX}),
10923 @option{-isysroot} (made from @env{TARGET_SYSTEM_ROOT}),
10924 @option{-isystem} (made from @env{COMPILER_PATH} and @option{-B} options)
10925 and @option{-imultilib} as necessary.
10927 @item %s
10928 Current argument is the name of a library or startup file of some sort.
10929 Search for that file in a standard list of directories and substitute
10930 the full name found.  The current working directory is included in the
10931 list of directories scanned.
10933 @item %T
10934 Current argument is the name of a linker script.  Search for that file
10935 in the current list of directories to scan for libraries. If the file
10936 is located insert a @option{--script} option into the command line
10937 followed by the full path name found.  If the file is not found then
10938 generate an error message.  Note: the current working directory is not
10939 searched.
10941 @item %e@var{str}
10942 Print @var{str} as an error message.  @var{str} is terminated by a newline.
10943 Use this when inconsistent options are detected.
10945 @item %(@var{name})
10946 Substitute the contents of spec string @var{name} at this point.
10948 @item %x@{@var{option}@}
10949 Accumulate an option for @samp{%X}.
10951 @item %X
10952 Output the accumulated linker options specified by @option{-Wl} or a @samp{%x}
10953 spec string.
10955 @item %Y
10956 Output the accumulated assembler options specified by @option{-Wa}.
10958 @item %Z
10959 Output the accumulated preprocessor options specified by @option{-Wp}.
10961 @item %a
10962 Process the @code{asm} spec.  This is used to compute the
10963 switches to be passed to the assembler.
10965 @item %A
10966 Process the @code{asm_final} spec.  This is a spec string for
10967 passing switches to an assembler post-processor, if such a program is
10968 needed.
10970 @item %l
10971 Process the @code{link} spec.  This is the spec for computing the
10972 command line passed to the linker.  Typically it makes use of the
10973 @samp{%L %G %S %D and %E} sequences.
10975 @item %D
10976 Dump out a @option{-L} option for each directory that GCC believes might
10977 contain startup files.  If the target supports multilibs then the
10978 current multilib directory is prepended to each of these paths.
10980 @item %L
10981 Process the @code{lib} spec.  This is a spec string for deciding which
10982 libraries are included on the command line to the linker.
10984 @item %G
10985 Process the @code{libgcc} spec.  This is a spec string for deciding
10986 which GCC support library is included on the command line to the linker.
10988 @item %S
10989 Process the @code{startfile} spec.  This is a spec for deciding which
10990 object files are the first ones passed to the linker.  Typically
10991 this might be a file named @file{crt0.o}.
10993 @item %E
10994 Process the @code{endfile} spec.  This is a spec string that specifies
10995 the last object files that are passed to the linker.
10997 @item %C
10998 Process the @code{cpp} spec.  This is used to construct the arguments
10999 to be passed to the C preprocessor.
11001 @item %1
11002 Process the @code{cc1} spec.  This is used to construct the options to be
11003 passed to the actual C compiler (@samp{cc1}).
11005 @item %2
11006 Process the @code{cc1plus} spec.  This is used to construct the options to be
11007 passed to the actual C++ compiler (@samp{cc1plus}).
11009 @item %*
11010 Substitute the variable part of a matched option.  See below.
11011 Note that each comma in the substituted string is replaced by
11012 a single space.
11014 @item %<@code{S}
11015 Remove all occurrences of @code{-S} from the command line.  Note---this
11016 command is position dependent.  @samp{%} commands in the spec string
11017 before this one see @code{-S}, @samp{%} commands in the spec string
11018 after this one do not.
11020 @item %:@var{function}(@var{args})
11021 Call the named function @var{function}, passing it @var{args}.
11022 @var{args} is first processed as a nested spec string, then split
11023 into an argument vector in the usual fashion.  The function returns
11024 a string which is processed as if it had appeared literally as part
11025 of the current spec.
11027 The following built-in spec functions are provided:
11029 @table @code
11030 @item @code{getenv}
11031 The @code{getenv} spec function takes two arguments: an environment
11032 variable name and a string.  If the environment variable is not
11033 defined, a fatal error is issued.  Otherwise, the return value is the
11034 value of the environment variable concatenated with the string.  For
11035 example, if @env{TOPDIR} is defined as @file{/path/to/top}, then:
11037 @smallexample
11038 %:getenv(TOPDIR /include)
11039 @end smallexample
11041 expands to @file{/path/to/top/include}.
11043 @item @code{if-exists}
11044 The @code{if-exists} spec function takes one argument, an absolute
11045 pathname to a file.  If the file exists, @code{if-exists} returns the
11046 pathname.  Here is a small example of its usage:
11048 @smallexample
11049 *startfile:
11050 crt0%O%s %:if-exists(crti%O%s) crtbegin%O%s
11051 @end smallexample
11053 @item @code{if-exists-else}
11054 The @code{if-exists-else} spec function is similar to the @code{if-exists}
11055 spec function, except that it takes two arguments.  The first argument is
11056 an absolute pathname to a file.  If the file exists, @code{if-exists-else}
11057 returns the pathname.  If it does not exist, it returns the second argument.
11058 This way, @code{if-exists-else} can be used to select one file or another,
11059 based on the existence of the first.  Here is a small example of its usage:
11061 @smallexample
11062 *startfile:
11063 crt0%O%s %:if-exists(crti%O%s) \
11064 %:if-exists-else(crtbeginT%O%s crtbegin%O%s)
11065 @end smallexample
11067 @item @code{replace-outfile}
11068 The @code{replace-outfile} spec function takes two arguments.  It looks for the
11069 first argument in the outfiles array and replaces it with the second argument.  Here
11070 is a small example of its usage:
11072 @smallexample
11073 %@{fgnu-runtime:%:replace-outfile(-lobjc -lobjc-gnu)@}
11074 @end smallexample
11076 @item @code{remove-outfile}
11077 The @code{remove-outfile} spec function takes one argument.  It looks for the
11078 first argument in the outfiles array and removes it.  Here is a small example
11079 its usage:
11081 @smallexample
11082 %:remove-outfile(-lm)
11083 @end smallexample
11085 @item @code{pass-through-libs}
11086 The @code{pass-through-libs} spec function takes any number of arguments.  It
11087 finds any @option{-l} options and any non-options ending in @file{.a} (which it
11088 assumes are the names of linker input library archive files) and returns a
11089 result containing all the found arguments each prepended by
11090 @option{-plugin-opt=-pass-through=} and joined by spaces.  This list is
11091 intended to be passed to the LTO linker plugin.
11093 @smallexample
11094 %:pass-through-libs(%G %L %G)
11095 @end smallexample
11097 @item @code{print-asm-header}
11098 The @code{print-asm-header} function takes no arguments and simply
11099 prints a banner like:
11101 @smallexample
11102 Assembler options
11103 =================
11105 Use "-Wa,OPTION" to pass "OPTION" to the assembler.
11106 @end smallexample
11108 It is used to separate compiler options from assembler options
11109 in the @option{--target-help} output.
11110 @end table
11112 @item %@{@code{S}@}
11113 Substitutes the @code{-S} switch, if that switch is given to GCC@.
11114 If that switch is not specified, this substitutes nothing.  Note that
11115 the leading dash is omitted when specifying this option, and it is
11116 automatically inserted if the substitution is performed.  Thus the spec
11117 string @samp{%@{foo@}} matches the command-line option @option{-foo}
11118 and outputs the command-line option @option{-foo}.
11120 @item %W@{@code{S}@}
11121 Like %@{@code{S}@} but mark last argument supplied within as a file to be
11122 deleted on failure.
11124 @item %@{@code{S}*@}
11125 Substitutes all the switches specified to GCC whose names start
11126 with @code{-S}, but which also take an argument.  This is used for
11127 switches like @option{-o}, @option{-D}, @option{-I}, etc.
11128 GCC considers @option{-o foo} as being
11129 one switch whose name starts with @samp{o}.  %@{o*@} substitutes this
11130 text, including the space.  Thus two arguments are generated.
11132 @item %@{@code{S}*&@code{T}*@}
11133 Like %@{@code{S}*@}, but preserve order of @code{S} and @code{T} options
11134 (the order of @code{S} and @code{T} in the spec is not significant).
11135 There can be any number of ampersand-separated variables; for each the
11136 wild card is optional.  Useful for CPP as @samp{%@{D*&U*&A*@}}.
11138 @item %@{@code{S}:@code{X}@}
11139 Substitutes @code{X}, if the @option{-S} switch is given to GCC@.
11141 @item %@{!@code{S}:@code{X}@}
11142 Substitutes @code{X}, if the @option{-S} switch is @emph{not} given to GCC@.
11144 @item %@{@code{S}*:@code{X}@}
11145 Substitutes @code{X} if one or more switches whose names start with
11146 @code{-S} are specified to GCC@.  Normally @code{X} is substituted only
11147 once, no matter how many such switches appeared.  However, if @code{%*}
11148 appears somewhere in @code{X}, then @code{X} is substituted once
11149 for each matching switch, with the @code{%*} replaced by the part of
11150 that switch matching the @code{*}.
11152 If @code{%*} appears as the last part of a spec sequence then a space
11153 will be added after the end of the last substitution.  If there is more
11154 text in the sequence however then a space will not be generated.  This
11155 allows the @code{%*} substitution to be used as part of a larger
11156 string.  For example, a spec string like this:
11158 @smallexample
11159 %@{mcu=*:--script=%*/memory.ld@}
11160 @end smallexample
11162 when matching an option like @code{-mcu=newchip} will produce:
11164 @smallexample
11165 --script=newchip/memory.ld
11166 @end smallexample
11168 @item %@{.@code{S}:@code{X}@}
11169 Substitutes @code{X}, if processing a file with suffix @code{S}.
11171 @item %@{!.@code{S}:@code{X}@}
11172 Substitutes @code{X}, if @emph{not} processing a file with suffix @code{S}.
11174 @item %@{,@code{S}:@code{X}@}
11175 Substitutes @code{X}, if processing a file for language @code{S}.
11177 @item %@{!,@code{S}:@code{X}@}
11178 Substitutes @code{X}, if not processing a file for language @code{S}.
11180 @item %@{@code{S}|@code{P}:@code{X}@}
11181 Substitutes @code{X} if either @code{-S} or @code{-P} is given to
11182 GCC@.  This may be combined with @samp{!}, @samp{.}, @samp{,}, and
11183 @code{*} sequences as well, although they have a stronger binding than
11184 the @samp{|}.  If @code{%*} appears in @code{X}, all of the
11185 alternatives must be starred, and only the first matching alternative
11186 is substituted.
11188 For example, a spec string like this:
11190 @smallexample
11191 %@{.c:-foo@} %@{!.c:-bar@} %@{.c|d:-baz@} %@{!.c|d:-boggle@}
11192 @end smallexample
11194 @noindent
11195 outputs the following command-line options from the following input
11196 command-line options:
11198 @smallexample
11199 fred.c        -foo -baz
11200 jim.d         -bar -boggle
11201 -d fred.c     -foo -baz -boggle
11202 -d jim.d      -bar -baz -boggle
11203 @end smallexample
11205 @item %@{S:X; T:Y; :D@}
11207 If @code{S} is given to GCC, substitutes @code{X}; else if @code{T} is
11208 given to GCC, substitutes @code{Y}; else substitutes @code{D}.  There can
11209 be as many clauses as you need.  This may be combined with @code{.},
11210 @code{,}, @code{!}, @code{|}, and @code{*} as needed.
11213 @end table
11215 The conditional text @code{X} in a %@{@code{S}:@code{X}@} or similar
11216 construct may contain other nested @samp{%} constructs or spaces, or
11217 even newlines.  They are processed as usual, as described above.
11218 Trailing white space in @code{X} is ignored.  White space may also
11219 appear anywhere on the left side of the colon in these constructs,
11220 except between @code{.} or @code{*} and the corresponding word.
11222 The @option{-O}, @option{-f}, @option{-m}, and @option{-W} switches are
11223 handled specifically in these constructs.  If another value of
11224 @option{-O} or the negated form of a @option{-f}, @option{-m}, or
11225 @option{-W} switch is found later in the command line, the earlier
11226 switch value is ignored, except with @{@code{S}*@} where @code{S} is
11227 just one letter, which passes all matching options.
11229 The character @samp{|} at the beginning of the predicate text is used to
11230 indicate that a command should be piped to the following command, but
11231 only if @option{-pipe} is specified.
11233 It is built into GCC which switches take arguments and which do not.
11234 (You might think it would be useful to generalize this to allow each
11235 compiler's spec to say which switches take arguments.  But this cannot
11236 be done in a consistent fashion.  GCC cannot even decide which input
11237 files have been specified without knowing which switches take arguments,
11238 and it must know which input files to compile in order to tell which
11239 compilers to run).
11241 GCC also knows implicitly that arguments starting in @option{-l} are to be
11242 treated as compiler output files, and passed to the linker in their
11243 proper position among the other output files.
11245 @c man begin OPTIONS
11247 @node Target Options
11248 @section Specifying Target Machine and Compiler Version
11249 @cindex target options
11250 @cindex cross compiling
11251 @cindex specifying machine version
11252 @cindex specifying compiler version and target machine
11253 @cindex compiler version, specifying
11254 @cindex target machine, specifying
11256 The usual way to run GCC is to run the executable called @command{gcc}, or
11257 @command{@var{machine}-gcc} when cross-compiling, or
11258 @command{@var{machine}-gcc-@var{version}} to run a version other than the
11259 one that was installed last.
11261 @node Submodel Options
11262 @section Hardware Models and Configurations
11263 @cindex submodel options
11264 @cindex specifying hardware config
11265 @cindex hardware models and configurations, specifying
11266 @cindex machine dependent options
11268 Each target machine types can have its own
11269 special options, starting with @samp{-m}, to choose among various
11270 hardware models or configurations---for example, 68010 vs 68020,
11271 floating coprocessor or none.  A single installed version of the
11272 compiler can compile for any model or configuration, according to the
11273 options specified.
11275 Some configurations of the compiler also support additional special
11276 options, usually for compatibility with other compilers on the same
11277 platform.
11279 @c This list is ordered alphanumerically by subsection name.
11280 @c It should be the same order and spelling as these options are listed
11281 @c in Machine Dependent Options
11283 @menu
11284 * AArch64 Options::
11285 * Adapteva Epiphany Options::
11286 * ARC Options::
11287 * ARM Options::
11288 * AVR Options::
11289 * Blackfin Options::
11290 * C6X Options::
11291 * CRIS Options::
11292 * CR16 Options::
11293 * Darwin Options::
11294 * DEC Alpha Options::
11295 * FR30 Options::
11296 * FRV Options::
11297 * GNU/Linux Options::
11298 * H8/300 Options::
11299 * HPPA Options::
11300 * i386 and x86-64 Options::
11301 * i386 and x86-64 Windows Options::
11302 * IA-64 Options::
11303 * LM32 Options::
11304 * M32C Options::
11305 * M32R/D Options::
11306 * M680x0 Options::
11307 * MCore Options::
11308 * MeP Options::
11309 * MicroBlaze Options::
11310 * MIPS Options::
11311 * MMIX Options::
11312 * MN10300 Options::
11313 * Moxie Options::
11314 * MSP430 Options::
11315 * NDS32 Options::
11316 * Nios II Options::
11317 * PDP-11 Options::
11318 * picoChip Options::
11319 * PowerPC Options::
11320 * RL78 Options::
11321 * RS/6000 and PowerPC Options::
11322 * RX Options::
11323 * S/390 and zSeries Options::
11324 * Score Options::
11325 * SH Options::
11326 * Solaris 2 Options::
11327 * SPARC Options::
11328 * SPU Options::
11329 * System V Options::
11330 * TILE-Gx Options::
11331 * TILEPro Options::
11332 * V850 Options::
11333 * VAX Options::
11334 * VMS Options::
11335 * VxWorks Options::
11336 * x86-64 Options::
11337 * Xstormy16 Options::
11338 * Xtensa Options::
11339 * zSeries Options::
11340 @end menu
11342 @node AArch64 Options
11343 @subsection AArch64 Options
11344 @cindex AArch64 Options
11346 These options are defined for AArch64 implementations:
11348 @table @gcctabopt
11350 @item -mabi=@var{name}
11351 @opindex mabi
11352 Generate code for the specified data model.  Permissible values
11353 are @samp{ilp32} for SysV-like data model where int, long int and pointer
11354 are 32-bit, and @samp{lp64} for SysV-like data model where int is 32-bit,
11355 but long int and pointer are 64-bit.
11357 The default depends on the specific target configuration.  Note that
11358 the LP64 and ILP32 ABIs are not link-compatible; you must compile your
11359 entire program with the same ABI, and link with a compatible set of libraries.
11361 @item -mbig-endian
11362 @opindex mbig-endian
11363 Generate big-endian code.  This is the default when GCC is configured for an
11364 @samp{aarch64_be-*-*} target.
11366 @item -mgeneral-regs-only
11367 @opindex mgeneral-regs-only
11368 Generate code which uses only the general registers.
11370 @item -mlittle-endian
11371 @opindex mlittle-endian
11372 Generate little-endian code.  This is the default when GCC is configured for an
11373 @samp{aarch64-*-*} but not an @samp{aarch64_be-*-*} target.
11375 @item -mcmodel=tiny
11376 @opindex mcmodel=tiny
11377 Generate code for the tiny code model.  The program and its statically defined
11378 symbols must be within 1GB of each other.  Pointers are 64 bits.  Programs can
11379 be statically or dynamically linked.  This model is not fully implemented and
11380 mostly treated as @samp{small}.
11382 @item -mcmodel=small
11383 @opindex mcmodel=small
11384 Generate code for the small code model.  The program and its statically defined
11385 symbols must be within 4GB of each other.  Pointers are 64 bits.  Programs can
11386 be statically or dynamically linked.  This is the default code model.
11388 @item -mcmodel=large
11389 @opindex mcmodel=large
11390 Generate code for the large code model.  This makes no assumptions about
11391 addresses and sizes of sections.  Pointers are 64 bits.  Programs can be
11392 statically linked only.
11394 @item -mstrict-align
11395 @opindex mstrict-align
11396 Do not assume that unaligned memory references will be handled by the system.
11398 @item -momit-leaf-frame-pointer
11399 @itemx -mno-omit-leaf-frame-pointer
11400 @opindex momit-leaf-frame-pointer
11401 @opindex mno-omit-leaf-frame-pointer
11402 Omit or keep the frame pointer in leaf functions.  The former behaviour is the
11403 default.
11405 @item -mtls-dialect=desc
11406 @opindex mtls-dialect=desc
11407 Use TLS descriptors as the thread-local storage mechanism for dynamic accesses
11408 of TLS variables.  This is the default.
11410 @item -mtls-dialect=traditional
11411 @opindex mtls-dialect=traditional
11412 Use traditional TLS as the thread-local storage mechanism for dynamic accesses
11413 of TLS variables.
11415 @item -march=@var{name}
11416 @opindex march
11417 Specify the name of the target architecture, optionally suffixed by one or
11418 more feature modifiers.  This option has the form
11419 @option{-march=@var{arch}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11420 only permissible value for @var{arch} is @samp{armv8-a}.  The permissible
11421 values for @var{feature} are documented in the sub-section below.
11423 Where conflicting feature modifiers are specified, the right-most feature is
11424 used.
11426 GCC uses this name to determine what kind of instructions it can emit when
11427 generating assembly code.
11429 Where @option{-march} is specified without either of @option{-mtune}
11430 or @option{-mcpu} also being specified, the code will be tuned to perform
11431 well across a range of target processors implementing the target
11432 architecture.
11434 @item -mtune=@var{name}
11435 @opindex mtune
11436 Specify the name of the target processor for which GCC should tune the
11437 performance of the code.  Permissible values for this option are:
11438 @samp{generic}, @samp{cortex-a53}, @samp{cortex-a57}.
11440 Additionally, this option can specify that GCC should tune the performance
11441 of the code for a big.LITTLE system.  The only permissible value is
11442 @samp{cortex-a57.cortex-a53}.
11444 Where none of @option{-mtune=}, @option{-mcpu=} or @option{-march=}
11445 are specified, the code will be tuned to perform well across a range
11446 of target processors.
11448 This option cannot be suffixed by feature modifiers.
11450 @item -mcpu=@var{name}
11451 @opindex mcpu
11452 Specify the name of the target processor, optionally suffixed by one or more
11453 feature modifiers.  This option has the form
11454 @option{-mcpu=@var{cpu}@r{@{}+@r{[}no@r{]}@var{feature}@r{@}*}}, where the
11455 permissible values for @var{cpu} are the same as those available for
11456 @option{-mtune}.
11458 The permissible values for @var{feature} are documented in the sub-section
11459 below.
11461 Where conflicting feature modifiers are specified, the right-most feature is
11462 used.
11464 GCC uses this name to determine what kind of instructions it can emit when
11465 generating assembly code (as if by @option{-march}) and to determine
11466 the target processor for which to tune for performance (as if
11467 by @option{-mtune}).  Where this option is used in conjunction
11468 with @option{-march} or @option{-mtune}, those options take precedence
11469 over the appropriate part of this option.
11470 @end table
11472 @subsubsection @option{-march} and @option{-mcpu} feature modifiers
11473 @cindex @option{-march} feature modifiers
11474 @cindex @option{-mcpu} feature modifiers
11475 Feature modifiers used with @option{-march} and @option{-mcpu} can be one
11476 the following:
11478 @table @samp
11479 @item crc
11480 Enable CRC extension.
11481 @item crypto
11482 Enable Crypto extension.  This implies Advanced SIMD is enabled.
11483 @item fp
11484 Enable floating-point instructions.
11485 @item simd
11486 Enable Advanced SIMD instructions.  This implies floating-point instructions
11487 are enabled.  This is the default for all current possible values for options
11488 @option{-march} and @option{-mcpu=}.
11489 @end table
11491 @node Adapteva Epiphany Options
11492 @subsection Adapteva Epiphany Options
11494 These @samp{-m} options are defined for Adapteva Epiphany:
11496 @table @gcctabopt
11497 @item -mhalf-reg-file
11498 @opindex mhalf-reg-file
11499 Don't allocate any register in the range @code{r32}@dots{}@code{r63}.
11500 That allows code to run on hardware variants that lack these registers.
11502 @item -mprefer-short-insn-regs
11503 @opindex mprefer-short-insn-regs
11504 Preferrentially allocate registers that allow short instruction generation.
11505 This can result in increased instruction count, so this may either reduce or
11506 increase overall code size.
11508 @item -mbranch-cost=@var{num}
11509 @opindex mbranch-cost
11510 Set the cost of branches to roughly @var{num} ``simple'' instructions.
11511 This cost is only a heuristic and is not guaranteed to produce
11512 consistent results across releases.
11514 @item -mcmove
11515 @opindex mcmove
11516 Enable the generation of conditional moves.
11518 @item -mnops=@var{num}
11519 @opindex mnops
11520 Emit @var{num} NOPs before every other generated instruction.
11522 @item -mno-soft-cmpsf
11523 @opindex mno-soft-cmpsf
11524 For single-precision floating-point comparisons, emit an @code{fsub} instruction
11525 and test the flags.  This is faster than a software comparison, but can
11526 get incorrect results in the presence of NaNs, or when two different small
11527 numbers are compared such that their difference is calculated as zero.
11528 The default is @option{-msoft-cmpsf}, which uses slower, but IEEE-compliant,
11529 software comparisons.
11531 @item -mstack-offset=@var{num}
11532 @opindex mstack-offset
11533 Set the offset between the top of the stack and the stack pointer.
11534 E.g., a value of 8 means that the eight bytes in the range @code{sp+0@dots{}sp+7}
11535 can be used by leaf functions without stack allocation.
11536 Values other than @samp{8} or @samp{16} are untested and unlikely to work.
11537 Note also that this option changes the ABI; compiling a program with a
11538 different stack offset than the libraries have been compiled with
11539 generally does not work.
11540 This option can be useful if you want to evaluate if a different stack
11541 offset would give you better code, but to actually use a different stack
11542 offset to build working programs, it is recommended to configure the
11543 toolchain with the appropriate @option{--with-stack-offset=@var{num}} option.
11545 @item -mno-round-nearest
11546 @opindex mno-round-nearest
11547 Make the scheduler assume that the rounding mode has been set to
11548 truncating.  The default is @option{-mround-nearest}.
11550 @item -mlong-calls
11551 @opindex mlong-calls
11552 If not otherwise specified by an attribute, assume all calls might be beyond
11553 the offset range of the @code{b} / @code{bl} instructions, and therefore load the
11554 function address into a register before performing a (otherwise direct) call.
11555 This is the default.
11557 @item -mshort-calls
11558 @opindex short-calls
11559 If not otherwise specified by an attribute, assume all direct calls are
11560 in the range of the @code{b} / @code{bl} instructions, so use these instructions
11561 for direct calls.  The default is @option{-mlong-calls}.
11563 @item -msmall16
11564 @opindex msmall16
11565 Assume addresses can be loaded as 16-bit unsigned values.  This does not
11566 apply to function addresses for which @option{-mlong-calls} semantics
11567 are in effect.
11569 @item -mfp-mode=@var{mode}
11570 @opindex mfp-mode
11571 Set the prevailing mode of the floating-point unit.
11572 This determines the floating-point mode that is provided and expected
11573 at function call and return time.  Making this mode match the mode you
11574 predominantly need at function start can make your programs smaller and
11575 faster by avoiding unnecessary mode switches.
11577 @var{mode} can be set to one the following values:
11579 @table @samp
11580 @item caller
11581 Any mode at function entry is valid, and retained or restored when
11582 the function returns, and when it calls other functions.
11583 This mode is useful for compiling libraries or other compilation units
11584 you might want to incorporate into different programs with different
11585 prevailing FPU modes, and the convenience of being able to use a single
11586 object file outweighs the size and speed overhead for any extra
11587 mode switching that might be needed, compared with what would be needed
11588 with a more specific choice of prevailing FPU mode.
11590 @item truncate
11591 This is the mode used for floating-point calculations with
11592 truncating (i.e.@: round towards zero) rounding mode.  That includes
11593 conversion from floating point to integer.
11595 @item round-nearest
11596 This is the mode used for floating-point calculations with
11597 round-to-nearest-or-even rounding mode.
11599 @item int
11600 This is the mode used to perform integer calculations in the FPU, e.g.@:
11601 integer multiply, or integer multiply-and-accumulate.
11602 @end table
11604 The default is @option{-mfp-mode=caller}
11606 @item -mnosplit-lohi
11607 @itemx -mno-postinc
11608 @itemx -mno-postmodify
11609 @opindex mnosplit-lohi
11610 @opindex mno-postinc
11611 @opindex mno-postmodify
11612 Code generation tweaks that disable, respectively, splitting of 32-bit
11613 loads, generation of post-increment addresses, and generation of
11614 post-modify addresses.  The defaults are @option{msplit-lohi},
11615 @option{-mpost-inc}, and @option{-mpost-modify}.
11617 @item -mnovect-double
11618 @opindex mno-vect-double
11619 Change the preferred SIMD mode to SImode.  The default is
11620 @option{-mvect-double}, which uses DImode as preferred SIMD mode.
11622 @item -max-vect-align=@var{num}
11623 @opindex max-vect-align
11624 The maximum alignment for SIMD vector mode types.
11625 @var{num} may be 4 or 8.  The default is 8.
11626 Note that this is an ABI change, even though many library function
11627 interfaces are unaffected if they don't use SIMD vector modes
11628 in places that affect size and/or alignment of relevant types.
11630 @item -msplit-vecmove-early
11631 @opindex msplit-vecmove-early
11632 Split vector moves into single word moves before reload.  In theory this
11633 can give better register allocation, but so far the reverse seems to be
11634 generally the case.
11636 @item -m1reg-@var{reg}
11637 @opindex m1reg-
11638 Specify a register to hold the constant @minus{}1, which makes loading small negative
11639 constants and certain bitmasks faster.
11640 Allowable values for @var{reg} are @samp{r43} and @samp{r63},
11641 which specify use of that register as a fixed register,
11642 and @samp{none}, which means that no register is used for this
11643 purpose.  The default is @option{-m1reg-none}.
11645 @end table
11647 @node ARC Options
11648 @subsection ARC Options
11649 @cindex ARC options
11651 The following options control the architecture variant for which code
11652 is being compiled:
11654 @c architecture variants
11655 @table @gcctabopt
11657 @item -mbarrel-shifter
11658 @opindex mbarrel-shifter
11659 Generate instructions supported by barrel shifter.  This is the default
11660 unless @samp{-mcpu=ARC601} is in effect.
11662 @item -mcpu=@var{cpu}
11663 @opindex mcpu
11664 Set architecture type, register usage, and instruction scheduling
11665 parameters for @var{cpu}.  There are also shortcut alias options
11666 available for backward compatibility and convenience.  Supported
11667 values for @var{cpu} are
11669 @table @samp
11670 @opindex mA6
11671 @opindex mARC600
11672 @item ARC600
11673 Compile for ARC600.  Aliases: @option{-mA6}, @option{-mARC600}.
11675 @item ARC601
11676 @opindex mARC601
11677 Compile for ARC601.  Alias: @option{-mARC601}.
11679 @item ARC700
11680 @opindex mA7
11681 @opindex mARC700
11682 Compile for ARC700.  Aliases: @option{-mA7}, @option{-mARC700}.
11683 This is the default when configured with @samp{--with-cpu=arc700}@.
11684 @end table
11686 @item -mdpfp
11687 @opindex mdpfp
11688 @itemx -mdpfp-compact
11689 @opindex mdpfp-compact
11690 FPX: Generate Double Precision FPX instructions, tuned for the compact
11691 implementation.
11693 @item -mdpfp-fast
11694 @opindex mdpfp-fast
11695 FPX: Generate Double Precision FPX instructions, tuned for the fast
11696 implementation.
11698 @item -mno-dpfp-lrsr
11699 @opindex mno-dpfp-lrsr
11700 Disable LR and SR instructions from using FPX extension aux registers.
11702 @item -mea
11703 @opindex mea
11704 Generate Extended arithmetic instructions.  Currently only
11705 @code{divaw}, @code{adds}, @code{subs}, and @code{sat16} are
11706 supported.  This is always enabled for @samp{-mcpu=ARC700}.
11708 @item -mno-mpy
11709 @opindex mno-mpy
11710 Do not generate mpy instructions for ARC700.
11712 @item -mmul32x16
11713 @opindex mmul32x16
11714 Generate 32x16 bit multiply and mac instructions.
11716 @item -mmul64
11717 @opindex mmul64
11718 Generate mul64 and mulu64 instructions.  Only valid for @samp{-mcpu=ARC600}.
11720 @item -mnorm
11721 @opindex mnorm
11722 Generate norm instruction.  This is the default if @samp{-mcpu=ARC700}
11723 is in effect.
11725 @item -mspfp
11726 @opindex mspfp
11727 @itemx -mspfp-compact
11728 @opindex mspfp-compact
11729 FPX: Generate Single Precision FPX instructions, tuned for the compact
11730 implementation.
11732 @item -mspfp-fast
11733 @opindex mspfp-fast
11734 FPX: Generate Single Precision FPX instructions, tuned for the fast
11735 implementation.
11737 @item -msimd
11738 @opindex msimd
11739 Enable generation of ARC SIMD instructions via target-specific
11740 builtins.  Only valid for @samp{-mcpu=ARC700}.
11742 @item -msoft-float
11743 @opindex msoft-float
11744 This option ignored; it is provided for compatibility purposes only.
11745 Software floating point code is emitted by default, and this default
11746 can overridden by FPX options; @samp{mspfp}, @samp{mspfp-compact}, or
11747 @samp{mspfp-fast} for single precision, and @samp{mdpfp},
11748 @samp{mdpfp-compact}, or @samp{mdpfp-fast} for double precision.
11750 @item -mswap
11751 @opindex mswap
11752 Generate swap instructions.
11754 @end table
11756 The following options are passed through to the assembler, and also
11757 define preprocessor macro symbols.
11759 @c Flags used by the assembler, but for which we define preprocessor
11760 @c macro symbols as well.
11761 @table @gcctabopt
11762 @item -mdsp-packa
11763 @opindex mdsp-packa
11764 Passed down to the assembler to enable the DSP Pack A extensions.
11765 Also sets the preprocessor symbol @code{__Xdsp_packa}.
11767 @item -mdvbf
11768 @opindex mdvbf
11769 Passed down to the assembler to enable the dual viterbi butterfly
11770 extension.  Also sets the preprocessor symbol @code{__Xdvbf}.
11772 @c ARC700 4.10 extension instruction
11773 @item -mlock
11774 @opindex mlock
11775 Passed down to the assembler to enable the Locked Load/Store
11776 Conditional extension.  Also sets the preprocessor symbol
11777 @code{__Xlock}.
11779 @item -mmac-d16
11780 @opindex mmac-d16
11781 Passed down to the assembler.  Also sets the preprocessor symbol
11782 @code{__Xxmac_d16}.
11784 @item -mmac-24
11785 @opindex mmac-24
11786 Passed down to the assembler.  Also sets the preprocessor symbol
11787 @code{__Xxmac_24}.
11789 @c ARC700 4.10 extension instruction
11790 @item -mrtsc
11791 @opindex mrtsc
11792 Passed down to the assembler to enable the 64-bit Time-Stamp Counter
11793 extension instruction.  Also sets the preprocessor symbol
11794 @code{__Xrtsc}.
11796 @c ARC700 4.10 extension instruction
11797 @item -mswape
11798 @opindex mswape
11799 Passed down to the assembler to enable the swap byte ordering
11800 extension instruction.  Also sets the preprocessor symbol
11801 @code{__Xswape}.
11803 @item -mtelephony
11804 @opindex mtelephony
11805 Passed down to the assembler to enable dual and single operand
11806 instructions for telephony.  Also sets the preprocessor symbol
11807 @code{__Xtelephony}.
11809 @item -mxy
11810 @opindex mxy
11811 Passed down to the assembler to enable the XY Memory extension.  Also
11812 sets the preprocessor symbol @code{__Xxy}.
11814 @end table
11816 The following options control how the assembly code is annotated:
11818 @c Assembly annotation options
11819 @table @gcctabopt
11820 @item -misize
11821 @opindex misize
11822 Annotate assembler instructions with estimated addresses.
11824 @item -mannotate-align
11825 @opindex mannotate-align
11826 Explain what alignment considerations lead to the decision to make an
11827 instruction short or long.
11829 @end table
11831 The following options are passed through to the linker:
11833 @c options passed through to the linker
11834 @table @gcctabopt
11835 @item -marclinux
11836 @opindex marclinux
11837 Passed through to the linker, to specify use of the @code{arclinux} emulation.
11838 This option is enabled by default in tool chains built for
11839 @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets
11840 when profiling is not requested.
11842 @item -marclinux_prof
11843 @opindex marclinux_prof
11844 Passed through to the linker, to specify use of the
11845 @code{arclinux_prof} emulation.  This option is enabled by default in
11846 tool chains built for @w{@code{arc-linux-uclibc}} and
11847 @w{@code{arceb-linux-uclibc}} targets when profiling is requested.
11849 @end table
11851 The following options control the semantics of generated code:
11853 @c semantically relevant code generation options
11854 @table @gcctabopt
11855 @item -mepilogue-cfi
11856 @opindex mepilogue-cfi
11857 Enable generation of call frame information for epilogues.
11859 @item -mno-epilogue-cfi
11860 @opindex mno-epilogue-cfi
11861 Disable generation of call frame information for epilogues.
11863 @item -mlong-calls
11864 @opindex mlong-calls
11865 Generate call insns as register indirect calls, thus providing access
11866 to the full 32-bit address range.
11868 @item -mmedium-calls
11869 @opindex mmedium-calls
11870 Don't use less than 25 bit addressing range for calls, which is the
11871 offset available for an unconditional branch-and-link
11872 instruction.  Conditional execution of function calls is suppressed, to
11873 allow use of the 25-bit range, rather than the 21-bit range with
11874 conditional branch-and-link.  This is the default for tool chains built
11875 for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}} targets.
11877 @item -mno-sdata
11878 @opindex mno-sdata
11879 Do not generate sdata references.  This is the default for tool chains
11880 built for @w{@code{arc-linux-uclibc}} and @w{@code{arceb-linux-uclibc}}
11881 targets.
11883 @item -mucb-mcount
11884 @opindex mucb-mcount
11885 Instrument with mcount calls as used in UCB code.  I.e. do the
11886 counting in the callee, not the caller.  By default ARC instrumentation
11887 counts in the caller.
11889 @item -mvolatile-cache
11890 @opindex mvolatile-cache
11891 Use ordinarily cached memory accesses for volatile references.  This is the
11892 default.
11894 @item -mno-volatile-cache
11895 @opindex mno-volatile-cache
11896 Enable cache bypass for volatile references.
11898 @end table
11900 The following options fine tune code generation:
11901 @c code generation tuning options
11902 @table @gcctabopt
11903 @item -malign-call
11904 @opindex malign-call
11905 Do alignment optimizations for call instructions.
11907 @item -mauto-modify-reg
11908 @opindex mauto-modify-reg
11909 Enable the use of pre/post modify with register displacement.
11911 @item -mbbit-peephole
11912 @opindex mbbit-peephole
11913 Enable bbit peephole2.
11915 @item -mno-brcc
11916 @opindex mno-brcc
11917 This option disables a target-specific pass in @file{arc_reorg} to
11918 generate @code{BRcc} instructions.  It has no effect on @code{BRcc}
11919 generation driven by the combiner pass.
11921 @item -mcase-vector-pcrel
11922 @opindex mcase-vector-pcrel
11923 Use pc-relative switch case tables - this enables case table shortening.
11924 This is the default for @option{-Os}.
11926 @item -mcompact-casesi
11927 @opindex mcompact-casesi
11928 Enable compact casesi pattern.
11929 This is the default for @option{-Os}.
11931 @item -mno-cond-exec
11932 @opindex mno-cond-exec
11933 Disable ARCompact specific pass to generate conditional execution instructions.
11934 Due to delay slot scheduling and interactions between operand numbers,
11935 literal sizes, instruction lengths, and the support for conditional execution,
11936 the target-independent pass to generate conditional execution is often lacking,
11937 so the ARC port has kept a special pass around that tries to find more
11938 conditional execution generating opportunities after register allocation,
11939 branch shortening, and delay slot scheduling have been done.  This pass
11940 generally, but not always, improves performance and code size, at the cost of
11941 extra compilation time, which is why there is an option to switch it off.
11942 If you have a problem with call instructions exceeding their allowable
11943 offset range because they are conditionalized, you should consider using
11944 @option{-mmedium-calls} instead.
11946 @item -mearly-cbranchsi
11947 @opindex mearly-cbranchsi
11948 Enable pre-reload use of the cbranchsi pattern.
11950 @item -mexpand-adddi
11951 @opindex mexpand-adddi
11952 Expand @code{adddi3} and @code{subdi3} at rtl generation time into
11953 @code{add.f}, @code{adc} etc.
11955 @item -mindexed-loads
11956 @opindex mindexed-loads
11957 Enable the use of indexed loads.  This can be problematic because some
11958 optimizers will then assume the that indexed stores exist, which is not
11959 the case.
11961 @item -mlra
11962 @opindex mlra
11963 Enable Local Register Allocation.  This is still experimental for ARC,
11964 so by default the compiler uses standard reload
11965 (i.e. @samp{-mno-lra}).
11967 @item -mlra-priority-none
11968 @opindex mlra-priority-none
11969 Don't indicate any priority for target registers.
11971 @item -mlra-priority-compact
11972 @opindex mlra-priority-compact
11973 Indicate target register priority for r0..r3 / r12..r15.
11975 @item -mlra-priority-noncompact
11976 @opindex mlra-priority-noncompact
11977 Reduce target regsiter priority for r0..r3 / r12..r15.
11979 @item -mno-millicode
11980 @opindex mno-millicode
11981 When optimizing for size (using @option{-Os}), prologues and epilogues
11982 that have to save or restore a large number of registers are often
11983 shortened by using call to a special function in libgcc; this is
11984 referred to as a @emph{millicode} call.  As these calls can pose
11985 performance issues, and/or cause linking issues when linking in a
11986 nonstandard way, this option is provided to turn off millicode call
11987 generation.
11989 @item -mmixed-code
11990 @opindex mmixed-code
11991 Tweak register allocation to help 16-bit instruction generation.
11992 This generally has the effect of decreasing the average instruction size
11993 while increasing the instruction count.
11995 @item -mq-class
11996 @opindex mq-class
11997 Enable 'q' instruction alternatives.
11998 This is the default for @option{-Os}.
12000 @item -mRcq
12001 @opindex mRcq
12002 Enable Rcq constraint handling - most short code generation depends on this.
12003 This is the default.
12005 @item -mRcw
12006 @opindex mRcw
12007 Enable Rcw constraint handling - ccfsm condexec mostly depends on this.
12008 This is the default.
12010 @item -msize-level=@var{level}
12011 @opindex msize-level
12012 Fine-tune size optimization with regards to instruction lengths and alignment.
12013 The recognized values for @var{level} are:
12014 @table @samp
12015 @item 0
12016 No size optimization.  This level is deprecated and treated like @samp{1}.
12018 @item 1
12019 Short instructions are used opportunistically.
12021 @item 2
12022 In addition, alignment of loops and of code after barriers are dropped.
12024 @item 3
12025 In addition, optional data alignment is dropped, and the option @option{Os} is enabled.
12027 @end table
12029 This defaults to @samp{3} when @option{-Os} is in effect.  Otherwise,
12030 the behavior when this is not set is equivalent to level @samp{1}.
12032 @item -mtune=@var{cpu}
12033 @opindex mtune
12034 Set instruction scheduling parameters for @var{cpu}, overriding any implied
12035 by @option{-mcpu=}.
12037 Supported values for @var{cpu} are
12039 @table @samp
12040 @item ARC600
12041 Tune for ARC600 cpu.
12043 @item ARC601
12044 Tune for ARC601 cpu.
12046 @item ARC700
12047 Tune for ARC700 cpu with standard multiplier block.
12049 @item ARC700-xmac
12050 Tune for ARC700 cpu with XMAC block.
12052 @item ARC725D
12053 Tune for ARC725D cpu.
12055 @item ARC750D
12056 Tune for ARC750D cpu.
12058 @end table
12060 @item -mmultcost=@var{num}
12061 @opindex mmultcost
12062 Cost to assume for a multiply instruction, with @samp{4} being equal to a
12063 normal instruction.
12065 @item -munalign-prob-threshold=@var{probability}
12066 @opindex munalign-prob-threshold
12067 Set probability threshold for unaligning branches.
12068 When tuning for @samp{ARC700} and optimizing for speed, branches without
12069 filled delay slot are preferably emitted unaligned and long, unless
12070 profiling indicates that the probability for the branch to be taken
12071 is below @var{probability}.  @xref{Cross-profiling}.
12072 The default is (REG_BR_PROB_BASE/2), i.e.@: 5000.
12074 @end table
12076 The following options are maintained for backward compatibility, but
12077 are now deprecated and will be removed in a future release:
12079 @c Deprecated options
12080 @table @gcctabopt
12082 @item -margonaut
12083 @opindex margonaut
12084 Obsolete FPX.
12086 @item -mbig-endian
12087 @opindex mbig-endian
12088 @itemx -EB
12089 @opindex EB
12090 Compile code for big endian targets.  Use of these options is now
12091 deprecated.  Users wanting big-endian code, should use the
12092 @w{@code{arceb-elf32}} and @w{@code{arceb-linux-uclibc}} targets when
12093 building the tool chain, for which big-endian is the default.
12095 @item -mlittle-endian
12096 @opindex mlittle-endian
12097 @itemx -EL
12098 @opindex EL
12099 Compile code for little endian targets.  Use of these options is now
12100 deprecated.  Users wanting little-endian code should use the
12101 @w{@code{arc-elf32}} and @w{@code{arc-linux-uclibc}} targets when
12102 building the tool chain, for which little-endian is the default.
12104 @item -mbarrel_shifter
12105 @opindex mbarrel_shifter
12106 Replaced by @samp{-mbarrel-shifter}
12108 @item -mdpfp_compact
12109 @opindex mdpfp_compact
12110 Replaced by @samp{-mdpfp-compact}
12112 @item -mdpfp_fast
12113 @opindex mdpfp_fast
12114 Replaced by @samp{-mdpfp-fast}
12116 @item -mdsp_packa
12117 @opindex mdsp_packa
12118 Replaced by @samp{-mdsp-packa}
12120 @item -mEA
12121 @opindex mEA
12122 Replaced by @samp{-mea}
12124 @item -mmac_24
12125 @opindex mmac_24
12126 Replaced by @samp{-mmac-24}
12128 @item -mmac_d16
12129 @opindex mmac_d16
12130 Replaced by @samp{-mmac-d16}
12132 @item -mspfp_compact
12133 @opindex mspfp_compact
12134 Replaced by @samp{-mspfp-compact}
12136 @item -mspfp_fast
12137 @opindex mspfp_fast
12138 Replaced by @samp{-mspfp-fast}
12140 @item -mtune=@var{cpu}
12141 @opindex mtune
12142 Values @samp{arc600}, @samp{arc601}, @samp{arc700} and
12143 @samp{arc700-xmac} for @var{cpu} are replaced by @samp{ARC600},
12144 @samp{ARC601}, @samp{ARC700} and @samp{ARC700-xmac} respectively
12146 @item -multcost=@var{num}
12147 @opindex multcost
12148 Replaced by @samp{-mmultcost}.
12150 @end table
12152 @node ARM Options
12153 @subsection ARM Options
12154 @cindex ARM options
12156 These @samp{-m} options are defined for Advanced RISC Machines (ARM)
12157 architectures:
12159 @table @gcctabopt
12160 @item -mabi=@var{name}
12161 @opindex mabi
12162 Generate code for the specified ABI@.  Permissible values are: @samp{apcs-gnu},
12163 @samp{atpcs}, @samp{aapcs}, @samp{aapcs-linux} and @samp{iwmmxt}.
12165 @item -mapcs-frame
12166 @opindex mapcs-frame
12167 Generate a stack frame that is compliant with the ARM Procedure Call
12168 Standard for all functions, even if this is not strictly necessary for
12169 correct execution of the code.  Specifying @option{-fomit-frame-pointer}
12170 with this option causes the stack frames not to be generated for
12171 leaf functions.  The default is @option{-mno-apcs-frame}.
12173 @item -mapcs
12174 @opindex mapcs
12175 This is a synonym for @option{-mapcs-frame}.
12177 @ignore
12178 @c not currently implemented
12179 @item -mapcs-stack-check
12180 @opindex mapcs-stack-check
12181 Generate code to check the amount of stack space available upon entry to
12182 every function (that actually uses some stack space).  If there is
12183 insufficient space available then either the function
12184 @samp{__rt_stkovf_split_small} or @samp{__rt_stkovf_split_big} is
12185 called, depending upon the amount of stack space required.  The runtime
12186 system is required to provide these functions.  The default is
12187 @option{-mno-apcs-stack-check}, since this produces smaller code.
12189 @c not currently implemented
12190 @item -mapcs-float
12191 @opindex mapcs-float
12192 Pass floating-point arguments using the floating-point registers.  This is
12193 one of the variants of the APCS@.  This option is recommended if the
12194 target hardware has a floating-point unit or if a lot of floating-point
12195 arithmetic is going to be performed by the code.  The default is
12196 @option{-mno-apcs-float}, since the size of integer-only code is 
12197 slightly increased if @option{-mapcs-float} is used.
12199 @c not currently implemented
12200 @item -mapcs-reentrant
12201 @opindex mapcs-reentrant
12202 Generate reentrant, position-independent code.  The default is
12203 @option{-mno-apcs-reentrant}.
12204 @end ignore
12206 @item -mthumb-interwork
12207 @opindex mthumb-interwork
12208 Generate code that supports calling between the ARM and Thumb
12209 instruction sets.  Without this option, on pre-v5 architectures, the
12210 two instruction sets cannot be reliably used inside one program.  The
12211 default is @option{-mno-thumb-interwork}, since slightly larger code
12212 is generated when @option{-mthumb-interwork} is specified.  In AAPCS
12213 configurations this option is meaningless.
12215 @item -mno-sched-prolog
12216 @opindex mno-sched-prolog
12217 Prevent the reordering of instructions in the function prologue, or the
12218 merging of those instruction with the instructions in the function's
12219 body.  This means that all functions start with a recognizable set
12220 of instructions (or in fact one of a choice from a small set of
12221 different function prologues), and this information can be used to
12222 locate the start of functions inside an executable piece of code.  The
12223 default is @option{-msched-prolog}.
12225 @item -mfloat-abi=@var{name}
12226 @opindex mfloat-abi
12227 Specifies which floating-point ABI to use.  Permissible values
12228 are: @samp{soft}, @samp{softfp} and @samp{hard}.
12230 Specifying @samp{soft} causes GCC to generate output containing
12231 library calls for floating-point operations.
12232 @samp{softfp} allows the generation of code using hardware floating-point
12233 instructions, but still uses the soft-float calling conventions.
12234 @samp{hard} allows generation of floating-point instructions
12235 and uses FPU-specific calling conventions.
12237 The default depends on the specific target configuration.  Note that
12238 the hard-float and soft-float ABIs are not link-compatible; you must
12239 compile your entire program with the same ABI, and link with a
12240 compatible set of libraries.
12242 @item -mlittle-endian
12243 @opindex mlittle-endian
12244 Generate code for a processor running in little-endian mode.  This is
12245 the default for all standard configurations.
12247 @item -mbig-endian
12248 @opindex mbig-endian
12249 Generate code for a processor running in big-endian mode; the default is
12250 to compile code for a little-endian processor.
12252 @item -mwords-little-endian
12253 @opindex mwords-little-endian
12254 This option only applies when generating code for big-endian processors.
12255 Generate code for a little-endian word order but a big-endian byte
12256 order.  That is, a byte order of the form @samp{32107654}.  Note: this
12257 option should only be used if you require compatibility with code for
12258 big-endian ARM processors generated by versions of the compiler prior to
12259 2.8.  This option is now deprecated.
12261 @item -march=@var{name}
12262 @opindex march
12263 This specifies the name of the target ARM architecture.  GCC uses this
12264 name to determine what kind of instructions it can emit when generating
12265 assembly code.  This option can be used in conjunction with or instead
12266 of the @option{-mcpu=} option.  Permissible names are: @samp{armv2},
12267 @samp{armv2a}, @samp{armv3}, @samp{armv3m}, @samp{armv4}, @samp{armv4t},
12268 @samp{armv5}, @samp{armv5t}, @samp{armv5e}, @samp{armv5te},
12269 @samp{armv6}, @samp{armv6j},
12270 @samp{armv6t2}, @samp{armv6z}, @samp{armv6zk}, @samp{armv6-m},
12271 @samp{armv7}, @samp{armv7-a}, @samp{armv7-r}, @samp{armv7-m}, @samp{armv7e-m},
12272 @samp{armv7ve}, @samp{armv8-a}, @samp{armv8-a+crc},
12273 @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312}.
12275 @option{-march=armv7ve} is the armv7-a architecture with virtualization
12276 extensions.
12278 @option{-march=armv8-a+crc} enables code generation for the ARMv8-A
12279 architecture together with the optional CRC32 extensions.
12281 @option{-march=native} causes the compiler to auto-detect the architecture
12282 of the build computer.  At present, this feature is only supported on
12283 Linux, and not all architectures are recognized.  If the auto-detect is
12284 unsuccessful the option has no effect.
12286 @item -mtune=@var{name}
12287 @opindex mtune
12288 This option specifies the name of the target ARM processor for
12289 which GCC should tune the performance of the code.
12290 For some ARM implementations better performance can be obtained by using
12291 this option.
12292 Permissible names are: @samp{arm2}, @samp{arm250},
12293 @samp{arm3}, @samp{arm6}, @samp{arm60}, @samp{arm600}, @samp{arm610},
12294 @samp{arm620}, @samp{arm7}, @samp{arm7m}, @samp{arm7d}, @samp{arm7dm},
12295 @samp{arm7di}, @samp{arm7dmi}, @samp{arm70}, @samp{arm700},
12296 @samp{arm700i}, @samp{arm710}, @samp{arm710c}, @samp{arm7100},
12297 @samp{arm720},
12298 @samp{arm7500}, @samp{arm7500fe}, @samp{arm7tdmi}, @samp{arm7tdmi-s},
12299 @samp{arm710t}, @samp{arm720t}, @samp{arm740t},
12300 @samp{strongarm}, @samp{strongarm110}, @samp{strongarm1100},
12301 @samp{strongarm1110},
12302 @samp{arm8}, @samp{arm810}, @samp{arm9}, @samp{arm9e}, @samp{arm920},
12303 @samp{arm920t}, @samp{arm922t}, @samp{arm946e-s}, @samp{arm966e-s},
12304 @samp{arm968e-s}, @samp{arm926ej-s}, @samp{arm940t}, @samp{arm9tdmi},
12305 @samp{arm10tdmi}, @samp{arm1020t}, @samp{arm1026ej-s},
12306 @samp{arm10e}, @samp{arm1020e}, @samp{arm1022e},
12307 @samp{arm1136j-s}, @samp{arm1136jf-s}, @samp{mpcore}, @samp{mpcorenovfp},
12308 @samp{arm1156t2-s}, @samp{arm1156t2f-s}, @samp{arm1176jz-s}, @samp{arm1176jzf-s},
12309 @samp{cortex-a5}, @samp{cortex-a7}, @samp{cortex-a8}, @samp{cortex-a9},
12310 @samp{cortex-a12}, @samp{cortex-a15}, @samp{cortex-a53}, @samp{cortex-a57},
12311 @samp{cortex-r4},
12312 @samp{cortex-r4f}, @samp{cortex-r5}, @samp{cortex-r7}, @samp{cortex-m4},
12313 @samp{cortex-m3},
12314 @samp{cortex-m1},
12315 @samp{cortex-m0},
12316 @samp{cortex-m0plus},
12317 @samp{marvell-pj4},
12318 @samp{xscale}, @samp{iwmmxt}, @samp{iwmmxt2}, @samp{ep9312},
12319 @samp{fa526}, @samp{fa626},
12320 @samp{fa606te}, @samp{fa626te}, @samp{fmp626}, @samp{fa726te}.
12322 Additionally, this option can specify that GCC should tune the performance
12323 of the code for a big.LITTLE system.  Permissible names are:
12324 @samp{cortex-a15.cortex-a7}, @samp{cortex-a57.cortex-a53}.
12326 @option{-mtune=generic-@var{arch}} specifies that GCC should tune the
12327 performance for a blend of processors within architecture @var{arch}.
12328 The aim is to generate code that run well on the current most popular
12329 processors, balancing between optimizations that benefit some CPUs in the
12330 range, and avoiding performance pitfalls of other CPUs.  The effects of
12331 this option may change in future GCC versions as CPU models come and go.
12333 @option{-mtune=native} causes the compiler to auto-detect the CPU
12334 of the build computer.  At present, this feature is only supported on
12335 Linux, and not all architectures are recognized.  If the auto-detect is
12336 unsuccessful the option has no effect.
12338 @item -mcpu=@var{name}
12339 @opindex mcpu
12340 This specifies the name of the target ARM processor.  GCC uses this name
12341 to derive the name of the target ARM architecture (as if specified
12342 by @option{-march}) and the ARM processor type for which to tune for
12343 performance (as if specified by @option{-mtune}).  Where this option
12344 is used in conjunction with @option{-march} or @option{-mtune},
12345 those options take precedence over the appropriate part of this option.
12347 Permissible names for this option are the same as those for
12348 @option{-mtune}.
12350 @option{-mcpu=generic-@var{arch}} is also permissible, and is
12351 equivalent to @option{-march=@var{arch} -mtune=generic-@var{arch}}.
12352 See @option{-mtune} for more information.
12354 @option{-mcpu=native} causes the compiler to auto-detect the CPU
12355 of the build computer.  At present, this feature is only supported on
12356 Linux, and not all architectures are recognized.  If the auto-detect is
12357 unsuccessful the option has no effect.
12359 @item -mfpu=@var{name}
12360 @opindex mfpu
12361 This specifies what floating-point hardware (or hardware emulation) is
12362 available on the target.  Permissible names are: @samp{vfp}, @samp{vfpv3},
12363 @samp{vfpv3-fp16}, @samp{vfpv3-d16}, @samp{vfpv3-d16-fp16}, @samp{vfpv3xd},
12364 @samp{vfpv3xd-fp16}, @samp{neon}, @samp{neon-fp16}, @samp{vfpv4},
12365 @samp{vfpv4-d16}, @samp{fpv4-sp-d16}, @samp{neon-vfpv4},
12366 @samp{fp-armv8}, @samp{neon-fp-armv8}, and @samp{crypto-neon-fp-armv8}.
12368 If @option{-msoft-float} is specified this specifies the format of
12369 floating-point values.
12371 If the selected floating-point hardware includes the NEON extension
12372 (e.g. @option{-mfpu}=@samp{neon}), note that floating-point
12373 operations are not generated by GCC's auto-vectorization pass unless
12374 @option{-funsafe-math-optimizations} is also specified.  This is
12375 because NEON hardware does not fully implement the IEEE 754 standard for
12376 floating-point arithmetic (in particular denormal values are treated as
12377 zero), so the use of NEON instructions may lead to a loss of precision.
12379 @item -mfp16-format=@var{name}
12380 @opindex mfp16-format
12381 Specify the format of the @code{__fp16} half-precision floating-point type.
12382 Permissible names are @samp{none}, @samp{ieee}, and @samp{alternative};
12383 the default is @samp{none}, in which case the @code{__fp16} type is not
12384 defined.  @xref{Half-Precision}, for more information.
12386 @item -mstructure-size-boundary=@var{n}
12387 @opindex mstructure-size-boundary
12388 The sizes of all structures and unions are rounded up to a multiple
12389 of the number of bits set by this option.  Permissible values are 8, 32
12390 and 64.  The default value varies for different toolchains.  For the COFF
12391 targeted toolchain the default value is 8.  A value of 64 is only allowed
12392 if the underlying ABI supports it.
12394 Specifying a larger number can produce faster, more efficient code, but
12395 can also increase the size of the program.  Different values are potentially
12396 incompatible.  Code compiled with one value cannot necessarily expect to
12397 work with code or libraries compiled with another value, if they exchange
12398 information using structures or unions.
12400 @item -mabort-on-noreturn
12401 @opindex mabort-on-noreturn
12402 Generate a call to the function @code{abort} at the end of a
12403 @code{noreturn} function.  It is executed if the function tries to
12404 return.
12406 @item -mlong-calls
12407 @itemx -mno-long-calls
12408 @opindex mlong-calls
12409 @opindex mno-long-calls
12410 Tells the compiler to perform function calls by first loading the
12411 address of the function into a register and then performing a subroutine
12412 call on this register.  This switch is needed if the target function
12413 lies outside of the 64-megabyte addressing range of the offset-based
12414 version of subroutine call instruction.
12416 Even if this switch is enabled, not all function calls are turned
12417 into long calls.  The heuristic is that static functions, functions
12418 that have the @samp{short-call} attribute, functions that are inside
12419 the scope of a @samp{#pragma no_long_calls} directive, and functions whose
12420 definitions have already been compiled within the current compilation
12421 unit are not turned into long calls.  The exceptions to this rule are
12422 that weak function definitions, functions with the @samp{long-call}
12423 attribute or the @samp{section} attribute, and functions that are within
12424 the scope of a @samp{#pragma long_calls} directive are always
12425 turned into long calls.
12427 This feature is not enabled by default.  Specifying
12428 @option{-mno-long-calls} restores the default behavior, as does
12429 placing the function calls within the scope of a @samp{#pragma
12430 long_calls_off} directive.  Note these switches have no effect on how
12431 the compiler generates code to handle function calls via function
12432 pointers.
12434 @item -msingle-pic-base
12435 @opindex msingle-pic-base
12436 Treat the register used for PIC addressing as read-only, rather than
12437 loading it in the prologue for each function.  The runtime system is
12438 responsible for initializing this register with an appropriate value
12439 before execution begins.
12441 @item -mpic-register=@var{reg}
12442 @opindex mpic-register
12443 Specify the register to be used for PIC addressing.
12444 For standard PIC base case, the default will be any suitable register
12445 determined by compiler.  For single PIC base case, the default is
12446 @samp{R9} if target is EABI based or stack-checking is enabled,
12447 otherwise the default is @samp{R10}.
12449 @item -mpic-data-is-text-relative
12450 @opindex mpic-data-is-text-relative
12451 Assume that each data segments are relative to text segment at load time.
12452 Therefore, it permits addressing data using PC-relative operations.
12453 This option is on by default for targets other than VxWorks RTP.
12455 @item -mpoke-function-name
12456 @opindex mpoke-function-name
12457 Write the name of each function into the text section, directly
12458 preceding the function prologue.  The generated code is similar to this:
12460 @smallexample
12461      t0
12462          .ascii "arm_poke_function_name", 0
12463          .align
12464      t1
12465          .word 0xff000000 + (t1 - t0)
12466      arm_poke_function_name
12467          mov     ip, sp
12468          stmfd   sp!, @{fp, ip, lr, pc@}
12469          sub     fp, ip, #4
12470 @end smallexample
12472 When performing a stack backtrace, code can inspect the value of
12473 @code{pc} stored at @code{fp + 0}.  If the trace function then looks at
12474 location @code{pc - 12} and the top 8 bits are set, then we know that
12475 there is a function name embedded immediately preceding this location
12476 and has length @code{((pc[-3]) & 0xff000000)}.
12478 @item -mthumb
12479 @itemx -marm
12480 @opindex marm
12481 @opindex mthumb
12483 Select between generating code that executes in ARM and Thumb
12484 states.  The default for most configurations is to generate code
12485 that executes in ARM state, but the default can be changed by
12486 configuring GCC with the @option{--with-mode=}@var{state}
12487 configure option.
12489 @item -mtpcs-frame
12490 @opindex mtpcs-frame
12491 Generate a stack frame that is compliant with the Thumb Procedure Call
12492 Standard for all non-leaf functions.  (A leaf function is one that does
12493 not call any other functions.)  The default is @option{-mno-tpcs-frame}.
12495 @item -mtpcs-leaf-frame
12496 @opindex mtpcs-leaf-frame
12497 Generate a stack frame that is compliant with the Thumb Procedure Call
12498 Standard for all leaf functions.  (A leaf function is one that does
12499 not call any other functions.)  The default is @option{-mno-apcs-leaf-frame}.
12501 @item -mcallee-super-interworking
12502 @opindex mcallee-super-interworking
12503 Gives all externally visible functions in the file being compiled an ARM
12504 instruction set header which switches to Thumb mode before executing the
12505 rest of the function.  This allows these functions to be called from
12506 non-interworking code.  This option is not valid in AAPCS configurations
12507 because interworking is enabled by default.
12509 @item -mcaller-super-interworking
12510 @opindex mcaller-super-interworking
12511 Allows calls via function pointers (including virtual functions) to
12512 execute correctly regardless of whether the target code has been
12513 compiled for interworking or not.  There is a small overhead in the cost
12514 of executing a function pointer if this option is enabled.  This option
12515 is not valid in AAPCS configurations because interworking is enabled
12516 by default.
12518 @item -mtp=@var{name}
12519 @opindex mtp
12520 Specify the access model for the thread local storage pointer.  The valid
12521 models are @option{soft}, which generates calls to @code{__aeabi_read_tp},
12522 @option{cp15}, which fetches the thread pointer from @code{cp15} directly
12523 (supported in the arm6k architecture), and @option{auto}, which uses the
12524 best available method for the selected processor.  The default setting is
12525 @option{auto}.
12527 @item -mtls-dialect=@var{dialect}
12528 @opindex mtls-dialect
12529 Specify the dialect to use for accessing thread local storage.  Two
12530 @var{dialect}s are supported---@samp{gnu} and @samp{gnu2}.  The
12531 @samp{gnu} dialect selects the original GNU scheme for supporting
12532 local and global dynamic TLS models.  The @samp{gnu2} dialect
12533 selects the GNU descriptor scheme, which provides better performance
12534 for shared libraries.  The GNU descriptor scheme is compatible with
12535 the original scheme, but does require new assembler, linker and
12536 library support.  Initial and local exec TLS models are unaffected by
12537 this option and always use the original scheme.
12539 @item -mword-relocations
12540 @opindex mword-relocations
12541 Only generate absolute relocations on word-sized values (i.e. R_ARM_ABS32).
12542 This is enabled by default on targets (uClinux, SymbianOS) where the runtime
12543 loader imposes this restriction, and when @option{-fpic} or @option{-fPIC}
12544 is specified.
12546 @item -mfix-cortex-m3-ldrd
12547 @opindex mfix-cortex-m3-ldrd
12548 Some Cortex-M3 cores can cause data corruption when @code{ldrd} instructions
12549 with overlapping destination and base registers are used.  This option avoids
12550 generating these instructions.  This option is enabled by default when
12551 @option{-mcpu=cortex-m3} is specified.
12553 @item -munaligned-access
12554 @itemx -mno-unaligned-access
12555 @opindex munaligned-access
12556 @opindex mno-unaligned-access
12557 Enables (or disables) reading and writing of 16- and 32- bit values
12558 from addresses that are not 16- or 32- bit aligned.  By default
12559 unaligned access is disabled for all pre-ARMv6 and all ARMv6-M
12560 architectures, and enabled for all other architectures.  If unaligned
12561 access is not enabled then words in packed data structures will be
12562 accessed a byte at a time.
12564 The ARM attribute @code{Tag_CPU_unaligned_access} will be set in the
12565 generated object file to either true or false, depending upon the
12566 setting of this option.  If unaligned access is enabled then the
12567 preprocessor symbol @code{__ARM_FEATURE_UNALIGNED} will also be
12568 defined.
12570 @item -mneon-for-64bits
12571 @opindex mneon-for-64bits
12572 Enables using Neon to handle scalar 64-bits operations. This is
12573 disabled by default since the cost of moving data from core registers
12574 to Neon is high.
12576 @item -mslow-flash-data
12577 @opindex mslow-flash-data
12578 Assume loading data from flash is slower than fetching instruction.
12579 Therefore literal load is minimized for better performance.
12580 This option is only supported when compiling for ARMv7 M-profile and
12581 off by default.
12583 @item -mrestrict-it
12584 @opindex mrestrict-it
12585 Restricts generation of IT blocks to conform to the rules of ARMv8.
12586 IT blocks can only contain a single 16-bit instruction from a select
12587 set of instructions. This option is on by default for ARMv8 Thumb mode.
12588 @end table
12590 @node AVR Options
12591 @subsection AVR Options
12592 @cindex AVR Options
12594 These options are defined for AVR implementations:
12596 @table @gcctabopt
12597 @item -mmcu=@var{mcu}
12598 @opindex mmcu
12599 Specify Atmel AVR instruction set architectures (ISA) or MCU type.
12601 The default for this option is@tie{}@code{avr2}.
12603 GCC supports the following AVR devices and ISAs:
12605 @include avr-mmcu.texi
12607 @item -maccumulate-args
12608 @opindex maccumulate-args
12609 Accumulate outgoing function arguments and acquire/release the needed
12610 stack space for outgoing function arguments once in function
12611 prologue/epilogue.  Without this option, outgoing arguments are pushed
12612 before calling a function and popped afterwards.
12614 Popping the arguments after the function call can be expensive on
12615 AVR so that accumulating the stack space might lead to smaller
12616 executables because arguments need not to be removed from the
12617 stack after such a function call.
12619 This option can lead to reduced code size for functions that perform
12620 several calls to functions that get their arguments on the stack like
12621 calls to printf-like functions.
12623 @item -mbranch-cost=@var{cost}
12624 @opindex mbranch-cost
12625 Set the branch costs for conditional branch instructions to
12626 @var{cost}.  Reasonable values for @var{cost} are small, non-negative
12627 integers. The default branch cost is 0.
12629 @item -mcall-prologues
12630 @opindex mcall-prologues
12631 Functions prologues/epilogues are expanded as calls to appropriate
12632 subroutines.  Code size is smaller.
12634 @item -mint8
12635 @opindex mint8
12636 Assume @code{int} to be 8-bit integer.  This affects the sizes of all types: a
12637 @code{char} is 1 byte, an @code{int} is 1 byte, a @code{long} is 2 bytes,
12638 and @code{long long} is 4 bytes.  Please note that this option does not
12639 conform to the C standards, but it results in smaller code
12640 size.
12642 @item -mno-interrupts
12643 @opindex mno-interrupts
12644 Generated code is not compatible with hardware interrupts.
12645 Code size is smaller.
12647 @item -mrelax
12648 @opindex mrelax
12649 Try to replace @code{CALL} resp.@: @code{JMP} instruction by the shorter
12650 @code{RCALL} resp.@: @code{RJMP} instruction if applicable.
12651 Setting @code{-mrelax} just adds the @code{--relax} option to the
12652 linker command line when the linker is called.
12654 Jump relaxing is performed by the linker because jump offsets are not
12655 known before code is located. Therefore, the assembler code generated by the
12656 compiler is the same, but the instructions in the executable may
12657 differ from instructions in the assembler code.
12659 Relaxing must be turned on if linker stubs are needed, see the
12660 section on @code{EIND} and linker stubs below.
12662 @item -msp8
12663 @opindex msp8
12664 Treat the stack pointer register as an 8-bit register,
12665 i.e.@: assume the high byte of the stack pointer is zero.
12666 In general, you don't need to set this option by hand.
12668 This option is used internally by the compiler to select and
12669 build multilibs for architectures @code{avr2} and @code{avr25}.
12670 These architectures mix devices with and without @code{SPH}.
12671 For any setting other than @code{-mmcu=avr2} or @code{-mmcu=avr25}
12672 the compiler driver will add or remove this option from the compiler
12673 proper's command line, because the compiler then knows if the device
12674 or architecture has an 8-bit stack pointer and thus no @code{SPH}
12675 register or not.
12677 @item -mstrict-X
12678 @opindex mstrict-X
12679 Use address register @code{X} in a way proposed by the hardware.  This means
12680 that @code{X} is only used in indirect, post-increment or
12681 pre-decrement addressing.
12683 Without this option, the @code{X} register may be used in the same way
12684 as @code{Y} or @code{Z} which then is emulated by additional
12685 instructions.  
12686 For example, loading a value with @code{X+const} addressing with a
12687 small non-negative @code{const < 64} to a register @var{Rn} is
12688 performed as
12690 @example
12691 adiw r26, const   ; X += const
12692 ld   @var{Rn}, X        ; @var{Rn} = *X
12693 sbiw r26, const   ; X -= const
12694 @end example
12696 @item -mtiny-stack
12697 @opindex mtiny-stack
12698 Only change the lower 8@tie{}bits of the stack pointer.
12700 @item -Waddr-space-convert
12701 @opindex Waddr-space-convert
12702 Warn about conversions between address spaces in the case where the
12703 resulting address space is not contained in the incoming address space.
12704 @end table
12706 @subsubsection @code{EIND} and Devices with more than 128 Ki Bytes of Flash
12707 @cindex @code{EIND}
12708 Pointers in the implementation are 16@tie{}bits wide.
12709 The address of a function or label is represented as word address so
12710 that indirect jumps and calls can target any code address in the
12711 range of 64@tie{}Ki words.
12713 In order to facilitate indirect jump on devices with more than 128@tie{}Ki
12714 bytes of program memory space, there is a special function register called
12715 @code{EIND} that serves as most significant part of the target address
12716 when @code{EICALL} or @code{EIJMP} instructions are used.
12718 Indirect jumps and calls on these devices are handled as follows by
12719 the compiler and are subject to some limitations:
12721 @itemize @bullet
12723 @item
12724 The compiler never sets @code{EIND}.
12726 @item
12727 The compiler uses @code{EIND} implicitely in @code{EICALL}/@code{EIJMP}
12728 instructions or might read @code{EIND} directly in order to emulate an
12729 indirect call/jump by means of a @code{RET} instruction.
12731 @item
12732 The compiler assumes that @code{EIND} never changes during the startup
12733 code or during the application. In particular, @code{EIND} is not
12734 saved/restored in function or interrupt service routine
12735 prologue/epilogue.
12737 @item
12738 For indirect calls to functions and computed goto, the linker
12739 generates @emph{stubs}. Stubs are jump pads sometimes also called
12740 @emph{trampolines}. Thus, the indirect call/jump jumps to such a stub.
12741 The stub contains a direct jump to the desired address.
12743 @item
12744 Linker relaxation must be turned on so that the linker will generate
12745 the stubs correctly an all situaltion. See the compiler option
12746 @code{-mrelax} and the linler option @code{--relax}.
12747 There are corner cases where the linker is supposed to generate stubs
12748 but aborts without relaxation and without a helpful error message.
12750 @item
12751 The default linker script is arranged for code with @code{EIND = 0}.
12752 If code is supposed to work for a setup with @code{EIND != 0}, a custom
12753 linker script has to be used in order to place the sections whose
12754 name start with @code{.trampolines} into the segment where @code{EIND}
12755 points to.
12757 @item
12758 The startup code from libgcc never sets @code{EIND}.
12759 Notice that startup code is a blend of code from libgcc and AVR-LibC.
12760 For the impact of AVR-LibC on @code{EIND}, see the
12761 @w{@uref{http://nongnu.org/avr-libc/user-manual/,AVR-LibC user manual}}.
12763 @item
12764 It is legitimate for user-specific startup code to set up @code{EIND}
12765 early, for example by means of initialization code located in
12766 section @code{.init3}. Such code runs prior to general startup code
12767 that initializes RAM and calls constructors, but after the bit
12768 of startup code from AVR-LibC that sets @code{EIND} to the segment
12769 where the vector table is located.
12770 @example
12771 #include <avr/io.h>
12773 static void
12774 __attribute__((section(".init3"),naked,used,no_instrument_function))
12775 init3_set_eind (void)
12777   __asm volatile ("ldi r24,pm_hh8(__trampolines_start)\n\t"
12778                   "out %i0,r24" :: "n" (&EIND) : "r24","memory");
12780 @end example
12782 @noindent
12783 The @code{__trampolines_start} symbol is defined in the linker script.
12785 @item
12786 Stubs are generated automatically by the linker if
12787 the following two conditions are met:
12788 @itemize @minus
12790 @item The address of a label is taken by means of the @code{gs} modifier
12791 (short for @emph{generate stubs}) like so:
12792 @example
12793 LDI r24, lo8(gs(@var{func}))
12794 LDI r25, hi8(gs(@var{func}))
12795 @end example
12796 @item The final location of that label is in a code segment
12797 @emph{outside} the segment where the stubs are located.
12798 @end itemize
12800 @item
12801 The compiler emits such @code{gs} modifiers for code labels in the
12802 following situations:
12803 @itemize @minus
12804 @item Taking address of a function or code label.
12805 @item Computed goto.
12806 @item If prologue-save function is used, see @option{-mcall-prologues}
12807 command-line option.
12808 @item Switch/case dispatch tables. If you do not want such dispatch
12809 tables you can specify the @option{-fno-jump-tables} command-line option.
12810 @item C and C++ constructors/destructors called during startup/shutdown.
12811 @item If the tools hit a @code{gs()} modifier explained above.
12812 @end itemize
12814 @item
12815 Jumping to non-symbolic addresses like so is @emph{not} supported:
12817 @example
12818 int main (void)
12820     /* Call function at word address 0x2 */
12821     return ((int(*)(void)) 0x2)();
12823 @end example
12825 Instead, a stub has to be set up, i.e.@: the function has to be called
12826 through a symbol (@code{func_4} in the example):
12828 @example
12829 int main (void)
12831     extern int func_4 (void);
12833     /* Call function at byte address 0x4 */
12834     return func_4();
12836 @end example
12838 and the application be linked with @code{-Wl,--defsym,func_4=0x4}.
12839 Alternatively, @code{func_4} can be defined in the linker script.
12840 @end itemize
12842 @subsubsection Handling of the @code{RAMPD}, @code{RAMPX}, @code{RAMPY} and @code{RAMPZ} Special Function Registers
12843 @cindex @code{RAMPD}
12844 @cindex @code{RAMPX}
12845 @cindex @code{RAMPY}
12846 @cindex @code{RAMPZ}
12847 Some AVR devices support memories larger than the 64@tie{}KiB range
12848 that can be accessed with 16-bit pointers.  To access memory locations
12849 outside this 64@tie{}KiB range, the contentent of a @code{RAMP}
12850 register is used as high part of the address:
12851 The @code{X}, @code{Y}, @code{Z} address register is concatenated
12852 with the @code{RAMPX}, @code{RAMPY}, @code{RAMPZ} special function
12853 register, respectively, to get a wide address. Similarly,
12854 @code{RAMPD} is used together with direct addressing.
12856 @itemize
12857 @item
12858 The startup code initializes the @code{RAMP} special function
12859 registers with zero.
12861 @item
12862 If a @ref{AVR Named Address Spaces,named address space} other than
12863 generic or @code{__flash} is used, then @code{RAMPZ} is set
12864 as needed before the operation.
12866 @item
12867 If the device supports RAM larger than 64@tie{}KiB and the compiler
12868 needs to change @code{RAMPZ} to accomplish an operation, @code{RAMPZ}
12869 is reset to zero after the operation.
12871 @item
12872 If the device comes with a specific @code{RAMP} register, the ISR
12873 prologue/epilogue saves/restores that SFR and initializes it with
12874 zero in case the ISR code might (implicitly) use it.
12876 @item
12877 RAM larger than 64@tie{}KiB is not supported by GCC for AVR targets.
12878 If you use inline assembler to read from locations outside the
12879 16-bit address range and change one of the @code{RAMP} registers,
12880 you must reset it to zero after the access.
12882 @end itemize
12884 @subsubsection AVR Built-in Macros
12886 GCC defines several built-in macros so that the user code can test
12887 for the presence or absence of features.  Almost any of the following
12888 built-in macros are deduced from device capabilities and thus
12889 triggered by the @code{-mmcu=} command-line option.
12891 For even more AVR-specific built-in macros see
12892 @ref{AVR Named Address Spaces} and @ref{AVR Built-in Functions}.
12894 @table @code
12896 @item __AVR_ARCH__
12897 Build-in macro that resolves to a decimal number that identifies the
12898 architecture and depends on the @code{-mmcu=@var{mcu}} option.
12899 Possible values are:
12901 @code{2}, @code{25}, @code{3}, @code{31}, @code{35},
12902 @code{4}, @code{5}, @code{51}, @code{6}, @code{102}, @code{104},
12903 @code{105}, @code{106}, @code{107}
12905 for @var{mcu}=@code{avr2}, @code{avr25}, @code{avr3},
12906 @code{avr31}, @code{avr35}, @code{avr4}, @code{avr5}, @code{avr51},
12907 @code{avr6}, @code{avrxmega2}, @code{avrxmega4}, @code{avrxmega5},
12908 @code{avrxmega6}, @code{avrxmega7}, respectively.
12909 If @var{mcu} specifies a device, this built-in macro is set
12910 accordingly. For example, with @code{-mmcu=atmega8} the macro will be
12911 defined to @code{4}.
12913 @item __AVR_@var{Device}__
12914 Setting @code{-mmcu=@var{device}} defines this built-in macro which reflects
12915 the device's name. For example, @code{-mmcu=atmega8} defines the
12916 built-in macro @code{__AVR_ATmega8__}, @code{-mmcu=attiny261a} defines
12917 @code{__AVR_ATtiny261A__}, etc.
12919 The built-in macros' names follow
12920 the scheme @code{__AVR_@var{Device}__} where @var{Device} is
12921 the device name as from the AVR user manual. The difference between
12922 @var{Device} in the built-in macro and @var{device} in
12923 @code{-mmcu=@var{device}} is that the latter is always lowercase.
12925 If @var{device} is not a device but only a core architecture like
12926 @code{avr51}, this macro will not be defined.
12928 @item __AVR_XMEGA__
12929 The device / architecture belongs to the XMEGA family of devices.
12931 @item __AVR_HAVE_ELPM__
12932 The device has the the @code{ELPM} instruction.
12934 @item __AVR_HAVE_ELPMX__
12935 The device has the @code{ELPM R@var{n},Z} and @code{ELPM
12936 R@var{n},Z+} instructions.
12938 @item __AVR_HAVE_MOVW__
12939 The device has the @code{MOVW} instruction to perform 16-bit
12940 register-register moves.
12942 @item __AVR_HAVE_LPMX__
12943 The device has the @code{LPM R@var{n},Z} and
12944 @code{LPM R@var{n},Z+} instructions.
12946 @item __AVR_HAVE_MUL__
12947 The device has a hardware multiplier. 
12949 @item __AVR_HAVE_JMP_CALL__
12950 The device has the @code{JMP} and @code{CALL} instructions.
12951 This is the case for devices with at least 16@tie{}KiB of program
12952 memory.
12954 @item __AVR_HAVE_EIJMP_EICALL__
12955 @itemx __AVR_3_BYTE_PC__
12956 The device has the @code{EIJMP} and @code{EICALL} instructions.
12957 This is the case for devices with more than 128@tie{}KiB of program memory.
12958 This also means that the program counter
12959 (PC) is 3@tie{}bytes wide.
12961 @item __AVR_2_BYTE_PC__
12962 The program counter (PC) is 2@tie{}bytes wide. This is the case for devices
12963 with up to 128@tie{}KiB of program memory.
12965 @item __AVR_HAVE_8BIT_SP__
12966 @itemx __AVR_HAVE_16BIT_SP__
12967 The stack pointer (SP) register is treated as 8-bit respectively
12968 16-bit register by the compiler.
12969 The definition of these macros is affected by @code{-mtiny-stack}.
12971 @item __AVR_HAVE_SPH__
12972 @itemx __AVR_SP8__
12973 The device has the SPH (high part of stack pointer) special function
12974 register or has an 8-bit stack pointer, respectively.
12975 The definition of these macros is affected by @code{-mmcu=} and
12976 in the cases of @code{-mmcu=avr2} and @code{-mmcu=avr25} also
12977 by @code{-msp8}.
12979 @item __AVR_HAVE_RAMPD__
12980 @itemx __AVR_HAVE_RAMPX__
12981 @itemx __AVR_HAVE_RAMPY__
12982 @itemx __AVR_HAVE_RAMPZ__
12983 The device has the @code{RAMPD}, @code{RAMPX}, @code{RAMPY},
12984 @code{RAMPZ} special function register, respectively.
12986 @item __NO_INTERRUPTS__
12987 This macro reflects the @code{-mno-interrupts} command line option.
12989 @item __AVR_ERRATA_SKIP__
12990 @itemx __AVR_ERRATA_SKIP_JMP_CALL__
12991 Some AVR devices (AT90S8515, ATmega103) must not skip 32-bit
12992 instructions because of a hardware erratum.  Skip instructions are
12993 @code{SBRS}, @code{SBRC}, @code{SBIS}, @code{SBIC} and @code{CPSE}.
12994 The second macro is only defined if @code{__AVR_HAVE_JMP_CALL__} is also
12995 set.
12997 @item __AVR_ISA_RMW__
12998 The device has Read-Modify-Write instructions (XCH, LAC, LAS and LAT).
13000 @item __AVR_SFR_OFFSET__=@var{offset}
13001 Instructions that can address I/O special function registers directly
13002 like @code{IN}, @code{OUT}, @code{SBI}, etc.@: may use a different
13003 address as if addressed by an instruction to access RAM like @code{LD}
13004 or @code{STS}. This offset depends on the device architecture and has
13005 to be subtracted from the RAM address in order to get the
13006 respective I/O@tie{}address.
13008 @item __WITH_AVRLIBC__
13009 The compiler is configured to be used together with AVR-Libc.
13010 See the @code{--with-avrlibc} configure option.
13012 @end table
13014 @node Blackfin Options
13015 @subsection Blackfin Options
13016 @cindex Blackfin Options
13018 @table @gcctabopt
13019 @item -mcpu=@var{cpu}@r{[}-@var{sirevision}@r{]}
13020 @opindex mcpu=
13021 Specifies the name of the target Blackfin processor.  Currently, @var{cpu}
13022 can be one of @samp{bf512}, @samp{bf514}, @samp{bf516}, @samp{bf518},
13023 @samp{bf522}, @samp{bf523}, @samp{bf524}, @samp{bf525}, @samp{bf526},
13024 @samp{bf527}, @samp{bf531}, @samp{bf532}, @samp{bf533},
13025 @samp{bf534}, @samp{bf536}, @samp{bf537}, @samp{bf538}, @samp{bf539},
13026 @samp{bf542}, @samp{bf544}, @samp{bf547}, @samp{bf548}, @samp{bf549},
13027 @samp{bf542m}, @samp{bf544m}, @samp{bf547m}, @samp{bf548m}, @samp{bf549m},
13028 @samp{bf561}, @samp{bf592}.
13030 The optional @var{sirevision} specifies the silicon revision of the target
13031 Blackfin processor.  Any workarounds available for the targeted silicon revision
13032 are enabled.  If @var{sirevision} is @samp{none}, no workarounds are enabled.
13033 If @var{sirevision} is @samp{any}, all workarounds for the targeted processor
13034 are enabled.  The @code{__SILICON_REVISION__} macro is defined to two
13035 hexadecimal digits representing the major and minor numbers in the silicon
13036 revision.  If @var{sirevision} is @samp{none}, the @code{__SILICON_REVISION__}
13037 is not defined.  If @var{sirevision} is @samp{any}, the
13038 @code{__SILICON_REVISION__} is defined to be @code{0xffff}.
13039 If this optional @var{sirevision} is not used, GCC assumes the latest known
13040 silicon revision of the targeted Blackfin processor.
13042 GCC defines a preprocessor macro for the specified @var{cpu}.
13043 For the @samp{bfin-elf} toolchain, this option causes the hardware BSP
13044 provided by libgloss to be linked in if @option{-msim} is not given.
13046 Without this option, @samp{bf532} is used as the processor by default.
13048 Note that support for @samp{bf561} is incomplete.  For @samp{bf561},
13049 only the preprocessor macro is defined.
13051 @item -msim
13052 @opindex msim
13053 Specifies that the program will be run on the simulator.  This causes
13054 the simulator BSP provided by libgloss to be linked in.  This option
13055 has effect only for @samp{bfin-elf} toolchain.
13056 Certain other options, such as @option{-mid-shared-library} and
13057 @option{-mfdpic}, imply @option{-msim}.
13059 @item -momit-leaf-frame-pointer
13060 @opindex momit-leaf-frame-pointer
13061 Don't keep the frame pointer in a register for leaf functions.  This
13062 avoids the instructions to save, set up and restore frame pointers and
13063 makes an extra register available in leaf functions.  The option
13064 @option{-fomit-frame-pointer} removes the frame pointer for all functions,
13065 which might make debugging harder.
13067 @item -mspecld-anomaly
13068 @opindex mspecld-anomaly
13069 When enabled, the compiler ensures that the generated code does not
13070 contain speculative loads after jump instructions. If this option is used,
13071 @code{__WORKAROUND_SPECULATIVE_LOADS} is defined.
13073 @item -mno-specld-anomaly
13074 @opindex mno-specld-anomaly
13075 Don't generate extra code to prevent speculative loads from occurring.
13077 @item -mcsync-anomaly
13078 @opindex mcsync-anomaly
13079 When enabled, the compiler ensures that the generated code does not
13080 contain CSYNC or SSYNC instructions too soon after conditional branches.
13081 If this option is used, @code{__WORKAROUND_SPECULATIVE_SYNCS} is defined.
13083 @item -mno-csync-anomaly
13084 @opindex mno-csync-anomaly
13085 Don't generate extra code to prevent CSYNC or SSYNC instructions from
13086 occurring too soon after a conditional branch.
13088 @item -mlow-64k
13089 @opindex mlow-64k
13090 When enabled, the compiler is free to take advantage of the knowledge that
13091 the entire program fits into the low 64k of memory.
13093 @item -mno-low-64k
13094 @opindex mno-low-64k
13095 Assume that the program is arbitrarily large.  This is the default.
13097 @item -mstack-check-l1
13098 @opindex mstack-check-l1
13099 Do stack checking using information placed into L1 scratchpad memory by the
13100 uClinux kernel.
13102 @item -mid-shared-library
13103 @opindex mid-shared-library
13104 Generate code that supports shared libraries via the library ID method.
13105 This allows for execute in place and shared libraries in an environment
13106 without virtual memory management.  This option implies @option{-fPIC}.
13107 With a @samp{bfin-elf} target, this option implies @option{-msim}.
13109 @item -mno-id-shared-library
13110 @opindex mno-id-shared-library
13111 Generate code that doesn't assume ID-based shared libraries are being used.
13112 This is the default.
13114 @item -mleaf-id-shared-library
13115 @opindex mleaf-id-shared-library
13116 Generate code that supports shared libraries via the library ID method,
13117 but assumes that this library or executable won't link against any other
13118 ID shared libraries.  That allows the compiler to use faster code for jumps
13119 and calls.
13121 @item -mno-leaf-id-shared-library
13122 @opindex mno-leaf-id-shared-library
13123 Do not assume that the code being compiled won't link against any ID shared
13124 libraries.  Slower code is generated for jump and call insns.
13126 @item -mshared-library-id=n
13127 @opindex mshared-library-id
13128 Specifies the identification number of the ID-based shared library being
13129 compiled.  Specifying a value of 0 generates more compact code; specifying
13130 other values forces the allocation of that number to the current
13131 library but is no more space- or time-efficient than omitting this option.
13133 @item -msep-data
13134 @opindex msep-data
13135 Generate code that allows the data segment to be located in a different
13136 area of memory from the text segment.  This allows for execute in place in
13137 an environment without virtual memory management by eliminating relocations
13138 against the text section.
13140 @item -mno-sep-data
13141 @opindex mno-sep-data
13142 Generate code that assumes that the data segment follows the text segment.
13143 This is the default.
13145 @item -mlong-calls
13146 @itemx -mno-long-calls
13147 @opindex mlong-calls
13148 @opindex mno-long-calls
13149 Tells the compiler to perform function calls by first loading the
13150 address of the function into a register and then performing a subroutine
13151 call on this register.  This switch is needed if the target function
13152 lies outside of the 24-bit addressing range of the offset-based
13153 version of subroutine call instruction.
13155 This feature is not enabled by default.  Specifying
13156 @option{-mno-long-calls} restores the default behavior.  Note these
13157 switches have no effect on how the compiler generates code to handle
13158 function calls via function pointers.
13160 @item -mfast-fp
13161 @opindex mfast-fp
13162 Link with the fast floating-point library. This library relaxes some of
13163 the IEEE floating-point standard's rules for checking inputs against
13164 Not-a-Number (NAN), in the interest of performance.
13166 @item -minline-plt
13167 @opindex minline-plt
13168 Enable inlining of PLT entries in function calls to functions that are
13169 not known to bind locally.  It has no effect without @option{-mfdpic}.
13171 @item -mmulticore
13172 @opindex mmulticore
13173 Build a standalone application for multicore Blackfin processors. 
13174 This option causes proper start files and link scripts supporting 
13175 multicore to be used, and defines the macro @code{__BFIN_MULTICORE}. 
13176 It can only be used with @option{-mcpu=bf561@r{[}-@var{sirevision}@r{]}}. 
13178 This option can be used with @option{-mcorea} or @option{-mcoreb}, which
13179 selects the one-application-per-core programming model.  Without
13180 @option{-mcorea} or @option{-mcoreb}, the single-application/dual-core
13181 programming model is used. In this model, the main function of Core B
13182 should be named as @code{coreb_main}.
13184 If this option is not used, the single-core application programming
13185 model is used.
13187 @item -mcorea
13188 @opindex mcorea
13189 Build a standalone application for Core A of BF561 when using
13190 the one-application-per-core programming model. Proper start files
13191 and link scripts are used to support Core A, and the macro
13192 @code{__BFIN_COREA} is defined.
13193 This option can only be used in conjunction with @option{-mmulticore}.
13195 @item -mcoreb
13196 @opindex mcoreb
13197 Build a standalone application for Core B of BF561 when using
13198 the one-application-per-core programming model. Proper start files
13199 and link scripts are used to support Core B, and the macro
13200 @code{__BFIN_COREB} is defined. When this option is used, @code{coreb_main}
13201 should be used instead of @code{main}. 
13202 This option can only be used in conjunction with @option{-mmulticore}.
13204 @item -msdram
13205 @opindex msdram
13206 Build a standalone application for SDRAM. Proper start files and
13207 link scripts are used to put the application into SDRAM, and the macro
13208 @code{__BFIN_SDRAM} is defined.
13209 The loader should initialize SDRAM before loading the application.
13211 @item -micplb
13212 @opindex micplb
13213 Assume that ICPLBs are enabled at run time.  This has an effect on certain
13214 anomaly workarounds.  For Linux targets, the default is to assume ICPLBs
13215 are enabled; for standalone applications the default is off.
13216 @end table
13218 @node C6X Options
13219 @subsection C6X Options
13220 @cindex C6X Options
13222 @table @gcctabopt
13223 @item -march=@var{name}
13224 @opindex march
13225 This specifies the name of the target architecture.  GCC uses this
13226 name to determine what kind of instructions it can emit when generating
13227 assembly code.  Permissible names are: @samp{c62x},
13228 @samp{c64x}, @samp{c64x+}, @samp{c67x}, @samp{c67x+}, @samp{c674x}.
13230 @item -mbig-endian
13231 @opindex mbig-endian
13232 Generate code for a big-endian target.
13234 @item -mlittle-endian
13235 @opindex mlittle-endian
13236 Generate code for a little-endian target.  This is the default.
13238 @item -msim
13239 @opindex msim
13240 Choose startup files and linker script suitable for the simulator.
13242 @item -msdata=default
13243 @opindex msdata=default
13244 Put small global and static data in the @samp{.neardata} section,
13245 which is pointed to by register @code{B14}.  Put small uninitialized
13246 global and static data in the @samp{.bss} section, which is adjacent
13247 to the @samp{.neardata} section.  Put small read-only data into the
13248 @samp{.rodata} section.  The corresponding sections used for large
13249 pieces of data are @samp{.fardata}, @samp{.far} and @samp{.const}.
13251 @item -msdata=all
13252 @opindex msdata=all
13253 Put all data, not just small objects, into the sections reserved for
13254 small data, and use addressing relative to the @code{B14} register to
13255 access them.
13257 @item -msdata=none
13258 @opindex msdata=none
13259 Make no use of the sections reserved for small data, and use absolute
13260 addresses to access all data.  Put all initialized global and static
13261 data in the @samp{.fardata} section, and all uninitialized data in the
13262 @samp{.far} section.  Put all constant data into the @samp{.const}
13263 section.
13264 @end table
13266 @node CRIS Options
13267 @subsection CRIS Options
13268 @cindex CRIS Options
13270 These options are defined specifically for the CRIS ports.
13272 @table @gcctabopt
13273 @item -march=@var{architecture-type}
13274 @itemx -mcpu=@var{architecture-type}
13275 @opindex march
13276 @opindex mcpu
13277 Generate code for the specified architecture.  The choices for
13278 @var{architecture-type} are @samp{v3}, @samp{v8} and @samp{v10} for
13279 respectively ETRAX@w{ }4, ETRAX@w{ }100, and ETRAX@w{ }100@w{ }LX@.
13280 Default is @samp{v0} except for cris-axis-linux-gnu, where the default is
13281 @samp{v10}.
13283 @item -mtune=@var{architecture-type}
13284 @opindex mtune
13285 Tune to @var{architecture-type} everything applicable about the generated
13286 code, except for the ABI and the set of available instructions.  The
13287 choices for @var{architecture-type} are the same as for
13288 @option{-march=@var{architecture-type}}.
13290 @item -mmax-stack-frame=@var{n}
13291 @opindex mmax-stack-frame
13292 Warn when the stack frame of a function exceeds @var{n} bytes.
13294 @item -metrax4
13295 @itemx -metrax100
13296 @opindex metrax4
13297 @opindex metrax100
13298 The options @option{-metrax4} and @option{-metrax100} are synonyms for
13299 @option{-march=v3} and @option{-march=v8} respectively.
13301 @item -mmul-bug-workaround
13302 @itemx -mno-mul-bug-workaround
13303 @opindex mmul-bug-workaround
13304 @opindex mno-mul-bug-workaround
13305 Work around a bug in the @code{muls} and @code{mulu} instructions for CPU
13306 models where it applies.  This option is active by default.
13308 @item -mpdebug
13309 @opindex mpdebug
13310 Enable CRIS-specific verbose debug-related information in the assembly
13311 code.  This option also has the effect of turning off the @samp{#NO_APP}
13312 formatted-code indicator to the assembler at the beginning of the
13313 assembly file.
13315 @item -mcc-init
13316 @opindex mcc-init
13317 Do not use condition-code results from previous instruction; always emit
13318 compare and test instructions before use of condition codes.
13320 @item -mno-side-effects
13321 @opindex mno-side-effects
13322 Do not emit instructions with side effects in addressing modes other than
13323 post-increment.
13325 @item -mstack-align
13326 @itemx -mno-stack-align
13327 @itemx -mdata-align
13328 @itemx -mno-data-align
13329 @itemx -mconst-align
13330 @itemx -mno-const-align
13331 @opindex mstack-align
13332 @opindex mno-stack-align
13333 @opindex mdata-align
13334 @opindex mno-data-align
13335 @opindex mconst-align
13336 @opindex mno-const-align
13337 These options (@samp{no-} options) arrange (eliminate arrangements) for the
13338 stack frame, individual data and constants to be aligned for the maximum
13339 single data access size for the chosen CPU model.  The default is to
13340 arrange for 32-bit alignment.  ABI details such as structure layout are
13341 not affected by these options.
13343 @item -m32-bit
13344 @itemx -m16-bit
13345 @itemx -m8-bit
13346 @opindex m32-bit
13347 @opindex m16-bit
13348 @opindex m8-bit
13349 Similar to the stack- data- and const-align options above, these options
13350 arrange for stack frame, writable data and constants to all be 32-bit,
13351 16-bit or 8-bit aligned.  The default is 32-bit alignment.
13353 @item -mno-prologue-epilogue
13354 @itemx -mprologue-epilogue
13355 @opindex mno-prologue-epilogue
13356 @opindex mprologue-epilogue
13357 With @option{-mno-prologue-epilogue}, the normal function prologue and
13358 epilogue which set up the stack frame are omitted and no return
13359 instructions or return sequences are generated in the code.  Use this
13360 option only together with visual inspection of the compiled code: no
13361 warnings or errors are generated when call-saved registers must be saved,
13362 or storage for local variables needs to be allocated.
13364 @item -mno-gotplt
13365 @itemx -mgotplt
13366 @opindex mno-gotplt
13367 @opindex mgotplt
13368 With @option{-fpic} and @option{-fPIC}, don't generate (do generate)
13369 instruction sequences that load addresses for functions from the PLT part
13370 of the GOT rather than (traditional on other architectures) calls to the
13371 PLT@.  The default is @option{-mgotplt}.
13373 @item -melf
13374 @opindex melf
13375 Legacy no-op option only recognized with the cris-axis-elf and
13376 cris-axis-linux-gnu targets.
13378 @item -mlinux
13379 @opindex mlinux
13380 Legacy no-op option only recognized with the cris-axis-linux-gnu target.
13382 @item -sim
13383 @opindex sim
13384 This option, recognized for the cris-axis-elf, arranges
13385 to link with input-output functions from a simulator library.  Code,
13386 initialized data and zero-initialized data are allocated consecutively.
13388 @item -sim2
13389 @opindex sim2
13390 Like @option{-sim}, but pass linker options to locate initialized data at
13391 0x40000000 and zero-initialized data at 0x80000000.
13392 @end table
13394 @node CR16 Options
13395 @subsection CR16 Options
13396 @cindex CR16 Options
13398 These options are defined specifically for the CR16 ports.
13400 @table @gcctabopt
13402 @item -mmac
13403 @opindex mmac
13404 Enable the use of multiply-accumulate instructions. Disabled by default.
13406 @item -mcr16cplus
13407 @itemx -mcr16c
13408 @opindex mcr16cplus
13409 @opindex mcr16c
13410 Generate code for CR16C or CR16C+ architecture. CR16C+ architecture 
13411 is default.
13413 @item -msim
13414 @opindex msim
13415 Links the library libsim.a which is in compatible with simulator. Applicable
13416 to ELF compiler only.
13418 @item -mint32
13419 @opindex mint32
13420 Choose integer type as 32-bit wide.
13422 @item -mbit-ops
13423 @opindex mbit-ops
13424 Generates @code{sbit}/@code{cbit} instructions for bit manipulations.
13426 @item -mdata-model=@var{model}
13427 @opindex mdata-model
13428 Choose a data model. The choices for @var{model} are @samp{near},
13429 @samp{far} or @samp{medium}. @samp{medium} is default.
13430 However, @samp{far} is not valid with @option{-mcr16c}, as the
13431 CR16C architecture does not support the far data model.
13432 @end table
13434 @node Darwin Options
13435 @subsection Darwin Options
13436 @cindex Darwin options
13438 These options are defined for all architectures running the Darwin operating
13439 system.
13441 FSF GCC on Darwin does not create ``fat'' object files; it creates
13442 an object file for the single architecture that GCC was built to
13443 target.  Apple's GCC on Darwin does create ``fat'' files if multiple
13444 @option{-arch} options are used; it does so by running the compiler or
13445 linker multiple times and joining the results together with
13446 @file{lipo}.
13448 The subtype of the file created (like @samp{ppc7400} or @samp{ppc970} or
13449 @samp{i686}) is determined by the flags that specify the ISA
13450 that GCC is targeting, like @option{-mcpu} or @option{-march}.  The
13451 @option{-force_cpusubtype_ALL} option can be used to override this.
13453 The Darwin tools vary in their behavior when presented with an ISA
13454 mismatch.  The assembler, @file{as}, only permits instructions to
13455 be used that are valid for the subtype of the file it is generating,
13456 so you cannot put 64-bit instructions in a @samp{ppc750} object file.
13457 The linker for shared libraries, @file{/usr/bin/libtool}, fails
13458 and prints an error if asked to create a shared library with a less
13459 restrictive subtype than its input files (for instance, trying to put
13460 a @samp{ppc970} object file in a @samp{ppc7400} library).  The linker
13461 for executables, @command{ld}, quietly gives the executable the most
13462 restrictive subtype of any of its input files.
13464 @table @gcctabopt
13465 @item -F@var{dir}
13466 @opindex F
13467 Add the framework directory @var{dir} to the head of the list of
13468 directories to be searched for header files.  These directories are
13469 interleaved with those specified by @option{-I} options and are
13470 scanned in a left-to-right order.
13472 A framework directory is a directory with frameworks in it.  A
13473 framework is a directory with a @file{Headers} and/or
13474 @file{PrivateHeaders} directory contained directly in it that ends
13475 in @file{.framework}.  The name of a framework is the name of this
13476 directory excluding the @file{.framework}.  Headers associated with
13477 the framework are found in one of those two directories, with
13478 @file{Headers} being searched first.  A subframework is a framework
13479 directory that is in a framework's @file{Frameworks} directory.
13480 Includes of subframework headers can only appear in a header of a
13481 framework that contains the subframework, or in a sibling subframework
13482 header.  Two subframeworks are siblings if they occur in the same
13483 framework.  A subframework should not have the same name as a
13484 framework; a warning is issued if this is violated.  Currently a
13485 subframework cannot have subframeworks; in the future, the mechanism
13486 may be extended to support this.  The standard frameworks can be found
13487 in @file{/System/Library/Frameworks} and
13488 @file{/Library/Frameworks}.  An example include looks like
13489 @code{#include <Framework/header.h>}, where @file{Framework} denotes
13490 the name of the framework and @file{header.h} is found in the
13491 @file{PrivateHeaders} or @file{Headers} directory.
13493 @item -iframework@var{dir}
13494 @opindex iframework
13495 Like @option{-F} except the directory is a treated as a system
13496 directory.  The main difference between this @option{-iframework} and
13497 @option{-F} is that with @option{-iframework} the compiler does not
13498 warn about constructs contained within header files found via
13499 @var{dir}.  This option is valid only for the C family of languages.
13501 @item -gused
13502 @opindex gused
13503 Emit debugging information for symbols that are used.  For stabs
13504 debugging format, this enables @option{-feliminate-unused-debug-symbols}.
13505 This is by default ON@.
13507 @item -gfull
13508 @opindex gfull
13509 Emit debugging information for all symbols and types.
13511 @item -mmacosx-version-min=@var{version}
13512 The earliest version of MacOS X that this executable will run on
13513 is @var{version}.  Typical values of @var{version} include @code{10.1},
13514 @code{10.2}, and @code{10.3.9}.
13516 If the compiler was built to use the system's headers by default,
13517 then the default for this option is the system version on which the
13518 compiler is running, otherwise the default is to make choices that
13519 are compatible with as many systems and code bases as possible.
13521 @item -mkernel
13522 @opindex mkernel
13523 Enable kernel development mode.  The @option{-mkernel} option sets
13524 @option{-static}, @option{-fno-common}, @option{-fno-cxa-atexit},
13525 @option{-fno-exceptions}, @option{-fno-non-call-exceptions},
13526 @option{-fapple-kext}, @option{-fno-weak} and @option{-fno-rtti} where
13527 applicable.  This mode also sets @option{-mno-altivec},
13528 @option{-msoft-float}, @option{-fno-builtin} and
13529 @option{-mlong-branch} for PowerPC targets.
13531 @item -mone-byte-bool
13532 @opindex mone-byte-bool
13533 Override the defaults for @samp{bool} so that @samp{sizeof(bool)==1}.
13534 By default @samp{sizeof(bool)} is @samp{4} when compiling for
13535 Darwin/PowerPC and @samp{1} when compiling for Darwin/x86, so this
13536 option has no effect on x86.
13538 @strong{Warning:} The @option{-mone-byte-bool} switch causes GCC
13539 to generate code that is not binary compatible with code generated
13540 without that switch.  Using this switch may require recompiling all
13541 other modules in a program, including system libraries.  Use this
13542 switch to conform to a non-default data model.
13544 @item -mfix-and-continue
13545 @itemx -ffix-and-continue
13546 @itemx -findirect-data
13547 @opindex mfix-and-continue
13548 @opindex ffix-and-continue
13549 @opindex findirect-data
13550 Generate code suitable for fast turnaround development, such as to
13551 allow GDB to dynamically load @code{.o} files into already-running
13552 programs.  @option{-findirect-data} and @option{-ffix-and-continue}
13553 are provided for backwards compatibility.
13555 @item -all_load
13556 @opindex all_load
13557 Loads all members of static archive libraries.
13558 See man ld(1) for more information.
13560 @item -arch_errors_fatal
13561 @opindex arch_errors_fatal
13562 Cause the errors having to do with files that have the wrong architecture
13563 to be fatal.
13565 @item -bind_at_load
13566 @opindex bind_at_load
13567 Causes the output file to be marked such that the dynamic linker will
13568 bind all undefined references when the file is loaded or launched.
13570 @item -bundle
13571 @opindex bundle
13572 Produce a Mach-o bundle format file.
13573 See man ld(1) for more information.
13575 @item -bundle_loader @var{executable}
13576 @opindex bundle_loader
13577 This option specifies the @var{executable} that will load the build
13578 output file being linked.  See man ld(1) for more information.
13580 @item -dynamiclib
13581 @opindex dynamiclib
13582 When passed this option, GCC produces a dynamic library instead of
13583 an executable when linking, using the Darwin @file{libtool} command.
13585 @item -force_cpusubtype_ALL
13586 @opindex force_cpusubtype_ALL
13587 This causes GCC's output file to have the @var{ALL} subtype, instead of
13588 one controlled by the @option{-mcpu} or @option{-march} option.
13590 @item -allowable_client  @var{client_name}
13591 @itemx -client_name
13592 @itemx -compatibility_version
13593 @itemx -current_version
13594 @itemx -dead_strip
13595 @itemx -dependency-file
13596 @itemx -dylib_file
13597 @itemx -dylinker_install_name
13598 @itemx -dynamic
13599 @itemx -exported_symbols_list
13600 @itemx -filelist
13601 @need 800
13602 @itemx -flat_namespace
13603 @itemx -force_flat_namespace
13604 @itemx -headerpad_max_install_names
13605 @itemx -image_base
13606 @itemx -init
13607 @itemx -install_name
13608 @itemx -keep_private_externs
13609 @itemx -multi_module
13610 @itemx -multiply_defined
13611 @itemx -multiply_defined_unused
13612 @need 800
13613 @itemx -noall_load
13614 @itemx -no_dead_strip_inits_and_terms
13615 @itemx -nofixprebinding
13616 @itemx -nomultidefs
13617 @itemx -noprebind
13618 @itemx -noseglinkedit
13619 @itemx -pagezero_size
13620 @itemx -prebind
13621 @itemx -prebind_all_twolevel_modules
13622 @itemx -private_bundle
13623 @need 800
13624 @itemx -read_only_relocs
13625 @itemx -sectalign
13626 @itemx -sectobjectsymbols
13627 @itemx -whyload
13628 @itemx -seg1addr
13629 @itemx -sectcreate
13630 @itemx -sectobjectsymbols
13631 @itemx -sectorder
13632 @itemx -segaddr
13633 @itemx -segs_read_only_addr
13634 @need 800
13635 @itemx -segs_read_write_addr
13636 @itemx -seg_addr_table
13637 @itemx -seg_addr_table_filename
13638 @itemx -seglinkedit
13639 @itemx -segprot
13640 @itemx -segs_read_only_addr
13641 @itemx -segs_read_write_addr
13642 @itemx -single_module
13643 @itemx -static
13644 @itemx -sub_library
13645 @need 800
13646 @itemx -sub_umbrella
13647 @itemx -twolevel_namespace
13648 @itemx -umbrella
13649 @itemx -undefined
13650 @itemx -unexported_symbols_list
13651 @itemx -weak_reference_mismatches
13652 @itemx -whatsloaded
13653 @opindex allowable_client
13654 @opindex client_name
13655 @opindex compatibility_version
13656 @opindex current_version
13657 @opindex dead_strip
13658 @opindex dependency-file
13659 @opindex dylib_file
13660 @opindex dylinker_install_name
13661 @opindex dynamic
13662 @opindex exported_symbols_list
13663 @opindex filelist
13664 @opindex flat_namespace
13665 @opindex force_flat_namespace
13666 @opindex headerpad_max_install_names
13667 @opindex image_base
13668 @opindex init
13669 @opindex install_name
13670 @opindex keep_private_externs
13671 @opindex multi_module
13672 @opindex multiply_defined
13673 @opindex multiply_defined_unused
13674 @opindex noall_load
13675 @opindex no_dead_strip_inits_and_terms
13676 @opindex nofixprebinding
13677 @opindex nomultidefs
13678 @opindex noprebind
13679 @opindex noseglinkedit
13680 @opindex pagezero_size
13681 @opindex prebind
13682 @opindex prebind_all_twolevel_modules
13683 @opindex private_bundle
13684 @opindex read_only_relocs
13685 @opindex sectalign
13686 @opindex sectobjectsymbols
13687 @opindex whyload
13688 @opindex seg1addr
13689 @opindex sectcreate
13690 @opindex sectobjectsymbols
13691 @opindex sectorder
13692 @opindex segaddr
13693 @opindex segs_read_only_addr
13694 @opindex segs_read_write_addr
13695 @opindex seg_addr_table
13696 @opindex seg_addr_table_filename
13697 @opindex seglinkedit
13698 @opindex segprot
13699 @opindex segs_read_only_addr
13700 @opindex segs_read_write_addr
13701 @opindex single_module
13702 @opindex static
13703 @opindex sub_library
13704 @opindex sub_umbrella
13705 @opindex twolevel_namespace
13706 @opindex umbrella
13707 @opindex undefined
13708 @opindex unexported_symbols_list
13709 @opindex weak_reference_mismatches
13710 @opindex whatsloaded
13711 These options are passed to the Darwin linker.  The Darwin linker man page
13712 describes them in detail.
13713 @end table
13715 @node DEC Alpha Options
13716 @subsection DEC Alpha Options
13718 These @samp{-m} options are defined for the DEC Alpha implementations:
13720 @table @gcctabopt
13721 @item -mno-soft-float
13722 @itemx -msoft-float
13723 @opindex mno-soft-float
13724 @opindex msoft-float
13725 Use (do not use) the hardware floating-point instructions for
13726 floating-point operations.  When @option{-msoft-float} is specified,
13727 functions in @file{libgcc.a} are used to perform floating-point
13728 operations.  Unless they are replaced by routines that emulate the
13729 floating-point operations, or compiled in such a way as to call such
13730 emulations routines, these routines issue floating-point
13731 operations.   If you are compiling for an Alpha without floating-point
13732 operations, you must ensure that the library is built so as not to call
13733 them.
13735 Note that Alpha implementations without floating-point operations are
13736 required to have floating-point registers.
13738 @item -mfp-reg
13739 @itemx -mno-fp-regs
13740 @opindex mfp-reg
13741 @opindex mno-fp-regs
13742 Generate code that uses (does not use) the floating-point register set.
13743 @option{-mno-fp-regs} implies @option{-msoft-float}.  If the floating-point
13744 register set is not used, floating-point operands are passed in integer
13745 registers as if they were integers and floating-point results are passed
13746 in @code{$0} instead of @code{$f0}.  This is a non-standard calling sequence,
13747 so any function with a floating-point argument or return value called by code
13748 compiled with @option{-mno-fp-regs} must also be compiled with that
13749 option.
13751 A typical use of this option is building a kernel that does not use,
13752 and hence need not save and restore, any floating-point registers.
13754 @item -mieee
13755 @opindex mieee
13756 The Alpha architecture implements floating-point hardware optimized for
13757 maximum performance.  It is mostly compliant with the IEEE floating-point
13758 standard.  However, for full compliance, software assistance is
13759 required.  This option generates code fully IEEE-compliant code
13760 @emph{except} that the @var{inexact-flag} is not maintained (see below).
13761 If this option is turned on, the preprocessor macro @code{_IEEE_FP} is
13762 defined during compilation.  The resulting code is less efficient but is
13763 able to correctly support denormalized numbers and exceptional IEEE
13764 values such as not-a-number and plus/minus infinity.  Other Alpha
13765 compilers call this option @option{-ieee_with_no_inexact}.
13767 @item -mieee-with-inexact
13768 @opindex mieee-with-inexact
13769 This is like @option{-mieee} except the generated code also maintains
13770 the IEEE @var{inexact-flag}.  Turning on this option causes the
13771 generated code to implement fully-compliant IEEE math.  In addition to
13772 @code{_IEEE_FP}, @code{_IEEE_FP_EXACT} is defined as a preprocessor
13773 macro.  On some Alpha implementations the resulting code may execute
13774 significantly slower than the code generated by default.  Since there is
13775 very little code that depends on the @var{inexact-flag}, you should
13776 normally not specify this option.  Other Alpha compilers call this
13777 option @option{-ieee_with_inexact}.
13779 @item -mfp-trap-mode=@var{trap-mode}
13780 @opindex mfp-trap-mode
13781 This option controls what floating-point related traps are enabled.
13782 Other Alpha compilers call this option @option{-fptm @var{trap-mode}}.
13783 The trap mode can be set to one of four values:
13785 @table @samp
13786 @item n
13787 This is the default (normal) setting.  The only traps that are enabled
13788 are the ones that cannot be disabled in software (e.g., division by zero
13789 trap).
13791 @item u
13792 In addition to the traps enabled by @samp{n}, underflow traps are enabled
13793 as well.
13795 @item su
13796 Like @samp{u}, but the instructions are marked to be safe for software
13797 completion (see Alpha architecture manual for details).
13799 @item sui
13800 Like @samp{su}, but inexact traps are enabled as well.
13801 @end table
13803 @item -mfp-rounding-mode=@var{rounding-mode}
13804 @opindex mfp-rounding-mode
13805 Selects the IEEE rounding mode.  Other Alpha compilers call this option
13806 @option{-fprm @var{rounding-mode}}.  The @var{rounding-mode} can be one
13809 @table @samp
13810 @item n
13811 Normal IEEE rounding mode.  Floating-point numbers are rounded towards
13812 the nearest machine number or towards the even machine number in case
13813 of a tie.
13815 @item m
13816 Round towards minus infinity.
13818 @item c
13819 Chopped rounding mode.  Floating-point numbers are rounded towards zero.
13821 @item d
13822 Dynamic rounding mode.  A field in the floating-point control register
13823 (@var{fpcr}, see Alpha architecture reference manual) controls the
13824 rounding mode in effect.  The C library initializes this register for
13825 rounding towards plus infinity.  Thus, unless your program modifies the
13826 @var{fpcr}, @samp{d} corresponds to round towards plus infinity.
13827 @end table
13829 @item -mtrap-precision=@var{trap-precision}
13830 @opindex mtrap-precision
13831 In the Alpha architecture, floating-point traps are imprecise.  This
13832 means without software assistance it is impossible to recover from a
13833 floating trap and program execution normally needs to be terminated.
13834 GCC can generate code that can assist operating system trap handlers
13835 in determining the exact location that caused a floating-point trap.
13836 Depending on the requirements of an application, different levels of
13837 precisions can be selected:
13839 @table @samp
13840 @item p
13841 Program precision.  This option is the default and means a trap handler
13842 can only identify which program caused a floating-point exception.
13844 @item f
13845 Function precision.  The trap handler can determine the function that
13846 caused a floating-point exception.
13848 @item i
13849 Instruction precision.  The trap handler can determine the exact
13850 instruction that caused a floating-point exception.
13851 @end table
13853 Other Alpha compilers provide the equivalent options called
13854 @option{-scope_safe} and @option{-resumption_safe}.
13856 @item -mieee-conformant
13857 @opindex mieee-conformant
13858 This option marks the generated code as IEEE conformant.  You must not
13859 use this option unless you also specify @option{-mtrap-precision=i} and either
13860 @option{-mfp-trap-mode=su} or @option{-mfp-trap-mode=sui}.  Its only effect
13861 is to emit the line @samp{.eflag 48} in the function prologue of the
13862 generated assembly file.
13864 @item -mbuild-constants
13865 @opindex mbuild-constants
13866 Normally GCC examines a 32- or 64-bit integer constant to
13867 see if it can construct it from smaller constants in two or three
13868 instructions.  If it cannot, it outputs the constant as a literal and
13869 generates code to load it from the data segment at run time.
13871 Use this option to require GCC to construct @emph{all} integer constants
13872 using code, even if it takes more instructions (the maximum is six).
13874 You typically use this option to build a shared library dynamic
13875 loader.  Itself a shared library, it must relocate itself in memory
13876 before it can find the variables and constants in its own data segment.
13878 @item -mbwx
13879 @itemx -mno-bwx
13880 @itemx -mcix
13881 @itemx -mno-cix
13882 @itemx -mfix
13883 @itemx -mno-fix
13884 @itemx -mmax
13885 @itemx -mno-max
13886 @opindex mbwx
13887 @opindex mno-bwx
13888 @opindex mcix
13889 @opindex mno-cix
13890 @opindex mfix
13891 @opindex mno-fix
13892 @opindex mmax
13893 @opindex mno-max
13894 Indicate whether GCC should generate code to use the optional BWX,
13895 CIX, FIX and MAX instruction sets.  The default is to use the instruction
13896 sets supported by the CPU type specified via @option{-mcpu=} option or that
13897 of the CPU on which GCC was built if none is specified.
13899 @item -mfloat-vax
13900 @itemx -mfloat-ieee
13901 @opindex mfloat-vax
13902 @opindex mfloat-ieee
13903 Generate code that uses (does not use) VAX F and G floating-point
13904 arithmetic instead of IEEE single and double precision.
13906 @item -mexplicit-relocs
13907 @itemx -mno-explicit-relocs
13908 @opindex mexplicit-relocs
13909 @opindex mno-explicit-relocs
13910 Older Alpha assemblers provided no way to generate symbol relocations
13911 except via assembler macros.  Use of these macros does not allow
13912 optimal instruction scheduling.  GNU binutils as of version 2.12
13913 supports a new syntax that allows the compiler to explicitly mark
13914 which relocations should apply to which instructions.  This option
13915 is mostly useful for debugging, as GCC detects the capabilities of
13916 the assembler when it is built and sets the default accordingly.
13918 @item -msmall-data
13919 @itemx -mlarge-data
13920 @opindex msmall-data
13921 @opindex mlarge-data
13922 When @option{-mexplicit-relocs} is in effect, static data is
13923 accessed via @dfn{gp-relative} relocations.  When @option{-msmall-data}
13924 is used, objects 8 bytes long or smaller are placed in a @dfn{small data area}
13925 (the @code{.sdata} and @code{.sbss} sections) and are accessed via
13926 16-bit relocations off of the @code{$gp} register.  This limits the
13927 size of the small data area to 64KB, but allows the variables to be
13928 directly accessed via a single instruction.
13930 The default is @option{-mlarge-data}.  With this option the data area
13931 is limited to just below 2GB@.  Programs that require more than 2GB of
13932 data must use @code{malloc} or @code{mmap} to allocate the data in the
13933 heap instead of in the program's data segment.
13935 When generating code for shared libraries, @option{-fpic} implies
13936 @option{-msmall-data} and @option{-fPIC} implies @option{-mlarge-data}.
13938 @item -msmall-text
13939 @itemx -mlarge-text
13940 @opindex msmall-text
13941 @opindex mlarge-text
13942 When @option{-msmall-text} is used, the compiler assumes that the
13943 code of the entire program (or shared library) fits in 4MB, and is
13944 thus reachable with a branch instruction.  When @option{-msmall-data}
13945 is used, the compiler can assume that all local symbols share the
13946 same @code{$gp} value, and thus reduce the number of instructions
13947 required for a function call from 4 to 1.
13949 The default is @option{-mlarge-text}.
13951 @item -mcpu=@var{cpu_type}
13952 @opindex mcpu
13953 Set the instruction set and instruction scheduling parameters for
13954 machine type @var{cpu_type}.  You can specify either the @samp{EV}
13955 style name or the corresponding chip number.  GCC supports scheduling
13956 parameters for the EV4, EV5 and EV6 family of processors and
13957 chooses the default values for the instruction set from the processor
13958 you specify.  If you do not specify a processor type, GCC defaults
13959 to the processor on which the compiler was built.
13961 Supported values for @var{cpu_type} are
13963 @table @samp
13964 @item ev4
13965 @itemx ev45
13966 @itemx 21064
13967 Schedules as an EV4 and has no instruction set extensions.
13969 @item ev5
13970 @itemx 21164
13971 Schedules as an EV5 and has no instruction set extensions.
13973 @item ev56
13974 @itemx 21164a
13975 Schedules as an EV5 and supports the BWX extension.
13977 @item pca56
13978 @itemx 21164pc
13979 @itemx 21164PC
13980 Schedules as an EV5 and supports the BWX and MAX extensions.
13982 @item ev6
13983 @itemx 21264
13984 Schedules as an EV6 and supports the BWX, FIX, and MAX extensions.
13986 @item ev67
13987 @itemx 21264a
13988 Schedules as an EV6 and supports the BWX, CIX, FIX, and MAX extensions.
13989 @end table
13991 Native toolchains also support the value @samp{native},
13992 which selects the best architecture option for the host processor.
13993 @option{-mcpu=native} has no effect if GCC does not recognize
13994 the processor.
13996 @item -mtune=@var{cpu_type}
13997 @opindex mtune
13998 Set only the instruction scheduling parameters for machine type
13999 @var{cpu_type}.  The instruction set is not changed.
14001 Native toolchains also support the value @samp{native},
14002 which selects the best architecture option for the host processor.
14003 @option{-mtune=native} has no effect if GCC does not recognize
14004 the processor.
14006 @item -mmemory-latency=@var{time}
14007 @opindex mmemory-latency
14008 Sets the latency the scheduler should assume for typical memory
14009 references as seen by the application.  This number is highly
14010 dependent on the memory access patterns used by the application
14011 and the size of the external cache on the machine.
14013 Valid options for @var{time} are
14015 @table @samp
14016 @item @var{number}
14017 A decimal number representing clock cycles.
14019 @item L1
14020 @itemx L2
14021 @itemx L3
14022 @itemx main
14023 The compiler contains estimates of the number of clock cycles for
14024 ``typical'' EV4 & EV5 hardware for the Level 1, 2 & 3 caches
14025 (also called Dcache, Scache, and Bcache), as well as to main memory.
14026 Note that L3 is only valid for EV5.
14028 @end table
14029 @end table
14031 @node FR30 Options
14032 @subsection FR30 Options
14033 @cindex FR30 Options
14035 These options are defined specifically for the FR30 port.
14037 @table @gcctabopt
14039 @item -msmall-model
14040 @opindex msmall-model
14041 Use the small address space model.  This can produce smaller code, but
14042 it does assume that all symbolic values and addresses fit into a
14043 20-bit range.
14045 @item -mno-lsim
14046 @opindex mno-lsim
14047 Assume that runtime support has been provided and so there is no need
14048 to include the simulator library (@file{libsim.a}) on the linker
14049 command line.
14051 @end table
14053 @node FRV Options
14054 @subsection FRV Options
14055 @cindex FRV Options
14057 @table @gcctabopt
14058 @item -mgpr-32
14059 @opindex mgpr-32
14061 Only use the first 32 general-purpose registers.
14063 @item -mgpr-64
14064 @opindex mgpr-64
14066 Use all 64 general-purpose registers.
14068 @item -mfpr-32
14069 @opindex mfpr-32
14071 Use only the first 32 floating-point registers.
14073 @item -mfpr-64
14074 @opindex mfpr-64
14076 Use all 64 floating-point registers.
14078 @item -mhard-float
14079 @opindex mhard-float
14081 Use hardware instructions for floating-point operations.
14083 @item -msoft-float
14084 @opindex msoft-float
14086 Use library routines for floating-point operations.
14088 @item -malloc-cc
14089 @opindex malloc-cc
14091 Dynamically allocate condition code registers.
14093 @item -mfixed-cc
14094 @opindex mfixed-cc
14096 Do not try to dynamically allocate condition code registers, only
14097 use @code{icc0} and @code{fcc0}.
14099 @item -mdword
14100 @opindex mdword
14102 Change ABI to use double word insns.
14104 @item -mno-dword
14105 @opindex mno-dword
14107 Do not use double word instructions.
14109 @item -mdouble
14110 @opindex mdouble
14112 Use floating-point double instructions.
14114 @item -mno-double
14115 @opindex mno-double
14117 Do not use floating-point double instructions.
14119 @item -mmedia
14120 @opindex mmedia
14122 Use media instructions.
14124 @item -mno-media
14125 @opindex mno-media
14127 Do not use media instructions.
14129 @item -mmuladd
14130 @opindex mmuladd
14132 Use multiply and add/subtract instructions.
14134 @item -mno-muladd
14135 @opindex mno-muladd
14137 Do not use multiply and add/subtract instructions.
14139 @item -mfdpic
14140 @opindex mfdpic
14142 Select the FDPIC ABI, which uses function descriptors to represent
14143 pointers to functions.  Without any PIC/PIE-related options, it
14144 implies @option{-fPIE}.  With @option{-fpic} or @option{-fpie}, it
14145 assumes GOT entries and small data are within a 12-bit range from the
14146 GOT base address; with @option{-fPIC} or @option{-fPIE}, GOT offsets
14147 are computed with 32 bits.
14148 With a @samp{bfin-elf} target, this option implies @option{-msim}.
14150 @item -minline-plt
14151 @opindex minline-plt
14153 Enable inlining of PLT entries in function calls to functions that are
14154 not known to bind locally.  It has no effect without @option{-mfdpic}.
14155 It's enabled by default if optimizing for speed and compiling for
14156 shared libraries (i.e., @option{-fPIC} or @option{-fpic}), or when an
14157 optimization option such as @option{-O3} or above is present in the
14158 command line.
14160 @item -mTLS
14161 @opindex mTLS
14163 Assume a large TLS segment when generating thread-local code.
14165 @item -mtls
14166 @opindex mtls
14168 Do not assume a large TLS segment when generating thread-local code.
14170 @item -mgprel-ro
14171 @opindex mgprel-ro
14173 Enable the use of @code{GPREL} relocations in the FDPIC ABI for data
14174 that is known to be in read-only sections.  It's enabled by default,
14175 except for @option{-fpic} or @option{-fpie}: even though it may help
14176 make the global offset table smaller, it trades 1 instruction for 4.
14177 With @option{-fPIC} or @option{-fPIE}, it trades 3 instructions for 4,
14178 one of which may be shared by multiple symbols, and it avoids the need
14179 for a GOT entry for the referenced symbol, so it's more likely to be a
14180 win.  If it is not, @option{-mno-gprel-ro} can be used to disable it.
14182 @item -multilib-library-pic
14183 @opindex multilib-library-pic
14185 Link with the (library, not FD) pic libraries.  It's implied by
14186 @option{-mlibrary-pic}, as well as by @option{-fPIC} and
14187 @option{-fpic} without @option{-mfdpic}.  You should never have to use
14188 it explicitly.
14190 @item -mlinked-fp
14191 @opindex mlinked-fp
14193 Follow the EABI requirement of always creating a frame pointer whenever
14194 a stack frame is allocated.  This option is enabled by default and can
14195 be disabled with @option{-mno-linked-fp}.
14197 @item -mlong-calls
14198 @opindex mlong-calls
14200 Use indirect addressing to call functions outside the current
14201 compilation unit.  This allows the functions to be placed anywhere
14202 within the 32-bit address space.
14204 @item -malign-labels
14205 @opindex malign-labels
14207 Try to align labels to an 8-byte boundary by inserting NOPs into the
14208 previous packet.  This option only has an effect when VLIW packing
14209 is enabled.  It doesn't create new packets; it merely adds NOPs to
14210 existing ones.
14212 @item -mlibrary-pic
14213 @opindex mlibrary-pic
14215 Generate position-independent EABI code.
14217 @item -macc-4
14218 @opindex macc-4
14220 Use only the first four media accumulator registers.
14222 @item -macc-8
14223 @opindex macc-8
14225 Use all eight media accumulator registers.
14227 @item -mpack
14228 @opindex mpack
14230 Pack VLIW instructions.
14232 @item -mno-pack
14233 @opindex mno-pack
14235 Do not pack VLIW instructions.
14237 @item -mno-eflags
14238 @opindex mno-eflags
14240 Do not mark ABI switches in e_flags.
14242 @item -mcond-move
14243 @opindex mcond-move
14245 Enable the use of conditional-move instructions (default).
14247 This switch is mainly for debugging the compiler and will likely be removed
14248 in a future version.
14250 @item -mno-cond-move
14251 @opindex mno-cond-move
14253 Disable the use of conditional-move instructions.
14255 This switch is mainly for debugging the compiler and will likely be removed
14256 in a future version.
14258 @item -mscc
14259 @opindex mscc
14261 Enable the use of conditional set instructions (default).
14263 This switch is mainly for debugging the compiler and will likely be removed
14264 in a future version.
14266 @item -mno-scc
14267 @opindex mno-scc
14269 Disable the use of conditional set instructions.
14271 This switch is mainly for debugging the compiler and will likely be removed
14272 in a future version.
14274 @item -mcond-exec
14275 @opindex mcond-exec
14277 Enable the use of conditional execution (default).
14279 This switch is mainly for debugging the compiler and will likely be removed
14280 in a future version.
14282 @item -mno-cond-exec
14283 @opindex mno-cond-exec
14285 Disable the use of conditional execution.
14287 This switch is mainly for debugging the compiler and will likely be removed
14288 in a future version.
14290 @item -mvliw-branch
14291 @opindex mvliw-branch
14293 Run a pass to pack branches into VLIW instructions (default).
14295 This switch is mainly for debugging the compiler and will likely be removed
14296 in a future version.
14298 @item -mno-vliw-branch
14299 @opindex mno-vliw-branch
14301 Do not run a pass to pack branches into VLIW instructions.
14303 This switch is mainly for debugging the compiler and will likely be removed
14304 in a future version.
14306 @item -mmulti-cond-exec
14307 @opindex mmulti-cond-exec
14309 Enable optimization of @code{&&} and @code{||} in conditional execution
14310 (default).
14312 This switch is mainly for debugging the compiler and will likely be removed
14313 in a future version.
14315 @item -mno-multi-cond-exec
14316 @opindex mno-multi-cond-exec
14318 Disable optimization of @code{&&} and @code{||} in conditional execution.
14320 This switch is mainly for debugging the compiler and will likely be removed
14321 in a future version.
14323 @item -mnested-cond-exec
14324 @opindex mnested-cond-exec
14326 Enable nested conditional execution optimizations (default).
14328 This switch is mainly for debugging the compiler and will likely be removed
14329 in a future version.
14331 @item -mno-nested-cond-exec
14332 @opindex mno-nested-cond-exec
14334 Disable nested conditional execution optimizations.
14336 This switch is mainly for debugging the compiler and will likely be removed
14337 in a future version.
14339 @item -moptimize-membar
14340 @opindex moptimize-membar
14342 This switch removes redundant @code{membar} instructions from the
14343 compiler-generated code.  It is enabled by default.
14345 @item -mno-optimize-membar
14346 @opindex mno-optimize-membar
14348 This switch disables the automatic removal of redundant @code{membar}
14349 instructions from the generated code.
14351 @item -mtomcat-stats
14352 @opindex mtomcat-stats
14354 Cause gas to print out tomcat statistics.
14356 @item -mcpu=@var{cpu}
14357 @opindex mcpu
14359 Select the processor type for which to generate code.  Possible values are
14360 @samp{frv}, @samp{fr550}, @samp{tomcat}, @samp{fr500}, @samp{fr450},
14361 @samp{fr405}, @samp{fr400}, @samp{fr300} and @samp{simple}.
14363 @end table
14365 @node GNU/Linux Options
14366 @subsection GNU/Linux Options
14368 These @samp{-m} options are defined for GNU/Linux targets:
14370 @table @gcctabopt
14371 @item -mglibc
14372 @opindex mglibc
14373 Use the GNU C library.  This is the default except
14374 on @samp{*-*-linux-*uclibc*} and @samp{*-*-linux-*android*} targets.
14376 @item -muclibc
14377 @opindex muclibc
14378 Use uClibc C library.  This is the default on
14379 @samp{*-*-linux-*uclibc*} targets.
14381 @item -mbionic
14382 @opindex mbionic
14383 Use Bionic C library.  This is the default on
14384 @samp{*-*-linux-*android*} targets.
14386 @item -mandroid
14387 @opindex mandroid
14388 Compile code compatible with Android platform.  This is the default on
14389 @samp{*-*-linux-*android*} targets.
14391 When compiling, this option enables @option{-mbionic}, @option{-fPIC},
14392 @option{-fno-exceptions} and @option{-fno-rtti} by default.  When linking,
14393 this option makes the GCC driver pass Android-specific options to the linker.
14394 Finally, this option causes the preprocessor macro @code{__ANDROID__}
14395 to be defined.
14397 @item -tno-android-cc
14398 @opindex tno-android-cc
14399 Disable compilation effects of @option{-mandroid}, i.e., do not enable
14400 @option{-mbionic}, @option{-fPIC}, @option{-fno-exceptions} and
14401 @option{-fno-rtti} by default.
14403 @item -tno-android-ld
14404 @opindex tno-android-ld
14405 Disable linking effects of @option{-mandroid}, i.e., pass standard Linux
14406 linking options to the linker.
14408 @end table
14410 @node H8/300 Options
14411 @subsection H8/300 Options
14413 These @samp{-m} options are defined for the H8/300 implementations:
14415 @table @gcctabopt
14416 @item -mrelax
14417 @opindex mrelax
14418 Shorten some address references at link time, when possible; uses the
14419 linker option @option{-relax}.  @xref{H8/300,, @code{ld} and the H8/300,
14420 ld, Using ld}, for a fuller description.
14422 @item -mh
14423 @opindex mh
14424 Generate code for the H8/300H@.
14426 @item -ms
14427 @opindex ms
14428 Generate code for the H8S@.
14430 @item -mn
14431 @opindex mn
14432 Generate code for the H8S and H8/300H in the normal mode.  This switch
14433 must be used either with @option{-mh} or @option{-ms}.
14435 @item -ms2600
14436 @opindex ms2600
14437 Generate code for the H8S/2600.  This switch must be used with @option{-ms}.
14439 @item -mexr
14440 @opindex mexr
14441 Extended registers are stored on stack before execution of function
14442 with monitor attribute. Default option is @option{-mexr}.
14443 This option is valid only for H8S targets.
14445 @item -mno-exr
14446 @opindex mno-exr
14447 Extended registers are not stored on stack before execution of function 
14448 with monitor attribute. Default option is @option{-mno-exr}. 
14449 This option is valid only for H8S targets.
14451 @item -mint32
14452 @opindex mint32
14453 Make @code{int} data 32 bits by default.
14455 @item -malign-300
14456 @opindex malign-300
14457 On the H8/300H and H8S, use the same alignment rules as for the H8/300.
14458 The default for the H8/300H and H8S is to align longs and floats on
14459 4-byte boundaries.
14460 @option{-malign-300} causes them to be aligned on 2-byte boundaries.
14461 This option has no effect on the H8/300.
14462 @end table
14464 @node HPPA Options
14465 @subsection HPPA Options
14466 @cindex HPPA Options
14468 These @samp{-m} options are defined for the HPPA family of computers:
14470 @table @gcctabopt
14471 @item -march=@var{architecture-type}
14472 @opindex march
14473 Generate code for the specified architecture.  The choices for
14474 @var{architecture-type} are @samp{1.0} for PA 1.0, @samp{1.1} for PA
14475 1.1, and @samp{2.0} for PA 2.0 processors.  Refer to
14476 @file{/usr/lib/sched.models} on an HP-UX system to determine the proper
14477 architecture option for your machine.  Code compiled for lower numbered
14478 architectures runs on higher numbered architectures, but not the
14479 other way around.
14481 @item -mpa-risc-1-0
14482 @itemx -mpa-risc-1-1
14483 @itemx -mpa-risc-2-0
14484 @opindex mpa-risc-1-0
14485 @opindex mpa-risc-1-1
14486 @opindex mpa-risc-2-0
14487 Synonyms for @option{-march=1.0}, @option{-march=1.1}, and @option{-march=2.0} respectively.
14489 @item -mjump-in-delay
14490 @opindex mjump-in-delay
14491 Fill delay slots of function calls with unconditional jump instructions
14492 by modifying the return pointer for the function call to be the target
14493 of the conditional jump.
14495 @item -mdisable-fpregs
14496 @opindex mdisable-fpregs
14497 Prevent floating-point registers from being used in any manner.  This is
14498 necessary for compiling kernels that perform lazy context switching of
14499 floating-point registers.  If you use this option and attempt to perform
14500 floating-point operations, the compiler aborts.
14502 @item -mdisable-indexing
14503 @opindex mdisable-indexing
14504 Prevent the compiler from using indexing address modes.  This avoids some
14505 rather obscure problems when compiling MIG generated code under MACH@.
14507 @item -mno-space-regs
14508 @opindex mno-space-regs
14509 Generate code that assumes the target has no space registers.  This allows
14510 GCC to generate faster indirect calls and use unscaled index address modes.
14512 Such code is suitable for level 0 PA systems and kernels.
14514 @item -mfast-indirect-calls
14515 @opindex mfast-indirect-calls
14516 Generate code that assumes calls never cross space boundaries.  This
14517 allows GCC to emit code that performs faster indirect calls.
14519 This option does not work in the presence of shared libraries or nested
14520 functions.
14522 @item -mfixed-range=@var{register-range}
14523 @opindex mfixed-range
14524 Generate code treating the given register range as fixed registers.
14525 A fixed register is one that the register allocator cannot use.  This is
14526 useful when compiling kernel code.  A register range is specified as
14527 two registers separated by a dash.  Multiple register ranges can be
14528 specified separated by a comma.
14530 @item -mlong-load-store
14531 @opindex mlong-load-store
14532 Generate 3-instruction load and store sequences as sometimes required by
14533 the HP-UX 10 linker.  This is equivalent to the @samp{+k} option to
14534 the HP compilers.
14536 @item -mportable-runtime
14537 @opindex mportable-runtime
14538 Use the portable calling conventions proposed by HP for ELF systems.
14540 @item -mgas
14541 @opindex mgas
14542 Enable the use of assembler directives only GAS understands.
14544 @item -mschedule=@var{cpu-type}
14545 @opindex mschedule
14546 Schedule code according to the constraints for the machine type
14547 @var{cpu-type}.  The choices for @var{cpu-type} are @samp{700}
14548 @samp{7100}, @samp{7100LC}, @samp{7200}, @samp{7300} and @samp{8000}.  Refer
14549 to @file{/usr/lib/sched.models} on an HP-UX system to determine the
14550 proper scheduling option for your machine.  The default scheduling is
14551 @samp{8000}.
14553 @item -mlinker-opt
14554 @opindex mlinker-opt
14555 Enable the optimization pass in the HP-UX linker.  Note this makes symbolic
14556 debugging impossible.  It also triggers a bug in the HP-UX 8 and HP-UX 9
14557 linkers in which they give bogus error messages when linking some programs.
14559 @item -msoft-float
14560 @opindex msoft-float
14561 Generate output containing library calls for floating point.
14562 @strong{Warning:} the requisite libraries are not available for all HPPA
14563 targets.  Normally the facilities of the machine's usual C compiler are
14564 used, but this cannot be done directly in cross-compilation.  You must make
14565 your own arrangements to provide suitable library functions for
14566 cross-compilation.
14568 @option{-msoft-float} changes the calling convention in the output file;
14569 therefore, it is only useful if you compile @emph{all} of a program with
14570 this option.  In particular, you need to compile @file{libgcc.a}, the
14571 library that comes with GCC, with @option{-msoft-float} in order for
14572 this to work.
14574 @item -msio
14575 @opindex msio
14576 Generate the predefine, @code{_SIO}, for server IO@.  The default is
14577 @option{-mwsio}.  This generates the predefines, @code{__hp9000s700},
14578 @code{__hp9000s700__} and @code{_WSIO}, for workstation IO@.  These
14579 options are available under HP-UX and HI-UX@.
14581 @item -mgnu-ld
14582 @opindex mgnu-ld
14583 Use options specific to GNU @command{ld}.
14584 This passes @option{-shared} to @command{ld} when
14585 building a shared library.  It is the default when GCC is configured,
14586 explicitly or implicitly, with the GNU linker.  This option does not
14587 affect which @command{ld} is called; it only changes what parameters
14588 are passed to that @command{ld}.
14589 The @command{ld} that is called is determined by the
14590 @option{--with-ld} configure option, GCC's program search path, and
14591 finally by the user's @env{PATH}.  The linker used by GCC can be printed
14592 using @samp{which `gcc -print-prog-name=ld`}.  This option is only available
14593 on the 64-bit HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14595 @item -mhp-ld
14596 @opindex mhp-ld
14597 Use options specific to HP @command{ld}.
14598 This passes @option{-b} to @command{ld} when building
14599 a shared library and passes @option{+Accept TypeMismatch} to @command{ld} on all
14600 links.  It is the default when GCC is configured, explicitly or
14601 implicitly, with the HP linker.  This option does not affect
14602 which @command{ld} is called; it only changes what parameters are passed to that
14603 @command{ld}.
14604 The @command{ld} that is called is determined by the @option{--with-ld}
14605 configure option, GCC's program search path, and finally by the user's
14606 @env{PATH}.  The linker used by GCC can be printed using @samp{which
14607 `gcc -print-prog-name=ld`}.  This option is only available on the 64-bit
14608 HP-UX GCC, i.e.@: configured with @samp{hppa*64*-*-hpux*}.
14610 @item -mlong-calls
14611 @opindex mno-long-calls
14612 Generate code that uses long call sequences.  This ensures that a call
14613 is always able to reach linker generated stubs.  The default is to generate
14614 long calls only when the distance from the call site to the beginning
14615 of the function or translation unit, as the case may be, exceeds a
14616 predefined limit set by the branch type being used.  The limits for
14617 normal calls are 7,600,000 and 240,000 bytes, respectively for the
14618 PA 2.0 and PA 1.X architectures.  Sibcalls are always limited at
14619 240,000 bytes.
14621 Distances are measured from the beginning of functions when using the
14622 @option{-ffunction-sections} option, or when using the @option{-mgas}
14623 and @option{-mno-portable-runtime} options together under HP-UX with
14624 the SOM linker.
14626 It is normally not desirable to use this option as it degrades
14627 performance.  However, it may be useful in large applications,
14628 particularly when partial linking is used to build the application.
14630 The types of long calls used depends on the capabilities of the
14631 assembler and linker, and the type of code being generated.  The
14632 impact on systems that support long absolute calls, and long pic
14633 symbol-difference or pc-relative calls should be relatively small.
14634 However, an indirect call is used on 32-bit ELF systems in pic code
14635 and it is quite long.
14637 @item -munix=@var{unix-std}
14638 @opindex march
14639 Generate compiler predefines and select a startfile for the specified
14640 UNIX standard.  The choices for @var{unix-std} are @samp{93}, @samp{95}
14641 and @samp{98}.  @samp{93} is supported on all HP-UX versions.  @samp{95}
14642 is available on HP-UX 10.10 and later.  @samp{98} is available on HP-UX
14643 11.11 and later.  The default values are @samp{93} for HP-UX 10.00,
14644 @samp{95} for HP-UX 10.10 though to 11.00, and @samp{98} for HP-UX 11.11
14645 and later.
14647 @option{-munix=93} provides the same predefines as GCC 3.3 and 3.4.
14648 @option{-munix=95} provides additional predefines for @code{XOPEN_UNIX}
14649 and @code{_XOPEN_SOURCE_EXTENDED}, and the startfile @file{unix95.o}.
14650 @option{-munix=98} provides additional predefines for @code{_XOPEN_UNIX},
14651 @code{_XOPEN_SOURCE_EXTENDED}, @code{_INCLUDE__STDC_A1_SOURCE} and
14652 @code{_INCLUDE_XOPEN_SOURCE_500}, and the startfile @file{unix98.o}.
14654 It is @emph{important} to note that this option changes the interfaces
14655 for various library routines.  It also affects the operational behavior
14656 of the C library.  Thus, @emph{extreme} care is needed in using this
14657 option.
14659 Library code that is intended to operate with more than one UNIX
14660 standard must test, set and restore the variable @var{__xpg4_extended_mask}
14661 as appropriate.  Most GNU software doesn't provide this capability.
14663 @item -nolibdld
14664 @opindex nolibdld
14665 Suppress the generation of link options to search libdld.sl when the
14666 @option{-static} option is specified on HP-UX 10 and later.
14668 @item -static
14669 @opindex static
14670 The HP-UX implementation of setlocale in libc has a dependency on
14671 libdld.sl.  There isn't an archive version of libdld.sl.  Thus,
14672 when the @option{-static} option is specified, special link options
14673 are needed to resolve this dependency.
14675 On HP-UX 10 and later, the GCC driver adds the necessary options to
14676 link with libdld.sl when the @option{-static} option is specified.
14677 This causes the resulting binary to be dynamic.  On the 64-bit port,
14678 the linkers generate dynamic binaries by default in any case.  The
14679 @option{-nolibdld} option can be used to prevent the GCC driver from
14680 adding these link options.
14682 @item -threads
14683 @opindex threads
14684 Add support for multithreading with the @dfn{dce thread} library
14685 under HP-UX@.  This option sets flags for both the preprocessor and
14686 linker.
14687 @end table
14689 @node i386 and x86-64 Options
14690 @subsection Intel 386 and AMD x86-64 Options
14691 @cindex i386 Options
14692 @cindex x86-64 Options
14693 @cindex Intel 386 Options
14694 @cindex AMD x86-64 Options
14696 These @samp{-m} options are defined for the i386 and x86-64 family of
14697 computers:
14699 @table @gcctabopt
14701 @item -march=@var{cpu-type}
14702 @opindex march
14703 Generate instructions for the machine type @var{cpu-type}.  In contrast to
14704 @option{-mtune=@var{cpu-type}}, which merely tunes the generated code 
14705 for the specified @var{cpu-type}, @option{-march=@var{cpu-type}} allows GCC
14706 to generate code that may not run at all on processors other than the one
14707 indicated.  Specifying @option{-march=@var{cpu-type}} implies 
14708 @option{-mtune=@var{cpu-type}}.
14710 The choices for @var{cpu-type} are:
14712 @table @samp
14713 @item native
14714 This selects the CPU to generate code for at compilation time by determining
14715 the processor type of the compiling machine.  Using @option{-march=native}
14716 enables all instruction subsets supported by the local machine (hence
14717 the result might not run on different machines).  Using @option{-mtune=native}
14718 produces code optimized for the local machine under the constraints
14719 of the selected instruction set.  
14721 @item i386
14722 Original Intel i386 CPU@.
14724 @item i486
14725 Intel i486 CPU@.  (No scheduling is implemented for this chip.)
14727 @item i586
14728 @itemx pentium
14729 Intel Pentium CPU with no MMX support.
14731 @item pentium-mmx
14732 Intel Pentium MMX CPU, based on Pentium core with MMX instruction set support.
14734 @item pentiumpro
14735 Intel Pentium Pro CPU@.
14737 @item i686
14738 When used with @option{-march}, the Pentium Pro
14739 instruction set is used, so the code runs on all i686 family chips.
14740 When used with @option{-mtune}, it has the same meaning as @samp{generic}.
14742 @item pentium2
14743 Intel Pentium II CPU, based on Pentium Pro core with MMX instruction set
14744 support.
14746 @item pentium3
14747 @itemx pentium3m
14748 Intel Pentium III CPU, based on Pentium Pro core with MMX and SSE instruction
14749 set support.
14751 @item pentium-m
14752 Intel Pentium M; low-power version of Intel Pentium III CPU
14753 with MMX, SSE and SSE2 instruction set support.  Used by Centrino notebooks.
14755 @item pentium4
14756 @itemx pentium4m
14757 Intel Pentium 4 CPU with MMX, SSE and SSE2 instruction set support.
14759 @item prescott
14760 Improved version of Intel Pentium 4 CPU with MMX, SSE, SSE2 and SSE3 instruction
14761 set support.
14763 @item nocona
14764 Improved version of Intel Pentium 4 CPU with 64-bit extensions, MMX, SSE,
14765 SSE2 and SSE3 instruction set support.
14767 @item core2
14768 Intel Core 2 CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3 and SSSE3
14769 instruction set support.
14771 @item nehalem
14772 Intel Nehalem CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14773 SSE4.1, SSE4.2 and POPCNT instruction set support.
14775 @item westmere
14776 Intel Westmere CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14777 SSE4.1, SSE4.2, POPCNT, AES and PCLMUL instruction set support.
14779 @item sandybridge
14780 Intel Sandy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14781 SSE4.1, SSE4.2, POPCNT, AVX, AES and PCLMUL instruction set support.
14783 @item ivybridge
14784 Intel Ivy Bridge CPU with 64-bit extensions, MMX, SSE, SSE2, SSE3, SSSE3,
14785 SSE4.1, SSE4.2, POPCNT, AVX, AES, PCLMUL, FSGSBASE, RDRND and F16C
14786 instruction set support.
14788 @item haswell
14789 Intel Haswell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14790 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14791 BMI, BMI2 and F16C instruction set support.
14793 @item broadwell
14794 Intel Broadwell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14795 SSE4.1, SSE4.2, POPCNT, AVX, AVX2, AES, PCLMUL, FSGSBASE, RDRND, FMA,
14796 BMI, BMI2, F16C, RDSEED, ADCX and PREFETCHW instruction set support.
14798 @item bonnell
14799 Intel Bonnell CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3 and SSSE3
14800 instruction set support.
14802 @item silvermont
14803 Intel Silvermont CPU with 64-bit extensions, MOVBE, MMX, SSE, SSE2, SSE3, SSSE3,
14804 SSE4.1, SSE4.2, POPCNT, AES, PCLMUL and RDRND instruction set support.
14806 @item k6
14807 AMD K6 CPU with MMX instruction set support.
14809 @item k6-2
14810 @itemx k6-3
14811 Improved versions of AMD K6 CPU with MMX and 3DNow!@: instruction set support.
14813 @item athlon
14814 @itemx athlon-tbird
14815 AMD Athlon CPU with MMX, 3dNOW!, enhanced 3DNow!@: and SSE prefetch instructions
14816 support.
14818 @item athlon-4
14819 @itemx athlon-xp
14820 @itemx athlon-mp
14821 Improved AMD Athlon CPU with MMX, 3DNow!, enhanced 3DNow!@: and full SSE
14822 instruction set support.
14824 @item k8
14825 @itemx opteron
14826 @itemx athlon64
14827 @itemx athlon-fx
14828 Processors based on the AMD K8 core with x86-64 instruction set support,
14829 including the AMD Opteron, Athlon 64, and Athlon 64 FX processors.
14830 (This supersets MMX, SSE, SSE2, 3DNow!, enhanced 3DNow!@: and 64-bit
14831 instruction set extensions.)
14833 @item k8-sse3
14834 @itemx opteron-sse3
14835 @itemx athlon64-sse3
14836 Improved versions of AMD K8 cores with SSE3 instruction set support.
14838 @item amdfam10
14839 @itemx barcelona
14840 CPUs based on AMD Family 10h cores with x86-64 instruction set support.  (This
14841 supersets MMX, SSE, SSE2, SSE3, SSE4A, 3DNow!, enhanced 3DNow!, ABM and 64-bit
14842 instruction set extensions.)
14844 @item bdver1
14845 CPUs based on AMD Family 15h cores with x86-64 instruction set support.  (This
14846 supersets FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A,
14847 SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set extensions.)
14848 @item bdver2
14849 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14850 supersets BMI, TBM, F16C, FMA, FMA4, AVX, XOP, LWP, AES, PCL_MUL, CX16, MMX,
14851 SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 64-bit instruction set 
14852 extensions.)
14853 @item bdver3
14854 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14855 supersets BMI, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, XOP, LWP, AES, 
14856 PCL_MUL, CX16, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, SSE4.2, ABM and 
14857 64-bit instruction set extensions.
14858 @item bdver4
14859 AMD Family 15h core based CPUs with x86-64 instruction set support.  (This
14860 supersets BMI, BMI2, TBM, F16C, FMA, FMA4, FSGSBASE, AVX, AVX2, XOP, LWP, 
14861 AES, PCL_MUL, CX16, MOVBE, MMX, SSE, SSE2, SSE3, SSE4A, SSSE3, SSE4.1, 
14862 SSE4.2, ABM and 64-bit instruction set extensions.
14864 @item btver1
14865 CPUs based on AMD Family 14h cores with x86-64 instruction set support.  (This
14866 supersets MMX, SSE, SSE2, SSE3, SSSE3, SSE4A, CX16, ABM and 64-bit
14867 instruction set extensions.)
14869 @item btver2
14870 CPUs based on AMD Family 16h cores with x86-64 instruction set support. This
14871 includes MOVBE, F16C, BMI, AVX, PCL_MUL, AES, SSE4.2, SSE4.1, CX16, ABM,
14872 SSE4A, SSSE3, SSE3, SSE2, SSE, MMX and 64-bit instruction set extensions.
14874 @item winchip-c6
14875 IDT WinChip C6 CPU, dealt in same way as i486 with additional MMX instruction
14876 set support.
14878 @item winchip2
14879 IDT WinChip 2 CPU, dealt in same way as i486 with additional MMX and 3DNow!@:
14880 instruction set support.
14882 @item c3
14883 VIA C3 CPU with MMX and 3DNow!@: instruction set support.  (No scheduling is
14884 implemented for this chip.)
14886 @item c3-2
14887 VIA C3-2 (Nehemiah/C5XL) CPU with MMX and SSE instruction set support.
14888 (No scheduling is
14889 implemented for this chip.)
14891 @item geode
14892 AMD Geode embedded processor with MMX and 3DNow!@: instruction set support.
14893 @end table
14895 @item -mtune=@var{cpu-type}
14896 @opindex mtune
14897 Tune to @var{cpu-type} everything applicable about the generated code, except
14898 for the ABI and the set of available instructions.  
14899 While picking a specific @var{cpu-type} schedules things appropriately
14900 for that particular chip, the compiler does not generate any code that
14901 cannot run on the default machine type unless you use a
14902 @option{-march=@var{cpu-type}} option.
14903 For example, if GCC is configured for i686-pc-linux-gnu
14904 then @option{-mtune=pentium4} generates code that is tuned for Pentium 4
14905 but still runs on i686 machines.
14907 The choices for @var{cpu-type} are the same as for @option{-march}.
14908 In addition, @option{-mtune} supports 2 extra choices for @var{cpu-type}:
14910 @table @samp
14911 @item generic
14912 Produce code optimized for the most common IA32/@/AMD64/@/EM64T processors.
14913 If you know the CPU on which your code will run, then you should use
14914 the corresponding @option{-mtune} or @option{-march} option instead of
14915 @option{-mtune=generic}.  But, if you do not know exactly what CPU users
14916 of your application will have, then you should use this option.
14918 As new processors are deployed in the marketplace, the behavior of this
14919 option will change.  Therefore, if you upgrade to a newer version of
14920 GCC, code generation controlled by this option will change to reflect
14921 the processors
14922 that are most common at the time that version of GCC is released.
14924 There is no @option{-march=generic} option because @option{-march}
14925 indicates the instruction set the compiler can use, and there is no
14926 generic instruction set applicable to all processors.  In contrast,
14927 @option{-mtune} indicates the processor (or, in this case, collection of
14928 processors) for which the code is optimized.
14930 @item intel
14931 Produce code optimized for the most current Intel processors, which are
14932 Haswell and Silvermont for this version of GCC.  If you know the CPU
14933 on which your code will run, then you should use the corresponding
14934 @option{-mtune} or @option{-march} option instead of @option{-mtune=intel}.
14935 But, if you want your application performs better on both Haswell and
14936 Silvermont, then you should use this option.
14938 As new Intel processors are deployed in the marketplace, the behavior of
14939 this option will change.  Therefore, if you upgrade to a newer version of
14940 GCC, code generation controlled by this option will change to reflect
14941 the most current Intel processors at the time that version of GCC is
14942 released.
14944 There is no @option{-march=intel} option because @option{-march} indicates
14945 the instruction set the compiler can use, and there is no common
14946 instruction set applicable to all processors.  In contrast,
14947 @option{-mtune} indicates the processor (or, in this case, collection of
14948 processors) for which the code is optimized.
14949 @end table
14951 @item -mcpu=@var{cpu-type}
14952 @opindex mcpu
14953 A deprecated synonym for @option{-mtune}.
14955 @item -mfpmath=@var{unit}
14956 @opindex mfpmath
14957 Generate floating-point arithmetic for selected unit @var{unit}.  The choices
14958 for @var{unit} are:
14960 @table @samp
14961 @item 387
14962 Use the standard 387 floating-point coprocessor present on the majority of chips and
14963 emulated otherwise.  Code compiled with this option runs almost everywhere.
14964 The temporary results are computed in 80-bit precision instead of the precision
14965 specified by the type, resulting in slightly different results compared to most
14966 of other chips.  See @option{-ffloat-store} for more detailed description.
14968 This is the default choice for i386 compiler.
14970 @item sse
14971 Use scalar floating-point instructions present in the SSE instruction set.
14972 This instruction set is supported by Pentium III and newer chips,
14973 and in the AMD line
14974 by Athlon-4, Athlon XP and Athlon MP chips.  The earlier version of the SSE
14975 instruction set supports only single-precision arithmetic, thus the double and
14976 extended-precision arithmetic are still done using 387.  A later version, present
14977 only in Pentium 4 and AMD x86-64 chips, supports double-precision
14978 arithmetic too.
14980 For the i386 compiler, you must use @option{-march=@var{cpu-type}}, @option{-msse}
14981 or @option{-msse2} switches to enable SSE extensions and make this option
14982 effective.  For the x86-64 compiler, these extensions are enabled by default.
14984 The resulting code should be considerably faster in the majority of cases and avoid
14985 the numerical instability problems of 387 code, but may break some existing
14986 code that expects temporaries to be 80 bits.
14988 This is the default choice for the x86-64 compiler.
14990 @item sse,387
14991 @itemx sse+387
14992 @itemx both
14993 Attempt to utilize both instruction sets at once.  This effectively doubles the
14994 amount of available registers, and on chips with separate execution units for
14995 387 and SSE the execution resources too.  Use this option with care, as it is
14996 still experimental, because the GCC register allocator does not model separate
14997 functional units well, resulting in unstable performance.
14998 @end table
15000 @item -masm=@var{dialect}
15001 @opindex masm=@var{dialect}
15002 Output assembly instructions using selected @var{dialect}.  Supported
15003 choices are @samp{intel} or @samp{att} (the default).  Darwin does
15004 not support @samp{intel}.
15006 @item -mieee-fp
15007 @itemx -mno-ieee-fp
15008 @opindex mieee-fp
15009 @opindex mno-ieee-fp
15010 Control whether or not the compiler uses IEEE floating-point
15011 comparisons.  These correctly handle the case where the result of a
15012 comparison is unordered.
15014 @item -msoft-float
15015 @opindex msoft-float
15016 Generate output containing library calls for floating point.
15018 @strong{Warning:} the requisite libraries are not part of GCC@.
15019 Normally the facilities of the machine's usual C compiler are used, but
15020 this can't be done directly in cross-compilation.  You must make your
15021 own arrangements to provide suitable library functions for
15022 cross-compilation.
15024 On machines where a function returns floating-point results in the 80387
15025 register stack, some floating-point opcodes may be emitted even if
15026 @option{-msoft-float} is used.
15028 @item -mno-fp-ret-in-387
15029 @opindex mno-fp-ret-in-387
15030 Do not use the FPU registers for return values of functions.
15032 The usual calling convention has functions return values of types
15033 @code{float} and @code{double} in an FPU register, even if there
15034 is no FPU@.  The idea is that the operating system should emulate
15035 an FPU@.
15037 The option @option{-mno-fp-ret-in-387} causes such values to be returned
15038 in ordinary CPU registers instead.
15040 @item -mno-fancy-math-387
15041 @opindex mno-fancy-math-387
15042 Some 387 emulators do not support the @code{sin}, @code{cos} and
15043 @code{sqrt} instructions for the 387.  Specify this option to avoid
15044 generating those instructions.  This option is the default on FreeBSD,
15045 OpenBSD and NetBSD@.  This option is overridden when @option{-march}
15046 indicates that the target CPU always has an FPU and so the
15047 instruction does not need emulation.  These
15048 instructions are not generated unless you also use the
15049 @option{-funsafe-math-optimizations} switch.
15051 @item -malign-double
15052 @itemx -mno-align-double
15053 @opindex malign-double
15054 @opindex mno-align-double
15055 Control whether GCC aligns @code{double}, @code{long double}, and
15056 @code{long long} variables on a two-word boundary or a one-word
15057 boundary.  Aligning @code{double} variables on a two-word boundary
15058 produces code that runs somewhat faster on a Pentium at the
15059 expense of more memory.
15061 On x86-64, @option{-malign-double} is enabled by default.
15063 @strong{Warning:} if you use the @option{-malign-double} switch,
15064 structures containing the above types are aligned differently than
15065 the published application binary interface specifications for the 386
15066 and are not binary compatible with structures in code compiled
15067 without that switch.
15069 @item -m96bit-long-double
15070 @itemx -m128bit-long-double
15071 @opindex m96bit-long-double
15072 @opindex m128bit-long-double
15073 These switches control the size of @code{long double} type.  The i386
15074 application binary interface specifies the size to be 96 bits,
15075 so @option{-m96bit-long-double} is the default in 32-bit mode.
15077 Modern architectures (Pentium and newer) prefer @code{long double}
15078 to be aligned to an 8- or 16-byte boundary.  In arrays or structures
15079 conforming to the ABI, this is not possible.  So specifying
15080 @option{-m128bit-long-double} aligns @code{long double}
15081 to a 16-byte boundary by padding the @code{long double} with an additional
15082 32-bit zero.
15084 In the x86-64 compiler, @option{-m128bit-long-double} is the default choice as
15085 its ABI specifies that @code{long double} is aligned on 16-byte boundary.
15087 Notice that neither of these options enable any extra precision over the x87
15088 standard of 80 bits for a @code{long double}.
15090 @strong{Warning:} if you override the default value for your target ABI, this
15091 changes the size of 
15092 structures and arrays containing @code{long double} variables,
15093 as well as modifying the function calling convention for functions taking
15094 @code{long double}.  Hence they are not binary-compatible
15095 with code compiled without that switch.
15097 @item -mlong-double-64
15098 @itemx -mlong-double-80
15099 @itemx -mlong-double-128
15100 @opindex mlong-double-64
15101 @opindex mlong-double-80
15102 @opindex mlong-double-128
15103 These switches control the size of @code{long double} type. A size
15104 of 64 bits makes the @code{long double} type equivalent to the @code{double}
15105 type. This is the default for 32-bit Bionic C library.  A size
15106 of 128 bits makes the @code{long double} type equivalent to the
15107 @code{__float128} type. This is the default for 64-bit Bionic C library.
15109 @strong{Warning:} if you override the default value for your target ABI, this
15110 changes the size of
15111 structures and arrays containing @code{long double} variables,
15112 as well as modifying the function calling convention for functions taking
15113 @code{long double}.  Hence they are not binary-compatible
15114 with code compiled without that switch.
15116 @item -mlarge-data-threshold=@var{threshold}
15117 @opindex mlarge-data-threshold
15118 When @option{-mcmodel=medium} is specified, data objects larger than
15119 @var{threshold} are placed in the large data section.  This value must be the
15120 same across all objects linked into the binary, and defaults to 65535.
15122 @item -mrtd
15123 @opindex mrtd
15124 Use a different function-calling convention, in which functions that
15125 take a fixed number of arguments return with the @code{ret @var{num}}
15126 instruction, which pops their arguments while returning.  This saves one
15127 instruction in the caller since there is no need to pop the arguments
15128 there.
15130 You can specify that an individual function is called with this calling
15131 sequence with the function attribute @samp{stdcall}.  You can also
15132 override the @option{-mrtd} option by using the function attribute
15133 @samp{cdecl}.  @xref{Function Attributes}.
15135 @strong{Warning:} this calling convention is incompatible with the one
15136 normally used on Unix, so you cannot use it if you need to call
15137 libraries compiled with the Unix compiler.
15139 Also, you must provide function prototypes for all functions that
15140 take variable numbers of arguments (including @code{printf});
15141 otherwise incorrect code is generated for calls to those
15142 functions.
15144 In addition, seriously incorrect code results if you call a
15145 function with too many arguments.  (Normally, extra arguments are
15146 harmlessly ignored.)
15148 @item -mregparm=@var{num}
15149 @opindex mregparm
15150 Control how many registers are used to pass integer arguments.  By
15151 default, no registers are used to pass arguments, and at most 3
15152 registers can be used.  You can control this behavior for a specific
15153 function by using the function attribute @samp{regparm}.
15154 @xref{Function Attributes}.
15156 @strong{Warning:} if you use this switch, and
15157 @var{num} is nonzero, then you must build all modules with the same
15158 value, including any libraries.  This includes the system libraries and
15159 startup modules.
15161 @item -msseregparm
15162 @opindex msseregparm
15163 Use SSE register passing conventions for float and double arguments
15164 and return values.  You can control this behavior for a specific
15165 function by using the function attribute @samp{sseregparm}.
15166 @xref{Function Attributes}.
15168 @strong{Warning:} if you use this switch then you must build all
15169 modules with the same value, including any libraries.  This includes
15170 the system libraries and startup modules.
15172 @item -mvect8-ret-in-mem
15173 @opindex mvect8-ret-in-mem
15174 Return 8-byte vectors in memory instead of MMX registers.  This is the
15175 default on Solaris@tie{}8 and 9 and VxWorks to match the ABI of the Sun
15176 Studio compilers until version 12.  Later compiler versions (starting
15177 with Studio 12 Update@tie{}1) follow the ABI used by other x86 targets, which
15178 is the default on Solaris@tie{}10 and later.  @emph{Only} use this option if
15179 you need to remain compatible with existing code produced by those
15180 previous compiler versions or older versions of GCC@.
15182 @item -mpc32
15183 @itemx -mpc64
15184 @itemx -mpc80
15185 @opindex mpc32
15186 @opindex mpc64
15187 @opindex mpc80
15189 Set 80387 floating-point precision to 32, 64 or 80 bits.  When @option{-mpc32}
15190 is specified, the significands of results of floating-point operations are
15191 rounded to 24 bits (single precision); @option{-mpc64} rounds the
15192 significands of results of floating-point operations to 53 bits (double
15193 precision) and @option{-mpc80} rounds the significands of results of
15194 floating-point operations to 64 bits (extended double precision), which is
15195 the default.  When this option is used, floating-point operations in higher
15196 precisions are not available to the programmer without setting the FPU
15197 control word explicitly.
15199 Setting the rounding of floating-point operations to less than the default
15200 80 bits can speed some programs by 2% or more.  Note that some mathematical
15201 libraries assume that extended-precision (80-bit) floating-point operations
15202 are enabled by default; routines in such libraries could suffer significant
15203 loss of accuracy, typically through so-called ``catastrophic cancellation'',
15204 when this option is used to set the precision to less than extended precision.
15206 @item -mstackrealign
15207 @opindex mstackrealign
15208 Realign the stack at entry.  On the Intel x86, the @option{-mstackrealign}
15209 option generates an alternate prologue and epilogue that realigns the
15210 run-time stack if necessary.  This supports mixing legacy codes that keep
15211 4-byte stack alignment with modern codes that keep 16-byte stack alignment for
15212 SSE compatibility.  See also the attribute @code{force_align_arg_pointer},
15213 applicable to individual functions.
15215 @item -mpreferred-stack-boundary=@var{num}
15216 @opindex mpreferred-stack-boundary
15217 Attempt to keep the stack boundary aligned to a 2 raised to @var{num}
15218 byte boundary.  If @option{-mpreferred-stack-boundary} is not specified,
15219 the default is 4 (16 bytes or 128 bits).
15221 @strong{Warning:} When generating code for the x86-64 architecture with
15222 SSE extensions disabled, @option{-mpreferred-stack-boundary=3} can be
15223 used to keep the stack boundary aligned to 8 byte boundary.  Since
15224 x86-64 ABI require 16 byte stack alignment, this is ABI incompatible and
15225 intended to be used in controlled environment where stack space is
15226 important limitation.  This option will lead to wrong code when functions
15227 compiled with 16 byte stack alignment (such as functions from a standard
15228 library) are called with misaligned stack.  In this case, SSE
15229 instructions may lead to misaligned memory access traps.  In addition,
15230 variable arguments will be handled incorrectly for 16 byte aligned
15231 objects (including x87 long double and __int128), leading to wrong
15232 results.  You must build all modules with
15233 @option{-mpreferred-stack-boundary=3}, including any libraries.  This
15234 includes the system libraries and startup modules.
15236 @item -mincoming-stack-boundary=@var{num}
15237 @opindex mincoming-stack-boundary
15238 Assume the incoming stack is aligned to a 2 raised to @var{num} byte
15239 boundary.  If @option{-mincoming-stack-boundary} is not specified,
15240 the one specified by @option{-mpreferred-stack-boundary} is used.
15242 On Pentium and Pentium Pro, @code{double} and @code{long double} values
15243 should be aligned to an 8-byte boundary (see @option{-malign-double}) or
15244 suffer significant run time performance penalties.  On Pentium III, the
15245 Streaming SIMD Extension (SSE) data type @code{__m128} may not work
15246 properly if it is not 16-byte aligned.
15248 To ensure proper alignment of this values on the stack, the stack boundary
15249 must be as aligned as that required by any value stored on the stack.
15250 Further, every function must be generated such that it keeps the stack
15251 aligned.  Thus calling a function compiled with a higher preferred
15252 stack boundary from a function compiled with a lower preferred stack
15253 boundary most likely misaligns the stack.  It is recommended that
15254 libraries that use callbacks always use the default setting.
15256 This extra alignment does consume extra stack space, and generally
15257 increases code size.  Code that is sensitive to stack space usage, such
15258 as embedded systems and operating system kernels, may want to reduce the
15259 preferred alignment to @option{-mpreferred-stack-boundary=2}.
15261 @item -mmmx
15262 @itemx -mno-mmx
15263 @itemx -msse
15264 @itemx -mno-sse
15265 @itemx -msse2
15266 @itemx -mno-sse2
15267 @itemx -msse3
15268 @itemx -mno-sse3
15269 @itemx -mssse3
15270 @itemx -mno-ssse3
15271 @itemx -msse4.1
15272 @need 800
15273 @itemx -mno-sse4.1
15274 @itemx -msse4.2
15275 @itemx -mno-sse4.2
15276 @itemx -msse4
15277 @itemx -mno-sse4
15278 @itemx -mavx
15279 @itemx -mno-avx
15280 @itemx -mavx2
15281 @itemx -mno-avx2
15282 @itemx -mavx512f
15283 @itemx -mno-avx512f
15284 @need 800
15285 @itemx -mavx512pf
15286 @itemx -mno-avx512pf
15287 @itemx -mavx512er
15288 @itemx -mno-avx512er
15289 @itemx -mavx512cd
15290 @itemx -mno-avx512cd
15291 @itemx -msha
15292 @itemx -mno-sha
15293 @itemx -maes
15294 @itemx -mno-aes
15295 @itemx -mpclmul
15296 @itemx -mno-pclmul
15297 @need 800
15298 @itemx -mfsgsbase
15299 @itemx -mno-fsgsbase
15300 @itemx -mrdrnd
15301 @itemx -mno-rdrnd
15302 @itemx -mf16c
15303 @itemx -mno-f16c
15304 @itemx -mfma
15305 @itemx -mno-fma
15306 @itemx -mprefetchwt1
15307 @itemx -mno-prefetchwt1
15308 @itemx -msse4a
15309 @itemx -mno-sse4a
15310 @itemx -mfma4
15311 @itemx -mno-fma4
15312 @need 800
15313 @itemx -mxop
15314 @itemx -mno-xop
15315 @itemx -mlwp
15316 @itemx -mno-lwp
15317 @itemx -m3dnow
15318 @itemx -mno-3dnow
15319 @itemx -mpopcnt
15320 @itemx -mno-popcnt
15321 @itemx -mabm
15322 @itemx -mno-abm
15323 @itemx -mbmi
15324 @itemx -mbmi2
15325 @itemx -mno-bmi
15326 @itemx -mno-bmi2
15327 @itemx -mlzcnt
15328 @itemx -mno-lzcnt
15329 @itemx -mfxsr
15330 @itemx -mxsave
15331 @itemx -mxsaveopt
15332 @itemx -mrtm
15333 @itemx -mtbm
15334 @itemx -mno-tbm
15335 @opindex mmmx
15336 @opindex mno-mmx
15337 @opindex msse
15338 @opindex mno-sse
15339 @opindex m3dnow
15340 @opindex mno-3dnow
15341 These switches enable or disable the use of instructions in the MMX, SSE,
15342 SSE2, SSE3, SSSE3, SSE4.1, AVX, AVX2, AVX512F, AVX512PF, AVX512ER, AVX512CD,
15343 SHA, AES, PCLMUL, FSGSBASE, RDRND, F16C, FMA, SSE4A, FMA4, XOP, LWP, ABM,
15344 BMI, BMI2, FXSR, XSAVE, XSAVEOPT, LZCNT, RTM, or 3DNow!@:
15345 extended instruction sets.
15346 These extensions are also available as built-in functions: see
15347 @ref{X86 Built-in Functions}, for details of the functions enabled and
15348 disabled by these switches.
15350 To generate SSE/SSE2 instructions automatically from floating-point
15351 code (as opposed to 387 instructions), see @option{-mfpmath=sse}.
15353 GCC depresses SSEx instructions when @option{-mavx} is used. Instead, it
15354 generates new AVX instructions or AVX equivalence for all SSEx instructions
15355 when needed.
15357 These options enable GCC to use these extended instructions in
15358 generated code, even without @option{-mfpmath=sse}.  Applications that
15359 perform run-time CPU detection must compile separate files for each
15360 supported architecture, using the appropriate flags.  In particular,
15361 the file containing the CPU detection code should be compiled without
15362 these options.
15364 @item -mdump-tune-features
15365 @opindex mdump-tune-features
15366 This option instructs GCC to dump the names of the x86 performance 
15367 tuning features and default settings. The names can be used in 
15368 @option{-mtune-ctrl=@var{feature-list}}.
15370 @item -mtune-ctrl=@var{feature-list}
15371 @opindex mtune-ctrl=@var{feature-list}
15372 This option is used to do fine grain control of x86 code generation features.
15373 @var{feature-list} is a comma separated list of @var{feature} names. See also
15374 @option{-mdump-tune-features}. When specified, the @var{feature} will be turned
15375 on if it is not preceded with @code{^}, otherwise, it will be turned off. 
15376 @option{-mtune-ctrl=@var{feature-list}} is intended to be used by GCC
15377 developers. Using it may lead to code paths not covered by testing and can
15378 potentially result in compiler ICEs or runtime errors.
15380 @item -mno-default
15381 @opindex mno-default
15382 This option instructs GCC to turn off all tunable features. See also 
15383 @option{-mtune-ctrl=@var{feature-list}} and @option{-mdump-tune-features}.
15385 @item -mcld
15386 @opindex mcld
15387 This option instructs GCC to emit a @code{cld} instruction in the prologue
15388 of functions that use string instructions.  String instructions depend on
15389 the DF flag to select between autoincrement or autodecrement mode.  While the
15390 ABI specifies the DF flag to be cleared on function entry, some operating
15391 systems violate this specification by not clearing the DF flag in their
15392 exception dispatchers.  The exception handler can be invoked with the DF flag
15393 set, which leads to wrong direction mode when string instructions are used.
15394 This option can be enabled by default on 32-bit x86 targets by configuring
15395 GCC with the @option{--enable-cld} configure option.  Generation of @code{cld}
15396 instructions can be suppressed with the @option{-mno-cld} compiler option
15397 in this case.
15399 @item -mvzeroupper
15400 @opindex mvzeroupper
15401 This option instructs GCC to emit a @code{vzeroupper} instruction
15402 before a transfer of control flow out of the function to minimize
15403 the AVX to SSE transition penalty as well as remove unnecessary @code{zeroupper}
15404 intrinsics.
15406 @item -mprefer-avx128
15407 @opindex mprefer-avx128
15408 This option instructs GCC to use 128-bit AVX instructions instead of
15409 256-bit AVX instructions in the auto-vectorizer.
15411 @item -mcx16
15412 @opindex mcx16
15413 This option enables GCC to generate @code{CMPXCHG16B} instructions.
15414 @code{CMPXCHG16B} allows for atomic operations on 128-bit double quadword
15415 (or oword) data types.  
15416 This is useful for high-resolution counters that can be updated
15417 by multiple processors (or cores).  This instruction is generated as part of
15418 atomic built-in functions: see @ref{__sync Builtins} or
15419 @ref{__atomic Builtins} for details.
15421 @item -msahf
15422 @opindex msahf
15423 This option enables generation of @code{SAHF} instructions in 64-bit code.
15424 Early Intel Pentium 4 CPUs with Intel 64 support,
15425 prior to the introduction of Pentium 4 G1 step in December 2005,
15426 lacked the @code{LAHF} and @code{SAHF} instructions
15427 which were supported by AMD64.
15428 These are load and store instructions, respectively, for certain status flags.
15429 In 64-bit mode, the @code{SAHF} instruction is used to optimize @code{fmod},
15430 @code{drem}, and @code{remainder} built-in functions;
15431 see @ref{Other Builtins} for details.
15433 @item -mmovbe
15434 @opindex mmovbe
15435 This option enables use of the @code{movbe} instruction to implement
15436 @code{__builtin_bswap32} and @code{__builtin_bswap64}.
15438 @item -mcrc32
15439 @opindex mcrc32
15440 This option enables built-in functions @code{__builtin_ia32_crc32qi},
15441 @code{__builtin_ia32_crc32hi}, @code{__builtin_ia32_crc32si} and
15442 @code{__builtin_ia32_crc32di} to generate the @code{crc32} machine instruction.
15444 @item -mrecip
15445 @opindex mrecip
15446 This option enables use of @code{RCPSS} and @code{RSQRTSS} instructions
15447 (and their vectorized variants @code{RCPPS} and @code{RSQRTPS})
15448 with an additional Newton-Raphson step
15449 to increase precision instead of @code{DIVSS} and @code{SQRTSS}
15450 (and their vectorized
15451 variants) for single-precision floating-point arguments.  These instructions
15452 are generated only when @option{-funsafe-math-optimizations} is enabled
15453 together with @option{-finite-math-only} and @option{-fno-trapping-math}.
15454 Note that while the throughput of the sequence is higher than the throughput
15455 of the non-reciprocal instruction, the precision of the sequence can be
15456 decreased by up to 2 ulp (i.e. the inverse of 1.0 equals 0.99999994).
15458 Note that GCC implements @code{1.0f/sqrtf(@var{x})} in terms of @code{RSQRTSS}
15459 (or @code{RSQRTPS}) already with @option{-ffast-math} (or the above option
15460 combination), and doesn't need @option{-mrecip}.
15462 Also note that GCC emits the above sequence with additional Newton-Raphson step
15463 for vectorized single-float division and vectorized @code{sqrtf(@var{x})}
15464 already with @option{-ffast-math} (or the above option combination), and
15465 doesn't need @option{-mrecip}.
15467 @item -mrecip=@var{opt}
15468 @opindex mrecip=opt
15469 This option controls which reciprocal estimate instructions
15470 may be used.  @var{opt} is a comma-separated list of options, which may
15471 be preceded by a @samp{!} to invert the option:
15473 @table @samp
15474 @item all
15475 Enable all estimate instructions.
15477 @item default
15478 Enable the default instructions, equivalent to @option{-mrecip}.
15480 @item none
15481 Disable all estimate instructions, equivalent to @option{-mno-recip}.
15483 @item div
15484 Enable the approximation for scalar division.
15486 @item vec-div
15487 Enable the approximation for vectorized division.
15489 @item sqrt
15490 Enable the approximation for scalar square root.
15492 @item vec-sqrt
15493 Enable the approximation for vectorized square root.
15494 @end table
15496 So, for example, @option{-mrecip=all,!sqrt} enables
15497 all of the reciprocal approximations, except for square root.
15499 @item -mveclibabi=@var{type}
15500 @opindex mveclibabi
15501 Specifies the ABI type to use for vectorizing intrinsics using an
15502 external library.  Supported values for @var{type} are @samp{svml} 
15503 for the Intel short
15504 vector math library and @samp{acml} for the AMD math core library.
15505 To use this option, both @option{-ftree-vectorize} and
15506 @option{-funsafe-math-optimizations} have to be enabled, and an SVML or ACML 
15507 ABI-compatible library must be specified at link time.
15509 GCC currently emits calls to @code{vmldExp2},
15510 @code{vmldLn2}, @code{vmldLog102}, @code{vmldLog102}, @code{vmldPow2},
15511 @code{vmldTanh2}, @code{vmldTan2}, @code{vmldAtan2}, @code{vmldAtanh2},
15512 @code{vmldCbrt2}, @code{vmldSinh2}, @code{vmldSin2}, @code{vmldAsinh2},
15513 @code{vmldAsin2}, @code{vmldCosh2}, @code{vmldCos2}, @code{vmldAcosh2},
15514 @code{vmldAcos2}, @code{vmlsExp4}, @code{vmlsLn4}, @code{vmlsLog104},
15515 @code{vmlsLog104}, @code{vmlsPow4}, @code{vmlsTanh4}, @code{vmlsTan4},
15516 @code{vmlsAtan4}, @code{vmlsAtanh4}, @code{vmlsCbrt4}, @code{vmlsSinh4},
15517 @code{vmlsSin4}, @code{vmlsAsinh4}, @code{vmlsAsin4}, @code{vmlsCosh4},
15518 @code{vmlsCos4}, @code{vmlsAcosh4} and @code{vmlsAcos4} for corresponding
15519 function type when @option{-mveclibabi=svml} is used, and @code{__vrd2_sin},
15520 @code{__vrd2_cos}, @code{__vrd2_exp}, @code{__vrd2_log}, @code{__vrd2_log2},
15521 @code{__vrd2_log10}, @code{__vrs4_sinf}, @code{__vrs4_cosf},
15522 @code{__vrs4_expf}, @code{__vrs4_logf}, @code{__vrs4_log2f},
15523 @code{__vrs4_log10f} and @code{__vrs4_powf} for the corresponding function type
15524 when @option{-mveclibabi=acml} is used.  
15526 @item -mabi=@var{name}
15527 @opindex mabi
15528 Generate code for the specified calling convention.  Permissible values
15529 are @samp{sysv} for the ABI used on GNU/Linux and other systems, and
15530 @samp{ms} for the Microsoft ABI.  The default is to use the Microsoft
15531 ABI when targeting Microsoft Windows and the SysV ABI on all other systems.
15532 You can control this behavior for a specific function by
15533 using the function attribute @samp{ms_abi}/@samp{sysv_abi}.
15534 @xref{Function Attributes}.
15536 @item -mtls-dialect=@var{type}
15537 @opindex mtls-dialect
15538 Generate code to access thread-local storage using the @samp{gnu} or
15539 @samp{gnu2} conventions.  @samp{gnu} is the conservative default;
15540 @samp{gnu2} is more efficient, but it may add compile- and run-time
15541 requirements that cannot be satisfied on all systems.
15543 @item -mpush-args
15544 @itemx -mno-push-args
15545 @opindex mpush-args
15546 @opindex mno-push-args
15547 Use PUSH operations to store outgoing parameters.  This method is shorter
15548 and usually equally fast as method using SUB/MOV operations and is enabled
15549 by default.  In some cases disabling it may improve performance because of
15550 improved scheduling and reduced dependencies.
15552 @item -maccumulate-outgoing-args
15553 @opindex maccumulate-outgoing-args
15554 If enabled, the maximum amount of space required for outgoing arguments is
15555 computed in the function prologue.  This is faster on most modern CPUs
15556 because of reduced dependencies, improved scheduling and reduced stack usage
15557 when the preferred stack boundary is not equal to 2.  The drawback is a notable
15558 increase in code size.  This switch implies @option{-mno-push-args}.
15560 @item -mthreads
15561 @opindex mthreads
15562 Support thread-safe exception handling on MinGW.  Programs that rely
15563 on thread-safe exception handling must compile and link all code with the
15564 @option{-mthreads} option.  When compiling, @option{-mthreads} defines
15565 @code{-D_MT}; when linking, it links in a special thread helper library
15566 @option{-lmingwthrd} which cleans up per-thread exception-handling data.
15568 @item -mno-align-stringops
15569 @opindex mno-align-stringops
15570 Do not align the destination of inlined string operations.  This switch reduces
15571 code size and improves performance in case the destination is already aligned,
15572 but GCC doesn't know about it.
15574 @item -minline-all-stringops
15575 @opindex minline-all-stringops
15576 By default GCC inlines string operations only when the destination is 
15577 known to be aligned to least a 4-byte boundary.  
15578 This enables more inlining and increases code
15579 size, but may improve performance of code that depends on fast
15580 @code{memcpy}, @code{strlen},
15581 and @code{memset} for short lengths.
15583 @item -minline-stringops-dynamically
15584 @opindex minline-stringops-dynamically
15585 For string operations of unknown size, use run-time checks with
15586 inline code for small blocks and a library call for large blocks.
15588 @item -mstringop-strategy=@var{alg}
15589 @opindex mstringop-strategy=@var{alg}
15590 Override the internal decision heuristic for the particular algorithm to use
15591 for inlining string operations.  The allowed values for @var{alg} are:
15593 @table @samp
15594 @item rep_byte
15595 @itemx rep_4byte
15596 @itemx rep_8byte
15597 Expand using i386 @code{rep} prefix of the specified size.
15599 @item byte_loop
15600 @itemx loop
15601 @itemx unrolled_loop
15602 Expand into an inline loop.
15604 @item libcall
15605 Always use a library call.
15606 @end table
15608 @item -mmemcpy-strategy=@var{strategy}
15609 @opindex mmemcpy-strategy=@var{strategy}
15610 Override the internal decision heuristic to decide if @code{__builtin_memcpy}
15611 should be inlined and what inline algorithm to use when the expected size
15612 of the copy operation is known. @var{strategy} 
15613 is a comma-separated list of @var{alg}:@var{max_size}:@var{dest_align} triplets. 
15614 @var{alg} is specified in @option{-mstringop-strategy}, @var{max_size} specifies
15615 the max byte size with which inline algorithm @var{alg} is allowed.  For the last
15616 triplet, the @var{max_size} must be @code{-1}. The @var{max_size} of the triplets
15617 in the list must be specified in increasing order.  The minimal byte size for 
15618 @var{alg} is @code{0} for the first triplet and @code{@var{max_size} + 1} of the 
15619 preceding range.
15621 @item -mmemset-strategy=@var{strategy}
15622 @opindex mmemset-strategy=@var{strategy}
15623 The option is similar to @option{-mmemcpy-strategy=} except that it is to control
15624 @code{__builtin_memset} expansion.
15626 @item -momit-leaf-frame-pointer
15627 @opindex momit-leaf-frame-pointer
15628 Don't keep the frame pointer in a register for leaf functions.  This
15629 avoids the instructions to save, set up, and restore frame pointers and
15630 makes an extra register available in leaf functions.  The option
15631 @option{-fomit-leaf-frame-pointer} removes the frame pointer for leaf functions,
15632 which might make debugging harder.
15634 @item -mtls-direct-seg-refs
15635 @itemx -mno-tls-direct-seg-refs
15636 @opindex mtls-direct-seg-refs
15637 Controls whether TLS variables may be accessed with offsets from the
15638 TLS segment register (@code{%gs} for 32-bit, @code{%fs} for 64-bit),
15639 or whether the thread base pointer must be added.  Whether or not this
15640 is valid depends on the operating system, and whether it maps the
15641 segment to cover the entire TLS area.
15643 For systems that use the GNU C Library, the default is on.
15645 @item -msse2avx
15646 @itemx -mno-sse2avx
15647 @opindex msse2avx
15648 Specify that the assembler should encode SSE instructions with VEX
15649 prefix.  The option @option{-mavx} turns this on by default.
15651 @item -mfentry
15652 @itemx -mno-fentry
15653 @opindex mfentry
15654 If profiling is active (@option{-pg}), put the profiling
15655 counter call before the prologue.
15656 Note: On x86 architectures the attribute @code{ms_hook_prologue}
15657 isn't possible at the moment for @option{-mfentry} and @option{-pg}.
15659 @item -m8bit-idiv
15660 @itemx -mno-8bit-idiv
15661 @opindex 8bit-idiv
15662 On some processors, like Intel Atom, 8-bit unsigned integer divide is
15663 much faster than 32-bit/64-bit integer divide.  This option generates a
15664 run-time check.  If both dividend and divisor are within range of 0
15665 to 255, 8-bit unsigned integer divide is used instead of
15666 32-bit/64-bit integer divide.
15668 @item -mavx256-split-unaligned-load
15669 @itemx -mavx256-split-unaligned-store
15670 @opindex avx256-split-unaligned-load
15671 @opindex avx256-split-unaligned-store
15672 Split 32-byte AVX unaligned load and store.
15674 @item -mstack-protector-guard=@var{guard}
15675 @opindex mstack-protector-guard=@var{guard}
15676 Generate stack protection code using canary at @var{guard}.  Supported
15677 locations are @samp{global} for global canary or @samp{tls} for per-thread
15678 canary in the TLS block (the default).  This option has effect only when
15679 @option{-fstack-protector} or @option{-fstack-protector-all} is specified.
15681 @end table
15683 These @samp{-m} switches are supported in addition to the above
15684 on x86-64 processors in 64-bit environments.
15686 @table @gcctabopt
15687 @item -m32
15688 @itemx -m64
15689 @itemx -mx32
15690 @itemx -m16
15691 @opindex m32
15692 @opindex m64
15693 @opindex mx32
15694 @opindex m16
15695 Generate code for a 16-bit, 32-bit or 64-bit environment.
15696 The @option{-m32} option sets @code{int}, @code{long}, and pointer types
15697 to 32 bits, and
15698 generates code that runs on any i386 system.
15700 The @option{-m64} option sets @code{int} to 32 bits and @code{long} and pointer
15701 types to 64 bits, and generates code for the x86-64 architecture.
15702 For Darwin only the @option{-m64} option also turns off the @option{-fno-pic}
15703 and @option{-mdynamic-no-pic} options.
15705 The @option{-mx32} option sets @code{int}, @code{long}, and pointer types
15706 to 32 bits, and
15707 generates code for the x86-64 architecture.
15709 The @option{-m16} option is the same as @option{-m32}, except for that
15710 it outputs the @code{.code16gcc} assembly directive at the beginning of
15711 the assembly output so that the binary can run in 16-bit mode.
15713 @item -mno-red-zone
15714 @opindex mno-red-zone
15715 Do not use a so-called ``red zone'' for x86-64 code.  The red zone is mandated
15716 by the x86-64 ABI; it is a 128-byte area beyond the location of the
15717 stack pointer that is not modified by signal or interrupt handlers
15718 and therefore can be used for temporary data without adjusting the stack
15719 pointer.  The flag @option{-mno-red-zone} disables this red zone.
15721 @item -mcmodel=small
15722 @opindex mcmodel=small
15723 Generate code for the small code model: the program and its symbols must
15724 be linked in the lower 2 GB of the address space.  Pointers are 64 bits.
15725 Programs can be statically or dynamically linked.  This is the default
15726 code model.
15728 @item -mcmodel=kernel
15729 @opindex mcmodel=kernel
15730 Generate code for the kernel code model.  The kernel runs in the
15731 negative 2 GB of the address space.
15732 This model has to be used for Linux kernel code.
15734 @item -mcmodel=medium
15735 @opindex mcmodel=medium
15736 Generate code for the medium model: the program is linked in the lower 2
15737 GB of the address space.  Small symbols are also placed there.  Symbols
15738 with sizes larger than @option{-mlarge-data-threshold} are put into
15739 large data or BSS sections and can be located above 2GB.  Programs can
15740 be statically or dynamically linked.
15742 @item -mcmodel=large
15743 @opindex mcmodel=large
15744 Generate code for the large model.  This model makes no assumptions
15745 about addresses and sizes of sections.
15747 @item -maddress-mode=long
15748 @opindex maddress-mode=long
15749 Generate code for long address mode.  This is only supported for 64-bit
15750 and x32 environments.  It is the default address mode for 64-bit
15751 environments.
15753 @item -maddress-mode=short
15754 @opindex maddress-mode=short
15755 Generate code for short address mode.  This is only supported for 32-bit
15756 and x32 environments.  It is the default address mode for 32-bit and
15757 x32 environments.
15758 @end table
15760 @node i386 and x86-64 Windows Options
15761 @subsection i386 and x86-64 Windows Options
15762 @cindex i386 and x86-64 Windows Options
15764 These additional options are available for Microsoft Windows targets:
15766 @table @gcctabopt
15767 @item -mconsole
15768 @opindex mconsole
15769 This option
15770 specifies that a console application is to be generated, by
15771 instructing the linker to set the PE header subsystem type
15772 required for console applications.
15773 This option is available for Cygwin and MinGW targets and is
15774 enabled by default on those targets.
15776 @item -mdll
15777 @opindex mdll
15778 This option is available for Cygwin and MinGW targets.  It
15779 specifies that a DLL---a dynamic link library---is to be
15780 generated, enabling the selection of the required runtime
15781 startup object and entry point.
15783 @item -mnop-fun-dllimport
15784 @opindex mnop-fun-dllimport
15785 This option is available for Cygwin and MinGW targets.  It
15786 specifies that the @code{dllimport} attribute should be ignored.
15788 @item -mthread
15789 @opindex mthread
15790 This option is available for MinGW targets. It specifies
15791 that MinGW-specific thread support is to be used.
15793 @item -municode
15794 @opindex municode
15795 This option is available for MinGW-w64 targets.  It causes
15796 the @code{UNICODE} preprocessor macro to be predefined, and
15797 chooses Unicode-capable runtime startup code.
15799 @item -mwin32
15800 @opindex mwin32
15801 This option is available for Cygwin and MinGW targets.  It
15802 specifies that the typical Microsoft Windows predefined macros are to
15803 be set in the pre-processor, but does not influence the choice
15804 of runtime library/startup code.
15806 @item -mwindows
15807 @opindex mwindows
15808 This option is available for Cygwin and MinGW targets.  It
15809 specifies that a GUI application is to be generated by
15810 instructing the linker to set the PE header subsystem type
15811 appropriately.
15813 @item -fno-set-stack-executable
15814 @opindex fno-set-stack-executable
15815 This option is available for MinGW targets. It specifies that
15816 the executable flag for the stack used by nested functions isn't
15817 set. This is necessary for binaries running in kernel mode of
15818 Microsoft Windows, as there the User32 API, which is used to set executable
15819 privileges, isn't available.
15821 @item -fwritable-relocated-rdata
15822 @opindex fno-writable-relocated-rdata
15823 This option is available for MinGW and Cygwin targets.  It specifies
15824 that relocated-data in read-only section is put into .data
15825 section.  This is a necessary for older runtimes not supporting
15826 modification of .rdata sections for pseudo-relocation.
15828 @item -mpe-aligned-commons
15829 @opindex mpe-aligned-commons
15830 This option is available for Cygwin and MinGW targets.  It
15831 specifies that the GNU extension to the PE file format that
15832 permits the correct alignment of COMMON variables should be
15833 used when generating code.  It is enabled by default if
15834 GCC detects that the target assembler found during configuration
15835 supports the feature.
15836 @end table
15838 See also under @ref{i386 and x86-64 Options} for standard options.
15840 @node IA-64 Options
15841 @subsection IA-64 Options
15842 @cindex IA-64 Options
15844 These are the @samp{-m} options defined for the Intel IA-64 architecture.
15846 @table @gcctabopt
15847 @item -mbig-endian
15848 @opindex mbig-endian
15849 Generate code for a big-endian target.  This is the default for HP-UX@.
15851 @item -mlittle-endian
15852 @opindex mlittle-endian
15853 Generate code for a little-endian target.  This is the default for AIX5
15854 and GNU/Linux.
15856 @item -mgnu-as
15857 @itemx -mno-gnu-as
15858 @opindex mgnu-as
15859 @opindex mno-gnu-as
15860 Generate (or don't) code for the GNU assembler.  This is the default.
15861 @c Also, this is the default if the configure option @option{--with-gnu-as}
15862 @c is used.
15864 @item -mgnu-ld
15865 @itemx -mno-gnu-ld
15866 @opindex mgnu-ld
15867 @opindex mno-gnu-ld
15868 Generate (or don't) code for the GNU linker.  This is the default.
15869 @c Also, this is the default if the configure option @option{--with-gnu-ld}
15870 @c is used.
15872 @item -mno-pic
15873 @opindex mno-pic
15874 Generate code that does not use a global pointer register.  The result
15875 is not position independent code, and violates the IA-64 ABI@.
15877 @item -mvolatile-asm-stop
15878 @itemx -mno-volatile-asm-stop
15879 @opindex mvolatile-asm-stop
15880 @opindex mno-volatile-asm-stop
15881 Generate (or don't) a stop bit immediately before and after volatile asm
15882 statements.
15884 @item -mregister-names
15885 @itemx -mno-register-names
15886 @opindex mregister-names
15887 @opindex mno-register-names
15888 Generate (or don't) @samp{in}, @samp{loc}, and @samp{out} register names for
15889 the stacked registers.  This may make assembler output more readable.
15891 @item -mno-sdata
15892 @itemx -msdata
15893 @opindex mno-sdata
15894 @opindex msdata
15895 Disable (or enable) optimizations that use the small data section.  This may
15896 be useful for working around optimizer bugs.
15898 @item -mconstant-gp
15899 @opindex mconstant-gp
15900 Generate code that uses a single constant global pointer value.  This is
15901 useful when compiling kernel code.
15903 @item -mauto-pic
15904 @opindex mauto-pic
15905 Generate code that is self-relocatable.  This implies @option{-mconstant-gp}.
15906 This is useful when compiling firmware code.
15908 @item -minline-float-divide-min-latency
15909 @opindex minline-float-divide-min-latency
15910 Generate code for inline divides of floating-point values
15911 using the minimum latency algorithm.
15913 @item -minline-float-divide-max-throughput
15914 @opindex minline-float-divide-max-throughput
15915 Generate code for inline divides of floating-point values
15916 using the maximum throughput algorithm.
15918 @item -mno-inline-float-divide
15919 @opindex mno-inline-float-divide
15920 Do not generate inline code for divides of floating-point values.
15922 @item -minline-int-divide-min-latency
15923 @opindex minline-int-divide-min-latency
15924 Generate code for inline divides of integer values
15925 using the minimum latency algorithm.
15927 @item -minline-int-divide-max-throughput
15928 @opindex minline-int-divide-max-throughput
15929 Generate code for inline divides of integer values
15930 using the maximum throughput algorithm.
15932 @item -mno-inline-int-divide
15933 @opindex mno-inline-int-divide
15934 Do not generate inline code for divides of integer values.
15936 @item -minline-sqrt-min-latency
15937 @opindex minline-sqrt-min-latency
15938 Generate code for inline square roots
15939 using the minimum latency algorithm.
15941 @item -minline-sqrt-max-throughput
15942 @opindex minline-sqrt-max-throughput
15943 Generate code for inline square roots
15944 using the maximum throughput algorithm.
15946 @item -mno-inline-sqrt
15947 @opindex mno-inline-sqrt
15948 Do not generate inline code for @code{sqrt}.
15950 @item -mfused-madd
15951 @itemx -mno-fused-madd
15952 @opindex mfused-madd
15953 @opindex mno-fused-madd
15954 Do (don't) generate code that uses the fused multiply/add or multiply/subtract
15955 instructions.  The default is to use these instructions.
15957 @item -mno-dwarf2-asm
15958 @itemx -mdwarf2-asm
15959 @opindex mno-dwarf2-asm
15960 @opindex mdwarf2-asm
15961 Don't (or do) generate assembler code for the DWARF 2 line number debugging
15962 info.  This may be useful when not using the GNU assembler.
15964 @item -mearly-stop-bits
15965 @itemx -mno-early-stop-bits
15966 @opindex mearly-stop-bits
15967 @opindex mno-early-stop-bits
15968 Allow stop bits to be placed earlier than immediately preceding the
15969 instruction that triggered the stop bit.  This can improve instruction
15970 scheduling, but does not always do so.
15972 @item -mfixed-range=@var{register-range}
15973 @opindex mfixed-range
15974 Generate code treating the given register range as fixed registers.
15975 A fixed register is one that the register allocator cannot use.  This is
15976 useful when compiling kernel code.  A register range is specified as
15977 two registers separated by a dash.  Multiple register ranges can be
15978 specified separated by a comma.
15980 @item -mtls-size=@var{tls-size}
15981 @opindex mtls-size
15982 Specify bit size of immediate TLS offsets.  Valid values are 14, 22, and
15985 @item -mtune=@var{cpu-type}
15986 @opindex mtune
15987 Tune the instruction scheduling for a particular CPU, Valid values are
15988 @samp{itanium}, @samp{itanium1}, @samp{merced}, @samp{itanium2},
15989 and @samp{mckinley}.
15991 @item -milp32
15992 @itemx -mlp64
15993 @opindex milp32
15994 @opindex mlp64
15995 Generate code for a 32-bit or 64-bit environment.
15996 The 32-bit environment sets int, long and pointer to 32 bits.
15997 The 64-bit environment sets int to 32 bits and long and pointer
15998 to 64 bits.  These are HP-UX specific flags.
16000 @item -mno-sched-br-data-spec
16001 @itemx -msched-br-data-spec
16002 @opindex mno-sched-br-data-spec
16003 @opindex msched-br-data-spec
16004 (Dis/En)able data speculative scheduling before reload.
16005 This results in generation of @code{ld.a} instructions and
16006 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16007 The default is 'disable'.
16009 @item -msched-ar-data-spec
16010 @itemx -mno-sched-ar-data-spec
16011 @opindex msched-ar-data-spec
16012 @opindex mno-sched-ar-data-spec
16013 (En/Dis)able data speculative scheduling after reload.
16014 This results in generation of @code{ld.a} instructions and
16015 the corresponding check instructions (@code{ld.c} / @code{chk.a}).
16016 The default is 'enable'.
16018 @item -mno-sched-control-spec
16019 @itemx -msched-control-spec
16020 @opindex mno-sched-control-spec
16021 @opindex msched-control-spec
16022 (Dis/En)able control speculative scheduling.  This feature is
16023 available only during region scheduling (i.e.@: before reload).
16024 This results in generation of the @code{ld.s} instructions and
16025 the corresponding check instructions @code{chk.s}.
16026 The default is 'disable'.
16028 @item -msched-br-in-data-spec
16029 @itemx -mno-sched-br-in-data-spec
16030 @opindex msched-br-in-data-spec
16031 @opindex mno-sched-br-in-data-spec
16032 (En/Dis)able speculative scheduling of the instructions that
16033 are dependent on the data speculative loads before reload.
16034 This is effective only with @option{-msched-br-data-spec} enabled.
16035 The default is 'enable'.
16037 @item -msched-ar-in-data-spec
16038 @itemx -mno-sched-ar-in-data-spec
16039 @opindex msched-ar-in-data-spec
16040 @opindex mno-sched-ar-in-data-spec
16041 (En/Dis)able speculative scheduling of the instructions that
16042 are dependent on the data speculative loads after reload.
16043 This is effective only with @option{-msched-ar-data-spec} enabled.
16044 The default is 'enable'.
16046 @item -msched-in-control-spec
16047 @itemx -mno-sched-in-control-spec
16048 @opindex msched-in-control-spec
16049 @opindex mno-sched-in-control-spec
16050 (En/Dis)able speculative scheduling of the instructions that
16051 are dependent on the control speculative loads.
16052 This is effective only with @option{-msched-control-spec} enabled.
16053 The default is 'enable'.
16055 @item -mno-sched-prefer-non-data-spec-insns
16056 @itemx -msched-prefer-non-data-spec-insns
16057 @opindex mno-sched-prefer-non-data-spec-insns
16058 @opindex msched-prefer-non-data-spec-insns
16059 If enabled, data-speculative instructions are chosen for schedule
16060 only if there are no other choices at the moment.  This makes
16061 the use of the data speculation much more conservative.
16062 The default is 'disable'.
16064 @item -mno-sched-prefer-non-control-spec-insns
16065 @itemx -msched-prefer-non-control-spec-insns
16066 @opindex mno-sched-prefer-non-control-spec-insns
16067 @opindex msched-prefer-non-control-spec-insns
16068 If enabled, control-speculative instructions are chosen for schedule
16069 only if there are no other choices at the moment.  This makes
16070 the use of the control speculation much more conservative.
16071 The default is 'disable'.
16073 @item -mno-sched-count-spec-in-critical-path
16074 @itemx -msched-count-spec-in-critical-path
16075 @opindex mno-sched-count-spec-in-critical-path
16076 @opindex msched-count-spec-in-critical-path
16077 If enabled, speculative dependencies are considered during
16078 computation of the instructions priorities.  This makes the use of the
16079 speculation a bit more conservative.
16080 The default is 'disable'.
16082 @item -msched-spec-ldc
16083 @opindex msched-spec-ldc
16084 Use a simple data speculation check.  This option is on by default.
16086 @item -msched-control-spec-ldc
16087 @opindex msched-spec-ldc
16088 Use a simple check for control speculation.  This option is on by default.
16090 @item -msched-stop-bits-after-every-cycle
16091 @opindex msched-stop-bits-after-every-cycle
16092 Place a stop bit after every cycle when scheduling.  This option is on
16093 by default.
16095 @item -msched-fp-mem-deps-zero-cost
16096 @opindex msched-fp-mem-deps-zero-cost
16097 Assume that floating-point stores and loads are not likely to cause a conflict
16098 when placed into the same instruction group.  This option is disabled by
16099 default.
16101 @item -msel-sched-dont-check-control-spec
16102 @opindex msel-sched-dont-check-control-spec
16103 Generate checks for control speculation in selective scheduling.
16104 This flag is disabled by default.
16106 @item -msched-max-memory-insns=@var{max-insns}
16107 @opindex msched-max-memory-insns
16108 Limit on the number of memory insns per instruction group, giving lower
16109 priority to subsequent memory insns attempting to schedule in the same
16110 instruction group. Frequently useful to prevent cache bank conflicts.
16111 The default value is 1.
16113 @item -msched-max-memory-insns-hard-limit
16114 @opindex msched-max-memory-insns-hard-limit
16115 Makes the limit specified by @option{msched-max-memory-insns} a hard limit,
16116 disallowing more than that number in an instruction group.
16117 Otherwise, the limit is ``soft'', meaning that non-memory operations
16118 are preferred when the limit is reached, but memory operations may still
16119 be scheduled.
16121 @end table
16123 @node LM32 Options
16124 @subsection LM32 Options
16125 @cindex LM32 options
16127 These @option{-m} options are defined for the LatticeMico32 architecture:
16129 @table @gcctabopt
16130 @item -mbarrel-shift-enabled
16131 @opindex mbarrel-shift-enabled
16132 Enable barrel-shift instructions.
16134 @item -mdivide-enabled
16135 @opindex mdivide-enabled
16136 Enable divide and modulus instructions.
16138 @item -mmultiply-enabled
16139 @opindex multiply-enabled
16140 Enable multiply instructions.
16142 @item -msign-extend-enabled
16143 @opindex msign-extend-enabled
16144 Enable sign extend instructions.
16146 @item -muser-enabled
16147 @opindex muser-enabled
16148 Enable user-defined instructions.
16150 @end table
16152 @node M32C Options
16153 @subsection M32C Options
16154 @cindex M32C options
16156 @table @gcctabopt
16157 @item -mcpu=@var{name}
16158 @opindex mcpu=
16159 Select the CPU for which code is generated.  @var{name} may be one of
16160 @samp{r8c} for the R8C/Tiny series, @samp{m16c} for the M16C (up to
16161 /60) series, @samp{m32cm} for the M16C/80 series, or @samp{m32c} for
16162 the M32C/80 series.
16164 @item -msim
16165 @opindex msim
16166 Specifies that the program will be run on the simulator.  This causes
16167 an alternate runtime library to be linked in which supports, for
16168 example, file I/O@.  You must not use this option when generating
16169 programs that will run on real hardware; you must provide your own
16170 runtime library for whatever I/O functions are needed.
16172 @item -memregs=@var{number}
16173 @opindex memregs=
16174 Specifies the number of memory-based pseudo-registers GCC uses
16175 during code generation.  These pseudo-registers are used like real
16176 registers, so there is a tradeoff between GCC's ability to fit the
16177 code into available registers, and the performance penalty of using
16178 memory instead of registers.  Note that all modules in a program must
16179 be compiled with the same value for this option.  Because of that, you
16180 must not use this option with GCC's default runtime libraries.
16182 @end table
16184 @node M32R/D Options
16185 @subsection M32R/D Options
16186 @cindex M32R/D options
16188 These @option{-m} options are defined for Renesas M32R/D architectures:
16190 @table @gcctabopt
16191 @item -m32r2
16192 @opindex m32r2
16193 Generate code for the M32R/2@.
16195 @item -m32rx
16196 @opindex m32rx
16197 Generate code for the M32R/X@.
16199 @item -m32r
16200 @opindex m32r
16201 Generate code for the M32R@.  This is the default.
16203 @item -mmodel=small
16204 @opindex mmodel=small
16205 Assume all objects live in the lower 16MB of memory (so that their addresses
16206 can be loaded with the @code{ld24} instruction), and assume all subroutines
16207 are reachable with the @code{bl} instruction.
16208 This is the default.
16210 The addressability of a particular object can be set with the
16211 @code{model} attribute.
16213 @item -mmodel=medium
16214 @opindex mmodel=medium
16215 Assume objects may be anywhere in the 32-bit address space (the compiler
16216 generates @code{seth/add3} instructions to load their addresses), and
16217 assume all subroutines are reachable with the @code{bl} instruction.
16219 @item -mmodel=large
16220 @opindex mmodel=large
16221 Assume objects may be anywhere in the 32-bit address space (the compiler
16222 generates @code{seth/add3} instructions to load their addresses), and
16223 assume subroutines may not be reachable with the @code{bl} instruction
16224 (the compiler generates the much slower @code{seth/add3/jl}
16225 instruction sequence).
16227 @item -msdata=none
16228 @opindex msdata=none
16229 Disable use of the small data area.  Variables are put into
16230 one of @samp{.data}, @samp{.bss}, or @samp{.rodata} (unless the
16231 @code{section} attribute has been specified).
16232 This is the default.
16234 The small data area consists of sections @samp{.sdata} and @samp{.sbss}.
16235 Objects may be explicitly put in the small data area with the
16236 @code{section} attribute using one of these sections.
16238 @item -msdata=sdata
16239 @opindex msdata=sdata
16240 Put small global and static data in the small data area, but do not
16241 generate special code to reference them.
16243 @item -msdata=use
16244 @opindex msdata=use
16245 Put small global and static data in the small data area, and generate
16246 special instructions to reference them.
16248 @item -G @var{num}
16249 @opindex G
16250 @cindex smaller data references
16251 Put global and static objects less than or equal to @var{num} bytes
16252 into the small data or BSS sections instead of the normal data or BSS
16253 sections.  The default value of @var{num} is 8.
16254 The @option{-msdata} option must be set to one of @samp{sdata} or @samp{use}
16255 for this option to have any effect.
16257 All modules should be compiled with the same @option{-G @var{num}} value.
16258 Compiling with different values of @var{num} may or may not work; if it
16259 doesn't the linker gives an error message---incorrect code is not
16260 generated.
16262 @item -mdebug
16263 @opindex mdebug
16264 Makes the M32R-specific code in the compiler display some statistics
16265 that might help in debugging programs.
16267 @item -malign-loops
16268 @opindex malign-loops
16269 Align all loops to a 32-byte boundary.
16271 @item -mno-align-loops
16272 @opindex mno-align-loops
16273 Do not enforce a 32-byte alignment for loops.  This is the default.
16275 @item -missue-rate=@var{number}
16276 @opindex missue-rate=@var{number}
16277 Issue @var{number} instructions per cycle.  @var{number} can only be 1
16278 or 2.
16280 @item -mbranch-cost=@var{number}
16281 @opindex mbranch-cost=@var{number}
16282 @var{number} can only be 1 or 2.  If it is 1 then branches are
16283 preferred over conditional code, if it is 2, then the opposite applies.
16285 @item -mflush-trap=@var{number}
16286 @opindex mflush-trap=@var{number}
16287 Specifies the trap number to use to flush the cache.  The default is
16288 12.  Valid numbers are between 0 and 15 inclusive.
16290 @item -mno-flush-trap
16291 @opindex mno-flush-trap
16292 Specifies that the cache cannot be flushed by using a trap.
16294 @item -mflush-func=@var{name}
16295 @opindex mflush-func=@var{name}
16296 Specifies the name of the operating system function to call to flush
16297 the cache.  The default is @emph{_flush_cache}, but a function call
16298 is only used if a trap is not available.
16300 @item -mno-flush-func
16301 @opindex mno-flush-func
16302 Indicates that there is no OS function for flushing the cache.
16304 @end table
16306 @node M680x0 Options
16307 @subsection M680x0 Options
16308 @cindex M680x0 options
16310 These are the @samp{-m} options defined for M680x0 and ColdFire processors.
16311 The default settings depend on which architecture was selected when
16312 the compiler was configured; the defaults for the most common choices
16313 are given below.
16315 @table @gcctabopt
16316 @item -march=@var{arch}
16317 @opindex march
16318 Generate code for a specific M680x0 or ColdFire instruction set
16319 architecture.  Permissible values of @var{arch} for M680x0
16320 architectures are: @samp{68000}, @samp{68010}, @samp{68020},
16321 @samp{68030}, @samp{68040}, @samp{68060} and @samp{cpu32}.  ColdFire
16322 architectures are selected according to Freescale's ISA classification
16323 and the permissible values are: @samp{isaa}, @samp{isaaplus},
16324 @samp{isab} and @samp{isac}.
16326 GCC defines a macro @samp{__mcf@var{arch}__} whenever it is generating
16327 code for a ColdFire target.  The @var{arch} in this macro is one of the
16328 @option{-march} arguments given above.
16330 When used together, @option{-march} and @option{-mtune} select code
16331 that runs on a family of similar processors but that is optimized
16332 for a particular microarchitecture.
16334 @item -mcpu=@var{cpu}
16335 @opindex mcpu
16336 Generate code for a specific M680x0 or ColdFire processor.
16337 The M680x0 @var{cpu}s are: @samp{68000}, @samp{68010}, @samp{68020},
16338 @samp{68030}, @samp{68040}, @samp{68060}, @samp{68302}, @samp{68332}
16339 and @samp{cpu32}.  The ColdFire @var{cpu}s are given by the table
16340 below, which also classifies the CPUs into families:
16342 @multitable @columnfractions 0.20 0.80
16343 @item @strong{Family} @tab @strong{@samp{-mcpu} arguments}
16344 @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}
16345 @item @samp{5206} @tab @samp{5202} @samp{5204} @samp{5206}
16346 @item @samp{5206e} @tab @samp{5206e}
16347 @item @samp{5208} @tab @samp{5207} @samp{5208}
16348 @item @samp{5211a} @tab @samp{5210a} @samp{5211a}
16349 @item @samp{5213} @tab @samp{5211} @samp{5212} @samp{5213}
16350 @item @samp{5216} @tab @samp{5214} @samp{5216}
16351 @item @samp{52235} @tab @samp{52230} @samp{52231} @samp{52232} @samp{52233} @samp{52234} @samp{52235}
16352 @item @samp{5225} @tab @samp{5224} @samp{5225}
16353 @item @samp{52259} @tab @samp{52252} @samp{52254} @samp{52255} @samp{52256} @samp{52258} @samp{52259}
16354 @item @samp{5235} @tab @samp{5232} @samp{5233} @samp{5234} @samp{5235} @samp{523x}
16355 @item @samp{5249} @tab @samp{5249}
16356 @item @samp{5250} @tab @samp{5250}
16357 @item @samp{5271} @tab @samp{5270} @samp{5271}
16358 @item @samp{5272} @tab @samp{5272}
16359 @item @samp{5275} @tab @samp{5274} @samp{5275}
16360 @item @samp{5282} @tab @samp{5280} @samp{5281} @samp{5282} @samp{528x}
16361 @item @samp{53017} @tab @samp{53011} @samp{53012} @samp{53013} @samp{53014} @samp{53015} @samp{53016} @samp{53017}
16362 @item @samp{5307} @tab @samp{5307}
16363 @item @samp{5329} @tab @samp{5327} @samp{5328} @samp{5329} @samp{532x}
16364 @item @samp{5373} @tab @samp{5372} @samp{5373} @samp{537x}
16365 @item @samp{5407} @tab @samp{5407}
16366 @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}
16367 @end multitable
16369 @option{-mcpu=@var{cpu}} overrides @option{-march=@var{arch}} if
16370 @var{arch} is compatible with @var{cpu}.  Other combinations of
16371 @option{-mcpu} and @option{-march} are rejected.
16373 GCC defines the macro @samp{__mcf_cpu_@var{cpu}} when ColdFire target
16374 @var{cpu} is selected.  It also defines @samp{__mcf_family_@var{family}},
16375 where the value of @var{family} is given by the table above.
16377 @item -mtune=@var{tune}
16378 @opindex mtune
16379 Tune the code for a particular microarchitecture within the
16380 constraints set by @option{-march} and @option{-mcpu}.
16381 The M680x0 microarchitectures are: @samp{68000}, @samp{68010},
16382 @samp{68020}, @samp{68030}, @samp{68040}, @samp{68060}
16383 and @samp{cpu32}.  The ColdFire microarchitectures
16384 are: @samp{cfv1}, @samp{cfv2}, @samp{cfv3}, @samp{cfv4} and @samp{cfv4e}.
16386 You can also use @option{-mtune=68020-40} for code that needs
16387 to run relatively well on 68020, 68030 and 68040 targets.
16388 @option{-mtune=68020-60} is similar but includes 68060 targets
16389 as well.  These two options select the same tuning decisions as
16390 @option{-m68020-40} and @option{-m68020-60} respectively.
16392 GCC defines the macros @samp{__mc@var{arch}} and @samp{__mc@var{arch}__}
16393 when tuning for 680x0 architecture @var{arch}.  It also defines
16394 @samp{mc@var{arch}} unless either @option{-ansi} or a non-GNU @option{-std}
16395 option is used.  If GCC is tuning for a range of architectures,
16396 as selected by @option{-mtune=68020-40} or @option{-mtune=68020-60},
16397 it defines the macros for every architecture in the range.
16399 GCC also defines the macro @samp{__m@var{uarch}__} when tuning for
16400 ColdFire microarchitecture @var{uarch}, where @var{uarch} is one
16401 of the arguments given above.
16403 @item -m68000
16404 @itemx -mc68000
16405 @opindex m68000
16406 @opindex mc68000
16407 Generate output for a 68000.  This is the default
16408 when the compiler is configured for 68000-based systems.
16409 It is equivalent to @option{-march=68000}.
16411 Use this option for microcontrollers with a 68000 or EC000 core,
16412 including the 68008, 68302, 68306, 68307, 68322, 68328 and 68356.
16414 @item -m68010
16415 @opindex m68010
16416 Generate output for a 68010.  This is the default
16417 when the compiler is configured for 68010-based systems.
16418 It is equivalent to @option{-march=68010}.
16420 @item -m68020
16421 @itemx -mc68020
16422 @opindex m68020
16423 @opindex mc68020
16424 Generate output for a 68020.  This is the default
16425 when the compiler is configured for 68020-based systems.
16426 It is equivalent to @option{-march=68020}.
16428 @item -m68030
16429 @opindex m68030
16430 Generate output for a 68030.  This is the default when the compiler is
16431 configured for 68030-based systems.  It is equivalent to
16432 @option{-march=68030}.
16434 @item -m68040
16435 @opindex m68040
16436 Generate output for a 68040.  This is the default when the compiler is
16437 configured for 68040-based systems.  It is equivalent to
16438 @option{-march=68040}.
16440 This option inhibits the use of 68881/68882 instructions that have to be
16441 emulated by software on the 68040.  Use this option if your 68040 does not
16442 have code to emulate those instructions.
16444 @item -m68060
16445 @opindex m68060
16446 Generate output for a 68060.  This is the default when the compiler is
16447 configured for 68060-based systems.  It is equivalent to
16448 @option{-march=68060}.
16450 This option inhibits the use of 68020 and 68881/68882 instructions that
16451 have to be emulated by software on the 68060.  Use this option if your 68060
16452 does not have code to emulate those instructions.
16454 @item -mcpu32
16455 @opindex mcpu32
16456 Generate output for a CPU32.  This is the default
16457 when the compiler is configured for CPU32-based systems.
16458 It is equivalent to @option{-march=cpu32}.
16460 Use this option for microcontrollers with a
16461 CPU32 or CPU32+ core, including the 68330, 68331, 68332, 68333, 68334,
16462 68336, 68340, 68341, 68349 and 68360.
16464 @item -m5200
16465 @opindex m5200
16466 Generate output for a 520X ColdFire CPU@.  This is the default
16467 when the compiler is configured for 520X-based systems.
16468 It is equivalent to @option{-mcpu=5206}, and is now deprecated
16469 in favor of that option.
16471 Use this option for microcontroller with a 5200 core, including
16472 the MCF5202, MCF5203, MCF5204 and MCF5206.
16474 @item -m5206e
16475 @opindex m5206e
16476 Generate output for a 5206e ColdFire CPU@.  The option is now
16477 deprecated in favor of the equivalent @option{-mcpu=5206e}.
16479 @item -m528x
16480 @opindex m528x
16481 Generate output for a member of the ColdFire 528X family.
16482 The option is now deprecated in favor of the equivalent
16483 @option{-mcpu=528x}.
16485 @item -m5307
16486 @opindex m5307
16487 Generate output for a ColdFire 5307 CPU@.  The option is now deprecated
16488 in favor of the equivalent @option{-mcpu=5307}.
16490 @item -m5407
16491 @opindex m5407
16492 Generate output for a ColdFire 5407 CPU@.  The option is now deprecated
16493 in favor of the equivalent @option{-mcpu=5407}.
16495 @item -mcfv4e
16496 @opindex mcfv4e
16497 Generate output for a ColdFire V4e family CPU (e.g.@: 547x/548x).
16498 This includes use of hardware floating-point instructions.
16499 The option is equivalent to @option{-mcpu=547x}, and is now
16500 deprecated in favor of that option.
16502 @item -m68020-40
16503 @opindex m68020-40
16504 Generate output for a 68040, without using any of the new instructions.
16505 This results in code that can run relatively efficiently on either a
16506 68020/68881 or a 68030 or a 68040.  The generated code does use the
16507 68881 instructions that are emulated on the 68040.
16509 The option is equivalent to @option{-march=68020} @option{-mtune=68020-40}.
16511 @item -m68020-60
16512 @opindex m68020-60
16513 Generate output for a 68060, without using any of the new instructions.
16514 This results in code that can run relatively efficiently on either a
16515 68020/68881 or a 68030 or a 68040.  The generated code does use the
16516 68881 instructions that are emulated on the 68060.
16518 The option is equivalent to @option{-march=68020} @option{-mtune=68020-60}.
16520 @item -mhard-float
16521 @itemx -m68881
16522 @opindex mhard-float
16523 @opindex m68881
16524 Generate floating-point instructions.  This is the default for 68020
16525 and above, and for ColdFire devices that have an FPU@.  It defines the
16526 macro @samp{__HAVE_68881__} on M680x0 targets and @samp{__mcffpu__}
16527 on ColdFire targets.
16529 @item -msoft-float
16530 @opindex msoft-float
16531 Do not generate floating-point instructions; use library calls instead.
16532 This is the default for 68000, 68010, and 68832 targets.  It is also
16533 the default for ColdFire devices that have no FPU.
16535 @item -mdiv
16536 @itemx -mno-div
16537 @opindex mdiv
16538 @opindex mno-div
16539 Generate (do not generate) ColdFire hardware divide and remainder
16540 instructions.  If @option{-march} is used without @option{-mcpu},
16541 the default is ``on'' for ColdFire architectures and ``off'' for M680x0
16542 architectures.  Otherwise, the default is taken from the target CPU
16543 (either the default CPU, or the one specified by @option{-mcpu}).  For
16544 example, the default is ``off'' for @option{-mcpu=5206} and ``on'' for
16545 @option{-mcpu=5206e}.
16547 GCC defines the macro @samp{__mcfhwdiv__} when this option is enabled.
16549 @item -mshort
16550 @opindex mshort
16551 Consider type @code{int} to be 16 bits wide, like @code{short int}.
16552 Additionally, parameters passed on the stack are also aligned to a
16553 16-bit boundary even on targets whose API mandates promotion to 32-bit.
16555 @item -mno-short
16556 @opindex mno-short
16557 Do not consider type @code{int} to be 16 bits wide.  This is the default.
16559 @item -mnobitfield
16560 @itemx -mno-bitfield
16561 @opindex mnobitfield
16562 @opindex mno-bitfield
16563 Do not use the bit-field instructions.  The @option{-m68000}, @option{-mcpu32}
16564 and @option{-m5200} options imply @w{@option{-mnobitfield}}.
16566 @item -mbitfield
16567 @opindex mbitfield
16568 Do use the bit-field instructions.  The @option{-m68020} option implies
16569 @option{-mbitfield}.  This is the default if you use a configuration
16570 designed for a 68020.
16572 @item -mrtd
16573 @opindex mrtd
16574 Use a different function-calling convention, in which functions
16575 that take a fixed number of arguments return with the @code{rtd}
16576 instruction, which pops their arguments while returning.  This
16577 saves one instruction in the caller since there is no need to pop
16578 the arguments there.
16580 This calling convention is incompatible with the one normally
16581 used on Unix, so you cannot use it if you need to call libraries
16582 compiled with the Unix compiler.
16584 Also, you must provide function prototypes for all functions that
16585 take variable numbers of arguments (including @code{printf});
16586 otherwise incorrect code is generated for calls to those
16587 functions.
16589 In addition, seriously incorrect code results if you call a
16590 function with too many arguments.  (Normally, extra arguments are
16591 harmlessly ignored.)
16593 The @code{rtd} instruction is supported by the 68010, 68020, 68030,
16594 68040, 68060 and CPU32 processors, but not by the 68000 or 5200.
16596 @item -mno-rtd
16597 @opindex mno-rtd
16598 Do not use the calling conventions selected by @option{-mrtd}.
16599 This is the default.
16601 @item -malign-int
16602 @itemx -mno-align-int
16603 @opindex malign-int
16604 @opindex mno-align-int
16605 Control whether GCC aligns @code{int}, @code{long}, @code{long long},
16606 @code{float}, @code{double}, and @code{long double} variables on a 32-bit
16607 boundary (@option{-malign-int}) or a 16-bit boundary (@option{-mno-align-int}).
16608 Aligning variables on 32-bit boundaries produces code that runs somewhat
16609 faster on processors with 32-bit busses at the expense of more memory.
16611 @strong{Warning:} if you use the @option{-malign-int} switch, GCC
16612 aligns structures containing the above types differently than
16613 most published application binary interface specifications for the m68k.
16615 @item -mpcrel
16616 @opindex mpcrel
16617 Use the pc-relative addressing mode of the 68000 directly, instead of
16618 using a global offset table.  At present, this option implies @option{-fpic},
16619 allowing at most a 16-bit offset for pc-relative addressing.  @option{-fPIC} is
16620 not presently supported with @option{-mpcrel}, though this could be supported for
16621 68020 and higher processors.
16623 @item -mno-strict-align
16624 @itemx -mstrict-align
16625 @opindex mno-strict-align
16626 @opindex mstrict-align
16627 Do not (do) assume that unaligned memory references are handled by
16628 the system.
16630 @item -msep-data
16631 Generate code that allows the data segment to be located in a different
16632 area of memory from the text segment.  This allows for execute-in-place in
16633 an environment without virtual memory management.  This option implies
16634 @option{-fPIC}.
16636 @item -mno-sep-data
16637 Generate code that assumes that the data segment follows the text segment.
16638 This is the default.
16640 @item -mid-shared-library
16641 Generate code that supports shared libraries via the library ID method.
16642 This allows for execute-in-place and shared libraries in an environment
16643 without virtual memory management.  This option implies @option{-fPIC}.
16645 @item -mno-id-shared-library
16646 Generate code that doesn't assume ID-based shared libraries are being used.
16647 This is the default.
16649 @item -mshared-library-id=n
16650 Specifies the identification number of the ID-based shared library being
16651 compiled.  Specifying a value of 0 generates more compact code; specifying
16652 other values forces the allocation of that number to the current
16653 library, but is no more space- or time-efficient than omitting this option.
16655 @item -mxgot
16656 @itemx -mno-xgot
16657 @opindex mxgot
16658 @opindex mno-xgot
16659 When generating position-independent code for ColdFire, generate code
16660 that works if the GOT has more than 8192 entries.  This code is
16661 larger and slower than code generated without this option.  On M680x0
16662 processors, this option is not needed; @option{-fPIC} suffices.
16664 GCC normally uses a single instruction to load values from the GOT@.
16665 While this is relatively efficient, it only works if the GOT
16666 is smaller than about 64k.  Anything larger causes the linker
16667 to report an error such as:
16669 @cindex relocation truncated to fit (ColdFire)
16670 @smallexample
16671 relocation truncated to fit: R_68K_GOT16O foobar
16672 @end smallexample
16674 If this happens, you should recompile your code with @option{-mxgot}.
16675 It should then work with very large GOTs.  However, code generated with
16676 @option{-mxgot} is less efficient, since it takes 4 instructions to fetch
16677 the value of a global symbol.
16679 Note that some linkers, including newer versions of the GNU linker,
16680 can create multiple GOTs and sort GOT entries.  If you have such a linker,
16681 you should only need to use @option{-mxgot} when compiling a single
16682 object file that accesses more than 8192 GOT entries.  Very few do.
16684 These options have no effect unless GCC is generating
16685 position-independent code.
16687 @end table
16689 @node MCore Options
16690 @subsection MCore Options
16691 @cindex MCore options
16693 These are the @samp{-m} options defined for the Motorola M*Core
16694 processors.
16696 @table @gcctabopt
16698 @item -mhardlit
16699 @itemx -mno-hardlit
16700 @opindex mhardlit
16701 @opindex mno-hardlit
16702 Inline constants into the code stream if it can be done in two
16703 instructions or less.
16705 @item -mdiv
16706 @itemx -mno-div
16707 @opindex mdiv
16708 @opindex mno-div
16709 Use the divide instruction.  (Enabled by default).
16711 @item -mrelax-immediate
16712 @itemx -mno-relax-immediate
16713 @opindex mrelax-immediate
16714 @opindex mno-relax-immediate
16715 Allow arbitrary-sized immediates in bit operations.
16717 @item -mwide-bitfields
16718 @itemx -mno-wide-bitfields
16719 @opindex mwide-bitfields
16720 @opindex mno-wide-bitfields
16721 Always treat bit-fields as @code{int}-sized.
16723 @item -m4byte-functions
16724 @itemx -mno-4byte-functions
16725 @opindex m4byte-functions
16726 @opindex mno-4byte-functions
16727 Force all functions to be aligned to a 4-byte boundary.
16729 @item -mcallgraph-data
16730 @itemx -mno-callgraph-data
16731 @opindex mcallgraph-data
16732 @opindex mno-callgraph-data
16733 Emit callgraph information.
16735 @item -mslow-bytes
16736 @itemx -mno-slow-bytes
16737 @opindex mslow-bytes
16738 @opindex mno-slow-bytes
16739 Prefer word access when reading byte quantities.
16741 @item -mlittle-endian
16742 @itemx -mbig-endian
16743 @opindex mlittle-endian
16744 @opindex mbig-endian
16745 Generate code for a little-endian target.
16747 @item -m210
16748 @itemx -m340
16749 @opindex m210
16750 @opindex m340
16751 Generate code for the 210 processor.
16753 @item -mno-lsim
16754 @opindex mno-lsim
16755 Assume that runtime support has been provided and so omit the
16756 simulator library (@file{libsim.a)} from the linker command line.
16758 @item -mstack-increment=@var{size}
16759 @opindex mstack-increment
16760 Set the maximum amount for a single stack increment operation.  Large
16761 values can increase the speed of programs that contain functions
16762 that need a large amount of stack space, but they can also trigger a
16763 segmentation fault if the stack is extended too much.  The default
16764 value is 0x1000.
16766 @end table
16768 @node MeP Options
16769 @subsection MeP Options
16770 @cindex MeP options
16772 @table @gcctabopt
16774 @item -mabsdiff
16775 @opindex mabsdiff
16776 Enables the @code{abs} instruction, which is the absolute difference
16777 between two registers.
16779 @item -mall-opts
16780 @opindex mall-opts
16781 Enables all the optional instructions---average, multiply, divide, bit
16782 operations, leading zero, absolute difference, min/max, clip, and
16783 saturation.
16786 @item -maverage
16787 @opindex maverage
16788 Enables the @code{ave} instruction, which computes the average of two
16789 registers.
16791 @item -mbased=@var{n}
16792 @opindex mbased=
16793 Variables of size @var{n} bytes or smaller are placed in the
16794 @code{.based} section by default.  Based variables use the @code{$tp}
16795 register as a base register, and there is a 128-byte limit to the
16796 @code{.based} section.
16798 @item -mbitops
16799 @opindex mbitops
16800 Enables the bit operation instructions---bit test (@code{btstm}), set
16801 (@code{bsetm}), clear (@code{bclrm}), invert (@code{bnotm}), and
16802 test-and-set (@code{tas}).
16804 @item -mc=@var{name}
16805 @opindex mc=
16806 Selects which section constant data is placed in.  @var{name} may
16807 be @code{tiny}, @code{near}, or @code{far}.
16809 @item -mclip
16810 @opindex mclip
16811 Enables the @code{clip} instruction.  Note that @code{-mclip} is not
16812 useful unless you also provide @code{-mminmax}.
16814 @item -mconfig=@var{name}
16815 @opindex mconfig=
16816 Selects one of the built-in core configurations.  Each MeP chip has
16817 one or more modules in it; each module has a core CPU and a variety of
16818 coprocessors, optional instructions, and peripherals.  The
16819 @code{MeP-Integrator} tool, not part of GCC, provides these
16820 configurations through this option; using this option is the same as
16821 using all the corresponding command-line options.  The default
16822 configuration is @code{default}.
16824 @item -mcop
16825 @opindex mcop
16826 Enables the coprocessor instructions.  By default, this is a 32-bit
16827 coprocessor.  Note that the coprocessor is normally enabled via the
16828 @code{-mconfig=} option.
16830 @item -mcop32
16831 @opindex mcop32
16832 Enables the 32-bit coprocessor's instructions.
16834 @item -mcop64
16835 @opindex mcop64
16836 Enables the 64-bit coprocessor's instructions.
16838 @item -mivc2
16839 @opindex mivc2
16840 Enables IVC2 scheduling.  IVC2 is a 64-bit VLIW coprocessor.
16842 @item -mdc
16843 @opindex mdc
16844 Causes constant variables to be placed in the @code{.near} section.
16846 @item -mdiv
16847 @opindex mdiv
16848 Enables the @code{div} and @code{divu} instructions.
16850 @item -meb
16851 @opindex meb
16852 Generate big-endian code.
16854 @item -mel
16855 @opindex mel
16856 Generate little-endian code.
16858 @item -mio-volatile
16859 @opindex mio-volatile
16860 Tells the compiler that any variable marked with the @code{io}
16861 attribute is to be considered volatile.
16863 @item -ml
16864 @opindex ml
16865 Causes variables to be assigned to the @code{.far} section by default.
16867 @item -mleadz
16868 @opindex mleadz
16869 Enables the @code{leadz} (leading zero) instruction.
16871 @item -mm
16872 @opindex mm
16873 Causes variables to be assigned to the @code{.near} section by default.
16875 @item -mminmax
16876 @opindex mminmax
16877 Enables the @code{min} and @code{max} instructions.
16879 @item -mmult
16880 @opindex mmult
16881 Enables the multiplication and multiply-accumulate instructions.
16883 @item -mno-opts
16884 @opindex mno-opts
16885 Disables all the optional instructions enabled by @code{-mall-opts}.
16887 @item -mrepeat
16888 @opindex mrepeat
16889 Enables the @code{repeat} and @code{erepeat} instructions, used for
16890 low-overhead looping.
16892 @item -ms
16893 @opindex ms
16894 Causes all variables to default to the @code{.tiny} section.  Note
16895 that there is a 65536-byte limit to this section.  Accesses to these
16896 variables use the @code{%gp} base register.
16898 @item -msatur
16899 @opindex msatur
16900 Enables the saturation instructions.  Note that the compiler does not
16901 currently generate these itself, but this option is included for
16902 compatibility with other tools, like @code{as}.
16904 @item -msdram
16905 @opindex msdram
16906 Link the SDRAM-based runtime instead of the default ROM-based runtime.
16908 @item -msim
16909 @opindex msim
16910 Link the simulator run-time libraries.
16912 @item -msimnovec
16913 @opindex msimnovec
16914 Link the simulator runtime libraries, excluding built-in support
16915 for reset and exception vectors and tables.
16917 @item -mtf
16918 @opindex mtf
16919 Causes all functions to default to the @code{.far} section.  Without
16920 this option, functions default to the @code{.near} section.
16922 @item -mtiny=@var{n}
16923 @opindex mtiny=
16924 Variables that are @var{n} bytes or smaller are allocated to the
16925 @code{.tiny} section.  These variables use the @code{$gp} base
16926 register.  The default for this option is 4, but note that there's a
16927 65536-byte limit to the @code{.tiny} section.
16929 @end table
16931 @node MicroBlaze Options
16932 @subsection MicroBlaze Options
16933 @cindex MicroBlaze Options
16935 @table @gcctabopt
16937 @item -msoft-float
16938 @opindex msoft-float
16939 Use software emulation for floating point (default).
16941 @item -mhard-float
16942 @opindex mhard-float
16943 Use hardware floating-point instructions.
16945 @item -mmemcpy
16946 @opindex mmemcpy
16947 Do not optimize block moves, use @code{memcpy}.
16949 @item -mno-clearbss
16950 @opindex mno-clearbss
16951 This option is deprecated.  Use @option{-fno-zero-initialized-in-bss} instead.
16953 @item -mcpu=@var{cpu-type}
16954 @opindex mcpu=
16955 Use features of, and schedule code for, the given CPU.
16956 Supported values are in the format @samp{v@var{X}.@var{YY}.@var{Z}},
16957 where @var{X} is a major version, @var{YY} is the minor version, and
16958 @var{Z} is compatibility code.  Example values are @samp{v3.00.a},
16959 @samp{v4.00.b}, @samp{v5.00.a}, @samp{v5.00.b}, @samp{v5.00.b}, @samp{v6.00.a}.
16961 @item -mxl-soft-mul
16962 @opindex mxl-soft-mul
16963 Use software multiply emulation (default).
16965 @item -mxl-soft-div
16966 @opindex mxl-soft-div
16967 Use software emulation for divides (default).
16969 @item -mxl-barrel-shift
16970 @opindex mxl-barrel-shift
16971 Use the hardware barrel shifter.
16973 @item -mxl-pattern-compare
16974 @opindex mxl-pattern-compare
16975 Use pattern compare instructions.
16977 @item -msmall-divides
16978 @opindex msmall-divides
16979 Use table lookup optimization for small signed integer divisions.
16981 @item -mxl-stack-check
16982 @opindex mxl-stack-check
16983 This option is deprecated.  Use @option{-fstack-check} instead.
16985 @item -mxl-gp-opt
16986 @opindex mxl-gp-opt
16987 Use GP-relative @code{.sdata}/@code{.sbss} sections.
16989 @item -mxl-multiply-high
16990 @opindex mxl-multiply-high
16991 Use multiply high instructions for high part of 32x32 multiply.
16993 @item -mxl-float-convert
16994 @opindex mxl-float-convert
16995 Use hardware floating-point conversion instructions.
16997 @item -mxl-float-sqrt
16998 @opindex mxl-float-sqrt
16999 Use hardware floating-point square root instruction.
17001 @item -mbig-endian
17002 @opindex mbig-endian
17003 Generate code for a big-endian target.
17005 @item -mlittle-endian
17006 @opindex mlittle-endian
17007 Generate code for a little-endian target.
17009 @item -mxl-reorder
17010 @opindex mxl-reorder
17011 Use reorder instructions (swap and byte reversed load/store).
17013 @item -mxl-mode-@var{app-model}
17014 Select application model @var{app-model}.  Valid models are
17015 @table @samp
17016 @item executable
17017 normal executable (default), uses startup code @file{crt0.o}.
17019 @item xmdstub
17020 for use with Xilinx Microprocessor Debugger (XMD) based
17021 software intrusive debug agent called xmdstub. This uses startup file
17022 @file{crt1.o} and sets the start address of the program to 0x800.
17024 @item bootstrap
17025 for applications that are loaded using a bootloader.
17026 This model uses startup file @file{crt2.o} which does not contain a processor
17027 reset vector handler. This is suitable for transferring control on a
17028 processor reset to the bootloader rather than the application.
17030 @item novectors
17031 for applications that do not require any of the
17032 MicroBlaze vectors. This option may be useful for applications running
17033 within a monitoring application. This model uses @file{crt3.o} as a startup file.
17034 @end table
17036 Option @option{-xl-mode-@var{app-model}} is a deprecated alias for
17037 @option{-mxl-mode-@var{app-model}}.
17039 @end table
17041 @node MIPS Options
17042 @subsection MIPS Options
17043 @cindex MIPS options
17045 @table @gcctabopt
17047 @item -EB
17048 @opindex EB
17049 Generate big-endian code.
17051 @item -EL
17052 @opindex EL
17053 Generate little-endian code.  This is the default for @samp{mips*el-*-*}
17054 configurations.
17056 @item -march=@var{arch}
17057 @opindex march
17058 Generate code that runs on @var{arch}, which can be the name of a
17059 generic MIPS ISA, or the name of a particular processor.
17060 The ISA names are:
17061 @samp{mips1}, @samp{mips2}, @samp{mips3}, @samp{mips4},
17062 @samp{mips32}, @samp{mips32r2}, @samp{mips64} and @samp{mips64r2}.
17063 The processor names are:
17064 @samp{4kc}, @samp{4km}, @samp{4kp}, @samp{4ksc},
17065 @samp{4kec}, @samp{4kem}, @samp{4kep}, @samp{4ksd},
17066 @samp{5kc}, @samp{5kf},
17067 @samp{20kc},
17068 @samp{24kc}, @samp{24kf2_1}, @samp{24kf1_1},
17069 @samp{24kec}, @samp{24kef2_1}, @samp{24kef1_1},
17070 @samp{34kc}, @samp{34kf2_1}, @samp{34kf1_1}, @samp{34kn},
17071 @samp{74kc}, @samp{74kf2_1}, @samp{74kf1_1}, @samp{74kf3_2},
17072 @samp{1004kc}, @samp{1004kf2_1}, @samp{1004kf1_1},
17073 @samp{loongson2e}, @samp{loongson2f}, @samp{loongson3a},
17074 @samp{m4k},
17075 @samp{m14k}, @samp{m14kc}, @samp{m14ke}, @samp{m14kec},
17076 @samp{octeon}, @samp{octeon+}, @samp{octeon2},
17077 @samp{orion},
17078 @samp{r2000}, @samp{r3000}, @samp{r3900}, @samp{r4000}, @samp{r4400},
17079 @samp{r4600}, @samp{r4650}, @samp{r4700}, @samp{r6000}, @samp{r8000},
17080 @samp{rm7000}, @samp{rm9000},
17081 @samp{r10000}, @samp{r12000}, @samp{r14000}, @samp{r16000},
17082 @samp{sb1},
17083 @samp{sr71000},
17084 @samp{vr4100}, @samp{vr4111}, @samp{vr4120}, @samp{vr4130}, @samp{vr4300},
17085 @samp{vr5000}, @samp{vr5400}, @samp{vr5500},
17086 @samp{xlr} and @samp{xlp}.
17087 The special value @samp{from-abi} selects the
17088 most compatible architecture for the selected ABI (that is,
17089 @samp{mips1} for 32-bit ABIs and @samp{mips3} for 64-bit ABIs)@.
17091 The native Linux/GNU toolchain also supports the value @samp{native},
17092 which selects the best architecture option for the host processor.
17093 @option{-march=native} has no effect if GCC does not recognize
17094 the processor.
17096 In processor names, a final @samp{000} can be abbreviated as @samp{k}
17097 (for example, @option{-march=r2k}).  Prefixes are optional, and
17098 @samp{vr} may be written @samp{r}.
17100 Names of the form @samp{@var{n}f2_1} refer to processors with
17101 FPUs clocked at half the rate of the core, names of the form
17102 @samp{@var{n}f1_1} refer to processors with FPUs clocked at the same
17103 rate as the core, and names of the form @samp{@var{n}f3_2} refer to
17104 processors with FPUs clocked a ratio of 3:2 with respect to the core.
17105 For compatibility reasons, @samp{@var{n}f} is accepted as a synonym
17106 for @samp{@var{n}f2_1} while @samp{@var{n}x} and @samp{@var{b}fx} are
17107 accepted as synonyms for @samp{@var{n}f1_1}.
17109 GCC defines two macros based on the value of this option.  The first
17110 is @samp{_MIPS_ARCH}, which gives the name of target architecture, as
17111 a string.  The second has the form @samp{_MIPS_ARCH_@var{foo}},
17112 where @var{foo} is the capitalized value of @samp{_MIPS_ARCH}@.
17113 For example, @option{-march=r2000} sets @samp{_MIPS_ARCH}
17114 to @samp{"r2000"} and defines the macro @samp{_MIPS_ARCH_R2000}.
17116 Note that the @samp{_MIPS_ARCH} macro uses the processor names given
17117 above.  In other words, it has the full prefix and does not
17118 abbreviate @samp{000} as @samp{k}.  In the case of @samp{from-abi},
17119 the macro names the resolved architecture (either @samp{"mips1"} or
17120 @samp{"mips3"}).  It names the default architecture when no
17121 @option{-march} option is given.
17123 @item -mtune=@var{arch}
17124 @opindex mtune
17125 Optimize for @var{arch}.  Among other things, this option controls
17126 the way instructions are scheduled, and the perceived cost of arithmetic
17127 operations.  The list of @var{arch} values is the same as for
17128 @option{-march}.
17130 When this option is not used, GCC optimizes for the processor
17131 specified by @option{-march}.  By using @option{-march} and
17132 @option{-mtune} together, it is possible to generate code that
17133 runs on a family of processors, but optimize the code for one
17134 particular member of that family.
17136 @option{-mtune} defines the macros @samp{_MIPS_TUNE} and
17137 @samp{_MIPS_TUNE_@var{foo}}, which work in the same way as the
17138 @option{-march} ones described above.
17140 @item -mips1
17141 @opindex mips1
17142 Equivalent to @option{-march=mips1}.
17144 @item -mips2
17145 @opindex mips2
17146 Equivalent to @option{-march=mips2}.
17148 @item -mips3
17149 @opindex mips3
17150 Equivalent to @option{-march=mips3}.
17152 @item -mips4
17153 @opindex mips4
17154 Equivalent to @option{-march=mips4}.
17156 @item -mips32
17157 @opindex mips32
17158 Equivalent to @option{-march=mips32}.
17160 @item -mips32r2
17161 @opindex mips32r2
17162 Equivalent to @option{-march=mips32r2}.
17164 @item -mips64
17165 @opindex mips64
17166 Equivalent to @option{-march=mips64}.
17168 @item -mips64r2
17169 @opindex mips64r2
17170 Equivalent to @option{-march=mips64r2}.
17172 @item -mips16
17173 @itemx -mno-mips16
17174 @opindex mips16
17175 @opindex mno-mips16
17176 Generate (do not generate) MIPS16 code.  If GCC is targeting a
17177 MIPS32 or MIPS64 architecture, it makes use of the MIPS16e ASE@.
17179 MIPS16 code generation can also be controlled on a per-function basis
17180 by means of @code{mips16} and @code{nomips16} attributes.
17181 @xref{Function Attributes}, for more information.
17183 @item -mflip-mips16
17184 @opindex mflip-mips16
17185 Generate MIPS16 code on alternating functions.  This option is provided
17186 for regression testing of mixed MIPS16/non-MIPS16 code generation, and is
17187 not intended for ordinary use in compiling user code.
17189 @item -minterlink-compressed
17190 @item -mno-interlink-compressed
17191 @opindex minterlink-compressed
17192 @opindex mno-interlink-compressed
17193 Require (do not require) that code using the standard (uncompressed) MIPS ISA
17194 be link-compatible with MIPS16 and microMIPS code, and vice versa.
17196 For example, code using the standard ISA encoding cannot jump directly
17197 to MIPS16 or microMIPS code; it must either use a call or an indirect jump.
17198 @option{-minterlink-compressed} therefore disables direct jumps unless GCC
17199 knows that the target of the jump is not compressed.
17201 @item -minterlink-mips16
17202 @itemx -mno-interlink-mips16
17203 @opindex minterlink-mips16
17204 @opindex mno-interlink-mips16
17205 Aliases of @option{-minterlink-compressed} and
17206 @option{-mno-interlink-compressed}.  These options predate the microMIPS ASE
17207 and are retained for backwards compatibility.
17209 @item -mabi=32
17210 @itemx -mabi=o64
17211 @itemx -mabi=n32
17212 @itemx -mabi=64
17213 @itemx -mabi=eabi
17214 @opindex mabi=32
17215 @opindex mabi=o64
17216 @opindex mabi=n32
17217 @opindex mabi=64
17218 @opindex mabi=eabi
17219 Generate code for the given ABI@.
17221 Note that the EABI has a 32-bit and a 64-bit variant.  GCC normally
17222 generates 64-bit code when you select a 64-bit architecture, but you
17223 can use @option{-mgp32} to get 32-bit code instead.
17225 For information about the O64 ABI, see
17226 @uref{http://gcc.gnu.org/@/projects/@/mipso64-abi.html}.
17228 GCC supports a variant of the o32 ABI in which floating-point registers
17229 are 64 rather than 32 bits wide.  You can select this combination with
17230 @option{-mabi=32} @option{-mfp64}.  This ABI relies on the @code{mthc1}
17231 and @code{mfhc1} instructions and is therefore only supported for
17232 MIPS32R2 processors.
17234 The register assignments for arguments and return values remain the
17235 same, but each scalar value is passed in a single 64-bit register
17236 rather than a pair of 32-bit registers.  For example, scalar
17237 floating-point values are returned in @samp{$f0} only, not a
17238 @samp{$f0}/@samp{$f1} pair.  The set of call-saved registers also
17239 remains the same, but all 64 bits are saved.
17241 @item -mabicalls
17242 @itemx -mno-abicalls
17243 @opindex mabicalls
17244 @opindex mno-abicalls
17245 Generate (do not generate) code that is suitable for SVR4-style
17246 dynamic objects.  @option{-mabicalls} is the default for SVR4-based
17247 systems.
17249 @item -mshared
17250 @itemx -mno-shared
17251 Generate (do not generate) code that is fully position-independent,
17252 and that can therefore be linked into shared libraries.  This option
17253 only affects @option{-mabicalls}.
17255 All @option{-mabicalls} code has traditionally been position-independent,
17256 regardless of options like @option{-fPIC} and @option{-fpic}.  However,
17257 as an extension, the GNU toolchain allows executables to use absolute
17258 accesses for locally-binding symbols.  It can also use shorter GP
17259 initialization sequences and generate direct calls to locally-defined
17260 functions.  This mode is selected by @option{-mno-shared}.
17262 @option{-mno-shared} depends on binutils 2.16 or higher and generates
17263 objects that can only be linked by the GNU linker.  However, the option
17264 does not affect the ABI of the final executable; it only affects the ABI
17265 of relocatable objects.  Using @option{-mno-shared} generally makes
17266 executables both smaller and quicker.
17268 @option{-mshared} is the default.
17270 @item -mplt
17271 @itemx -mno-plt
17272 @opindex mplt
17273 @opindex mno-plt
17274 Assume (do not assume) that the static and dynamic linkers
17275 support PLTs and copy relocations.  This option only affects
17276 @option{-mno-shared -mabicalls}.  For the n64 ABI, this option
17277 has no effect without @option{-msym32}.
17279 You can make @option{-mplt} the default by configuring
17280 GCC with @option{--with-mips-plt}.  The default is
17281 @option{-mno-plt} otherwise.
17283 @item -mxgot
17284 @itemx -mno-xgot
17285 @opindex mxgot
17286 @opindex mno-xgot
17287 Lift (do not lift) the usual restrictions on the size of the global
17288 offset table.
17290 GCC normally uses a single instruction to load values from the GOT@.
17291 While this is relatively efficient, it only works if the GOT
17292 is smaller than about 64k.  Anything larger causes the linker
17293 to report an error such as:
17295 @cindex relocation truncated to fit (MIPS)
17296 @smallexample
17297 relocation truncated to fit: R_MIPS_GOT16 foobar
17298 @end smallexample
17300 If this happens, you should recompile your code with @option{-mxgot}.
17301 This works with very large GOTs, although the code is also
17302 less efficient, since it takes three instructions to fetch the
17303 value of a global symbol.
17305 Note that some linkers can create multiple GOTs.  If you have such a
17306 linker, you should only need to use @option{-mxgot} when a single object
17307 file accesses more than 64k's worth of GOT entries.  Very few do.
17309 These options have no effect unless GCC is generating position
17310 independent code.
17312 @item -mgp32
17313 @opindex mgp32
17314 Assume that general-purpose registers are 32 bits wide.
17316 @item -mgp64
17317 @opindex mgp64
17318 Assume that general-purpose registers are 64 bits wide.
17320 @item -mfp32
17321 @opindex mfp32
17322 Assume that floating-point registers are 32 bits wide.
17324 @item -mfp64
17325 @opindex mfp64
17326 Assume that floating-point registers are 64 bits wide.
17328 @item -mhard-float
17329 @opindex mhard-float
17330 Use floating-point coprocessor instructions.
17332 @item -msoft-float
17333 @opindex msoft-float
17334 Do not use floating-point coprocessor instructions.  Implement
17335 floating-point calculations using library calls instead.
17337 @item -mno-float
17338 @opindex mno-float
17339 Equivalent to @option{-msoft-float}, but additionally asserts that the
17340 program being compiled does not perform any floating-point operations.
17341 This option is presently supported only by some bare-metal MIPS
17342 configurations, where it may select a special set of libraries
17343 that lack all floating-point support (including, for example, the
17344 floating-point @code{printf} formats).  
17345 If code compiled with @code{-mno-float} accidentally contains
17346 floating-point operations, it is likely to suffer a link-time
17347 or run-time failure.
17349 @item -msingle-float
17350 @opindex msingle-float
17351 Assume that the floating-point coprocessor only supports single-precision
17352 operations.
17354 @item -mdouble-float
17355 @opindex mdouble-float
17356 Assume that the floating-point coprocessor supports double-precision
17357 operations.  This is the default.
17359 @item -mabs=2008
17360 @itemx -mabs=legacy
17361 @opindex mabs=2008
17362 @opindex mabs=legacy
17363 These options control the treatment of the special not-a-number (NaN)
17364 IEEE 754 floating-point data with the @code{abs.@i{fmt}} and
17365 @code{neg.@i{fmt}} machine instructions.
17367 By default or when the @option{-mabs=legacy} is used the legacy
17368 treatment is selected.  In this case these instructions are considered
17369 arithmetic and avoided where correct operation is required and the
17370 input operand might be a NaN.  A longer sequence of instructions that
17371 manipulate the sign bit of floating-point datum manually is used
17372 instead unless the @option{-ffinite-math-only} option has also been
17373 specified.
17375 The @option{-mabs=2008} option selects the IEEE 754-2008 treatment.  In
17376 this case these instructions are considered non-arithmetic and therefore
17377 operating correctly in all cases, including in particular where the
17378 input operand is a NaN.  These instructions are therefore always used
17379 for the respective operations.
17381 @item -mnan=2008
17382 @itemx -mnan=legacy
17383 @opindex mnan=2008
17384 @opindex mnan=legacy
17385 These options control the encoding of the special not-a-number (NaN)
17386 IEEE 754 floating-point data.
17388 The @option{-mnan=legacy} option selects the legacy encoding.  In this
17389 case quiet NaNs (qNaNs) are denoted by the first bit of their trailing
17390 significand field being 0, whereas signalling NaNs (sNaNs) are denoted
17391 by the first bit of their trailing significand field being 1.
17393 The @option{-mnan=2008} option selects the IEEE 754-2008 encoding.  In
17394 this case qNaNs are denoted by the first bit of their trailing
17395 significand field being 1, whereas sNaNs are denoted by the first bit of
17396 their trailing significand field being 0.
17398 The default is @option{-mnan=legacy} unless GCC has been configured with
17399 @option{--with-nan=2008}.
17401 @item -mllsc
17402 @itemx -mno-llsc
17403 @opindex mllsc
17404 @opindex mno-llsc
17405 Use (do not use) @samp{ll}, @samp{sc}, and @samp{sync} instructions to
17406 implement atomic memory built-in functions.  When neither option is
17407 specified, GCC uses the instructions if the target architecture
17408 supports them.
17410 @option{-mllsc} is useful if the runtime environment can emulate the
17411 instructions and @option{-mno-llsc} can be useful when compiling for
17412 nonstandard ISAs.  You can make either option the default by
17413 configuring GCC with @option{--with-llsc} and @option{--without-llsc}
17414 respectively.  @option{--with-llsc} is the default for some
17415 configurations; see the installation documentation for details.
17417 @item -mdsp
17418 @itemx -mno-dsp
17419 @opindex mdsp
17420 @opindex mno-dsp
17421 Use (do not use) revision 1 of the MIPS DSP ASE@.
17422 @xref{MIPS DSP Built-in Functions}.  This option defines the
17423 preprocessor macro @samp{__mips_dsp}.  It also defines
17424 @samp{__mips_dsp_rev} to 1.
17426 @item -mdspr2
17427 @itemx -mno-dspr2
17428 @opindex mdspr2
17429 @opindex mno-dspr2
17430 Use (do not use) revision 2 of the MIPS DSP ASE@.
17431 @xref{MIPS DSP Built-in Functions}.  This option defines the
17432 preprocessor macros @samp{__mips_dsp} and @samp{__mips_dspr2}.
17433 It also defines @samp{__mips_dsp_rev} to 2.
17435 @item -msmartmips
17436 @itemx -mno-smartmips
17437 @opindex msmartmips
17438 @opindex mno-smartmips
17439 Use (do not use) the MIPS SmartMIPS ASE.
17441 @item -mpaired-single
17442 @itemx -mno-paired-single
17443 @opindex mpaired-single
17444 @opindex mno-paired-single
17445 Use (do not use) paired-single floating-point instructions.
17446 @xref{MIPS Paired-Single Support}.  This option requires
17447 hardware floating-point support to be enabled.
17449 @item -mdmx
17450 @itemx -mno-mdmx
17451 @opindex mdmx
17452 @opindex mno-mdmx
17453 Use (do not use) MIPS Digital Media Extension instructions.
17454 This option can only be used when generating 64-bit code and requires
17455 hardware floating-point support to be enabled.
17457 @item -mips3d
17458 @itemx -mno-mips3d
17459 @opindex mips3d
17460 @opindex mno-mips3d
17461 Use (do not use) the MIPS-3D ASE@.  @xref{MIPS-3D Built-in Functions}.
17462 The option @option{-mips3d} implies @option{-mpaired-single}.
17464 @item -mmicromips
17465 @itemx -mno-micromips
17466 @opindex mmicromips
17467 @opindex mno-mmicromips
17468 Generate (do not generate) microMIPS code.
17470 MicroMIPS code generation can also be controlled on a per-function basis
17471 by means of @code{micromips} and @code{nomicromips} attributes.
17472 @xref{Function Attributes}, for more information.
17474 @item -mmt
17475 @itemx -mno-mt
17476 @opindex mmt
17477 @opindex mno-mt
17478 Use (do not use) MT Multithreading instructions.
17480 @item -mmcu
17481 @itemx -mno-mcu
17482 @opindex mmcu
17483 @opindex mno-mcu
17484 Use (do not use) the MIPS MCU ASE instructions.
17486 @item -meva
17487 @itemx -mno-eva
17488 @opindex meva
17489 @opindex mno-eva
17490 Use (do not use) the MIPS Enhanced Virtual Addressing instructions.
17492 @item -mvirt
17493 @itemx -mno-virt
17494 @opindex mvirt
17495 @opindex mno-virt
17496 Use (do not use) the MIPS Virtualization Application Specific instructions.
17498 @item -mlong64
17499 @opindex mlong64
17500 Force @code{long} types to be 64 bits wide.  See @option{-mlong32} for
17501 an explanation of the default and the way that the pointer size is
17502 determined.
17504 @item -mlong32
17505 @opindex mlong32
17506 Force @code{long}, @code{int}, and pointer types to be 32 bits wide.
17508 The default size of @code{int}s, @code{long}s and pointers depends on
17509 the ABI@.  All the supported ABIs use 32-bit @code{int}s.  The n64 ABI
17510 uses 64-bit @code{long}s, as does the 64-bit EABI; the others use
17511 32-bit @code{long}s.  Pointers are the same size as @code{long}s,
17512 or the same size as integer registers, whichever is smaller.
17514 @item -msym32
17515 @itemx -mno-sym32
17516 @opindex msym32
17517 @opindex mno-sym32
17518 Assume (do not assume) that all symbols have 32-bit values, regardless
17519 of the selected ABI@.  This option is useful in combination with
17520 @option{-mabi=64} and @option{-mno-abicalls} because it allows GCC
17521 to generate shorter and faster references to symbolic addresses.
17523 @item -G @var{num}
17524 @opindex G
17525 Put definitions of externally-visible data in a small data section
17526 if that data is no bigger than @var{num} bytes.  GCC can then generate
17527 more efficient accesses to the data; see @option{-mgpopt} for details.
17529 The default @option{-G} option depends on the configuration.
17531 @item -mlocal-sdata
17532 @itemx -mno-local-sdata
17533 @opindex mlocal-sdata
17534 @opindex mno-local-sdata
17535 Extend (do not extend) the @option{-G} behavior to local data too,
17536 such as to static variables in C@.  @option{-mlocal-sdata} is the
17537 default for all configurations.
17539 If the linker complains that an application is using too much small data,
17540 you might want to try rebuilding the less performance-critical parts with
17541 @option{-mno-local-sdata}.  You might also want to build large
17542 libraries with @option{-mno-local-sdata}, so that the libraries leave
17543 more room for the main program.
17545 @item -mextern-sdata
17546 @itemx -mno-extern-sdata
17547 @opindex mextern-sdata
17548 @opindex mno-extern-sdata
17549 Assume (do not assume) that externally-defined data is in
17550 a small data section if the size of that data is within the @option{-G} limit.
17551 @option{-mextern-sdata} is the default for all configurations.
17553 If you compile a module @var{Mod} with @option{-mextern-sdata} @option{-G
17554 @var{num}} @option{-mgpopt}, and @var{Mod} references a variable @var{Var}
17555 that is no bigger than @var{num} bytes, you must make sure that @var{Var}
17556 is placed in a small data section.  If @var{Var} is defined by another
17557 module, you must either compile that module with a high-enough
17558 @option{-G} setting or attach a @code{section} attribute to @var{Var}'s
17559 definition.  If @var{Var} is common, you must link the application
17560 with a high-enough @option{-G} setting.
17562 The easiest way of satisfying these restrictions is to compile
17563 and link every module with the same @option{-G} option.  However,
17564 you may wish to build a library that supports several different
17565 small data limits.  You can do this by compiling the library with
17566 the highest supported @option{-G} setting and additionally using
17567 @option{-mno-extern-sdata} to stop the library from making assumptions
17568 about externally-defined data.
17570 @item -mgpopt
17571 @itemx -mno-gpopt
17572 @opindex mgpopt
17573 @opindex mno-gpopt
17574 Use (do not use) GP-relative accesses for symbols that are known to be
17575 in a small data section; see @option{-G}, @option{-mlocal-sdata} and
17576 @option{-mextern-sdata}.  @option{-mgpopt} is the default for all
17577 configurations.
17579 @option{-mno-gpopt} is useful for cases where the @code{$gp} register
17580 might not hold the value of @code{_gp}.  For example, if the code is
17581 part of a library that might be used in a boot monitor, programs that
17582 call boot monitor routines pass an unknown value in @code{$gp}.
17583 (In such situations, the boot monitor itself is usually compiled
17584 with @option{-G0}.)
17586 @option{-mno-gpopt} implies @option{-mno-local-sdata} and
17587 @option{-mno-extern-sdata}.
17589 @item -membedded-data
17590 @itemx -mno-embedded-data
17591 @opindex membedded-data
17592 @opindex mno-embedded-data
17593 Allocate variables to the read-only data section first if possible, then
17594 next in the small data section if possible, otherwise in data.  This gives
17595 slightly slower code than the default, but reduces the amount of RAM required
17596 when executing, and thus may be preferred for some embedded systems.
17598 @item -muninit-const-in-rodata
17599 @itemx -mno-uninit-const-in-rodata
17600 @opindex muninit-const-in-rodata
17601 @opindex mno-uninit-const-in-rodata
17602 Put uninitialized @code{const} variables in the read-only data section.
17603 This option is only meaningful in conjunction with @option{-membedded-data}.
17605 @item -mcode-readable=@var{setting}
17606 @opindex mcode-readable
17607 Specify whether GCC may generate code that reads from executable sections.
17608 There are three possible settings:
17610 @table @gcctabopt
17611 @item -mcode-readable=yes
17612 Instructions may freely access executable sections.  This is the
17613 default setting.
17615 @item -mcode-readable=pcrel
17616 MIPS16 PC-relative load instructions can access executable sections,
17617 but other instructions must not do so.  This option is useful on 4KSc
17618 and 4KSd processors when the code TLBs have the Read Inhibit bit set.
17619 It is also useful on processors that can be configured to have a dual
17620 instruction/data SRAM interface and that, like the M4K, automatically
17621 redirect PC-relative loads to the instruction RAM.
17623 @item -mcode-readable=no
17624 Instructions must not access executable sections.  This option can be
17625 useful on targets that are configured to have a dual instruction/data
17626 SRAM interface but that (unlike the M4K) do not automatically redirect
17627 PC-relative loads to the instruction RAM.
17628 @end table
17630 @item -msplit-addresses
17631 @itemx -mno-split-addresses
17632 @opindex msplit-addresses
17633 @opindex mno-split-addresses
17634 Enable (disable) use of the @code{%hi()} and @code{%lo()} assembler
17635 relocation operators.  This option has been superseded by
17636 @option{-mexplicit-relocs} but is retained for backwards compatibility.
17638 @item -mexplicit-relocs
17639 @itemx -mno-explicit-relocs
17640 @opindex mexplicit-relocs
17641 @opindex mno-explicit-relocs
17642 Use (do not use) assembler relocation operators when dealing with symbolic
17643 addresses.  The alternative, selected by @option{-mno-explicit-relocs},
17644 is to use assembler macros instead.
17646 @option{-mexplicit-relocs} is the default if GCC was configured
17647 to use an assembler that supports relocation operators.
17649 @item -mcheck-zero-division
17650 @itemx -mno-check-zero-division
17651 @opindex mcheck-zero-division
17652 @opindex mno-check-zero-division
17653 Trap (do not trap) on integer division by zero.
17655 The default is @option{-mcheck-zero-division}.
17657 @item -mdivide-traps
17658 @itemx -mdivide-breaks
17659 @opindex mdivide-traps
17660 @opindex mdivide-breaks
17661 MIPS systems check for division by zero by generating either a
17662 conditional trap or a break instruction.  Using traps results in
17663 smaller code, but is only supported on MIPS II and later.  Also, some
17664 versions of the Linux kernel have a bug that prevents trap from
17665 generating the proper signal (@code{SIGFPE}).  Use @option{-mdivide-traps} to
17666 allow conditional traps on architectures that support them and
17667 @option{-mdivide-breaks} to force the use of breaks.
17669 The default is usually @option{-mdivide-traps}, but this can be
17670 overridden at configure time using @option{--with-divide=breaks}.
17671 Divide-by-zero checks can be completely disabled using
17672 @option{-mno-check-zero-division}.
17674 @item -mmemcpy
17675 @itemx -mno-memcpy
17676 @opindex mmemcpy
17677 @opindex mno-memcpy
17678 Force (do not force) the use of @code{memcpy()} for non-trivial block
17679 moves.  The default is @option{-mno-memcpy}, which allows GCC to inline
17680 most constant-sized copies.
17682 @item -mlong-calls
17683 @itemx -mno-long-calls
17684 @opindex mlong-calls
17685 @opindex mno-long-calls
17686 Disable (do not disable) use of the @code{jal} instruction.  Calling
17687 functions using @code{jal} is more efficient but requires the caller
17688 and callee to be in the same 256 megabyte segment.
17690 This option has no effect on abicalls code.  The default is
17691 @option{-mno-long-calls}.
17693 @item -mmad
17694 @itemx -mno-mad
17695 @opindex mmad
17696 @opindex mno-mad
17697 Enable (disable) use of the @code{mad}, @code{madu} and @code{mul}
17698 instructions, as provided by the R4650 ISA@.
17700 @item -mimadd
17701 @itemx -mno-imadd
17702 @opindex mimadd
17703 @opindex mno-imadd
17704 Enable (disable) use of the @code{madd} and @code{msub} integer
17705 instructions.  The default is @option{-mimadd} on architectures
17706 that support @code{madd} and @code{msub} except for the 74k 
17707 architecture where it was found to generate slower code.
17709 @item -mfused-madd
17710 @itemx -mno-fused-madd
17711 @opindex mfused-madd
17712 @opindex mno-fused-madd
17713 Enable (disable) use of the floating-point multiply-accumulate
17714 instructions, when they are available.  The default is
17715 @option{-mfused-madd}.
17717 On the R8000 CPU when multiply-accumulate instructions are used,
17718 the intermediate product is calculated to infinite precision
17719 and is not subject to the FCSR Flush to Zero bit.  This may be
17720 undesirable in some circumstances.  On other processors the result
17721 is numerically identical to the equivalent computation using
17722 separate multiply, add, subtract and negate instructions.
17724 @item -nocpp
17725 @opindex nocpp
17726 Tell the MIPS assembler to not run its preprocessor over user
17727 assembler files (with a @samp{.s} suffix) when assembling them.
17729 @item -mfix-24k
17730 @item -mno-fix-24k
17731 @opindex mfix-24k
17732 @opindex mno-fix-24k
17733 Work around the 24K E48 (lost data on stores during refill) errata.
17734 The workarounds are implemented by the assembler rather than by GCC@.
17736 @item -mfix-r4000
17737 @itemx -mno-fix-r4000
17738 @opindex mfix-r4000
17739 @opindex mno-fix-r4000
17740 Work around certain R4000 CPU errata:
17741 @itemize @minus
17742 @item
17743 A double-word or a variable shift may give an incorrect result if executed
17744 immediately after starting an integer division.
17745 @item
17746 A double-word or a variable shift may give an incorrect result if executed
17747 while an integer multiplication is in progress.
17748 @item
17749 An integer division may give an incorrect result if started in a delay slot
17750 of a taken branch or a jump.
17751 @end itemize
17753 @item -mfix-r4400
17754 @itemx -mno-fix-r4400
17755 @opindex mfix-r4400
17756 @opindex mno-fix-r4400
17757 Work around certain R4400 CPU errata:
17758 @itemize @minus
17759 @item
17760 A double-word or a variable shift may give an incorrect result if executed
17761 immediately after starting an integer division.
17762 @end itemize
17764 @item -mfix-r10000
17765 @itemx -mno-fix-r10000
17766 @opindex mfix-r10000
17767 @opindex mno-fix-r10000
17768 Work around certain R10000 errata:
17769 @itemize @minus
17770 @item
17771 @code{ll}/@code{sc} sequences may not behave atomically on revisions
17772 prior to 3.0.  They may deadlock on revisions 2.6 and earlier.
17773 @end itemize
17775 This option can only be used if the target architecture supports
17776 branch-likely instructions.  @option{-mfix-r10000} is the default when
17777 @option{-march=r10000} is used; @option{-mno-fix-r10000} is the default
17778 otherwise.
17780 @item -mfix-rm7000
17781 @itemx -mno-fix-rm7000
17782 @opindex mfix-rm7000
17783 Work around the RM7000 @code{dmult}/@code{dmultu} errata.  The
17784 workarounds are implemented by the assembler rather than by GCC@.
17786 @item -mfix-vr4120
17787 @itemx -mno-fix-vr4120
17788 @opindex mfix-vr4120
17789 Work around certain VR4120 errata:
17790 @itemize @minus
17791 @item
17792 @code{dmultu} does not always produce the correct result.
17793 @item
17794 @code{div} and @code{ddiv} do not always produce the correct result if one
17795 of the operands is negative.
17796 @end itemize
17797 The workarounds for the division errata rely on special functions in
17798 @file{libgcc.a}.  At present, these functions are only provided by
17799 the @code{mips64vr*-elf} configurations.
17801 Other VR4120 errata require a NOP to be inserted between certain pairs of
17802 instructions.  These errata are handled by the assembler, not by GCC itself.
17804 @item -mfix-vr4130
17805 @opindex mfix-vr4130
17806 Work around the VR4130 @code{mflo}/@code{mfhi} errata.  The
17807 workarounds are implemented by the assembler rather than by GCC,
17808 although GCC avoids using @code{mflo} and @code{mfhi} if the
17809 VR4130 @code{macc}, @code{macchi}, @code{dmacc} and @code{dmacchi}
17810 instructions are available instead.
17812 @item -mfix-sb1
17813 @itemx -mno-fix-sb1
17814 @opindex mfix-sb1
17815 Work around certain SB-1 CPU core errata.
17816 (This flag currently works around the SB-1 revision 2
17817 ``F1'' and ``F2'' floating-point errata.)
17819 @item -mr10k-cache-barrier=@var{setting}
17820 @opindex mr10k-cache-barrier
17821 Specify whether GCC should insert cache barriers to avoid the
17822 side-effects of speculation on R10K processors.
17824 In common with many processors, the R10K tries to predict the outcome
17825 of a conditional branch and speculatively executes instructions from
17826 the ``taken'' branch.  It later aborts these instructions if the
17827 predicted outcome is wrong.  However, on the R10K, even aborted
17828 instructions can have side effects.
17830 This problem only affects kernel stores and, depending on the system,
17831 kernel loads.  As an example, a speculatively-executed store may load
17832 the target memory into cache and mark the cache line as dirty, even if
17833 the store itself is later aborted.  If a DMA operation writes to the
17834 same area of memory before the ``dirty'' line is flushed, the cached
17835 data overwrites the DMA-ed data.  See the R10K processor manual
17836 for a full description, including other potential problems.
17838 One workaround is to insert cache barrier instructions before every memory
17839 access that might be speculatively executed and that might have side
17840 effects even if aborted.  @option{-mr10k-cache-barrier=@var{setting}}
17841 controls GCC's implementation of this workaround.  It assumes that
17842 aborted accesses to any byte in the following regions does not have
17843 side effects:
17845 @enumerate
17846 @item
17847 the memory occupied by the current function's stack frame;
17849 @item
17850 the memory occupied by an incoming stack argument;
17852 @item
17853 the memory occupied by an object with a link-time-constant address.
17854 @end enumerate
17856 It is the kernel's responsibility to ensure that speculative
17857 accesses to these regions are indeed safe.
17859 If the input program contains a function declaration such as:
17861 @smallexample
17862 void foo (void);
17863 @end smallexample
17865 then the implementation of @code{foo} must allow @code{j foo} and
17866 @code{jal foo} to be executed speculatively.  GCC honors this
17867 restriction for functions it compiles itself.  It expects non-GCC
17868 functions (such as hand-written assembly code) to do the same.
17870 The option has three forms:
17872 @table @gcctabopt
17873 @item -mr10k-cache-barrier=load-store
17874 Insert a cache barrier before a load or store that might be
17875 speculatively executed and that might have side effects even
17876 if aborted.
17878 @item -mr10k-cache-barrier=store
17879 Insert a cache barrier before a store that might be speculatively
17880 executed and that might have side effects even if aborted.
17882 @item -mr10k-cache-barrier=none
17883 Disable the insertion of cache barriers.  This is the default setting.
17884 @end table
17886 @item -mflush-func=@var{func}
17887 @itemx -mno-flush-func
17888 @opindex mflush-func
17889 Specifies the function to call to flush the I and D caches, or to not
17890 call any such function.  If called, the function must take the same
17891 arguments as the common @code{_flush_func()}, that is, the address of the
17892 memory range for which the cache is being flushed, the size of the
17893 memory range, and the number 3 (to flush both caches).  The default
17894 depends on the target GCC was configured for, but commonly is either
17895 @samp{_flush_func} or @samp{__cpu_flush}.
17897 @item mbranch-cost=@var{num}
17898 @opindex mbranch-cost
17899 Set the cost of branches to roughly @var{num} ``simple'' instructions.
17900 This cost is only a heuristic and is not guaranteed to produce
17901 consistent results across releases.  A zero cost redundantly selects
17902 the default, which is based on the @option{-mtune} setting.
17904 @item -mbranch-likely
17905 @itemx -mno-branch-likely
17906 @opindex mbranch-likely
17907 @opindex mno-branch-likely
17908 Enable or disable use of Branch Likely instructions, regardless of the
17909 default for the selected architecture.  By default, Branch Likely
17910 instructions may be generated if they are supported by the selected
17911 architecture.  An exception is for the MIPS32 and MIPS64 architectures
17912 and processors that implement those architectures; for those, Branch
17913 Likely instructions are not be generated by default because the MIPS32
17914 and MIPS64 architectures specifically deprecate their use.
17916 @item -mfp-exceptions
17917 @itemx -mno-fp-exceptions
17918 @opindex mfp-exceptions
17919 Specifies whether FP exceptions are enabled.  This affects how
17920 FP instructions are scheduled for some processors.
17921 The default is that FP exceptions are
17922 enabled.
17924 For instance, on the SB-1, if FP exceptions are disabled, and we are emitting
17925 64-bit code, then we can use both FP pipes.  Otherwise, we can only use one
17926 FP pipe.
17928 @item -mvr4130-align
17929 @itemx -mno-vr4130-align
17930 @opindex mvr4130-align
17931 The VR4130 pipeline is two-way superscalar, but can only issue two
17932 instructions together if the first one is 8-byte aligned.  When this
17933 option is enabled, GCC aligns pairs of instructions that it
17934 thinks should execute in parallel.
17936 This option only has an effect when optimizing for the VR4130.
17937 It normally makes code faster, but at the expense of making it bigger.
17938 It is enabled by default at optimization level @option{-O3}.
17940 @item -msynci
17941 @itemx -mno-synci
17942 @opindex msynci
17943 Enable (disable) generation of @code{synci} instructions on
17944 architectures that support it.  The @code{synci} instructions (if
17945 enabled) are generated when @code{__builtin___clear_cache()} is
17946 compiled.
17948 This option defaults to @code{-mno-synci}, but the default can be
17949 overridden by configuring with @code{--with-synci}.
17951 When compiling code for single processor systems, it is generally safe
17952 to use @code{synci}.  However, on many multi-core (SMP) systems, it
17953 does not invalidate the instruction caches on all cores and may lead
17954 to undefined behavior.
17956 @item -mrelax-pic-calls
17957 @itemx -mno-relax-pic-calls
17958 @opindex mrelax-pic-calls
17959 Try to turn PIC calls that are normally dispatched via register
17960 @code{$25} into direct calls.  This is only possible if the linker can
17961 resolve the destination at link-time and if the destination is within
17962 range for a direct call.
17964 @option{-mrelax-pic-calls} is the default if GCC was configured to use
17965 an assembler and a linker that support the @code{.reloc} assembly
17966 directive and @code{-mexplicit-relocs} is in effect.  With
17967 @code{-mno-explicit-relocs}, this optimization can be performed by the
17968 assembler and the linker alone without help from the compiler.
17970 @item -mmcount-ra-address
17971 @itemx -mno-mcount-ra-address
17972 @opindex mmcount-ra-address
17973 @opindex mno-mcount-ra-address
17974 Emit (do not emit) code that allows @code{_mcount} to modify the
17975 calling function's return address.  When enabled, this option extends
17976 the usual @code{_mcount} interface with a new @var{ra-address}
17977 parameter, which has type @code{intptr_t *} and is passed in register
17978 @code{$12}.  @code{_mcount} can then modify the return address by
17979 doing both of the following:
17980 @itemize
17981 @item
17982 Returning the new address in register @code{$31}.
17983 @item
17984 Storing the new address in @code{*@var{ra-address}},
17985 if @var{ra-address} is nonnull.
17986 @end itemize
17988 The default is @option{-mno-mcount-ra-address}.
17990 @end table
17992 @node MMIX Options
17993 @subsection MMIX Options
17994 @cindex MMIX Options
17996 These options are defined for the MMIX:
17998 @table @gcctabopt
17999 @item -mlibfuncs
18000 @itemx -mno-libfuncs
18001 @opindex mlibfuncs
18002 @opindex mno-libfuncs
18003 Specify that intrinsic library functions are being compiled, passing all
18004 values in registers, no matter the size.
18006 @item -mepsilon
18007 @itemx -mno-epsilon
18008 @opindex mepsilon
18009 @opindex mno-epsilon
18010 Generate floating-point comparison instructions that compare with respect
18011 to the @code{rE} epsilon register.
18013 @item -mabi=mmixware
18014 @itemx -mabi=gnu
18015 @opindex mabi=mmixware
18016 @opindex mabi=gnu
18017 Generate code that passes function parameters and return values that (in
18018 the called function) are seen as registers @code{$0} and up, as opposed to
18019 the GNU ABI which uses global registers @code{$231} and up.
18021 @item -mzero-extend
18022 @itemx -mno-zero-extend
18023 @opindex mzero-extend
18024 @opindex mno-zero-extend
18025 When reading data from memory in sizes shorter than 64 bits, use (do not
18026 use) zero-extending load instructions by default, rather than
18027 sign-extending ones.
18029 @item -mknuthdiv
18030 @itemx -mno-knuthdiv
18031 @opindex mknuthdiv
18032 @opindex mno-knuthdiv
18033 Make the result of a division yielding a remainder have the same sign as
18034 the divisor.  With the default, @option{-mno-knuthdiv}, the sign of the
18035 remainder follows the sign of the dividend.  Both methods are
18036 arithmetically valid, the latter being almost exclusively used.
18038 @item -mtoplevel-symbols
18039 @itemx -mno-toplevel-symbols
18040 @opindex mtoplevel-symbols
18041 @opindex mno-toplevel-symbols
18042 Prepend (do not prepend) a @samp{:} to all global symbols, so the assembly
18043 code can be used with the @code{PREFIX} assembly directive.
18045 @item -melf
18046 @opindex melf
18047 Generate an executable in the ELF format, rather than the default
18048 @samp{mmo} format used by the @command{mmix} simulator.
18050 @item -mbranch-predict
18051 @itemx -mno-branch-predict
18052 @opindex mbranch-predict
18053 @opindex mno-branch-predict
18054 Use (do not use) the probable-branch instructions, when static branch
18055 prediction indicates a probable branch.
18057 @item -mbase-addresses
18058 @itemx -mno-base-addresses
18059 @opindex mbase-addresses
18060 @opindex mno-base-addresses
18061 Generate (do not generate) code that uses @emph{base addresses}.  Using a
18062 base address automatically generates a request (handled by the assembler
18063 and the linker) for a constant to be set up in a global register.  The
18064 register is used for one or more base address requests within the range 0
18065 to 255 from the value held in the register.  The generally leads to short
18066 and fast code, but the number of different data items that can be
18067 addressed is limited.  This means that a program that uses lots of static
18068 data may require @option{-mno-base-addresses}.
18070 @item -msingle-exit
18071 @itemx -mno-single-exit
18072 @opindex msingle-exit
18073 @opindex mno-single-exit
18074 Force (do not force) generated code to have a single exit point in each
18075 function.
18076 @end table
18078 @node MN10300 Options
18079 @subsection MN10300 Options
18080 @cindex MN10300 options
18082 These @option{-m} options are defined for Matsushita MN10300 architectures:
18084 @table @gcctabopt
18085 @item -mmult-bug
18086 @opindex mmult-bug
18087 Generate code to avoid bugs in the multiply instructions for the MN10300
18088 processors.  This is the default.
18090 @item -mno-mult-bug
18091 @opindex mno-mult-bug
18092 Do not generate code to avoid bugs in the multiply instructions for the
18093 MN10300 processors.
18095 @item -mam33
18096 @opindex mam33
18097 Generate code using features specific to the AM33 processor.
18099 @item -mno-am33
18100 @opindex mno-am33
18101 Do not generate code using features specific to the AM33 processor.  This
18102 is the default.
18104 @item -mam33-2
18105 @opindex mam33-2
18106 Generate code using features specific to the AM33/2.0 processor.
18108 @item -mam34
18109 @opindex mam34
18110 Generate code using features specific to the AM34 processor.
18112 @item -mtune=@var{cpu-type}
18113 @opindex mtune
18114 Use the timing characteristics of the indicated CPU type when
18115 scheduling instructions.  This does not change the targeted processor
18116 type.  The CPU type must be one of @samp{mn10300}, @samp{am33},
18117 @samp{am33-2} or @samp{am34}.
18119 @item -mreturn-pointer-on-d0
18120 @opindex mreturn-pointer-on-d0
18121 When generating a function that returns a pointer, return the pointer
18122 in both @code{a0} and @code{d0}.  Otherwise, the pointer is returned
18123 only in @code{a0}, and attempts to call such functions without a prototype
18124 result in errors.  Note that this option is on by default; use
18125 @option{-mno-return-pointer-on-d0} to disable it.
18127 @item -mno-crt0
18128 @opindex mno-crt0
18129 Do not link in the C run-time initialization object file.
18131 @item -mrelax
18132 @opindex mrelax
18133 Indicate to the linker that it should perform a relaxation optimization pass
18134 to shorten branches, calls and absolute memory addresses.  This option only
18135 has an effect when used on the command line for the final link step.
18137 This option makes symbolic debugging impossible.
18139 @item -mliw
18140 @opindex mliw
18141 Allow the compiler to generate @emph{Long Instruction Word}
18142 instructions if the target is the @samp{AM33} or later.  This is the
18143 default.  This option defines the preprocessor macro @samp{__LIW__}.
18145 @item -mnoliw
18146 @opindex mnoliw
18147 Do not allow the compiler to generate @emph{Long Instruction Word}
18148 instructions.  This option defines the preprocessor macro
18149 @samp{__NO_LIW__}.
18151 @item -msetlb
18152 @opindex msetlb
18153 Allow the compiler to generate the @emph{SETLB} and @emph{Lcc}
18154 instructions if the target is the @samp{AM33} or later.  This is the
18155 default.  This option defines the preprocessor macro @samp{__SETLB__}.
18157 @item -mnosetlb
18158 @opindex mnosetlb
18159 Do not allow the compiler to generate @emph{SETLB} or @emph{Lcc}
18160 instructions.  This option defines the preprocessor macro
18161 @samp{__NO_SETLB__}.
18163 @end table
18165 @node Moxie Options
18166 @subsection Moxie Options
18167 @cindex Moxie Options
18169 @table @gcctabopt
18171 @item -meb
18172 @opindex meb
18173 Generate big-endian code.  This is the default for @samp{moxie-*-*}
18174 configurations.
18176 @item -mel
18177 @opindex mel
18178 Generate little-endian code.
18180 @item -mno-crt0
18181 @opindex mno-crt0
18182 Do not link in the C run-time initialization object file.
18184 @end table
18186 @node MSP430 Options
18187 @subsection MSP430 Options
18188 @cindex MSP430 Options
18190 These options are defined for the MSP430:
18192 @table @gcctabopt
18194 @item -masm-hex
18195 @opindex masm-hex
18196 Force assembly output to always use hex constants.  Normally such
18197 constants are signed decimals, but this option is available for
18198 testsuite and/or aesthetic purposes.
18200 @item -mmcu=
18201 @opindex mmcu=
18202 Select the MCU to target.  This is used to create a C preprocessor
18203 symbol based upon the MCU name, converted to upper case and pre- and
18204 post- fixed with @code{__}.  This in turn will be used by the
18205 @code{msp430.h} header file to select an MCU specific supplimentary
18206 header file.
18208 The option also sets the ISA to use.  If the MCU name is one that is
18209 known to only support the 430 ISA then that is selected, otherwise the
18210 430X ISA is selected.  A generic MCU name of @code{msp430} can also be
18211 used to select the 430 ISA.  Similarly the generic @code{msp430x} MCU
18212 name will select the 430X ISA.
18214 In addition an MCU specific linker script will be added to the linker
18215 command line.  The script's name is the name of the MCU with
18216 @code{.ld} appended.  Thus specifying @option{-mmcu=xxx} on the gcc
18217 command line will define the C preprocessor symbol @code{__XXX__} and
18218 cause the linker to search for a script called @file{xxx.ld}.
18220 This option is also passed on to the assembler.
18222 @item -mcpu=
18223 @opindex -mcpu=
18224 Specifies the ISA to use.  Accepted values are @code{msp430},
18225 @code{msp430x} and @code{msp430xv2}.  This option is deprecated.  The
18226 @option{-mmcu=} option should be used to select the ISA.
18228 @item -msim
18229 @opindex msim
18230 Link to the simulator runtime libraries and linker script.  Overrides
18231 any scripts that would be selected by the @option{-mmcu=} option.
18233 @item -mlarge
18234 @opindex mlarge
18235 Use large-model addressing (20-bit pointers, 32-bit @code{size_t}).
18237 @item -msmall
18238 @opindex msmall
18239 Use small-model addressing (16-bit pointers, 16-bit @code{size_t}).
18241 @item -mrelax
18242 @opindex mrelax
18243 This option is passed to the assembler and linker, and allows the
18244 linker to perform certain optimizations that cannot be done until
18245 the final link.
18247 @item mhwmult=
18248 @opindex mhwmult=
18249 Describes the type of hardware multiply supported by the target.
18250 Accepted values are @code{none} for no hardware multiply, @code{16bit}
18251 for the original 16-bit-only multiply supported by early MCUs.
18252 @code{32bit} for the 16/32-bit multiply supported by later MCUs and
18253 @code{f5series} for the 16/32-bit multiply supported by F5-series MCUs.
18254 A value of @code{auto} can also be given.  This tells GCC to deduce
18255 the hardware multiply support based upon the MCU name provided by the
18256 @option{-mmcu} option.  If no @option{-mmcu} option is specified then
18257 @code{32bit} hardware multiply support is assumed.  @code{auto} is the
18258 default setting.
18260 Hardware multiplies are normally performed by calling a library
18261 routine.  This saves space in the generated code.  When compiling at
18262 @code{-O3} or higher however the hardware multiplier is invoked
18263 inline.  This makes for bigger, but faster code.
18265 The hardware multiply routines disable interrupts whilst running and
18266 restore the previous interrupt state when they finish.  This makes
18267 them safe to use inside interrupt handlers as well as in normal code.
18269 @end table
18271 @node NDS32 Options
18272 @subsection NDS32 Options
18273 @cindex NDS32 Options
18275 These options are defined for NDS32 implementations:
18277 @table @gcctabopt
18279 @item -mbig-endian
18280 @opindex mbig-endian
18281 Generate code in big-endian mode.
18283 @item -mlittle-endian
18284 @opindex mlittle-endian
18285 Generate code in little-endian mode.
18287 @item -mreduced-regs
18288 @opindex mreduced-regs
18289 Use reduced-set registers for register allocation.
18291 @item -mfull-regs
18292 @opindex mfull-regs
18293 Use full-set registers for register allocation.
18295 @item -mcmov
18296 @opindex mcmov
18297 Generate conditional move instructions.
18299 @item -mno-cmov
18300 @opindex mno-cmov
18301 Do not generate conditional move instructions.
18303 @item -mperf-ext
18304 @opindex mperf-ext
18305 Generate performance extension instructions.
18307 @item -mno-perf-ext
18308 @opindex mno-perf-ext
18309 Do not generate performance extension instructions.
18311 @item -mv3push
18312 @opindex mv3push
18313 Generate v3 push25/pop25 instructions.
18315 @item -mno-v3push
18316 @opindex mno-v3push
18317 Do not generate v3 push25/pop25 instructions.
18319 @item -m16-bit
18320 @opindex m16-bit
18321 Generate 16-bit instructions.
18323 @item -mno-16-bit
18324 @opindex mno-16-bit
18325 Do not generate 16-bit instructions.
18327 @item -mgp-direct
18328 @opindex mgp-direct
18329 Generate GP base instructions directly.
18331 @item -mno-gp-direct
18332 @opindex mno-gp-direct
18333 Do no generate GP base instructions directly.
18335 @item -misr-vector-size=@var{num}
18336 @opindex misr-vector-size
18337 Specify the size of each interrupt vector, which must be 4 or 16.
18339 @item -mcache-block-size=@var{num}
18340 @opindex mcache-block-size
18341 Specify the size of each cache block,
18342 which must be a power of 2 between 4 and 512.
18344 @item -march=@var{arch}
18345 @opindex march
18346 Specify the name of the target architecture.
18348 @item -mforce-fp-as-gp
18349 @opindex mforce-fp-as-gp
18350 Prevent $fp being allocated during register allocation so that compiler
18351 is able to force performing fp-as-gp optimization.
18353 @item -mforbid-fp-as-gp
18354 @opindex mforbid-fp-as-gp
18355 Forbid using $fp to access static and global variables.
18356 This option strictly forbids fp-as-gp optimization
18357 regardless of @option{-mforce-fp-as-gp}.
18359 @item -mex9
18360 @opindex mex9
18361 Use special directives to guide linker doing ex9 optimization.
18363 @item -mctor-dtor
18364 @opindex mctor-dtor
18365 Enable constructor/destructor feature.
18367 @item -mrelax
18368 @opindex mrelax
18369 Guide linker to relax instructions.
18371 @end table
18373 @node Nios II Options
18374 @subsection Nios II Options
18375 @cindex Nios II options
18376 @cindex Altera Nios II options
18378 These are the options defined for the Altera Nios II processor.
18380 @table @gcctabopt
18382 @item -G @var{num}
18383 @opindex G
18384 @cindex smaller data references
18385 Put global and static objects less than or equal to @var{num} bytes
18386 into the small data or BSS sections instead of the normal data or BSS
18387 sections.  The default value of @var{num} is 8.
18389 @item -mgpopt
18390 @itemx -mno-gpopt
18391 @opindex mgpopt
18392 @opindex mno-gpopt
18393 Generate (do not generate) GP-relative accesses for objects in the
18394 small data or BSS sections.  The default is @option{-mgpopt} except
18395 when @option{-fpic} or @option{-fPIC} is specified to generate
18396 position-independent code.  Note that the Nios II ABI does not permit
18397 GP-relative accesses from shared libraries.
18399 You may need to specify @option{-mno-gpopt} explicitly when building
18400 programs that include large amounts of small data, including large
18401 GOT data sections.  In this case, the 16-bit offset for GP-relative
18402 addressing may not be large enough to allow access to the entire 
18403 small data section.
18405 @item -mel
18406 @itemx -meb
18407 @opindex mel
18408 @opindex meb
18409 Generate little-endian (default) or big-endian (experimental) code,
18410 respectively.
18412 @item -mbypass-cache
18413 @itemx -mno-bypass-cache
18414 @opindex mno-bypass-cache
18415 @opindex mbypass-cache
18416 Force all load and store instructions to always bypass cache by 
18417 using I/O variants of the instructions. The default is not to
18418 bypass the cache.
18420 @item -mno-cache-volatile 
18421 @itemx -mcache-volatile       
18422 @opindex mcache-volatile 
18423 @opindex mno-cache-volatile
18424 Volatile memory access bypass the cache using the I/O variants of 
18425 the load and store instructions. The default is not to bypass the cache.
18427 @item -mno-fast-sw-div
18428 @itemx -mfast-sw-div
18429 @opindex mno-fast-sw-div
18430 @opindex mfast-sw-div
18431 Do not use table-based fast divide for small numbers. The default 
18432 is to use the fast divide at @option{-O3} and above.
18434 @item -mno-hw-mul
18435 @itemx -mhw-mul
18436 @itemx -mno-hw-mulx
18437 @itemx -mhw-mulx
18438 @itemx -mno-hw-div
18439 @itemx -mhw-div
18440 @opindex mno-hw-mul
18441 @opindex mhw-mul
18442 @opindex mno-hw-mulx
18443 @opindex mhw-mulx
18444 @opindex mno-hw-div
18445 @opindex mhw-div
18446 Enable or disable emitting @code{mul}, @code{mulx} and @code{div} family of 
18447 instructions by the compiler. The default is to emit @code{mul}
18448 and not emit @code{div} and @code{mulx}.
18450 @item -mcustom-@var{insn}=@var{N}
18451 @itemx -mno-custom-@var{insn}
18452 @opindex mcustom-@var{insn}
18453 @opindex mno-custom-@var{insn}
18454 Each @option{-mcustom-@var{insn}=@var{N}} option enables use of a
18455 custom instruction with encoding @var{N} when generating code that uses 
18456 @var{insn}.  For example, @code{-mcustom-fadds=253} generates custom
18457 instruction 253 for single-precision floating-point add operations instead
18458 of the default behavior of using a library call.
18460 The following values of @var{insn} are supported.  Except as otherwise
18461 noted, floating-point operations are expected to be implemented with
18462 normal IEEE 754 semantics and correspond directly to the C operators or the
18463 equivalent GCC built-in functions (@pxref{Other Builtins}).
18465 Single-precision floating point:
18466 @table @asis
18468 @item @samp{fadds}, @samp{fsubs}, @samp{fdivs}, @samp{fmuls}
18469 Binary arithmetic operations.
18471 @item @samp{fnegs}
18472 Unary negation.
18474 @item @samp{fabss}
18475 Unary absolute value.
18477 @item @samp{fcmpeqs}, @samp{fcmpges}, @samp{fcmpgts}, @samp{fcmples}, @samp{fcmplts}, @samp{fcmpnes}
18478 Comparison operations.
18480 @item @samp{fmins}, @samp{fmaxs}
18481 Floating-point minimum and maximum.  These instructions are only
18482 generated if @option{-ffinite-math-only} is specified.
18484 @item @samp{fsqrts}
18485 Unary square root operation.
18487 @item @samp{fcoss}, @samp{fsins}, @samp{ftans}, @samp{fatans}, @samp{fexps}, @samp{flogs}
18488 Floating-point trigonometric and exponential functions.  These instructions
18489 are only generated if @option{-funsafe-math-optimizations} is also specified.
18491 @end table
18493 Double-precision floating point:
18494 @table @asis
18496 @item @samp{faddd}, @samp{fsubd}, @samp{fdivd}, @samp{fmuld}
18497 Binary arithmetic operations.
18499 @item @samp{fnegd}
18500 Unary negation.
18502 @item @samp{fabsd}
18503 Unary absolute value.
18505 @item @samp{fcmpeqd}, @samp{fcmpged}, @samp{fcmpgtd}, @samp{fcmpled}, @samp{fcmpltd}, @samp{fcmpned}
18506 Comparison operations.
18508 @item @samp{fmind}, @samp{fmaxd}
18509 Double-precision minimum and maximum.  These instructions are only
18510 generated if @option{-ffinite-math-only} is specified.
18512 @item @samp{fsqrtd}
18513 Unary square root operation.
18515 @item @samp{fcosd}, @samp{fsind}, @samp{ftand}, @samp{fatand}, @samp{fexpd}, @samp{flogd}
18516 Double-precision trigonometric and exponential functions.  These instructions
18517 are only generated if @option{-funsafe-math-optimizations} is also specified.
18519 @end table
18521 Conversions:
18522 @table @asis
18523 @item @samp{fextsd}
18524 Conversion from single precision to double precision.
18526 @item @samp{ftruncds}
18527 Conversion from double precision to single precision.
18529 @item @samp{fixsi}, @samp{fixsu}, @samp{fixdi}, @samp{fixdu}
18530 Conversion from floating point to signed or unsigned integer types, with
18531 truncation towards zero.
18533 @item @samp{round}
18534 Conversion from single-precision floating point to signed integer,
18535 rounding to the nearest integer and ties away from zero.
18536 This corresponds to the @code{__builtin_lroundf} function when
18537 @option{-fno-math-errno} is used.
18539 @item @samp{floatis}, @samp{floatus}, @samp{floatid}, @samp{floatud}
18540 Conversion from signed or unsigned integer types to floating-point types.
18542 @end table
18544 In addition, all of the following transfer instructions for internal
18545 registers X and Y must be provided to use any of the double-precision
18546 floating-point instructions.  Custom instructions taking two
18547 double-precision source operands expect the first operand in the
18548 64-bit register X.  The other operand (or only operand of a unary
18549 operation) is given to the custom arithmetic instruction with the
18550 least significant half in source register @var{src1} and the most
18551 significant half in @var{src2}.  A custom instruction that returns a
18552 double-precision result returns the most significant 32 bits in the
18553 destination register and the other half in 32-bit register Y.  
18554 GCC automatically generates the necessary code sequences to write
18555 register X and/or read register Y when double-precision floating-point
18556 instructions are used.
18558 @table @asis
18560 @item @samp{fwrx}
18561 Write @var{src1} into the least significant half of X and @var{src2} into
18562 the most significant half of X.
18564 @item @samp{fwry}
18565 Write @var{src1} into Y.
18567 @item @samp{frdxhi}, @samp{frdxlo}
18568 Read the most or least (respectively) significant half of X and store it in
18569 @var{dest}.
18571 @item @samp{frdy}
18572 Read the value of Y and store it into @var{dest}.
18573 @end table
18575 Note that you can gain more local control over generation of Nios II custom
18576 instructions by using the @code{target("custom-@var{insn}=@var{N}")}
18577 and @code{target("no-custom-@var{insn}")} function attributes
18578 (@pxref{Function Attributes})
18579 or pragmas (@pxref{Function Specific Option Pragmas}).
18581 @item -mcustom-fpu-cfg=@var{name}
18582 @opindex mcustom-fpu-cfg
18584 This option enables a predefined, named set of custom instruction encodings
18585 (see @option{-mcustom-@var{insn}} above).  
18586 Currently, the following sets are defined:
18588 @option{-mcustom-fpu-cfg=60-1} is equivalent to:
18589 @gccoptlist{-mcustom-fmuls=252 @gol
18590 -mcustom-fadds=253 @gol
18591 -mcustom-fsubs=254 @gol
18592 -fsingle-precision-constant}
18594 @option{-mcustom-fpu-cfg=60-2} is equivalent to:
18595 @gccoptlist{-mcustom-fmuls=252 @gol
18596 -mcustom-fadds=253 @gol
18597 -mcustom-fsubs=254 @gol
18598 -mcustom-fdivs=255 @gol
18599 -fsingle-precision-constant}
18601 @option{-mcustom-fpu-cfg=72-3} is equivalent to:
18602 @gccoptlist{-mcustom-floatus=243 @gol
18603 -mcustom-fixsi=244 @gol
18604 -mcustom-floatis=245 @gol
18605 -mcustom-fcmpgts=246 @gol
18606 -mcustom-fcmples=249 @gol
18607 -mcustom-fcmpeqs=250 @gol
18608 -mcustom-fcmpnes=251 @gol
18609 -mcustom-fmuls=252 @gol
18610 -mcustom-fadds=253 @gol
18611 -mcustom-fsubs=254 @gol
18612 -mcustom-fdivs=255 @gol
18613 -fsingle-precision-constant}
18615 Custom instruction assignments given by individual
18616 @option{-mcustom-@var{insn}=} options override those given by
18617 @option{-mcustom-fpu-cfg=}, regardless of the
18618 order of the options on the command line.
18620 Note that you can gain more local control over selection of a FPU
18621 configuration by using the @code{target("custom-fpu-cfg=@var{name}")}
18622 function attribute (@pxref{Function Attributes})
18623 or pragma (@pxref{Function Specific Option Pragmas}).
18625 @end table
18627 These additional @samp{-m} options are available for the Altera Nios II
18628 ELF (bare-metal) target:
18630 @table @gcctabopt
18632 @item -mhal
18633 @opindex mhal
18634 Link with HAL BSP.  This suppresses linking with the GCC-provided C runtime
18635 startup and termination code, and is typically used in conjunction with
18636 @option{-msys-crt0=} to specify the location of the alternate startup code
18637 provided by the HAL BSP.
18639 @item -msmallc
18640 @opindex msmallc
18641 Link with a limited version of the C library, @option{-lsmallc}, rather than
18642 Newlib.
18644 @item -msys-crt0=@var{startfile}
18645 @opindex msys-crt0
18646 @var{startfile} is the file name of the startfile (crt0) to use 
18647 when linking.  This option is only useful in conjunction with @option{-mhal}.
18649 @item -msys-lib=@var{systemlib}
18650 @opindex msys-lib
18651 @var{systemlib} is the library name of the library that provides
18652 low-level system calls required by the C library,
18653 e.g. @code{read} and @code{write}.
18654 This option is typically used to link with a library provided by a HAL BSP.
18656 @end table
18658 @node PDP-11 Options
18659 @subsection PDP-11 Options
18660 @cindex PDP-11 Options
18662 These options are defined for the PDP-11:
18664 @table @gcctabopt
18665 @item -mfpu
18666 @opindex mfpu
18667 Use hardware FPP floating point.  This is the default.  (FIS floating
18668 point on the PDP-11/40 is not supported.)
18670 @item -msoft-float
18671 @opindex msoft-float
18672 Do not use hardware floating point.
18674 @item -mac0
18675 @opindex mac0
18676 Return floating-point results in ac0 (fr0 in Unix assembler syntax).
18678 @item -mno-ac0
18679 @opindex mno-ac0
18680 Return floating-point results in memory.  This is the default.
18682 @item -m40
18683 @opindex m40
18684 Generate code for a PDP-11/40.
18686 @item -m45
18687 @opindex m45
18688 Generate code for a PDP-11/45.  This is the default.
18690 @item -m10
18691 @opindex m10
18692 Generate code for a PDP-11/10.
18694 @item -mbcopy-builtin
18695 @opindex mbcopy-builtin
18696 Use inline @code{movmemhi} patterns for copying memory.  This is the
18697 default.
18699 @item -mbcopy
18700 @opindex mbcopy
18701 Do not use inline @code{movmemhi} patterns for copying memory.
18703 @item -mint16
18704 @itemx -mno-int32
18705 @opindex mint16
18706 @opindex mno-int32
18707 Use 16-bit @code{int}.  This is the default.
18709 @item -mint32
18710 @itemx -mno-int16
18711 @opindex mint32
18712 @opindex mno-int16
18713 Use 32-bit @code{int}.
18715 @item -mfloat64
18716 @itemx -mno-float32
18717 @opindex mfloat64
18718 @opindex mno-float32
18719 Use 64-bit @code{float}.  This is the default.
18721 @item -mfloat32
18722 @itemx -mno-float64
18723 @opindex mfloat32
18724 @opindex mno-float64
18725 Use 32-bit @code{float}.
18727 @item -mabshi
18728 @opindex mabshi
18729 Use @code{abshi2} pattern.  This is the default.
18731 @item -mno-abshi
18732 @opindex mno-abshi
18733 Do not use @code{abshi2} pattern.
18735 @item -mbranch-expensive
18736 @opindex mbranch-expensive
18737 Pretend that branches are expensive.  This is for experimenting with
18738 code generation only.
18740 @item -mbranch-cheap
18741 @opindex mbranch-cheap
18742 Do not pretend that branches are expensive.  This is the default.
18744 @item -munix-asm
18745 @opindex munix-asm
18746 Use Unix assembler syntax.  This is the default when configured for
18747 @samp{pdp11-*-bsd}.
18749 @item -mdec-asm
18750 @opindex mdec-asm
18751 Use DEC assembler syntax.  This is the default when configured for any
18752 PDP-11 target other than @samp{pdp11-*-bsd}.
18753 @end table
18755 @node picoChip Options
18756 @subsection picoChip Options
18757 @cindex picoChip options
18759 These @samp{-m} options are defined for picoChip implementations:
18761 @table @gcctabopt
18763 @item -mae=@var{ae_type}
18764 @opindex mcpu
18765 Set the instruction set, register set, and instruction scheduling
18766 parameters for array element type @var{ae_type}.  Supported values
18767 for @var{ae_type} are @samp{ANY}, @samp{MUL}, and @samp{MAC}.
18769 @option{-mae=ANY} selects a completely generic AE type.  Code
18770 generated with this option runs on any of the other AE types.  The
18771 code is not as efficient as it would be if compiled for a specific
18772 AE type, and some types of operation (e.g., multiplication) do not
18773 work properly on all types of AE.
18775 @option{-mae=MUL} selects a MUL AE type.  This is the most useful AE type
18776 for compiled code, and is the default.
18778 @option{-mae=MAC} selects a DSP-style MAC AE.  Code compiled with this
18779 option may suffer from poor performance of byte (char) manipulation,
18780 since the DSP AE does not provide hardware support for byte load/stores.
18782 @item -msymbol-as-address
18783 Enable the compiler to directly use a symbol name as an address in a
18784 load/store instruction, without first loading it into a
18785 register.  Typically, the use of this option generates larger
18786 programs, which run faster than when the option isn't used.  However, the
18787 results vary from program to program, so it is left as a user option,
18788 rather than being permanently enabled.
18790 @item -mno-inefficient-warnings
18791 Disables warnings about the generation of inefficient code.  These
18792 warnings can be generated, for example, when compiling code that
18793 performs byte-level memory operations on the MAC AE type.  The MAC AE has
18794 no hardware support for byte-level memory operations, so all byte
18795 load/stores must be synthesized from word load/store operations.  This is
18796 inefficient and a warning is generated to indicate
18797 that you should rewrite the code to avoid byte operations, or to target
18798 an AE type that has the necessary hardware support.  This option disables
18799 these warnings.
18801 @end table
18803 @node PowerPC Options
18804 @subsection PowerPC Options
18805 @cindex PowerPC options
18807 These are listed under @xref{RS/6000 and PowerPC Options}.
18809 @node RL78 Options
18810 @subsection RL78 Options
18811 @cindex RL78 Options
18813 @table @gcctabopt
18815 @item -msim
18816 @opindex msim
18817 Links in additional target libraries to support operation within a
18818 simulator.
18820 @item -mmul=none
18821 @itemx -mmul=g13
18822 @itemx -mmul=rl78
18823 @opindex mmul
18824 Specifies the type of hardware multiplication support to be used.  The
18825 default is @code{none}, which uses software multiplication functions.
18826 The @code{g13} option is for the hardware multiply/divide peripheral
18827 only on the RL78/G13 targets.  The @code{rl78} option is for the
18828 standard hardware multiplication defined in the RL78 software manual.
18830 @end table
18832 @node RS/6000 and PowerPC Options
18833 @subsection IBM RS/6000 and PowerPC Options
18834 @cindex RS/6000 and PowerPC Options
18835 @cindex IBM RS/6000 and PowerPC Options
18837 These @samp{-m} options are defined for the IBM RS/6000 and PowerPC:
18838 @table @gcctabopt
18839 @item -mpowerpc-gpopt
18840 @itemx -mno-powerpc-gpopt
18841 @itemx -mpowerpc-gfxopt
18842 @itemx -mno-powerpc-gfxopt
18843 @need 800
18844 @itemx -mpowerpc64
18845 @itemx -mno-powerpc64
18846 @itemx -mmfcrf
18847 @itemx -mno-mfcrf
18848 @itemx -mpopcntb
18849 @itemx -mno-popcntb
18850 @itemx -mpopcntd
18851 @itemx -mno-popcntd
18852 @itemx -mfprnd
18853 @itemx -mno-fprnd
18854 @need 800
18855 @itemx -mcmpb
18856 @itemx -mno-cmpb
18857 @itemx -mmfpgpr
18858 @itemx -mno-mfpgpr
18859 @itemx -mhard-dfp
18860 @itemx -mno-hard-dfp
18861 @opindex mpowerpc-gpopt
18862 @opindex mno-powerpc-gpopt
18863 @opindex mpowerpc-gfxopt
18864 @opindex mno-powerpc-gfxopt
18865 @opindex mpowerpc64
18866 @opindex mno-powerpc64
18867 @opindex mmfcrf
18868 @opindex mno-mfcrf
18869 @opindex mpopcntb
18870 @opindex mno-popcntb
18871 @opindex mpopcntd
18872 @opindex mno-popcntd
18873 @opindex mfprnd
18874 @opindex mno-fprnd
18875 @opindex mcmpb
18876 @opindex mno-cmpb
18877 @opindex mmfpgpr
18878 @opindex mno-mfpgpr
18879 @opindex mhard-dfp
18880 @opindex mno-hard-dfp
18881 You use these options to specify which instructions are available on the
18882 processor you are using.  The default value of these options is
18883 determined when configuring GCC@.  Specifying the
18884 @option{-mcpu=@var{cpu_type}} overrides the specification of these
18885 options.  We recommend you use the @option{-mcpu=@var{cpu_type}} option
18886 rather than the options listed above.
18888 Specifying @option{-mpowerpc-gpopt} allows
18889 GCC to use the optional PowerPC architecture instructions in the
18890 General Purpose group, including floating-point square root.  Specifying
18891 @option{-mpowerpc-gfxopt} allows GCC to
18892 use the optional PowerPC architecture instructions in the Graphics
18893 group, including floating-point select.
18895 The @option{-mmfcrf} option allows GCC to generate the move from
18896 condition register field instruction implemented on the POWER4
18897 processor and other processors that support the PowerPC V2.01
18898 architecture.
18899 The @option{-mpopcntb} option allows GCC to generate the popcount and
18900 double-precision FP reciprocal estimate instruction implemented on the
18901 POWER5 processor and other processors that support the PowerPC V2.02
18902 architecture.
18903 The @option{-mpopcntd} option allows GCC to generate the popcount
18904 instruction implemented on the POWER7 processor and other processors
18905 that support the PowerPC V2.06 architecture.
18906 The @option{-mfprnd} option allows GCC to generate the FP round to
18907 integer instructions implemented on the POWER5+ processor and other
18908 processors that support the PowerPC V2.03 architecture.
18909 The @option{-mcmpb} option allows GCC to generate the compare bytes
18910 instruction implemented on the POWER6 processor and other processors
18911 that support the PowerPC V2.05 architecture.
18912 The @option{-mmfpgpr} option allows GCC to generate the FP move to/from
18913 general-purpose register instructions implemented on the POWER6X
18914 processor and other processors that support the extended PowerPC V2.05
18915 architecture.
18916 The @option{-mhard-dfp} option allows GCC to generate the decimal
18917 floating-point instructions implemented on some POWER processors.
18919 The @option{-mpowerpc64} option allows GCC to generate the additional
18920 64-bit instructions that are found in the full PowerPC64 architecture
18921 and to treat GPRs as 64-bit, doubleword quantities.  GCC defaults to
18922 @option{-mno-powerpc64}.
18924 @item -mcpu=@var{cpu_type}
18925 @opindex mcpu
18926 Set architecture type, register usage, and
18927 instruction scheduling parameters for machine type @var{cpu_type}.
18928 Supported values for @var{cpu_type} are @samp{401}, @samp{403},
18929 @samp{405}, @samp{405fp}, @samp{440}, @samp{440fp}, @samp{464}, @samp{464fp},
18930 @samp{476}, @samp{476fp}, @samp{505}, @samp{601}, @samp{602}, @samp{603},
18931 @samp{603e}, @samp{604}, @samp{604e}, @samp{620}, @samp{630}, @samp{740},
18932 @samp{7400}, @samp{7450}, @samp{750}, @samp{801}, @samp{821}, @samp{823},
18933 @samp{860}, @samp{970}, @samp{8540}, @samp{a2}, @samp{e300c2},
18934 @samp{e300c3}, @samp{e500mc}, @samp{e500mc64}, @samp{e5500},
18935 @samp{e6500}, @samp{ec603e}, @samp{G3}, @samp{G4}, @samp{G5},
18936 @samp{titan}, @samp{power3}, @samp{power4}, @samp{power5}, @samp{power5+},
18937 @samp{power6}, @samp{power6x}, @samp{power7}, @samp{power8}, @samp{powerpc},
18938 @samp{powerpc64}, and @samp{rs64}.
18940 @option{-mcpu=powerpc}, and @option{-mcpu=powerpc64} specify pure 32-bit
18941 PowerPC and 64-bit PowerPC architecture machine
18942 types, with an appropriate, generic processor model assumed for
18943 scheduling purposes.
18945 The other options specify a specific processor.  Code generated under
18946 those options runs best on that processor, and may not run at all on
18947 others.
18949 The @option{-mcpu} options automatically enable or disable the
18950 following options:
18952 @gccoptlist{-maltivec  -mfprnd  -mhard-float  -mmfcrf  -mmultiple @gol
18953 -mpopcntb -mpopcntd  -mpowerpc64 @gol
18954 -mpowerpc-gpopt  -mpowerpc-gfxopt  -msingle-float -mdouble-float @gol
18955 -msimple-fpu -mstring  -mmulhw  -mdlmzb  -mmfpgpr -mvsx @gol
18956 -mcrypto -mdirect-move -mpower8-fusion -mpower8-vector @gol
18957 -mquad-memory -mquad-memory-atomic}
18959 The particular options set for any particular CPU varies between
18960 compiler versions, depending on what setting seems to produce optimal
18961 code for that CPU; it doesn't necessarily reflect the actual hardware's
18962 capabilities.  If you wish to set an individual option to a particular
18963 value, you may specify it after the @option{-mcpu} option, like
18964 @option{-mcpu=970 -mno-altivec}.
18966 On AIX, the @option{-maltivec} and @option{-mpowerpc64} options are
18967 not enabled or disabled by the @option{-mcpu} option at present because
18968 AIX does not have full support for these options.  You may still
18969 enable or disable them individually if you're sure it'll work in your
18970 environment.
18972 @item -mtune=@var{cpu_type}
18973 @opindex mtune
18974 Set the instruction scheduling parameters for machine type
18975 @var{cpu_type}, but do not set the architecture type or register usage,
18976 as @option{-mcpu=@var{cpu_type}} does.  The same
18977 values for @var{cpu_type} are used for @option{-mtune} as for
18978 @option{-mcpu}.  If both are specified, the code generated uses the
18979 architecture and registers set by @option{-mcpu}, but the
18980 scheduling parameters set by @option{-mtune}.
18982 @item -mcmodel=small
18983 @opindex mcmodel=small
18984 Generate PowerPC64 code for the small model: The TOC is limited to
18985 64k.
18987 @item -mcmodel=medium
18988 @opindex mcmodel=medium
18989 Generate PowerPC64 code for the medium model: The TOC and other static
18990 data may be up to a total of 4G in size.
18992 @item -mcmodel=large
18993 @opindex mcmodel=large
18994 Generate PowerPC64 code for the large model: The TOC may be up to 4G
18995 in size.  Other data and code is only limited by the 64-bit address
18996 space.
18998 @item -maltivec
18999 @itemx -mno-altivec
19000 @opindex maltivec
19001 @opindex mno-altivec
19002 Generate code that uses (does not use) AltiVec instructions, and also
19003 enable the use of built-in functions that allow more direct access to
19004 the AltiVec instruction set.  You may also need to set
19005 @option{-mabi=altivec} to adjust the current ABI with AltiVec ABI
19006 enhancements.
19008 When @option{-maltivec} is used, rather than @option{-maltivec=le} or
19009 @option{-maltivec=be}, the element order for Altivec intrinsics such
19010 as @code{vec_splat}, @code{vec_extract}, and @code{vec_insert} will
19011 match array element order corresponding to the endianness of the
19012 target.  That is, element zero identifies the leftmost element in a
19013 vector register when targeting a big-endian platform, and identifies
19014 the rightmost element in a vector register when targeting a
19015 little-endian platform.
19017 @item -maltivec=be
19018 @opindex maltivec=be
19019 Generate Altivec instructions using big-endian element order,
19020 regardless of whether the target is big- or little-endian.  This is
19021 the default when targeting a big-endian platform.
19023 The element order is used to interpret element numbers in Altivec
19024 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19025 @code{vec_insert}.  By default, these will match array element order
19026 corresponding to the endianness for the target.
19028 @item -maltivec=le
19029 @opindex maltivec=le
19030 Generate Altivec instructions using little-endian element order,
19031 regardless of whether the target is big- or little-endian.  This is
19032 the default when targeting a little-endian platform.  This option is
19033 currently ignored when targeting a big-endian platform.
19035 The element order is used to interpret element numbers in Altivec
19036 intrinsics such as @code{vec_splat}, @code{vec_extract}, and
19037 @code{vec_insert}.  By default, these will match array element order
19038 corresponding to the endianness for the target.
19040 @item -mvrsave
19041 @itemx -mno-vrsave
19042 @opindex mvrsave
19043 @opindex mno-vrsave
19044 Generate VRSAVE instructions when generating AltiVec code.
19046 @item -mgen-cell-microcode
19047 @opindex mgen-cell-microcode
19048 Generate Cell microcode instructions.
19050 @item -mwarn-cell-microcode
19051 @opindex mwarn-cell-microcode
19052 Warn when a Cell microcode instruction is emitted.  An example
19053 of a Cell microcode instruction is a variable shift.
19055 @item -msecure-plt
19056 @opindex msecure-plt
19057 Generate code that allows @command{ld} and @command{ld.so}
19058 to build executables and shared
19059 libraries with non-executable @code{.plt} and @code{.got} sections.
19060 This is a PowerPC
19061 32-bit SYSV ABI option.
19063 @item -mbss-plt
19064 @opindex mbss-plt
19065 Generate code that uses a BSS @code{.plt} section that @command{ld.so}
19066 fills in, and
19067 requires @code{.plt} and @code{.got}
19068 sections that are both writable and executable.
19069 This is a PowerPC 32-bit SYSV ABI option.
19071 @item -misel
19072 @itemx -mno-isel
19073 @opindex misel
19074 @opindex mno-isel
19075 This switch enables or disables the generation of ISEL instructions.
19077 @item -misel=@var{yes/no}
19078 This switch has been deprecated.  Use @option{-misel} and
19079 @option{-mno-isel} instead.
19081 @item -mspe
19082 @itemx -mno-spe
19083 @opindex mspe
19084 @opindex mno-spe
19085 This switch enables or disables the generation of SPE simd
19086 instructions.
19088 @item -mpaired
19089 @itemx -mno-paired
19090 @opindex mpaired
19091 @opindex mno-paired
19092 This switch enables or disables the generation of PAIRED simd
19093 instructions.
19095 @item -mspe=@var{yes/no}
19096 This option has been deprecated.  Use @option{-mspe} and
19097 @option{-mno-spe} instead.
19099 @item -mvsx
19100 @itemx -mno-vsx
19101 @opindex mvsx
19102 @opindex mno-vsx
19103 Generate code that uses (does not use) vector/scalar (VSX)
19104 instructions, and also enable the use of built-in functions that allow
19105 more direct access to the VSX instruction set.
19107 @item -mcrypto
19108 @itemx -mno-crypto
19109 @opindex mcrypto
19110 @opindex mno-crypto
19111 Enable the use (disable) of the built-in functions that allow direct
19112 access to the cryptographic instructions that were added in version
19113 2.07 of the PowerPC ISA.
19115 @item -mdirect-move
19116 @itemx -mno-direct-move
19117 @opindex mdirect-move
19118 @opindex mno-direct-move
19119 Generate code that uses (does not use) the instructions to move data
19120 between the general purpose registers and the vector/scalar (VSX)
19121 registers that were added in version 2.07 of the PowerPC ISA.
19123 @item -mpower8-fusion
19124 @itemx -mno-power8-fusion
19125 @opindex mpower8-fusion
19126 @opindex mno-power8-fusion
19127 Generate code that keeps (does not keeps) some integer operations
19128 adjacent so that the instructions can be fused together on power8 and
19129 later processors.
19131 @item -mpower8-vector
19132 @itemx -mno-power8-vector
19133 @opindex mpower8-vector
19134 @opindex mno-power8-vector
19135 Generate code that uses (does not use) the vector and scalar
19136 instructions that were added in version 2.07 of the PowerPC ISA.  Also
19137 enable the use of built-in functions that allow more direct access to
19138 the vector instructions.
19140 @item -mquad-memory
19141 @itemx -mno-quad-memory
19142 @opindex mquad-memory
19143 @opindex mno-quad-memory
19144 Generate code that uses (does not use) the non-atomic quad word memory
19145 instructions.  The @option{-mquad-memory} option requires use of
19146 64-bit mode.
19148 @item -mquad-memory-atomic
19149 @itemx -mno-quad-memory-atomic
19150 @opindex mquad-memory-atomic
19151 @opindex mno-quad-memory-atomic
19152 Generate code that uses (does not use) the atomic quad word memory
19153 instructions.  The @option{-mquad-memory-atomic} option requires use of
19154 64-bit mode.
19156 @item -mfloat-gprs=@var{yes/single/double/no}
19157 @itemx -mfloat-gprs
19158 @opindex mfloat-gprs
19159 This switch enables or disables the generation of floating-point
19160 operations on the general-purpose registers for architectures that
19161 support it.
19163 The argument @var{yes} or @var{single} enables the use of
19164 single-precision floating-point operations.
19166 The argument @var{double} enables the use of single and
19167 double-precision floating-point operations.
19169 The argument @var{no} disables floating-point operations on the
19170 general-purpose registers.
19172 This option is currently only available on the MPC854x.
19174 @item -m32
19175 @itemx -m64
19176 @opindex m32
19177 @opindex m64
19178 Generate code for 32-bit or 64-bit environments of Darwin and SVR4
19179 targets (including GNU/Linux).  The 32-bit environment sets int, long
19180 and pointer to 32 bits and generates code that runs on any PowerPC
19181 variant.  The 64-bit environment sets int to 32 bits and long and
19182 pointer to 64 bits, and generates code for PowerPC64, as for
19183 @option{-mpowerpc64}.
19185 @item -mfull-toc
19186 @itemx -mno-fp-in-toc
19187 @itemx -mno-sum-in-toc
19188 @itemx -mminimal-toc
19189 @opindex mfull-toc
19190 @opindex mno-fp-in-toc
19191 @opindex mno-sum-in-toc
19192 @opindex mminimal-toc
19193 Modify generation of the TOC (Table Of Contents), which is created for
19194 every executable file.  The @option{-mfull-toc} option is selected by
19195 default.  In that case, GCC allocates at least one TOC entry for
19196 each unique non-automatic variable reference in your program.  GCC
19197 also places floating-point constants in the TOC@.  However, only
19198 16,384 entries are available in the TOC@.
19200 If you receive a linker error message that saying you have overflowed
19201 the available TOC space, you can reduce the amount of TOC space used
19202 with the @option{-mno-fp-in-toc} and @option{-mno-sum-in-toc} options.
19203 @option{-mno-fp-in-toc} prevents GCC from putting floating-point
19204 constants in the TOC and @option{-mno-sum-in-toc} forces GCC to
19205 generate code to calculate the sum of an address and a constant at
19206 run time instead of putting that sum into the TOC@.  You may specify one
19207 or both of these options.  Each causes GCC to produce very slightly
19208 slower and larger code at the expense of conserving TOC space.
19210 If you still run out of space in the TOC even when you specify both of
19211 these options, specify @option{-mminimal-toc} instead.  This option causes
19212 GCC to make only one TOC entry for every file.  When you specify this
19213 option, GCC produces code that is slower and larger but which
19214 uses extremely little TOC space.  You may wish to use this option
19215 only on files that contain less frequently-executed code.
19217 @item -maix64
19218 @itemx -maix32
19219 @opindex maix64
19220 @opindex maix32
19221 Enable 64-bit AIX ABI and calling convention: 64-bit pointers, 64-bit
19222 @code{long} type, and the infrastructure needed to support them.
19223 Specifying @option{-maix64} implies @option{-mpowerpc64},
19224 while @option{-maix32} disables the 64-bit ABI and
19225 implies @option{-mno-powerpc64}.  GCC defaults to @option{-maix32}.
19227 @item -mxl-compat
19228 @itemx -mno-xl-compat
19229 @opindex mxl-compat
19230 @opindex mno-xl-compat
19231 Produce code that conforms more closely to IBM XL compiler semantics
19232 when using AIX-compatible ABI@.  Pass floating-point arguments to
19233 prototyped functions beyond the register save area (RSA) on the stack
19234 in addition to argument FPRs.  Do not assume that most significant
19235 double in 128-bit long double value is properly rounded when comparing
19236 values and converting to double.  Use XL symbol names for long double
19237 support routines.
19239 The AIX calling convention was extended but not initially documented to
19240 handle an obscure K&R C case of calling a function that takes the
19241 address of its arguments with fewer arguments than declared.  IBM XL
19242 compilers access floating-point arguments that do not fit in the
19243 RSA from the stack when a subroutine is compiled without
19244 optimization.  Because always storing floating-point arguments on the
19245 stack is inefficient and rarely needed, this option is not enabled by
19246 default and only is necessary when calling subroutines compiled by IBM
19247 XL compilers without optimization.
19249 @item -mpe
19250 @opindex mpe
19251 Support @dfn{IBM RS/6000 SP} @dfn{Parallel Environment} (PE)@.  Link an
19252 application written to use message passing with special startup code to
19253 enable the application to run.  The system must have PE installed in the
19254 standard location (@file{/usr/lpp/ppe.poe/}), or the @file{specs} file
19255 must be overridden with the @option{-specs=} option to specify the
19256 appropriate directory location.  The Parallel Environment does not
19257 support threads, so the @option{-mpe} option and the @option{-pthread}
19258 option are incompatible.
19260 @item -malign-natural
19261 @itemx -malign-power
19262 @opindex malign-natural
19263 @opindex malign-power
19264 On AIX, 32-bit Darwin, and 64-bit PowerPC GNU/Linux, the option
19265 @option{-malign-natural} overrides the ABI-defined alignment of larger
19266 types, such as floating-point doubles, on their natural size-based boundary.
19267 The option @option{-malign-power} instructs GCC to follow the ABI-specified
19268 alignment rules.  GCC defaults to the standard alignment defined in the ABI@.
19270 On 64-bit Darwin, natural alignment is the default, and @option{-malign-power}
19271 is not supported.
19273 @item -msoft-float
19274 @itemx -mhard-float
19275 @opindex msoft-float
19276 @opindex mhard-float
19277 Generate code that does not use (uses) the floating-point register set.
19278 Software floating-point emulation is provided if you use the
19279 @option{-msoft-float} option, and pass the option to GCC when linking.
19281 @item -msingle-float
19282 @itemx -mdouble-float
19283 @opindex msingle-float
19284 @opindex mdouble-float
19285 Generate code for single- or double-precision floating-point operations.
19286 @option{-mdouble-float} implies @option{-msingle-float}.
19288 @item -msimple-fpu
19289 @opindex msimple-fpu
19290 Do not generate @code{sqrt} and @code{div} instructions for hardware
19291 floating-point unit.
19293 @item -mfpu=@var{name}
19294 @opindex mfpu
19295 Specify type of floating-point unit.  Valid values for @var{name} are
19296 @samp{sp_lite} (equivalent to @option{-msingle-float -msimple-fpu}),
19297 @samp{dp_lite} (equivalent to @option{-mdouble-float -msimple-fpu}),
19298 @samp{sp_full} (equivalent to @option{-msingle-float}),
19299 and @samp{dp_full} (equivalent to @option{-mdouble-float}).
19301 @item -mxilinx-fpu
19302 @opindex mxilinx-fpu
19303 Perform optimizations for the floating-point unit on Xilinx PPC 405/440.
19305 @item -mmultiple
19306 @itemx -mno-multiple
19307 @opindex mmultiple
19308 @opindex mno-multiple
19309 Generate code that uses (does not use) the load multiple word
19310 instructions and the store multiple word instructions.  These
19311 instructions are generated by default on POWER systems, and not
19312 generated on PowerPC systems.  Do not use @option{-mmultiple} on little-endian
19313 PowerPC systems, since those instructions do not work when the
19314 processor is in little-endian mode.  The exceptions are PPC740 and
19315 PPC750 which permit these instructions in little-endian mode.
19317 @item -mstring
19318 @itemx -mno-string
19319 @opindex mstring
19320 @opindex mno-string
19321 Generate code that uses (does not use) the load string instructions
19322 and the store string word instructions to save multiple registers and
19323 do small block moves.  These instructions are generated by default on
19324 POWER systems, and not generated on PowerPC systems.  Do not use
19325 @option{-mstring} on little-endian PowerPC systems, since those
19326 instructions do not work when the processor is in little-endian mode.
19327 The exceptions are PPC740 and PPC750 which permit these instructions
19328 in little-endian mode.
19330 @item -mupdate
19331 @itemx -mno-update
19332 @opindex mupdate
19333 @opindex mno-update
19334 Generate code that uses (does not use) the load or store instructions
19335 that update the base register to the address of the calculated memory
19336 location.  These instructions are generated by default.  If you use
19337 @option{-mno-update}, there is a small window between the time that the
19338 stack pointer is updated and the address of the previous frame is
19339 stored, which means code that walks the stack frame across interrupts or
19340 signals may get corrupted data.
19342 @item -mavoid-indexed-addresses
19343 @itemx -mno-avoid-indexed-addresses
19344 @opindex mavoid-indexed-addresses
19345 @opindex mno-avoid-indexed-addresses
19346 Generate code that tries to avoid (not avoid) the use of indexed load
19347 or store instructions. These instructions can incur a performance
19348 penalty on Power6 processors in certain situations, such as when
19349 stepping through large arrays that cross a 16M boundary.  This option
19350 is enabled by default when targeting Power6 and disabled otherwise.
19352 @item -mfused-madd
19353 @itemx -mno-fused-madd
19354 @opindex mfused-madd
19355 @opindex mno-fused-madd
19356 Generate code that uses (does not use) the floating-point multiply and
19357 accumulate instructions.  These instructions are generated by default
19358 if hardware floating point is used.  The machine-dependent
19359 @option{-mfused-madd} option is now mapped to the machine-independent
19360 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
19361 mapped to @option{-ffp-contract=off}.
19363 @item -mmulhw
19364 @itemx -mno-mulhw
19365 @opindex mmulhw
19366 @opindex mno-mulhw
19367 Generate code that uses (does not use) the half-word multiply and
19368 multiply-accumulate instructions on the IBM 405, 440, 464 and 476 processors.
19369 These instructions are generated by default when targeting those
19370 processors.
19372 @item -mdlmzb
19373 @itemx -mno-dlmzb
19374 @opindex mdlmzb
19375 @opindex mno-dlmzb
19376 Generate code that uses (does not use) the string-search @samp{dlmzb}
19377 instruction on the IBM 405, 440, 464 and 476 processors.  This instruction is
19378 generated by default when targeting those processors.
19380 @item -mno-bit-align
19381 @itemx -mbit-align
19382 @opindex mno-bit-align
19383 @opindex mbit-align
19384 On System V.4 and embedded PowerPC systems do not (do) force structures
19385 and unions that contain bit-fields to be aligned to the base type of the
19386 bit-field.
19388 For example, by default a structure containing nothing but 8
19389 @code{unsigned} bit-fields of length 1 is aligned to a 4-byte
19390 boundary and has a size of 4 bytes.  By using @option{-mno-bit-align},
19391 the structure is aligned to a 1-byte boundary and is 1 byte in
19392 size.
19394 @item -mno-strict-align
19395 @itemx -mstrict-align
19396 @opindex mno-strict-align
19397 @opindex mstrict-align
19398 On System V.4 and embedded PowerPC systems do not (do) assume that
19399 unaligned memory references are handled by the system.
19401 @item -mrelocatable
19402 @itemx -mno-relocatable
19403 @opindex mrelocatable
19404 @opindex mno-relocatable
19405 Generate code that allows (does not allow) a static executable to be
19406 relocated to a different address at run time.  A simple embedded
19407 PowerPC system loader should relocate the entire contents of
19408 @code{.got2} and 4-byte locations listed in the @code{.fixup} section,
19409 a table of 32-bit addresses generated by this option.  For this to
19410 work, all objects linked together must be compiled with
19411 @option{-mrelocatable} or @option{-mrelocatable-lib}.
19412 @option{-mrelocatable} code aligns the stack to an 8-byte boundary.
19414 @item -mrelocatable-lib
19415 @itemx -mno-relocatable-lib
19416 @opindex mrelocatable-lib
19417 @opindex mno-relocatable-lib
19418 Like @option{-mrelocatable}, @option{-mrelocatable-lib} generates a
19419 @code{.fixup} section to allow static executables to be relocated at
19420 run time, but @option{-mrelocatable-lib} does not use the smaller stack
19421 alignment of @option{-mrelocatable}.  Objects compiled with
19422 @option{-mrelocatable-lib} may be linked with objects compiled with
19423 any combination of the @option{-mrelocatable} options.
19425 @item -mno-toc
19426 @itemx -mtoc
19427 @opindex mno-toc
19428 @opindex mtoc
19429 On System V.4 and embedded PowerPC systems do not (do) assume that
19430 register 2 contains a pointer to a global area pointing to the addresses
19431 used in the program.
19433 @item -mlittle
19434 @itemx -mlittle-endian
19435 @opindex mlittle
19436 @opindex mlittle-endian
19437 On System V.4 and embedded PowerPC systems compile code for the
19438 processor in little-endian mode.  The @option{-mlittle-endian} option is
19439 the same as @option{-mlittle}.
19441 @item -mbig
19442 @itemx -mbig-endian
19443 @opindex mbig
19444 @opindex mbig-endian
19445 On System V.4 and embedded PowerPC systems compile code for the
19446 processor in big-endian mode.  The @option{-mbig-endian} option is
19447 the same as @option{-mbig}.
19449 @item -mdynamic-no-pic
19450 @opindex mdynamic-no-pic
19451 On Darwin and Mac OS X systems, compile code so that it is not
19452 relocatable, but that its external references are relocatable.  The
19453 resulting code is suitable for applications, but not shared
19454 libraries.
19456 @item -msingle-pic-base
19457 @opindex msingle-pic-base
19458 Treat the register used for PIC addressing as read-only, rather than
19459 loading it in the prologue for each function.  The runtime system is
19460 responsible for initializing this register with an appropriate value
19461 before execution begins.
19463 @item -mprioritize-restricted-insns=@var{priority}
19464 @opindex mprioritize-restricted-insns
19465 This option controls the priority that is assigned to
19466 dispatch-slot restricted instructions during the second scheduling
19467 pass.  The argument @var{priority} takes the value @samp{0}, @samp{1},
19468 or @samp{2} to assign no, highest, or second-highest (respectively) 
19469 priority to dispatch-slot restricted
19470 instructions.
19472 @item -msched-costly-dep=@var{dependence_type}
19473 @opindex msched-costly-dep
19474 This option controls which dependences are considered costly
19475 by the target during instruction scheduling.  The argument
19476 @var{dependence_type} takes one of the following values:
19478 @table @asis
19479 @item @samp{no}
19480 No dependence is costly.
19482 @item @samp{all}
19483 All dependences are costly.
19485 @item @samp{true_store_to_load}
19486 A true dependence from store to load is costly.
19488 @item @samp{store_to_load}
19489 Any dependence from store to load is costly.
19491 @item @var{number}
19492 Any dependence for which the latency is greater than or equal to 
19493 @var{number} is costly.
19494 @end table
19496 @item -minsert-sched-nops=@var{scheme}
19497 @opindex minsert-sched-nops
19498 This option controls which NOP insertion scheme is used during
19499 the second scheduling pass.  The argument @var{scheme} takes one of the
19500 following values:
19502 @table @asis
19503 @item @samp{no}
19504 Don't insert NOPs.
19506 @item @samp{pad}
19507 Pad with NOPs any dispatch group that has vacant issue slots,
19508 according to the scheduler's grouping.
19510 @item @samp{regroup_exact}
19511 Insert NOPs to force costly dependent insns into
19512 separate groups.  Insert exactly as many NOPs as needed to force an insn
19513 to a new group, according to the estimated processor grouping.
19515 @item @var{number}
19516 Insert NOPs to force costly dependent insns into
19517 separate groups.  Insert @var{number} NOPs to force an insn to a new group.
19518 @end table
19520 @item -mcall-sysv
19521 @opindex mcall-sysv
19522 On System V.4 and embedded PowerPC systems compile code using calling
19523 conventions that adhere to the March 1995 draft of the System V
19524 Application Binary Interface, PowerPC processor supplement.  This is the
19525 default unless you configured GCC using @samp{powerpc-*-eabiaix}.
19527 @item -mcall-sysv-eabi
19528 @itemx -mcall-eabi
19529 @opindex mcall-sysv-eabi
19530 @opindex mcall-eabi
19531 Specify both @option{-mcall-sysv} and @option{-meabi} options.
19533 @item -mcall-sysv-noeabi
19534 @opindex mcall-sysv-noeabi
19535 Specify both @option{-mcall-sysv} and @option{-mno-eabi} options.
19537 @item -mcall-aixdesc
19538 @opindex m
19539 On System V.4 and embedded PowerPC systems compile code for the AIX
19540 operating system.
19542 @item -mcall-linux
19543 @opindex mcall-linux
19544 On System V.4 and embedded PowerPC systems compile code for the
19545 Linux-based GNU system.
19547 @item -mcall-freebsd
19548 @opindex mcall-freebsd
19549 On System V.4 and embedded PowerPC systems compile code for the
19550 FreeBSD operating system.
19552 @item -mcall-netbsd
19553 @opindex mcall-netbsd
19554 On System V.4 and embedded PowerPC systems compile code for the
19555 NetBSD operating system.
19557 @item -mcall-openbsd
19558 @opindex mcall-netbsd
19559 On System V.4 and embedded PowerPC systems compile code for the
19560 OpenBSD operating system.
19562 @item -maix-struct-return
19563 @opindex maix-struct-return
19564 Return all structures in memory (as specified by the AIX ABI)@.
19566 @item -msvr4-struct-return
19567 @opindex msvr4-struct-return
19568 Return structures smaller than 8 bytes in registers (as specified by the
19569 SVR4 ABI)@.
19571 @item -mabi=@var{abi-type}
19572 @opindex mabi
19573 Extend the current ABI with a particular extension, or remove such extension.
19574 Valid values are @var{altivec}, @var{no-altivec}, @var{spe},
19575 @var{no-spe}, @var{ibmlongdouble}, @var{ieeelongdouble},
19576 @var{elfv1}, @var{elfv2}@.
19578 @item -mabi=spe
19579 @opindex mabi=spe
19580 Extend the current ABI with SPE ABI extensions.  This does not change
19581 the default ABI, instead it adds the SPE ABI extensions to the current
19582 ABI@.
19584 @item -mabi=no-spe
19585 @opindex mabi=no-spe
19586 Disable Book-E SPE ABI extensions for the current ABI@.
19588 @item -mabi=ibmlongdouble
19589 @opindex mabi=ibmlongdouble
19590 Change the current ABI to use IBM extended-precision long double.
19591 This is a PowerPC 32-bit SYSV ABI option.
19593 @item -mabi=ieeelongdouble
19594 @opindex mabi=ieeelongdouble
19595 Change the current ABI to use IEEE extended-precision long double.
19596 This is a PowerPC 32-bit Linux ABI option.
19598 @item -mabi=elfv1
19599 @opindex mabi=elfv1
19600 Change the current ABI to use the ELFv1 ABI.
19601 This is the default ABI for big-endian PowerPC 64-bit Linux.
19602 Overriding the default ABI requires special system support and is
19603 likely to fail in spectacular ways.
19605 @item -mabi=elfv2
19606 @opindex mabi=elfv2
19607 Change the current ABI to use the ELFv2 ABI.
19608 This is the default ABI for little-endian PowerPC 64-bit Linux.
19609 Overriding the default ABI requires special system support and is
19610 likely to fail in spectacular ways.
19612 @item -mprototype
19613 @itemx -mno-prototype
19614 @opindex mprototype
19615 @opindex mno-prototype
19616 On System V.4 and embedded PowerPC systems assume that all calls to
19617 variable argument functions are properly prototyped.  Otherwise, the
19618 compiler must insert an instruction before every non-prototyped call to
19619 set or clear bit 6 of the condition code register (@var{CR}) to
19620 indicate whether floating-point values are passed in the floating-point
19621 registers in case the function takes variable arguments.  With
19622 @option{-mprototype}, only calls to prototyped variable argument functions
19623 set or clear the bit.
19625 @item -msim
19626 @opindex msim
19627 On embedded PowerPC systems, assume that the startup module is called
19628 @file{sim-crt0.o} and that the standard C libraries are @file{libsim.a} and
19629 @file{libc.a}.  This is the default for @samp{powerpc-*-eabisim}
19630 configurations.
19632 @item -mmvme
19633 @opindex mmvme
19634 On embedded PowerPC systems, assume that the startup module is called
19635 @file{crt0.o} and the standard C libraries are @file{libmvme.a} and
19636 @file{libc.a}.
19638 @item -mads
19639 @opindex mads
19640 On embedded PowerPC systems, assume that the startup module is called
19641 @file{crt0.o} and the standard C libraries are @file{libads.a} and
19642 @file{libc.a}.
19644 @item -myellowknife
19645 @opindex myellowknife
19646 On embedded PowerPC systems, assume that the startup module is called
19647 @file{crt0.o} and the standard C libraries are @file{libyk.a} and
19648 @file{libc.a}.
19650 @item -mvxworks
19651 @opindex mvxworks
19652 On System V.4 and embedded PowerPC systems, specify that you are
19653 compiling for a VxWorks system.
19655 @item -memb
19656 @opindex memb
19657 On embedded PowerPC systems, set the @var{PPC_EMB} bit in the ELF flags
19658 header to indicate that @samp{eabi} extended relocations are used.
19660 @item -meabi
19661 @itemx -mno-eabi
19662 @opindex meabi
19663 @opindex mno-eabi
19664 On System V.4 and embedded PowerPC systems do (do not) adhere to the
19665 Embedded Applications Binary Interface (EABI), which is a set of
19666 modifications to the System V.4 specifications.  Selecting @option{-meabi}
19667 means that the stack is aligned to an 8-byte boundary, a function
19668 @code{__eabi} is called from @code{main} to set up the EABI
19669 environment, and the @option{-msdata} option can use both @code{r2} and
19670 @code{r13} to point to two separate small data areas.  Selecting
19671 @option{-mno-eabi} means that the stack is aligned to a 16-byte boundary,
19672 no EABI initialization function is called from @code{main}, and the
19673 @option{-msdata} option only uses @code{r13} to point to a single
19674 small data area.  The @option{-meabi} option is on by default if you
19675 configured GCC using one of the @samp{powerpc*-*-eabi*} options.
19677 @item -msdata=eabi
19678 @opindex msdata=eabi
19679 On System V.4 and embedded PowerPC systems, put small initialized
19680 @code{const} global and static data in the @samp{.sdata2} section, which
19681 is pointed to by register @code{r2}.  Put small initialized
19682 non-@code{const} global and static data in the @samp{.sdata} section,
19683 which is pointed to by register @code{r13}.  Put small uninitialized
19684 global and static data in the @samp{.sbss} section, which is adjacent to
19685 the @samp{.sdata} section.  The @option{-msdata=eabi} option is
19686 incompatible with the @option{-mrelocatable} option.  The
19687 @option{-msdata=eabi} option also sets the @option{-memb} option.
19689 @item -msdata=sysv
19690 @opindex msdata=sysv
19691 On System V.4 and embedded PowerPC systems, put small global and static
19692 data in the @samp{.sdata} section, which is pointed to by register
19693 @code{r13}.  Put small uninitialized global and static data in the
19694 @samp{.sbss} section, which is adjacent to the @samp{.sdata} section.
19695 The @option{-msdata=sysv} option is incompatible with the
19696 @option{-mrelocatable} option.
19698 @item -msdata=default
19699 @itemx -msdata
19700 @opindex msdata=default
19701 @opindex msdata
19702 On System V.4 and embedded PowerPC systems, if @option{-meabi} is used,
19703 compile code the same as @option{-msdata=eabi}, otherwise compile code the
19704 same as @option{-msdata=sysv}.
19706 @item -msdata=data
19707 @opindex msdata=data
19708 On System V.4 and embedded PowerPC systems, put small global
19709 data in the @samp{.sdata} section.  Put small uninitialized global
19710 data in the @samp{.sbss} section.  Do not use register @code{r13}
19711 to address small data however.  This is the default behavior unless
19712 other @option{-msdata} options are used.
19714 @item -msdata=none
19715 @itemx -mno-sdata
19716 @opindex msdata=none
19717 @opindex mno-sdata
19718 On embedded PowerPC systems, put all initialized global and static data
19719 in the @samp{.data} section, and all uninitialized data in the
19720 @samp{.bss} section.
19722 @item -mblock-move-inline-limit=@var{num}
19723 @opindex mblock-move-inline-limit
19724 Inline all block moves (such as calls to @code{memcpy} or structure
19725 copies) less than or equal to @var{num} bytes.  The minimum value for
19726 @var{num} is 32 bytes on 32-bit targets and 64 bytes on 64-bit
19727 targets.  The default value is target-specific.
19729 @item -G @var{num}
19730 @opindex G
19731 @cindex smaller data references (PowerPC)
19732 @cindex .sdata/.sdata2 references (PowerPC)
19733 On embedded PowerPC systems, put global and static items less than or
19734 equal to @var{num} bytes into the small data or BSS sections instead of
19735 the normal data or BSS section.  By default, @var{num} is 8.  The
19736 @option{-G @var{num}} switch is also passed to the linker.
19737 All modules should be compiled with the same @option{-G @var{num}} value.
19739 @item -mregnames
19740 @itemx -mno-regnames
19741 @opindex mregnames
19742 @opindex mno-regnames
19743 On System V.4 and embedded PowerPC systems do (do not) emit register
19744 names in the assembly language output using symbolic forms.
19746 @item -mlongcall
19747 @itemx -mno-longcall
19748 @opindex mlongcall
19749 @opindex mno-longcall
19750 By default assume that all calls are far away so that a longer and more
19751 expensive calling sequence is required.  This is required for calls
19752 farther than 32 megabytes (33,554,432 bytes) from the current location.
19753 A short call is generated if the compiler knows
19754 the call cannot be that far away.  This setting can be overridden by
19755 the @code{shortcall} function attribute, or by @code{#pragma
19756 longcall(0)}.
19758 Some linkers are capable of detecting out-of-range calls and generating
19759 glue code on the fly.  On these systems, long calls are unnecessary and
19760 generate slower code.  As of this writing, the AIX linker can do this,
19761 as can the GNU linker for PowerPC/64.  It is planned to add this feature
19762 to the GNU linker for 32-bit PowerPC systems as well.
19764 On Darwin/PPC systems, @code{#pragma longcall} generates @code{jbsr
19765 callee, L42}, plus a @dfn{branch island} (glue code).  The two target
19766 addresses represent the callee and the branch island.  The
19767 Darwin/PPC linker prefers the first address and generates a @code{bl
19768 callee} if the PPC @code{bl} instruction reaches the callee directly;
19769 otherwise, the linker generates @code{bl L42} to call the branch
19770 island.  The branch island is appended to the body of the
19771 calling function; it computes the full 32-bit address of the callee
19772 and jumps to it.
19774 On Mach-O (Darwin) systems, this option directs the compiler emit to
19775 the glue for every direct call, and the Darwin linker decides whether
19776 to use or discard it.
19778 In the future, GCC may ignore all longcall specifications
19779 when the linker is known to generate glue.
19781 @item -mtls-markers
19782 @itemx -mno-tls-markers
19783 @opindex mtls-markers
19784 @opindex mno-tls-markers
19785 Mark (do not mark) calls to @code{__tls_get_addr} with a relocation
19786 specifying the function argument.  The relocation allows the linker to
19787 reliably associate function call with argument setup instructions for
19788 TLS optimization, which in turn allows GCC to better schedule the
19789 sequence.
19791 @item -pthread
19792 @opindex pthread
19793 Adds support for multithreading with the @dfn{pthreads} library.
19794 This option sets flags for both the preprocessor and linker.
19796 @item -mrecip
19797 @itemx -mno-recip
19798 @opindex mrecip
19799 This option enables use of the reciprocal estimate and
19800 reciprocal square root estimate instructions with additional
19801 Newton-Raphson steps to increase precision instead of doing a divide or
19802 square root and divide for floating-point arguments.  You should use
19803 the @option{-ffast-math} option when using @option{-mrecip} (or at
19804 least @option{-funsafe-math-optimizations},
19805 @option{-finite-math-only}, @option{-freciprocal-math} and
19806 @option{-fno-trapping-math}).  Note that while the throughput of the
19807 sequence is generally higher than the throughput of the non-reciprocal
19808 instruction, the precision of the sequence can be decreased by up to 2
19809 ulp (i.e.@: the inverse of 1.0 equals 0.99999994) for reciprocal square
19810 roots.
19812 @item -mrecip=@var{opt}
19813 @opindex mrecip=opt
19814 This option controls which reciprocal estimate instructions
19815 may be used.  @var{opt} is a comma-separated list of options, which may
19816 be preceded by a @code{!} to invert the option:
19817 @code{all}: enable all estimate instructions,
19818 @code{default}: enable the default instructions, equivalent to @option{-mrecip},
19819 @code{none}: disable all estimate instructions, equivalent to @option{-mno-recip};
19820 @code{div}: enable the reciprocal approximation instructions for both single and double precision;
19821 @code{divf}: enable the single-precision reciprocal approximation instructions;
19822 @code{divd}: enable the double-precision reciprocal approximation instructions;
19823 @code{rsqrt}: enable the reciprocal square root approximation instructions for both single and double precision;
19824 @code{rsqrtf}: enable the single-precision reciprocal square root approximation instructions;
19825 @code{rsqrtd}: enable the double-precision reciprocal square root approximation instructions;
19827 So, for example, @option{-mrecip=all,!rsqrtd} enables
19828 all of the reciprocal estimate instructions, except for the
19829 @code{FRSQRTE}, @code{XSRSQRTEDP}, and @code{XVRSQRTEDP} instructions
19830 which handle the double-precision reciprocal square root calculations.
19832 @item -mrecip-precision
19833 @itemx -mno-recip-precision
19834 @opindex mrecip-precision
19835 Assume (do not assume) that the reciprocal estimate instructions
19836 provide higher-precision estimates than is mandated by the PowerPC
19837 ABI.  Selecting @option{-mcpu=power6}, @option{-mcpu=power7} or
19838 @option{-mcpu=power8} automatically selects @option{-mrecip-precision}.
19839 The double-precision square root estimate instructions are not generated by
19840 default on low-precision machines, since they do not provide an
19841 estimate that converges after three steps.
19843 @item -mveclibabi=@var{type}
19844 @opindex mveclibabi
19845 Specifies the ABI type to use for vectorizing intrinsics using an
19846 external library.  The only type supported at present is @code{mass},
19847 which specifies to use IBM's Mathematical Acceleration Subsystem
19848 (MASS) libraries for vectorizing intrinsics using external libraries.
19849 GCC currently emits calls to @code{acosd2}, @code{acosf4},
19850 @code{acoshd2}, @code{acoshf4}, @code{asind2}, @code{asinf4},
19851 @code{asinhd2}, @code{asinhf4}, @code{atan2d2}, @code{atan2f4},
19852 @code{atand2}, @code{atanf4}, @code{atanhd2}, @code{atanhf4},
19853 @code{cbrtd2}, @code{cbrtf4}, @code{cosd2}, @code{cosf4},
19854 @code{coshd2}, @code{coshf4}, @code{erfcd2}, @code{erfcf4},
19855 @code{erfd2}, @code{erff4}, @code{exp2d2}, @code{exp2f4},
19856 @code{expd2}, @code{expf4}, @code{expm1d2}, @code{expm1f4},
19857 @code{hypotd2}, @code{hypotf4}, @code{lgammad2}, @code{lgammaf4},
19858 @code{log10d2}, @code{log10f4}, @code{log1pd2}, @code{log1pf4},
19859 @code{log2d2}, @code{log2f4}, @code{logd2}, @code{logf4},
19860 @code{powd2}, @code{powf4}, @code{sind2}, @code{sinf4}, @code{sinhd2},
19861 @code{sinhf4}, @code{sqrtd2}, @code{sqrtf4}, @code{tand2},
19862 @code{tanf4}, @code{tanhd2}, and @code{tanhf4} when generating code
19863 for power7.  Both @option{-ftree-vectorize} and
19864 @option{-funsafe-math-optimizations} must also be enabled.  The MASS
19865 libraries must be specified at link time.
19867 @item -mfriz
19868 @itemx -mno-friz
19869 @opindex mfriz
19870 Generate (do not generate) the @code{friz} instruction when the
19871 @option{-funsafe-math-optimizations} option is used to optimize
19872 rounding of floating-point values to 64-bit integer and back to floating
19873 point.  The @code{friz} instruction does not return the same value if
19874 the floating-point number is too large to fit in an integer.
19876 @item -mpointers-to-nested-functions
19877 @itemx -mno-pointers-to-nested-functions
19878 @opindex mpointers-to-nested-functions
19879 Generate (do not generate) code to load up the static chain register
19880 (@var{r11}) when calling through a pointer on AIX and 64-bit Linux
19881 systems where a function pointer points to a 3-word descriptor giving
19882 the function address, TOC value to be loaded in register @var{r2}, and
19883 static chain value to be loaded in register @var{r11}.  The
19884 @option{-mpointers-to-nested-functions} is on by default.  You cannot
19885 call through pointers to nested functions or pointers
19886 to functions compiled in other languages that use the static chain if
19887 you use the @option{-mno-pointers-to-nested-functions}.
19889 @item -msave-toc-indirect
19890 @itemx -mno-save-toc-indirect
19891 @opindex msave-toc-indirect
19892 Generate (do not generate) code to save the TOC value in the reserved
19893 stack location in the function prologue if the function calls through
19894 a pointer on AIX and 64-bit Linux systems.  If the TOC value is not
19895 saved in the prologue, it is saved just before the call through the
19896 pointer.  The @option{-mno-save-toc-indirect} option is the default.
19898 @item -mcompat-align-parm
19899 @itemx -mno-compat-align-parm
19900 @opindex mcompat-align-parm
19901 Generate (do not generate) code to pass structure parameters with a
19902 maximum alignment of 64 bits, for compatibility with older versions
19903 of GCC.
19905 Older versions of GCC (prior to 4.9.0) incorrectly did not align a
19906 structure parameter on a 128-bit boundary when that structure contained
19907 a member requiring 128-bit alignment.  This is corrected in more
19908 recent versions of GCC.  This option may be used to generate code
19909 that is compatible with functions compiled with older versions of
19910 GCC.
19912 The @option{-mno-compat-align-parm} option is the default.
19913 @end table
19915 @node RX Options
19916 @subsection RX Options
19917 @cindex RX Options
19919 These command-line options are defined for RX targets:
19921 @table @gcctabopt
19922 @item -m64bit-doubles
19923 @itemx -m32bit-doubles
19924 @opindex m64bit-doubles
19925 @opindex m32bit-doubles
19926 Make the @code{double} data type be 64 bits (@option{-m64bit-doubles})
19927 or 32 bits (@option{-m32bit-doubles}) in size.  The default is
19928 @option{-m32bit-doubles}.  @emph{Note} RX floating-point hardware only
19929 works on 32-bit values, which is why the default is
19930 @option{-m32bit-doubles}.
19932 @item -fpu
19933 @itemx -nofpu
19934 @opindex fpu
19935 @opindex nofpu
19936 Enables (@option{-fpu}) or disables (@option{-nofpu}) the use of RX
19937 floating-point hardware.  The default is enabled for the @var{RX600}
19938 series and disabled for the @var{RX200} series.
19940 Floating-point instructions are only generated for 32-bit floating-point 
19941 values, however, so the FPU hardware is not used for doubles if the
19942 @option{-m64bit-doubles} option is used.
19944 @emph{Note} If the @option{-fpu} option is enabled then
19945 @option{-funsafe-math-optimizations} is also enabled automatically.
19946 This is because the RX FPU instructions are themselves unsafe.
19948 @item -mcpu=@var{name}
19949 @opindex -mcpu
19950 Selects the type of RX CPU to be targeted.  Currently three types are
19951 supported, the generic @var{RX600} and @var{RX200} series hardware and
19952 the specific @var{RX610} CPU.  The default is @var{RX600}.
19954 The only difference between @var{RX600} and @var{RX610} is that the
19955 @var{RX610} does not support the @code{MVTIPL} instruction.
19957 The @var{RX200} series does not have a hardware floating-point unit
19958 and so @option{-nofpu} is enabled by default when this type is
19959 selected.
19961 @item -mbig-endian-data
19962 @itemx -mlittle-endian-data
19963 @opindex mbig-endian-data
19964 @opindex mlittle-endian-data
19965 Store data (but not code) in the big-endian format.  The default is
19966 @option{-mlittle-endian-data}, i.e.@: to store data in the little-endian
19967 format.
19969 @item -msmall-data-limit=@var{N}
19970 @opindex msmall-data-limit
19971 Specifies the maximum size in bytes of global and static variables
19972 which can be placed into the small data area.  Using the small data
19973 area can lead to smaller and faster code, but the size of area is
19974 limited and it is up to the programmer to ensure that the area does
19975 not overflow.  Also when the small data area is used one of the RX's
19976 registers (usually @code{r13}) is reserved for use pointing to this
19977 area, so it is no longer available for use by the compiler.  This
19978 could result in slower and/or larger code if variables are pushed onto
19979 the stack instead of being held in this register.
19981 Note, common variables (variables that have not been initialized) and
19982 constants are not placed into the small data area as they are assigned
19983 to other sections in the output executable.
19985 The default value is zero, which disables this feature.  Note, this
19986 feature is not enabled by default with higher optimization levels
19987 (@option{-O2} etc) because of the potentially detrimental effects of
19988 reserving a register.  It is up to the programmer to experiment and
19989 discover whether this feature is of benefit to their program.  See the
19990 description of the @option{-mpid} option for a description of how the
19991 actual register to hold the small data area pointer is chosen.
19993 @item -msim
19994 @itemx -mno-sim
19995 @opindex msim
19996 @opindex mno-sim
19997 Use the simulator runtime.  The default is to use the libgloss
19998 board-specific runtime.
20000 @item -mas100-syntax
20001 @itemx -mno-as100-syntax
20002 @opindex mas100-syntax
20003 @opindex mno-as100-syntax
20004 When generating assembler output use a syntax that is compatible with
20005 Renesas's AS100 assembler.  This syntax can also be handled by the GAS
20006 assembler, but it has some restrictions so it is not generated by default.
20008 @item -mmax-constant-size=@var{N}
20009 @opindex mmax-constant-size
20010 Specifies the maximum size, in bytes, of a constant that can be used as
20011 an operand in a RX instruction.  Although the RX instruction set does
20012 allow constants of up to 4 bytes in length to be used in instructions,
20013 a longer value equates to a longer instruction.  Thus in some
20014 circumstances it can be beneficial to restrict the size of constants
20015 that are used in instructions.  Constants that are too big are instead
20016 placed into a constant pool and referenced via register indirection.
20018 The value @var{N} can be between 0 and 4.  A value of 0 (the default)
20019 or 4 means that constants of any size are allowed.
20021 @item -mrelax
20022 @opindex mrelax
20023 Enable linker relaxation.  Linker relaxation is a process whereby the
20024 linker attempts to reduce the size of a program by finding shorter
20025 versions of various instructions.  Disabled by default.
20027 @item -mint-register=@var{N}
20028 @opindex mint-register
20029 Specify the number of registers to reserve for fast interrupt handler
20030 functions.  The value @var{N} can be between 0 and 4.  A value of 1
20031 means that register @code{r13} is reserved for the exclusive use
20032 of fast interrupt handlers.  A value of 2 reserves @code{r13} and
20033 @code{r12}.  A value of 3 reserves @code{r13}, @code{r12} and
20034 @code{r11}, and a value of 4 reserves @code{r13} through @code{r10}.
20035 A value of 0, the default, does not reserve any registers.
20037 @item -msave-acc-in-interrupts
20038 @opindex msave-acc-in-interrupts
20039 Specifies that interrupt handler functions should preserve the
20040 accumulator register.  This is only necessary if normal code might use
20041 the accumulator register, for example because it performs 64-bit
20042 multiplications.  The default is to ignore the accumulator as this
20043 makes the interrupt handlers faster.
20045 @item -mpid
20046 @itemx -mno-pid
20047 @opindex mpid
20048 @opindex mno-pid
20049 Enables the generation of position independent data.  When enabled any
20050 access to constant data is done via an offset from a base address
20051 held in a register.  This allows the location of constant data to be
20052 determined at run time without requiring the executable to be
20053 relocated, which is a benefit to embedded applications with tight
20054 memory constraints.  Data that can be modified is not affected by this
20055 option.
20057 Note, using this feature reserves a register, usually @code{r13}, for
20058 the constant data base address.  This can result in slower and/or
20059 larger code, especially in complicated functions.
20061 The actual register chosen to hold the constant data base address
20062 depends upon whether the @option{-msmall-data-limit} and/or the
20063 @option{-mint-register} command-line options are enabled.  Starting
20064 with register @code{r13} and proceeding downwards, registers are
20065 allocated first to satisfy the requirements of @option{-mint-register},
20066 then @option{-mpid} and finally @option{-msmall-data-limit}.  Thus it
20067 is possible for the small data area register to be @code{r8} if both
20068 @option{-mint-register=4} and @option{-mpid} are specified on the
20069 command line.
20071 By default this feature is not enabled.  The default can be restored
20072 via the @option{-mno-pid} command-line option.
20074 @item -mno-warn-multiple-fast-interrupts
20075 @itemx -mwarn-multiple-fast-interrupts
20076 @opindex mno-warn-multiple-fast-interrupts
20077 @opindex mwarn-multiple-fast-interrupts
20078 Prevents GCC from issuing a warning message if it finds more than one
20079 fast interrupt handler when it is compiling a file.  The default is to
20080 issue a warning for each extra fast interrupt handler found, as the RX
20081 only supports one such interrupt.
20083 @end table
20085 @emph{Note:} The generic GCC command-line option @option{-ffixed-@var{reg}}
20086 has special significance to the RX port when used with the
20087 @code{interrupt} function attribute.  This attribute indicates a
20088 function intended to process fast interrupts.  GCC ensures
20089 that it only uses the registers @code{r10}, @code{r11}, @code{r12}
20090 and/or @code{r13} and only provided that the normal use of the
20091 corresponding registers have been restricted via the
20092 @option{-ffixed-@var{reg}} or @option{-mint-register} command-line
20093 options.
20095 @node S/390 and zSeries Options
20096 @subsection S/390 and zSeries Options
20097 @cindex S/390 and zSeries Options
20099 These are the @samp{-m} options defined for the S/390 and zSeries architecture.
20101 @table @gcctabopt
20102 @item -mhard-float
20103 @itemx -msoft-float
20104 @opindex mhard-float
20105 @opindex msoft-float
20106 Use (do not use) the hardware floating-point instructions and registers
20107 for floating-point operations.  When @option{-msoft-float} is specified,
20108 functions in @file{libgcc.a} are used to perform floating-point
20109 operations.  When @option{-mhard-float} is specified, the compiler
20110 generates IEEE floating-point instructions.  This is the default.
20112 @item -mhard-dfp
20113 @itemx -mno-hard-dfp
20114 @opindex mhard-dfp
20115 @opindex mno-hard-dfp
20116 Use (do not use) the hardware decimal-floating-point instructions for
20117 decimal-floating-point operations.  When @option{-mno-hard-dfp} is
20118 specified, functions in @file{libgcc.a} are used to perform
20119 decimal-floating-point operations.  When @option{-mhard-dfp} is
20120 specified, the compiler generates decimal-floating-point hardware
20121 instructions.  This is the default for @option{-march=z9-ec} or higher.
20123 @item -mlong-double-64
20124 @itemx -mlong-double-128
20125 @opindex mlong-double-64
20126 @opindex mlong-double-128
20127 These switches control the size of @code{long double} type. A size
20128 of 64 bits makes the @code{long double} type equivalent to the @code{double}
20129 type. This is the default.
20131 @item -mbackchain
20132 @itemx -mno-backchain
20133 @opindex mbackchain
20134 @opindex mno-backchain
20135 Store (do not store) the address of the caller's frame as backchain pointer
20136 into the callee's stack frame.
20137 A backchain may be needed to allow debugging using tools that do not understand
20138 DWARF 2 call frame information.
20139 When @option{-mno-packed-stack} is in effect, the backchain pointer is stored
20140 at the bottom of the stack frame; when @option{-mpacked-stack} is in effect,
20141 the backchain is placed into the topmost word of the 96/160 byte register
20142 save area.
20144 In general, code compiled with @option{-mbackchain} is call-compatible with
20145 code compiled with @option{-mmo-backchain}; however, use of the backchain
20146 for debugging purposes usually requires that the whole binary is built with
20147 @option{-mbackchain}.  Note that the combination of @option{-mbackchain},
20148 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20149 to build a linux kernel use @option{-msoft-float}.
20151 The default is to not maintain the backchain.
20153 @item -mpacked-stack
20154 @itemx -mno-packed-stack
20155 @opindex mpacked-stack
20156 @opindex mno-packed-stack
20157 Use (do not use) the packed stack layout.  When @option{-mno-packed-stack} is
20158 specified, the compiler uses the all fields of the 96/160 byte register save
20159 area only for their default purpose; unused fields still take up stack space.
20160 When @option{-mpacked-stack} is specified, register save slots are densely
20161 packed at the top of the register save area; unused space is reused for other
20162 purposes, allowing for more efficient use of the available stack space.
20163 However, when @option{-mbackchain} is also in effect, the topmost word of
20164 the save area is always used to store the backchain, and the return address
20165 register is always saved two words below the backchain.
20167 As long as the stack frame backchain is not used, code generated with
20168 @option{-mpacked-stack} is call-compatible with code generated with
20169 @option{-mno-packed-stack}.  Note that some non-FSF releases of GCC 2.95 for
20170 S/390 or zSeries generated code that uses the stack frame backchain at run
20171 time, not just for debugging purposes.  Such code is not call-compatible
20172 with code compiled with @option{-mpacked-stack}.  Also, note that the
20173 combination of @option{-mbackchain},
20174 @option{-mpacked-stack} and @option{-mhard-float} is not supported.  In order
20175 to build a linux kernel use @option{-msoft-float}.
20177 The default is to not use the packed stack layout.
20179 @item -msmall-exec
20180 @itemx -mno-small-exec
20181 @opindex msmall-exec
20182 @opindex mno-small-exec
20183 Generate (or do not generate) code using the @code{bras} instruction
20184 to do subroutine calls.
20185 This only works reliably if the total executable size does not
20186 exceed 64k.  The default is to use the @code{basr} instruction instead,
20187 which does not have this limitation.
20189 @item -m64
20190 @itemx -m31
20191 @opindex m64
20192 @opindex m31
20193 When @option{-m31} is specified, generate code compliant to the
20194 GNU/Linux for S/390 ABI@.  When @option{-m64} is specified, generate
20195 code compliant to the GNU/Linux for zSeries ABI@.  This allows GCC in
20196 particular to generate 64-bit instructions.  For the @samp{s390}
20197 targets, the default is @option{-m31}, while the @samp{s390x}
20198 targets default to @option{-m64}.
20200 @item -mzarch
20201 @itemx -mesa
20202 @opindex mzarch
20203 @opindex mesa
20204 When @option{-mzarch} is specified, generate code using the
20205 instructions available on z/Architecture.
20206 When @option{-mesa} is specified, generate code using the
20207 instructions available on ESA/390.  Note that @option{-mesa} is
20208 not possible with @option{-m64}.
20209 When generating code compliant to the GNU/Linux for S/390 ABI,
20210 the default is @option{-mesa}.  When generating code compliant
20211 to the GNU/Linux for zSeries ABI, the default is @option{-mzarch}.
20213 @item -mmvcle
20214 @itemx -mno-mvcle
20215 @opindex mmvcle
20216 @opindex mno-mvcle
20217 Generate (or do not generate) code using the @code{mvcle} instruction
20218 to perform block moves.  When @option{-mno-mvcle} is specified,
20219 use a @code{mvc} loop instead.  This is the default unless optimizing for
20220 size.
20222 @item -mdebug
20223 @itemx -mno-debug
20224 @opindex mdebug
20225 @opindex mno-debug
20226 Print (or do not print) additional debug information when compiling.
20227 The default is to not print debug information.
20229 @item -march=@var{cpu-type}
20230 @opindex march
20231 Generate code that runs on @var{cpu-type}, which is the name of a system
20232 representing a certain processor type.  Possible values for
20233 @var{cpu-type} are @samp{g5}, @samp{g6}, @samp{z900}, @samp{z990},
20234 @samp{z9-109}, @samp{z9-ec} and @samp{z10}.
20235 When generating code using the instructions available on z/Architecture,
20236 the default is @option{-march=z900}.  Otherwise, the default is
20237 @option{-march=g5}.
20239 @item -mtune=@var{cpu-type}
20240 @opindex mtune
20241 Tune to @var{cpu-type} everything applicable about the generated code,
20242 except for the ABI and the set of available instructions.
20243 The list of @var{cpu-type} values is the same as for @option{-march}.
20244 The default is the value used for @option{-march}.
20246 @item -mtpf-trace
20247 @itemx -mno-tpf-trace
20248 @opindex mtpf-trace
20249 @opindex mno-tpf-trace
20250 Generate code that adds (does not add) in TPF OS specific branches to trace
20251 routines in the operating system.  This option is off by default, even
20252 when compiling for the TPF OS@.
20254 @item -mfused-madd
20255 @itemx -mno-fused-madd
20256 @opindex mfused-madd
20257 @opindex mno-fused-madd
20258 Generate code that uses (does not use) the floating-point multiply and
20259 accumulate instructions.  These instructions are generated by default if
20260 hardware floating point is used.
20262 @item -mwarn-framesize=@var{framesize}
20263 @opindex mwarn-framesize
20264 Emit a warning if the current function exceeds the given frame size.  Because
20265 this is a compile-time check it doesn't need to be a real problem when the program
20266 runs.  It is intended to identify functions that most probably cause
20267 a stack overflow.  It is useful to be used in an environment with limited stack
20268 size e.g.@: the linux kernel.
20270 @item -mwarn-dynamicstack
20271 @opindex mwarn-dynamicstack
20272 Emit a warning if the function calls @code{alloca} or uses dynamically-sized
20273 arrays.  This is generally a bad idea with a limited stack size.
20275 @item -mstack-guard=@var{stack-guard}
20276 @itemx -mstack-size=@var{stack-size}
20277 @opindex mstack-guard
20278 @opindex mstack-size
20279 If these options are provided the S/390 back end emits additional instructions in
20280 the function prologue that trigger a trap if the stack size is @var{stack-guard}
20281 bytes above the @var{stack-size} (remember that the stack on S/390 grows downward).
20282 If the @var{stack-guard} option is omitted the smallest power of 2 larger than
20283 the frame size of the compiled function is chosen.
20284 These options are intended to be used to help debugging stack overflow problems.
20285 The additionally emitted code causes only little overhead and hence can also be
20286 used in production-like systems without greater performance degradation.  The given
20287 values have to be exact powers of 2 and @var{stack-size} has to be greater than
20288 @var{stack-guard} without exceeding 64k.
20289 In order to be efficient the extra code makes the assumption that the stack starts
20290 at an address aligned to the value given by @var{stack-size}.
20291 The @var{stack-guard} option can only be used in conjunction with @var{stack-size}.
20293 @item -mhotpatch[=@var{halfwords}]
20294 @itemx -mno-hotpatch
20295 @opindex mhotpatch
20296 If the hotpatch option is enabled, a ``hot-patching'' function
20297 prologue is generated for all functions in the compilation unit.
20298 The funtion label is prepended with the given number of two-byte
20299 Nop instructions (@var{halfwords}, maximum 1000000) or 12 Nop
20300 instructions if no argument is present.  Functions with a
20301 hot-patching prologue are never inlined automatically, and a
20302 hot-patching prologue is never generated for functions functions
20303 that are explicitly inline.
20305 This option can be overridden for individual functions with the
20306 @code{hotpatch} attribute.
20307 @end table
20309 @node Score Options
20310 @subsection Score Options
20311 @cindex Score Options
20313 These options are defined for Score implementations:
20315 @table @gcctabopt
20316 @item -meb
20317 @opindex meb
20318 Compile code for big-endian mode.  This is the default.
20320 @item -mel
20321 @opindex mel
20322 Compile code for little-endian mode.
20324 @item -mnhwloop
20325 @opindex mnhwloop
20326 Disable generation of @code{bcnz} instructions.
20328 @item -muls
20329 @opindex muls
20330 Enable generation of unaligned load and store instructions.
20332 @item -mmac
20333 @opindex mmac
20334 Enable the use of multiply-accumulate instructions. Disabled by default.
20336 @item -mscore5
20337 @opindex mscore5
20338 Specify the SCORE5 as the target architecture.
20340 @item -mscore5u
20341 @opindex mscore5u
20342 Specify the SCORE5U of the target architecture.
20344 @item -mscore7
20345 @opindex mscore7
20346 Specify the SCORE7 as the target architecture. This is the default.
20348 @item -mscore7d
20349 @opindex mscore7d
20350 Specify the SCORE7D as the target architecture.
20351 @end table
20353 @node SH Options
20354 @subsection SH Options
20356 These @samp{-m} options are defined for the SH implementations:
20358 @table @gcctabopt
20359 @item -m1
20360 @opindex m1
20361 Generate code for the SH1.
20363 @item -m2
20364 @opindex m2
20365 Generate code for the SH2.
20367 @item -m2e
20368 Generate code for the SH2e.
20370 @item -m2a-nofpu
20371 @opindex m2a-nofpu
20372 Generate code for the SH2a without FPU, or for a SH2a-FPU in such a way
20373 that the floating-point unit is not used.
20375 @item -m2a-single-only
20376 @opindex m2a-single-only
20377 Generate code for the SH2a-FPU, in such a way that no double-precision
20378 floating-point operations are used.
20380 @item -m2a-single
20381 @opindex m2a-single
20382 Generate code for the SH2a-FPU assuming the floating-point unit is in
20383 single-precision mode by default.
20385 @item -m2a
20386 @opindex m2a
20387 Generate code for the SH2a-FPU assuming the floating-point unit is in
20388 double-precision mode by default.
20390 @item -m3
20391 @opindex m3
20392 Generate code for the SH3.
20394 @item -m3e
20395 @opindex m3e
20396 Generate code for the SH3e.
20398 @item -m4-nofpu
20399 @opindex m4-nofpu
20400 Generate code for the SH4 without a floating-point unit.
20402 @item -m4-single-only
20403 @opindex m4-single-only
20404 Generate code for the SH4 with a floating-point unit that only
20405 supports single-precision arithmetic.
20407 @item -m4-single
20408 @opindex m4-single
20409 Generate code for the SH4 assuming the floating-point unit is in
20410 single-precision mode by default.
20412 @item -m4
20413 @opindex m4
20414 Generate code for the SH4.
20416 @item -m4a-nofpu
20417 @opindex m4a-nofpu
20418 Generate code for the SH4al-dsp, or for a SH4a in such a way that the
20419 floating-point unit is not used.
20421 @item -m4a-single-only
20422 @opindex m4a-single-only
20423 Generate code for the SH4a, in such a way that no double-precision
20424 floating-point operations are used.
20426 @item -m4a-single
20427 @opindex m4a-single
20428 Generate code for the SH4a assuming the floating-point unit is in
20429 single-precision mode by default.
20431 @item -m4a
20432 @opindex m4a
20433 Generate code for the SH4a.
20435 @item -m4al
20436 @opindex m4al
20437 Same as @option{-m4a-nofpu}, except that it implicitly passes
20438 @option{-dsp} to the assembler.  GCC doesn't generate any DSP
20439 instructions at the moment.
20441 @item -mb
20442 @opindex mb
20443 Compile code for the processor in big-endian mode.
20445 @item -ml
20446 @opindex ml
20447 Compile code for the processor in little-endian mode.
20449 @item -mdalign
20450 @opindex mdalign
20451 Align doubles at 64-bit boundaries.  Note that this changes the calling
20452 conventions, and thus some functions from the standard C library do
20453 not work unless you recompile it first with @option{-mdalign}.
20455 @item -mrelax
20456 @opindex mrelax
20457 Shorten some address references at link time, when possible; uses the
20458 linker option @option{-relax}.
20460 @item -mbigtable
20461 @opindex mbigtable
20462 Use 32-bit offsets in @code{switch} tables.  The default is to use
20463 16-bit offsets.
20465 @item -mbitops
20466 @opindex mbitops
20467 Enable the use of bit manipulation instructions on SH2A.
20469 @item -mfmovd
20470 @opindex mfmovd
20471 Enable the use of the instruction @code{fmovd}.  Check @option{-mdalign} for
20472 alignment constraints.
20474 @item -mhitachi
20475 @opindex mhitachi
20476 Comply with the calling conventions defined by Renesas.
20478 @item -mrenesas
20479 @opindex mhitachi
20480 Comply with the calling conventions defined by Renesas.
20482 @item -mno-renesas
20483 @opindex mhitachi
20484 Comply with the calling conventions defined for GCC before the Renesas
20485 conventions were available.  This option is the default for all
20486 targets of the SH toolchain.
20488 @item -mnomacsave
20489 @opindex mnomacsave
20490 Mark the @code{MAC} register as call-clobbered, even if
20491 @option{-mhitachi} is given.
20493 @item -mieee
20494 @itemx -mno-ieee
20495 @opindex mieee
20496 @opindex mnoieee
20497 Control the IEEE compliance of floating-point comparisons, which affects the
20498 handling of cases where the result of a comparison is unordered.  By default
20499 @option{-mieee} is implicitly enabled.  If @option{-ffinite-math-only} is
20500 enabled @option{-mno-ieee} is implicitly set, which results in faster
20501 floating-point greater-equal and less-equal comparisons.  The implcit settings
20502 can be overridden by specifying either @option{-mieee} or @option{-mno-ieee}.
20504 @item -minline-ic_invalidate
20505 @opindex minline-ic_invalidate
20506 Inline code to invalidate instruction cache entries after setting up
20507 nested function trampolines.
20508 This option has no effect if @option{-musermode} is in effect and the selected
20509 code generation option (e.g. @option{-m4}) does not allow the use of the @code{icbi}
20510 instruction.
20511 If the selected code generation option does not allow the use of the @code{icbi}
20512 instruction, and @option{-musermode} is not in effect, the inlined code
20513 manipulates the instruction cache address array directly with an associative
20514 write.  This not only requires privileged mode at run time, but it also
20515 fails if the cache line had been mapped via the TLB and has become unmapped.
20517 @item -misize
20518 @opindex misize
20519 Dump instruction size and location in the assembly code.
20521 @item -mpadstruct
20522 @opindex mpadstruct
20523 This option is deprecated.  It pads structures to multiple of 4 bytes,
20524 which is incompatible with the SH ABI@.
20526 @item -matomic-model=@var{model}
20527 @opindex matomic-model=@var{model}
20528 Sets the model of atomic operations and additional parameters as a comma
20529 separated list.  For details on the atomic built-in functions see
20530 @ref{__atomic Builtins}.  The following models and parameters are supported:
20532 @table @samp
20534 @item none
20535 Disable compiler generated atomic sequences and emit library calls for atomic
20536 operations.  This is the default if the target is not @code{sh-*-linux*}.
20538 @item soft-gusa
20539 Generate GNU/Linux compatible gUSA software atomic sequences for the atomic
20540 built-in functions.  The generated atomic sequences require additional support
20541 from the interrupt/exception handling code of the system and are only suitable
20542 for SH3* and SH4* single-core systems.  This option is enabled by default when
20543 the target is @code{sh-*-linux*} and SH3* or SH4*.  When the target is SH4A,
20544 this option will also partially utilize the hardware atomic instructions
20545 @code{movli.l} and @code{movco.l} to create more efficient code, unless
20546 @samp{strict} is specified.  
20548 @item soft-tcb
20549 Generate software atomic sequences that use a variable in the thread control
20550 block.  This is a variation of the gUSA sequences which can also be used on
20551 SH1* and SH2* targets.  The generated atomic sequences require additional
20552 support from the interrupt/exception handling code of the system and are only
20553 suitable for single-core systems.  When using this model, the @samp{gbr-offset=}
20554 parameter has to be specified as well.
20556 @item soft-imask
20557 Generate software atomic sequences that temporarily disable interrupts by
20558 setting @code{SR.IMASK = 1111}.  This model works only when the program runs
20559 in privileged mode and is only suitable for single-core systems.  Additional
20560 support from the interrupt/exception handling code of the system is not
20561 required.  This model is enabled by default when the target is
20562 @code{sh-*-linux*} and SH1* or SH2*.
20564 @item hard-llcs
20565 Generate hardware atomic sequences using the @code{movli.l} and @code{movco.l}
20566 instructions only.  This is only available on SH4A and is suitable for
20567 multi-core systems.  Since the hardware instructions support only 32 bit atomic
20568 variables access to 8 or 16 bit variables is emulated with 32 bit accesses.
20569 Code compiled with this option will also be compatible with other software
20570 atomic model interrupt/exception handling systems if executed on an SH4A
20571 system.  Additional support from the interrupt/exception handling code of the
20572 system is not required for this model.
20574 @item gbr-offset=
20575 This parameter specifies the offset in bytes of the variable in the thread
20576 control block structure that should be used by the generated atomic sequences
20577 when the @samp{soft-tcb} model has been selected.  For other models this
20578 parameter is ignored.  The specified value must be an integer multiple of four
20579 and in the range 0-1020.
20581 @item strict
20582 This parameter prevents mixed usage of multiple atomic models, even though they
20583 would be compatible, and will make the compiler generate atomic sequences of the
20584 specified model only.
20586 @end table
20588 @item -mtas
20589 @opindex mtas
20590 Generate the @code{tas.b} opcode for @code{__atomic_test_and_set}.
20591 Notice that depending on the particular hardware and software configuration
20592 this can degrade overall performance due to the operand cache line flushes
20593 that are implied by the @code{tas.b} instruction.  On multi-core SH4A
20594 processors the @code{tas.b} instruction must be used with caution since it
20595 can result in data corruption for certain cache configurations.
20597 @item -mspace
20598 @opindex mspace
20599 Optimize for space instead of speed.  Implied by @option{-Os}.
20601 @item -mprefergot
20602 @opindex mprefergot
20603 When generating position-independent code, emit function calls using
20604 the Global Offset Table instead of the Procedure Linkage Table.
20606 @item -musermode
20607 @opindex musermode
20608 Don't generate privileged mode only code.  This option
20609 implies @option{-mno-inline-ic_invalidate}
20610 if the inlined code would not work in user mode.
20611 This is the default when the target is @code{sh-*-linux*}.
20613 @item -multcost=@var{number}
20614 @opindex multcost=@var{number}
20615 Set the cost to assume for a multiply insn.
20617 @item -mdiv=@var{strategy}
20618 @opindex mdiv=@var{strategy}
20619 Set the division strategy to be used for integer division operations.
20620 For SHmedia @var{strategy} can be one of: 
20622 @table @samp
20624 @item fp 
20625 Performs the operation in floating point.  This has a very high latency,
20626 but needs only a few instructions, so it might be a good choice if
20627 your code has enough easily-exploitable ILP to allow the compiler to
20628 schedule the floating-point instructions together with other instructions.
20629 Division by zero causes a floating-point exception.
20631 @item inv
20632 Uses integer operations to calculate the inverse of the divisor,
20633 and then multiplies the dividend with the inverse.  This strategy allows
20634 CSE and hoisting of the inverse calculation.  Division by zero calculates
20635 an unspecified result, but does not trap.
20637 @item inv:minlat
20638 A variant of @samp{inv} where, if no CSE or hoisting opportunities
20639 have been found, or if the entire operation has been hoisted to the same
20640 place, the last stages of the inverse calculation are intertwined with the
20641 final multiply to reduce the overall latency, at the expense of using a few
20642 more instructions, and thus offering fewer scheduling opportunities with
20643 other code.
20645 @item call
20646 Calls a library function that usually implements the @samp{inv:minlat}
20647 strategy.
20648 This gives high code density for @code{m5-*media-nofpu} compilations.
20650 @item call2
20651 Uses a different entry point of the same library function, where it
20652 assumes that a pointer to a lookup table has already been set up, which
20653 exposes the pointer load to CSE and code hoisting optimizations.
20655 @item inv:call
20656 @itemx inv:call2
20657 @itemx inv:fp
20658 Use the @samp{inv} algorithm for initial
20659 code generation, but if the code stays unoptimized, revert to the @samp{call},
20660 @samp{call2}, or @samp{fp} strategies, respectively.  Note that the
20661 potentially-trapping side effect of division by zero is carried by a
20662 separate instruction, so it is possible that all the integer instructions
20663 are hoisted out, but the marker for the side effect stays where it is.
20664 A recombination to floating-point operations or a call is not possible
20665 in that case.
20667 @item inv20u
20668 @itemx inv20l
20669 Variants of the @samp{inv:minlat} strategy.  In the case
20670 that the inverse calculation is not separated from the multiply, they speed
20671 up division where the dividend fits into 20 bits (plus sign where applicable)
20672 by inserting a test to skip a number of operations in this case; this test
20673 slows down the case of larger dividends.  @samp{inv20u} assumes the case of a such
20674 a small dividend to be unlikely, and @samp{inv20l} assumes it to be likely.
20676 @end table
20678 For targets other than SHmedia @var{strategy} can be one of:
20680 @table @samp
20682 @item call-div1
20683 Calls a library function that uses the single-step division instruction
20684 @code{div1} to perform the operation.  Division by zero calculates an
20685 unspecified result and does not trap.  This is the default except for SH4,
20686 SH2A and SHcompact.
20688 @item call-fp
20689 Calls a library function that performs the operation in double precision
20690 floating point.  Division by zero causes a floating-point exception.  This is
20691 the default for SHcompact with FPU.  Specifying this for targets that do not
20692 have a double precision FPU will default to @code{call-div1}.
20694 @item call-table
20695 Calls a library function that uses a lookup table for small divisors and
20696 the @code{div1} instruction with case distinction for larger divisors.  Division
20697 by zero calculates an unspecified result and does not trap.  This is the default
20698 for SH4.  Specifying this for targets that do not have dynamic shift
20699 instructions will default to @code{call-div1}.
20701 @end table
20703 When a division strategy has not been specified the default strategy will be
20704 selected based on the current target.  For SH2A the default strategy is to
20705 use the @code{divs} and @code{divu} instructions instead of library function
20706 calls.
20708 @item -maccumulate-outgoing-args
20709 @opindex maccumulate-outgoing-args
20710 Reserve space once for outgoing arguments in the function prologue rather
20711 than around each call.  Generally beneficial for performance and size.  Also
20712 needed for unwinding to avoid changing the stack frame around conditional code.
20714 @item -mdivsi3_libfunc=@var{name}
20715 @opindex mdivsi3_libfunc=@var{name}
20716 Set the name of the library function used for 32-bit signed division to
20717 @var{name}.
20718 This only affects the name used in the @samp{call} and @samp{inv:call}
20719 division strategies, and the compiler still expects the same
20720 sets of input/output/clobbered registers as if this option were not present.
20722 @item -mfixed-range=@var{register-range}
20723 @opindex mfixed-range
20724 Generate code treating the given register range as fixed registers.
20725 A fixed register is one that the register allocator can not use.  This is
20726 useful when compiling kernel code.  A register range is specified as
20727 two registers separated by a dash.  Multiple register ranges can be
20728 specified separated by a comma.
20730 @item -mindexed-addressing
20731 @opindex mindexed-addressing
20732 Enable the use of the indexed addressing mode for SHmedia32/SHcompact.
20733 This is only safe if the hardware and/or OS implement 32-bit wrap-around
20734 semantics for the indexed addressing mode.  The architecture allows the
20735 implementation of processors with 64-bit MMU, which the OS could use to
20736 get 32-bit addressing, but since no current hardware implementation supports
20737 this or any other way to make the indexed addressing mode safe to use in
20738 the 32-bit ABI, the default is @option{-mno-indexed-addressing}.
20740 @item -mgettrcost=@var{number}
20741 @opindex mgettrcost=@var{number}
20742 Set the cost assumed for the @code{gettr} instruction to @var{number}.
20743 The default is 2 if @option{-mpt-fixed} is in effect, 100 otherwise.
20745 @item -mpt-fixed
20746 @opindex mpt-fixed
20747 Assume @code{pt*} instructions won't trap.  This generally generates
20748 better-scheduled code, but is unsafe on current hardware.
20749 The current architecture
20750 definition says that @code{ptabs} and @code{ptrel} trap when the target 
20751 anded with 3 is 3.
20752 This has the unintentional effect of making it unsafe to schedule these
20753 instructions before a branch, or hoist them out of a loop.  For example,
20754 @code{__do_global_ctors}, a part of @file{libgcc}
20755 that runs constructors at program
20756 startup, calls functions in a list which is delimited by @minus{}1.  With the
20757 @option{-mpt-fixed} option, the @code{ptabs} is done before testing against @minus{}1.
20758 That means that all the constructors run a bit more quickly, but when
20759 the loop comes to the end of the list, the program crashes because @code{ptabs}
20760 loads @minus{}1 into a target register.  
20762 Since this option is unsafe for any
20763 hardware implementing the current architecture specification, the default
20764 is @option{-mno-pt-fixed}.  Unless specified explicitly with 
20765 @option{-mgettrcost}, @option{-mno-pt-fixed} also implies @option{-mgettrcost=100};
20766 this deters register allocation from using target registers for storing
20767 ordinary integers.
20769 @item -minvalid-symbols
20770 @opindex minvalid-symbols
20771 Assume symbols might be invalid.  Ordinary function symbols generated by
20772 the compiler are always valid to load with
20773 @code{movi}/@code{shori}/@code{ptabs} or
20774 @code{movi}/@code{shori}/@code{ptrel},
20775 but with assembler and/or linker tricks it is possible
20776 to generate symbols that cause @code{ptabs} or @code{ptrel} to trap.
20777 This option is only meaningful when @option{-mno-pt-fixed} is in effect.
20778 It prevents cross-basic-block CSE, hoisting and most scheduling
20779 of symbol loads.  The default is @option{-mno-invalid-symbols}.
20781 @item -mbranch-cost=@var{num}
20782 @opindex mbranch-cost=@var{num}
20783 Assume @var{num} to be the cost for a branch instruction.  Higher numbers
20784 make the compiler try to generate more branch-free code if possible.  
20785 If not specified the value is selected depending on the processor type that
20786 is being compiled for.
20788 @item -mzdcbranch
20789 @itemx -mno-zdcbranch
20790 @opindex mzdcbranch
20791 @opindex mno-zdcbranch
20792 Assume (do not assume) that zero displacement conditional branch instructions
20793 @code{bt} and @code{bf} are fast.  If @option{-mzdcbranch} is specified, the
20794 compiler will try to prefer zero displacement branch code sequences.  This is
20795 enabled by default when generating code for SH4 and SH4A.  It can be explicitly
20796 disabled by specifying @option{-mno-zdcbranch}.
20798 @item -mfused-madd
20799 @itemx -mno-fused-madd
20800 @opindex mfused-madd
20801 @opindex mno-fused-madd
20802 Generate code that uses (does not use) the floating-point multiply and
20803 accumulate instructions.  These instructions are generated by default
20804 if hardware floating point is used.  The machine-dependent
20805 @option{-mfused-madd} option is now mapped to the machine-independent
20806 @option{-ffp-contract=fast} option, and @option{-mno-fused-madd} is
20807 mapped to @option{-ffp-contract=off}.
20809 @item -mfsca
20810 @itemx -mno-fsca
20811 @opindex mfsca
20812 @opindex mno-fsca
20813 Allow or disallow the compiler to emit the @code{fsca} instruction for sine
20814 and cosine approximations.  The option @code{-mfsca} must be used in
20815 combination with @code{-funsafe-math-optimizations}.  It is enabled by default
20816 when generating code for SH4A.  Using @code{-mno-fsca} disables sine and cosine
20817 approximations even if @code{-funsafe-math-optimizations} is in effect.
20819 @item -mfsrra
20820 @itemx -mno-fsrra
20821 @opindex mfsrra
20822 @opindex mno-fsrra
20823 Allow or disallow the compiler to emit the @code{fsrra} instruction for
20824 reciprocal square root approximations.  The option @code{-mfsrra} must be used
20825 in combination with @code{-funsafe-math-optimizations} and
20826 @code{-ffinite-math-only}.  It is enabled by default when generating code for
20827 SH4A.  Using @code{-mno-fsrra} disables reciprocal square root approximations
20828 even if @code{-funsafe-math-optimizations} and @code{-ffinite-math-only} are
20829 in effect.
20831 @item -mpretend-cmove
20832 @opindex mpretend-cmove
20833 Prefer zero-displacement conditional branches for conditional move instruction
20834 patterns.  This can result in faster code on the SH4 processor.
20836 @end table
20838 @node Solaris 2 Options
20839 @subsection Solaris 2 Options
20840 @cindex Solaris 2 options
20842 These @samp{-m} options are supported on Solaris 2:
20844 @table @gcctabopt
20845 @item -mimpure-text
20846 @opindex mimpure-text
20847 @option{-mimpure-text}, used in addition to @option{-shared}, tells
20848 the compiler to not pass @option{-z text} to the linker when linking a
20849 shared object.  Using this option, you can link position-dependent
20850 code into a shared object.
20852 @option{-mimpure-text} suppresses the ``relocations remain against
20853 allocatable but non-writable sections'' linker error message.
20854 However, the necessary relocations trigger copy-on-write, and the
20855 shared object is not actually shared across processes.  Instead of
20856 using @option{-mimpure-text}, you should compile all source code with
20857 @option{-fpic} or @option{-fPIC}.
20859 @end table
20861 These switches are supported in addition to the above on Solaris 2:
20863 @table @gcctabopt
20864 @item -pthreads
20865 @opindex pthreads
20866 Add support for multithreading using the POSIX threads library.  This
20867 option sets flags for both the preprocessor and linker.  This option does
20868 not affect the thread safety of object code produced  by the compiler or
20869 that of libraries supplied with it.
20871 @item -pthread
20872 @opindex pthread
20873 This is a synonym for @option{-pthreads}.
20874 @end table
20876 @node SPARC Options
20877 @subsection SPARC Options
20878 @cindex SPARC options
20880 These @samp{-m} options are supported on the SPARC:
20882 @table @gcctabopt
20883 @item -mno-app-regs
20884 @itemx -mapp-regs
20885 @opindex mno-app-regs
20886 @opindex mapp-regs
20887 Specify @option{-mapp-regs} to generate output using the global registers
20888 2 through 4, which the SPARC SVR4 ABI reserves for applications.  Like the
20889 global register 1, each global register 2 through 4 is then treated as an
20890 allocable register that is clobbered by function calls.  This is the default.
20892 To be fully SVR4 ABI-compliant at the cost of some performance loss,
20893 specify @option{-mno-app-regs}.  You should compile libraries and system
20894 software with this option.
20896 @item -mflat
20897 @itemx -mno-flat
20898 @opindex mflat
20899 @opindex mno-flat
20900 With @option{-mflat}, the compiler does not generate save/restore instructions
20901 and uses a ``flat'' or single register window model.  This model is compatible
20902 with the regular register window model.  The local registers and the input
20903 registers (0--5) are still treated as ``call-saved'' registers and are
20904 saved on the stack as needed.
20906 With @option{-mno-flat} (the default), the compiler generates save/restore
20907 instructions (except for leaf functions).  This is the normal operating mode.
20909 @item -mfpu
20910 @itemx -mhard-float
20911 @opindex mfpu
20912 @opindex mhard-float
20913 Generate output containing floating-point instructions.  This is the
20914 default.
20916 @item -mno-fpu
20917 @itemx -msoft-float
20918 @opindex mno-fpu
20919 @opindex msoft-float
20920 Generate output containing library calls for floating point.
20921 @strong{Warning:} the requisite libraries are not available for all SPARC
20922 targets.  Normally the facilities of the machine's usual C compiler are
20923 used, but this cannot be done directly in cross-compilation.  You must make
20924 your own arrangements to provide suitable library functions for
20925 cross-compilation.  The embedded targets @samp{sparc-*-aout} and
20926 @samp{sparclite-*-*} do provide software floating-point support.
20928 @option{-msoft-float} changes the calling convention in the output file;
20929 therefore, it is only useful if you compile @emph{all} of a program with
20930 this option.  In particular, you need to compile @file{libgcc.a}, the
20931 library that comes with GCC, with @option{-msoft-float} in order for
20932 this to work.
20934 @item -mhard-quad-float
20935 @opindex mhard-quad-float
20936 Generate output containing quad-word (long double) floating-point
20937 instructions.
20939 @item -msoft-quad-float
20940 @opindex msoft-quad-float
20941 Generate output containing library calls for quad-word (long double)
20942 floating-point instructions.  The functions called are those specified
20943 in the SPARC ABI@.  This is the default.
20945 As of this writing, there are no SPARC implementations that have hardware
20946 support for the quad-word floating-point instructions.  They all invoke
20947 a trap handler for one of these instructions, and then the trap handler
20948 emulates the effect of the instruction.  Because of the trap handler overhead,
20949 this is much slower than calling the ABI library routines.  Thus the
20950 @option{-msoft-quad-float} option is the default.
20952 @item -mno-unaligned-doubles
20953 @itemx -munaligned-doubles
20954 @opindex mno-unaligned-doubles
20955 @opindex munaligned-doubles
20956 Assume that doubles have 8-byte alignment.  This is the default.
20958 With @option{-munaligned-doubles}, GCC assumes that doubles have 8-byte
20959 alignment only if they are contained in another type, or if they have an
20960 absolute address.  Otherwise, it assumes they have 4-byte alignment.
20961 Specifying this option avoids some rare compatibility problems with code
20962 generated by other compilers.  It is not the default because it results
20963 in a performance loss, especially for floating-point code.
20965 @item -muser-mode
20966 @itemx -mno-user-mode
20967 @opindex muser-mode
20968 @opindex mno-user-mode
20969 Do not generate code that can only run in supervisor mode.  This is relevant
20970 only for the @code{casa} instruction emitted for the LEON3 processor.  The
20971 default is @option{-mno-user-mode}.
20973 @item -mno-faster-structs
20974 @itemx -mfaster-structs
20975 @opindex mno-faster-structs
20976 @opindex mfaster-structs
20977 With @option{-mfaster-structs}, the compiler assumes that structures
20978 should have 8-byte alignment.  This enables the use of pairs of
20979 @code{ldd} and @code{std} instructions for copies in structure
20980 assignment, in place of twice as many @code{ld} and @code{st} pairs.
20981 However, the use of this changed alignment directly violates the SPARC
20982 ABI@.  Thus, it's intended only for use on targets where the developer
20983 acknowledges that their resulting code is not directly in line with
20984 the rules of the ABI@.
20986 @item -mcpu=@var{cpu_type}
20987 @opindex mcpu
20988 Set the instruction set, register set, and instruction scheduling parameters
20989 for machine type @var{cpu_type}.  Supported values for @var{cpu_type} are
20990 @samp{v7}, @samp{cypress}, @samp{v8}, @samp{supersparc}, @samp{hypersparc},
20991 @samp{leon}, @samp{leon3}, @samp{sparclite}, @samp{f930}, @samp{f934},
20992 @samp{sparclite86x}, @samp{sparclet}, @samp{tsc701}, @samp{v9},
20993 @samp{ultrasparc}, @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2},
20994 @samp{niagara3} and @samp{niagara4}.
20996 Native Solaris and GNU/Linux toolchains also support the value @samp{native},
20997 which selects the best architecture option for the host processor.
20998 @option{-mcpu=native} has no effect if GCC does not recognize
20999 the processor.
21001 Default instruction scheduling parameters are used for values that select
21002 an architecture and not an implementation.  These are @samp{v7}, @samp{v8},
21003 @samp{sparclite}, @samp{sparclet}, @samp{v9}.
21005 Here is a list of each supported architecture and their supported
21006 implementations.
21008 @table @asis
21009 @item v7
21010 cypress
21012 @item v8
21013 supersparc, hypersparc, leon, leon3
21015 @item sparclite
21016 f930, f934, sparclite86x
21018 @item sparclet
21019 tsc701
21021 @item v9
21022 ultrasparc, ultrasparc3, niagara, niagara2, niagara3, niagara4
21023 @end table
21025 By default (unless configured otherwise), GCC generates code for the V7
21026 variant of the SPARC architecture.  With @option{-mcpu=cypress}, the compiler
21027 additionally optimizes it for the Cypress CY7C602 chip, as used in the
21028 SPARCStation/SPARCServer 3xx series.  This is also appropriate for the older
21029 SPARCStation 1, 2, IPX etc.
21031 With @option{-mcpu=v8}, GCC generates code for the V8 variant of the SPARC
21032 architecture.  The only difference from V7 code is that the compiler emits
21033 the integer multiply and integer divide instructions which exist in SPARC-V8
21034 but not in SPARC-V7.  With @option{-mcpu=supersparc}, the compiler additionally
21035 optimizes it for the SuperSPARC chip, as used in the SPARCStation 10, 1000 and
21036 2000 series.
21038 With @option{-mcpu=sparclite}, GCC generates code for the SPARClite variant of
21039 the SPARC architecture.  This adds the integer multiply, integer divide step
21040 and scan (@code{ffs}) instructions which exist in SPARClite but not in SPARC-V7.
21041 With @option{-mcpu=f930}, the compiler additionally optimizes it for the
21042 Fujitsu MB86930 chip, which is the original SPARClite, with no FPU@.  With
21043 @option{-mcpu=f934}, the compiler additionally optimizes it for the Fujitsu
21044 MB86934 chip, which is the more recent SPARClite with FPU@.
21046 With @option{-mcpu=sparclet}, GCC generates code for the SPARClet variant of
21047 the SPARC architecture.  This adds the integer multiply, multiply/accumulate,
21048 integer divide step and scan (@code{ffs}) instructions which exist in SPARClet
21049 but not in SPARC-V7.  With @option{-mcpu=tsc701}, the compiler additionally
21050 optimizes it for the TEMIC SPARClet chip.
21052 With @option{-mcpu=v9}, GCC generates code for the V9 variant of the SPARC
21053 architecture.  This adds 64-bit integer and floating-point move instructions,
21054 3 additional floating-point condition code registers and conditional move
21055 instructions.  With @option{-mcpu=ultrasparc}, the compiler additionally
21056 optimizes it for the Sun UltraSPARC I/II/IIi chips.  With
21057 @option{-mcpu=ultrasparc3}, the compiler additionally optimizes it for the
21058 Sun UltraSPARC III/III+/IIIi/IIIi+/IV/IV+ chips.  With
21059 @option{-mcpu=niagara}, the compiler additionally optimizes it for
21060 Sun UltraSPARC T1 chips.  With @option{-mcpu=niagara2}, the compiler
21061 additionally optimizes it for Sun UltraSPARC T2 chips. With
21062 @option{-mcpu=niagara3}, the compiler additionally optimizes it for Sun
21063 UltraSPARC T3 chips.  With @option{-mcpu=niagara4}, the compiler
21064 additionally optimizes it for Sun UltraSPARC T4 chips.
21066 @item -mtune=@var{cpu_type}
21067 @opindex mtune
21068 Set the instruction scheduling parameters for machine type
21069 @var{cpu_type}, but do not set the instruction set or register set that the
21070 option @option{-mcpu=@var{cpu_type}} does.
21072 The same values for @option{-mcpu=@var{cpu_type}} can be used for
21073 @option{-mtune=@var{cpu_type}}, but the only useful values are those
21074 that select a particular CPU implementation.  Those are @samp{cypress},
21075 @samp{supersparc}, @samp{hypersparc}, @samp{leon}, @samp{leon3}, @samp{f930},
21076 @samp{f934}, @samp{sparclite86x}, @samp{tsc701}, @samp{ultrasparc},
21077 @samp{ultrasparc3}, @samp{niagara}, @samp{niagara2}, @samp{niagara3} and
21078 @samp{niagara4}.  With native Solaris and GNU/Linux toolchains, @samp{native}
21079 can also be used.
21081 @item -mv8plus
21082 @itemx -mno-v8plus
21083 @opindex mv8plus
21084 @opindex mno-v8plus
21085 With @option{-mv8plus}, GCC generates code for the SPARC-V8+ ABI@.  The
21086 difference from the V8 ABI is that the global and out registers are
21087 considered 64 bits wide.  This is enabled by default on Solaris in 32-bit
21088 mode for all SPARC-V9 processors.
21090 @item -mvis
21091 @itemx -mno-vis
21092 @opindex mvis
21093 @opindex mno-vis
21094 With @option{-mvis}, GCC generates code that takes advantage of the UltraSPARC
21095 Visual Instruction Set extensions.  The default is @option{-mno-vis}.
21097 @item -mvis2
21098 @itemx -mno-vis2
21099 @opindex mvis2
21100 @opindex mno-vis2
21101 With @option{-mvis2}, GCC generates code that takes advantage of
21102 version 2.0 of the UltraSPARC Visual Instruction Set extensions.  The
21103 default is @option{-mvis2} when targeting a cpu that supports such
21104 instructions, such as UltraSPARC-III and later.  Setting @option{-mvis2}
21105 also sets @option{-mvis}.
21107 @item -mvis3
21108 @itemx -mno-vis3
21109 @opindex mvis3
21110 @opindex mno-vis3
21111 With @option{-mvis3}, GCC generates code that takes advantage of
21112 version 3.0 of the UltraSPARC Visual Instruction Set extensions.  The
21113 default is @option{-mvis3} when targeting a cpu that supports such
21114 instructions, such as niagara-3 and later.  Setting @option{-mvis3}
21115 also sets @option{-mvis2} and @option{-mvis}.
21117 @item -mcbcond
21118 @itemx -mno-cbcond
21119 @opindex mcbcond
21120 @opindex mno-cbcond
21121 With @option{-mcbcond}, GCC generates code that takes advantage of
21122 compare-and-branch instructions, as defined in the Sparc Architecture 2011.
21123 The default is @option{-mcbcond} when targeting a cpu that supports such
21124 instructions, such as niagara-4 and later.
21126 @item -mpopc
21127 @itemx -mno-popc
21128 @opindex mpopc
21129 @opindex mno-popc
21130 With @option{-mpopc}, GCC generates code that takes advantage of the UltraSPARC
21131 population count instruction.  The default is @option{-mpopc}
21132 when targeting a cpu that supports such instructions, such as Niagara-2 and
21133 later.
21135 @item -mfmaf
21136 @itemx -mno-fmaf
21137 @opindex mfmaf
21138 @opindex mno-fmaf
21139 With @option{-mfmaf}, GCC generates code that takes advantage of the UltraSPARC
21140 Fused Multiply-Add Floating-point extensions.  The default is @option{-mfmaf}
21141 when targeting a cpu that supports such instructions, such as Niagara-3 and
21142 later.
21144 @item -mfix-at697f
21145 @opindex mfix-at697f
21146 Enable the documented workaround for the single erratum of the Atmel AT697F
21147 processor (which corresponds to erratum #13 of the AT697E processor).
21149 @item -mfix-ut699
21150 @opindex mfix-ut699
21151 Enable the documented workarounds for the floating-point errata and the data
21152 cache nullify errata of the UT699 processor.
21153 @end table
21155 These @samp{-m} options are supported in addition to the above
21156 on SPARC-V9 processors in 64-bit environments:
21158 @table @gcctabopt
21159 @item -m32
21160 @itemx -m64
21161 @opindex m32
21162 @opindex m64
21163 Generate code for a 32-bit or 64-bit environment.
21164 The 32-bit environment sets int, long and pointer to 32 bits.
21165 The 64-bit environment sets int to 32 bits and long and pointer
21166 to 64 bits.
21168 @item -mcmodel=@var{which}
21169 @opindex mcmodel
21170 Set the code model to one of
21172 @table @samp
21173 @item medlow
21174 The Medium/Low code model: 64-bit addresses, programs
21175 must be linked in the low 32 bits of memory.  Programs can be statically
21176 or dynamically linked.
21178 @item medmid
21179 The Medium/Middle code model: 64-bit addresses, programs
21180 must be linked in the low 44 bits of memory, the text and data segments must
21181 be less than 2GB in size and the data segment must be located within 2GB of
21182 the text segment.
21184 @item medany
21185 The Medium/Anywhere code model: 64-bit addresses, programs
21186 may be linked anywhere in memory, the text and data segments must be less
21187 than 2GB in size and the data segment must be located within 2GB of the
21188 text segment.
21190 @item embmedany
21191 The Medium/Anywhere code model for embedded systems:
21192 64-bit addresses, the text and data segments must be less than 2GB in
21193 size, both starting anywhere in memory (determined at link time).  The
21194 global register %g4 points to the base of the data segment.  Programs
21195 are statically linked and PIC is not supported.
21196 @end table
21198 @item -mmemory-model=@var{mem-model}
21199 @opindex mmemory-model
21200 Set the memory model in force on the processor to one of
21202 @table @samp
21203 @item default
21204 The default memory model for the processor and operating system.
21206 @item rmo
21207 Relaxed Memory Order
21209 @item pso
21210 Partial Store Order
21212 @item tso
21213 Total Store Order
21215 @item sc
21216 Sequential Consistency
21217 @end table
21219 These memory models are formally defined in Appendix D of the Sparc V9
21220 architecture manual, as set in the processor's @code{PSTATE.MM} field.
21222 @item -mstack-bias
21223 @itemx -mno-stack-bias
21224 @opindex mstack-bias
21225 @opindex mno-stack-bias
21226 With @option{-mstack-bias}, GCC assumes that the stack pointer, and
21227 frame pointer if present, are offset by @minus{}2047 which must be added back
21228 when making stack frame references.  This is the default in 64-bit mode.
21229 Otherwise, assume no such offset is present.
21230 @end table
21232 @node SPU Options
21233 @subsection SPU Options
21234 @cindex SPU options
21236 These @samp{-m} options are supported on the SPU:
21238 @table @gcctabopt
21239 @item -mwarn-reloc
21240 @itemx -merror-reloc
21241 @opindex mwarn-reloc
21242 @opindex merror-reloc
21244 The loader for SPU does not handle dynamic relocations.  By default, GCC
21245 gives an error when it generates code that requires a dynamic
21246 relocation.  @option{-mno-error-reloc} disables the error,
21247 @option{-mwarn-reloc} generates a warning instead.
21249 @item -msafe-dma
21250 @itemx -munsafe-dma
21251 @opindex msafe-dma
21252 @opindex munsafe-dma
21254 Instructions that initiate or test completion of DMA must not be
21255 reordered with respect to loads and stores of the memory that is being
21256 accessed.
21257 With @option{-munsafe-dma} you must use the @code{volatile} keyword to protect
21258 memory accesses, but that can lead to inefficient code in places where the
21259 memory is known to not change.  Rather than mark the memory as volatile,
21260 you can use @option{-msafe-dma} to tell the compiler to treat
21261 the DMA instructions as potentially affecting all memory.  
21263 @item -mbranch-hints
21264 @opindex mbranch-hints
21266 By default, GCC generates a branch hint instruction to avoid
21267 pipeline stalls for always-taken or probably-taken branches.  A hint
21268 is not generated closer than 8 instructions away from its branch.
21269 There is little reason to disable them, except for debugging purposes,
21270 or to make an object a little bit smaller.
21272 @item -msmall-mem
21273 @itemx -mlarge-mem
21274 @opindex msmall-mem
21275 @opindex mlarge-mem
21277 By default, GCC generates code assuming that addresses are never larger
21278 than 18 bits.  With @option{-mlarge-mem} code is generated that assumes
21279 a full 32-bit address.
21281 @item -mstdmain
21282 @opindex mstdmain
21284 By default, GCC links against startup code that assumes the SPU-style
21285 main function interface (which has an unconventional parameter list).
21286 With @option{-mstdmain}, GCC links your program against startup
21287 code that assumes a C99-style interface to @code{main}, including a
21288 local copy of @code{argv} strings.
21290 @item -mfixed-range=@var{register-range}
21291 @opindex mfixed-range
21292 Generate code treating the given register range as fixed registers.
21293 A fixed register is one that the register allocator cannot use.  This is
21294 useful when compiling kernel code.  A register range is specified as
21295 two registers separated by a dash.  Multiple register ranges can be
21296 specified separated by a comma.
21298 @item -mea32
21299 @itemx -mea64
21300 @opindex mea32
21301 @opindex mea64
21302 Compile code assuming that pointers to the PPU address space accessed
21303 via the @code{__ea} named address space qualifier are either 32 or 64
21304 bits wide.  The default is 32 bits.  As this is an ABI-changing option,
21305 all object code in an executable must be compiled with the same setting.
21307 @item -maddress-space-conversion
21308 @itemx -mno-address-space-conversion
21309 @opindex maddress-space-conversion
21310 @opindex mno-address-space-conversion
21311 Allow/disallow treating the @code{__ea} address space as superset
21312 of the generic address space.  This enables explicit type casts
21313 between @code{__ea} and generic pointer as well as implicit
21314 conversions of generic pointers to @code{__ea} pointers.  The
21315 default is to allow address space pointer conversions.
21317 @item -mcache-size=@var{cache-size}
21318 @opindex mcache-size
21319 This option controls the version of libgcc that the compiler links to an
21320 executable and selects a software-managed cache for accessing variables
21321 in the @code{__ea} address space with a particular cache size.  Possible
21322 options for @var{cache-size} are @samp{8}, @samp{16}, @samp{32}, @samp{64}
21323 and @samp{128}.  The default cache size is 64KB.
21325 @item -matomic-updates
21326 @itemx -mno-atomic-updates
21327 @opindex matomic-updates
21328 @opindex mno-atomic-updates
21329 This option controls the version of libgcc that the compiler links to an
21330 executable and selects whether atomic updates to the software-managed
21331 cache of PPU-side variables are used.  If you use atomic updates, changes
21332 to a PPU variable from SPU code using the @code{__ea} named address space
21333 qualifier do not interfere with changes to other PPU variables residing
21334 in the same cache line from PPU code.  If you do not use atomic updates,
21335 such interference may occur; however, writing back cache lines is
21336 more efficient.  The default behavior is to use atomic updates.
21338 @item -mdual-nops
21339 @itemx -mdual-nops=@var{n}
21340 @opindex mdual-nops
21341 By default, GCC inserts nops to increase dual issue when it expects
21342 it to increase performance.  @var{n} can be a value from 0 to 10.  A
21343 smaller @var{n} inserts fewer nops.  10 is the default, 0 is the
21344 same as @option{-mno-dual-nops}.  Disabled with @option{-Os}.
21346 @item -mhint-max-nops=@var{n}
21347 @opindex mhint-max-nops
21348 Maximum number of nops to insert for a branch hint.  A branch hint must
21349 be at least 8 instructions away from the branch it is affecting.  GCC
21350 inserts up to @var{n} nops to enforce this, otherwise it does not
21351 generate the branch hint.
21353 @item -mhint-max-distance=@var{n}
21354 @opindex mhint-max-distance
21355 The encoding of the branch hint instruction limits the hint to be within
21356 256 instructions of the branch it is affecting.  By default, GCC makes
21357 sure it is within 125.
21359 @item -msafe-hints
21360 @opindex msafe-hints
21361 Work around a hardware bug that causes the SPU to stall indefinitely.
21362 By default, GCC inserts the @code{hbrp} instruction to make sure
21363 this stall won't happen.
21365 @end table
21367 @node System V Options
21368 @subsection Options for System V
21370 These additional options are available on System V Release 4 for
21371 compatibility with other compilers on those systems:
21373 @table @gcctabopt
21374 @item -G
21375 @opindex G
21376 Create a shared object.
21377 It is recommended that @option{-symbolic} or @option{-shared} be used instead.
21379 @item -Qy
21380 @opindex Qy
21381 Identify the versions of each tool used by the compiler, in a
21382 @code{.ident} assembler directive in the output.
21384 @item -Qn
21385 @opindex Qn
21386 Refrain from adding @code{.ident} directives to the output file (this is
21387 the default).
21389 @item -YP,@var{dirs}
21390 @opindex YP
21391 Search the directories @var{dirs}, and no others, for libraries
21392 specified with @option{-l}.
21394 @item -Ym,@var{dir}
21395 @opindex Ym
21396 Look in the directory @var{dir} to find the M4 preprocessor.
21397 The assembler uses this option.
21398 @c This is supposed to go with a -Yd for predefined M4 macro files, but
21399 @c the generic assembler that comes with Solaris takes just -Ym.
21400 @end table
21402 @node TILE-Gx Options
21403 @subsection TILE-Gx Options
21404 @cindex TILE-Gx options
21406 These @samp{-m} options are supported on the TILE-Gx:
21408 @table @gcctabopt
21409 @item -mcmodel=small
21410 @opindex mcmodel=small
21411 Generate code for the small model.  The distance for direct calls is
21412 limited to 500M in either direction.  PC-relative addresses are 32
21413 bits.  Absolute addresses support the full address range.
21415 @item -mcmodel=large
21416 @opindex mcmodel=large
21417 Generate code for the large model.  There is no limitation on call
21418 distance, pc-relative addresses, or absolute addresses.
21420 @item -mcpu=@var{name}
21421 @opindex mcpu
21422 Selects the type of CPU to be targeted.  Currently the only supported
21423 type is @samp{tilegx}.
21425 @item -m32
21426 @itemx -m64
21427 @opindex m32
21428 @opindex m64
21429 Generate code for a 32-bit or 64-bit environment.  The 32-bit
21430 environment sets int, long, and pointer to 32 bits.  The 64-bit
21431 environment sets int to 32 bits and long and pointer to 64 bits.
21433 @item -mbig-endian
21434 @itemx -mlittle-endian
21435 @opindex mbig-endian
21436 @opindex mlittle-endian
21437 Generate code in big/little endian mode, respectively.
21438 @end table
21440 @node TILEPro Options
21441 @subsection TILEPro Options
21442 @cindex TILEPro options
21444 These @samp{-m} options are supported on the TILEPro:
21446 @table @gcctabopt
21447 @item -mcpu=@var{name}
21448 @opindex mcpu
21449 Selects the type of CPU to be targeted.  Currently the only supported
21450 type is @samp{tilepro}.
21452 @item -m32
21453 @opindex m32
21454 Generate code for a 32-bit environment, which sets int, long, and
21455 pointer to 32 bits.  This is the only supported behavior so the flag
21456 is essentially ignored.
21457 @end table
21459 @node V850 Options
21460 @subsection V850 Options
21461 @cindex V850 Options
21463 These @samp{-m} options are defined for V850 implementations:
21465 @table @gcctabopt
21466 @item -mlong-calls
21467 @itemx -mno-long-calls
21468 @opindex mlong-calls
21469 @opindex mno-long-calls
21470 Treat all calls as being far away (near).  If calls are assumed to be
21471 far away, the compiler always loads the function's address into a
21472 register, and calls indirect through the pointer.
21474 @item -mno-ep
21475 @itemx -mep
21476 @opindex mno-ep
21477 @opindex mep
21478 Do not optimize (do optimize) basic blocks that use the same index
21479 pointer 4 or more times to copy pointer into the @code{ep} register, and
21480 use the shorter @code{sld} and @code{sst} instructions.  The @option{-mep}
21481 option is on by default if you optimize.
21483 @item -mno-prolog-function
21484 @itemx -mprolog-function
21485 @opindex mno-prolog-function
21486 @opindex mprolog-function
21487 Do not use (do use) external functions to save and restore registers
21488 at the prologue and epilogue of a function.  The external functions
21489 are slower, but use less code space if more than one function saves
21490 the same number of registers.  The @option{-mprolog-function} option
21491 is on by default if you optimize.
21493 @item -mspace
21494 @opindex mspace
21495 Try to make the code as small as possible.  At present, this just turns
21496 on the @option{-mep} and @option{-mprolog-function} options.
21498 @item -mtda=@var{n}
21499 @opindex mtda
21500 Put static or global variables whose size is @var{n} bytes or less into
21501 the tiny data area that register @code{ep} points to.  The tiny data
21502 area can hold up to 256 bytes in total (128 bytes for byte references).
21504 @item -msda=@var{n}
21505 @opindex msda
21506 Put static or global variables whose size is @var{n} bytes or less into
21507 the small data area that register @code{gp} points to.  The small data
21508 area can hold up to 64 kilobytes.
21510 @item -mzda=@var{n}
21511 @opindex mzda
21512 Put static or global variables whose size is @var{n} bytes or less into
21513 the first 32 kilobytes of memory.
21515 @item -mv850
21516 @opindex mv850
21517 Specify that the target processor is the V850.
21519 @item -mv850e3v5
21520 @opindex mv850e3v5
21521 Specify that the target processor is the V850E3V5.  The preprocessor
21522 constant @samp{__v850e3v5__} is defined if this option is used.
21524 @item -mv850e2v4
21525 @opindex mv850e2v4
21526 Specify that the target processor is the V850E3V5.  This is an alias for
21527 the @option{-mv850e3v5} option.
21529 @item -mv850e2v3
21530 @opindex mv850e2v3
21531 Specify that the target processor is the V850E2V3.  The preprocessor
21532 constant @samp{__v850e2v3__} is defined if this option is used.
21534 @item -mv850e2
21535 @opindex mv850e2
21536 Specify that the target processor is the V850E2.  The preprocessor
21537 constant @samp{__v850e2__} is defined if this option is used.
21539 @item -mv850e1
21540 @opindex mv850e1
21541 Specify that the target processor is the V850E1.  The preprocessor
21542 constants @samp{__v850e1__} and @samp{__v850e__} are defined if
21543 this option is used.
21545 @item -mv850es
21546 @opindex mv850es
21547 Specify that the target processor is the V850ES.  This is an alias for
21548 the @option{-mv850e1} option.
21550 @item -mv850e
21551 @opindex mv850e
21552 Specify that the target processor is the V850E@.  The preprocessor
21553 constant @samp{__v850e__} is defined if this option is used.
21555 If neither @option{-mv850} nor @option{-mv850e} nor @option{-mv850e1}
21556 nor @option{-mv850e2} nor @option{-mv850e2v3} nor @option{-mv850e3v5}
21557 are defined then a default target processor is chosen and the
21558 relevant @samp{__v850*__} preprocessor constant is defined.
21560 The preprocessor constants @samp{__v850} and @samp{__v851__} are always
21561 defined, regardless of which processor variant is the target.
21563 @item -mdisable-callt
21564 @itemx -mno-disable-callt
21565 @opindex mdisable-callt
21566 @opindex mno-disable-callt
21567 This option suppresses generation of the @code{CALLT} instruction for the
21568 v850e, v850e1, v850e2, v850e2v3 and v850e3v5 flavors of the v850
21569 architecture.
21571 This option is enabled by default when the RH850 ABI is
21572 in use (see @option{-mrh850-abi}), and disabled by default when the
21573 GCC ABI is in use.  If @code{CALLT} instructions are being generated
21574 then the C preprocessor symbol @code{__V850_CALLT__} will be defined.
21576 @item -mrelax
21577 @itemx -mno-relax
21578 @opindex mrelax
21579 @opindex mno-relax
21580 Pass on (or do not pass on) the @option{-mrelax} command line option
21581 to the assembler.
21583 @item -mlong-jumps
21584 @itemx -mno-long-jumps
21585 @opindex mlong-jumps
21586 @opindex mno-long-jumps
21587 Disable (or re-enable) the generation of PC-relative jump instructions.
21589 @item -msoft-float
21590 @itemx -mhard-float
21591 @opindex msoft-float
21592 @opindex mhard-float
21593 Disable (or re-enable) the generation of hardware floating point
21594 instructions.  This option is only significant when the target
21595 architecture is @samp{V850E2V3} or higher.  If hardware floating point
21596 instructions are being generated then the C preprocessor symbol
21597 @code{__FPU_OK__} will be defined, otherwise the symbol
21598 @code{__NO_FPU__} will be defined.
21600 @item -mloop
21601 @opindex mloop
21602 Enables the use of the e3v5 LOOP instruction.  The use of this
21603 instruction is not enabled by default when the e3v5 architecture is
21604 selected because its use is still experimental.
21606 @item -mrh850-abi
21607 @itemx -mghs
21608 @opindex mrh850-abi
21609 @opindex mghs
21610 Enables support for the RH850 version of the V850 ABI.  This is the
21611 default.  With this version of the ABI the following rules apply:
21613 @itemize
21614 @item
21615 Integer sized structures and unions are returned via a memory pointer
21616 rather than a register.
21618 @item
21619 Large structures and unions (more than 8 bytes in size) are passed by
21620 value.
21622 @item
21623 Functions are aligned to 16-bit boundaries.
21625 @item
21626 The @option{-m8byte-align} command line option is supported.
21628 @item
21629 The @option{-mdisable-callt} command line option is enabled by
21630 default.  The @option{-mno-disable-callt} command line option is not
21631 supported.
21632 @end itemize
21634 When this version of the ABI is enabled the C preprocessor symbol
21635 @code{__V850_RH850_ABI__} is defined.
21637 @item -mgcc-abi
21638 @opindex mgcc-abi
21639 Enables support for the old GCC version of the V850 ABI.  With this
21640 version of the ABI the following rules apply:
21642 @itemize
21643 @item
21644 Integer sized structures and unions are returned in register @code{r10}.
21646 @item
21647 Large structures and unions (more than 8 bytes in size) are passed by
21648 reference.
21650 @item
21651 Functions are aligned to 32-bit boundaries, unless optimizing for
21652 size.
21654 @item
21655 The @option{-m8byte-align} command line option is not supported.
21657 @item
21658 The @option{-mdisable-callt} command line option is supported but not
21659 enabled by default.
21660 @end itemize
21662 When this version of the ABI is enabled the C preprocessor symbol
21663 @code{__V850_GCC_ABI__} is defined.
21665 @item -m8byte-align
21666 @itemx -mno-8byte-align
21667 @opindex m8byte-align
21668 @opindex mno-8byte-align
21669 Enables support for @code{doubles} and @code{long long} types to be
21670 aligned on 8-byte boundaries.  The default is to restrict the
21671 alignment of all objects to at most 4-bytes.  When
21672 @option{-m8byte-align} is in effect the C preprocessor symbol
21673 @code{__V850_8BYTE_ALIGN__} will be defined.
21675 @item -mbig-switch
21676 @opindex mbig-switch
21677 Generate code suitable for big switch tables.  Use this option only if
21678 the assembler/linker complain about out of range branches within a switch
21679 table.
21681 @item -mapp-regs
21682 @opindex mapp-regs
21683 This option causes r2 and r5 to be used in the code generated by
21684 the compiler.  This setting is the default.
21686 @item -mno-app-regs
21687 @opindex mno-app-regs
21688 This option causes r2 and r5 to be treated as fixed registers.
21690 @end table
21692 @node VAX Options
21693 @subsection VAX Options
21694 @cindex VAX options
21696 These @samp{-m} options are defined for the VAX:
21698 @table @gcctabopt
21699 @item -munix
21700 @opindex munix
21701 Do not output certain jump instructions (@code{aobleq} and so on)
21702 that the Unix assembler for the VAX cannot handle across long
21703 ranges.
21705 @item -mgnu
21706 @opindex mgnu
21707 Do output those jump instructions, on the assumption that the
21708 GNU assembler is being used.
21710 @item -mg
21711 @opindex mg
21712 Output code for G-format floating-point numbers instead of D-format.
21713 @end table
21715 @node VMS Options
21716 @subsection VMS Options
21718 These @samp{-m} options are defined for the VMS implementations:
21720 @table @gcctabopt
21721 @item -mvms-return-codes
21722 @opindex mvms-return-codes
21723 Return VMS condition codes from @code{main}. The default is to return POSIX-style
21724 condition (e.g.@ error) codes.
21726 @item -mdebug-main=@var{prefix}
21727 @opindex mdebug-main=@var{prefix}
21728 Flag the first routine whose name starts with @var{prefix} as the main
21729 routine for the debugger.
21731 @item -mmalloc64
21732 @opindex mmalloc64
21733 Default to 64-bit memory allocation routines.
21735 @item -mpointer-size=@var{size}
21736 @opindex -mpointer-size=@var{size}
21737 Set the default size of pointers. Possible options for @var{size} are
21738 @samp{32} or @samp{short} for 32 bit pointers, @samp{64} or @samp{long}
21739 for 64 bit pointers, and @samp{no} for supporting only 32 bit pointers.
21740 The later option disables @code{pragma pointer_size}.
21741 @end table
21743 @node VxWorks Options
21744 @subsection VxWorks Options
21745 @cindex VxWorks Options
21747 The options in this section are defined for all VxWorks targets.
21748 Options specific to the target hardware are listed with the other
21749 options for that target.
21751 @table @gcctabopt
21752 @item -mrtp
21753 @opindex mrtp
21754 GCC can generate code for both VxWorks kernels and real time processes
21755 (RTPs).  This option switches from the former to the latter.  It also
21756 defines the preprocessor macro @code{__RTP__}.
21758 @item -non-static
21759 @opindex non-static
21760 Link an RTP executable against shared libraries rather than static
21761 libraries.  The options @option{-static} and @option{-shared} can
21762 also be used for RTPs (@pxref{Link Options}); @option{-static}
21763 is the default.
21765 @item -Bstatic
21766 @itemx -Bdynamic
21767 @opindex Bstatic
21768 @opindex Bdynamic
21769 These options are passed down to the linker.  They are defined for
21770 compatibility with Diab.
21772 @item -Xbind-lazy
21773 @opindex Xbind-lazy
21774 Enable lazy binding of function calls.  This option is equivalent to
21775 @option{-Wl,-z,now} and is defined for compatibility with Diab.
21777 @item -Xbind-now
21778 @opindex Xbind-now
21779 Disable lazy binding of function calls.  This option is the default and
21780 is defined for compatibility with Diab.
21781 @end table
21783 @node x86-64 Options
21784 @subsection x86-64 Options
21785 @cindex x86-64 options
21787 These are listed under @xref{i386 and x86-64 Options}.
21789 @node Xstormy16 Options
21790 @subsection Xstormy16 Options
21791 @cindex Xstormy16 Options
21793 These options are defined for Xstormy16:
21795 @table @gcctabopt
21796 @item -msim
21797 @opindex msim
21798 Choose startup files and linker script suitable for the simulator.
21799 @end table
21801 @node Xtensa Options
21802 @subsection Xtensa Options
21803 @cindex Xtensa Options
21805 These options are supported for Xtensa targets:
21807 @table @gcctabopt
21808 @item -mconst16
21809 @itemx -mno-const16
21810 @opindex mconst16
21811 @opindex mno-const16
21812 Enable or disable use of @code{CONST16} instructions for loading
21813 constant values.  The @code{CONST16} instruction is currently not a
21814 standard option from Tensilica.  When enabled, @code{CONST16}
21815 instructions are always used in place of the standard @code{L32R}
21816 instructions.  The use of @code{CONST16} is enabled by default only if
21817 the @code{L32R} instruction is not available.
21819 @item -mfused-madd
21820 @itemx -mno-fused-madd
21821 @opindex mfused-madd
21822 @opindex mno-fused-madd
21823 Enable or disable use of fused multiply/add and multiply/subtract
21824 instructions in the floating-point option.  This has no effect if the
21825 floating-point option is not also enabled.  Disabling fused multiply/add
21826 and multiply/subtract instructions forces the compiler to use separate
21827 instructions for the multiply and add/subtract operations.  This may be
21828 desirable in some cases where strict IEEE 754-compliant results are
21829 required: the fused multiply add/subtract instructions do not round the
21830 intermediate result, thereby producing results with @emph{more} bits of
21831 precision than specified by the IEEE standard.  Disabling fused multiply
21832 add/subtract instructions also ensures that the program output is not
21833 sensitive to the compiler's ability to combine multiply and add/subtract
21834 operations.
21836 @item -mserialize-volatile
21837 @itemx -mno-serialize-volatile
21838 @opindex mserialize-volatile
21839 @opindex mno-serialize-volatile
21840 When this option is enabled, GCC inserts @code{MEMW} instructions before
21841 @code{volatile} memory references to guarantee sequential consistency.
21842 The default is @option{-mserialize-volatile}.  Use
21843 @option{-mno-serialize-volatile} to omit the @code{MEMW} instructions.
21845 @item -mforce-no-pic
21846 @opindex mforce-no-pic
21847 For targets, like GNU/Linux, where all user-mode Xtensa code must be
21848 position-independent code (PIC), this option disables PIC for compiling
21849 kernel code.
21851 @item -mtext-section-literals
21852 @itemx -mno-text-section-literals
21853 @opindex mtext-section-literals
21854 @opindex mno-text-section-literals
21855 Control the treatment of literal pools.  The default is
21856 @option{-mno-text-section-literals}, which places literals in a separate
21857 section in the output file.  This allows the literal pool to be placed
21858 in a data RAM/ROM, and it also allows the linker to combine literal
21859 pools from separate object files to remove redundant literals and
21860 improve code size.  With @option{-mtext-section-literals}, the literals
21861 are interspersed in the text section in order to keep them as close as
21862 possible to their references.  This may be necessary for large assembly
21863 files.
21865 @item -mtarget-align
21866 @itemx -mno-target-align
21867 @opindex mtarget-align
21868 @opindex mno-target-align
21869 When this option is enabled, GCC instructs the assembler to
21870 automatically align instructions to reduce branch penalties at the
21871 expense of some code density.  The assembler attempts to widen density
21872 instructions to align branch targets and the instructions following call
21873 instructions.  If there are not enough preceding safe density
21874 instructions to align a target, no widening is performed.  The
21875 default is @option{-mtarget-align}.  These options do not affect the
21876 treatment of auto-aligned instructions like @code{LOOP}, which the
21877 assembler always aligns, either by widening density instructions or
21878 by inserting NOP instructions.
21880 @item -mlongcalls
21881 @itemx -mno-longcalls
21882 @opindex mlongcalls
21883 @opindex mno-longcalls
21884 When this option is enabled, GCC instructs the assembler to translate
21885 direct calls to indirect calls unless it can determine that the target
21886 of a direct call is in the range allowed by the call instruction.  This
21887 translation typically occurs for calls to functions in other source
21888 files.  Specifically, the assembler translates a direct @code{CALL}
21889 instruction into an @code{L32R} followed by a @code{CALLX} instruction.
21890 The default is @option{-mno-longcalls}.  This option should be used in
21891 programs where the call target can potentially be out of range.  This
21892 option is implemented in the assembler, not the compiler, so the
21893 assembly code generated by GCC still shows direct call
21894 instructions---look at the disassembled object code to see the actual
21895 instructions.  Note that the assembler uses an indirect call for
21896 every cross-file call, not just those that really are out of range.
21897 @end table
21899 @node zSeries Options
21900 @subsection zSeries Options
21901 @cindex zSeries options
21903 These are listed under @xref{S/390 and zSeries Options}.
21905 @node Code Gen Options
21906 @section Options for Code Generation Conventions
21907 @cindex code generation conventions
21908 @cindex options, code generation
21909 @cindex run-time options
21911 These machine-independent options control the interface conventions
21912 used in code generation.
21914 Most of them have both positive and negative forms; the negative form
21915 of @option{-ffoo} is @option{-fno-foo}.  In the table below, only
21916 one of the forms is listed---the one that is not the default.  You
21917 can figure out the other form by either removing @samp{no-} or adding
21920 @table @gcctabopt
21921 @item -fbounds-check
21922 @opindex fbounds-check
21923 For front ends that support it, generate additional code to check that
21924 indices used to access arrays are within the declared range.  This is
21925 currently only supported by the Java and Fortran front ends, where
21926 this option defaults to true and false respectively.
21928 @item -fstack-reuse=@var{reuse-level}
21929 @opindex fstack_reuse
21930 This option controls stack space reuse for user declared local/auto variables
21931 and compiler generated temporaries.  @var{reuse_level} can be @samp{all},
21932 @samp{named_vars}, or @samp{none}. @samp{all} enables stack reuse for all
21933 local variables and temporaries, @samp{named_vars} enables the reuse only for
21934 user defined local variables with names, and @samp{none} disables stack reuse
21935 completely. The default value is @samp{all}. The option is needed when the
21936 program extends the lifetime of a scoped local variable or a compiler generated
21937 temporary beyond the end point defined by the language.  When a lifetime of
21938 a variable ends, and if the variable lives in memory, the optimizing compiler
21939 has the freedom to reuse its stack space with other temporaries or scoped
21940 local variables whose live range does not overlap with it. Legacy code extending
21941 local lifetime will likely to break with the stack reuse optimization.
21943 For example,
21945 @smallexample
21946    int *p;
21947    @{
21948      int local1;
21950      p = &local1;
21951      local1 = 10;
21952      ....
21953    @}
21954    @{
21955       int local2;
21956       local2 = 20;
21957       ...
21958    @}
21960    if (*p == 10)  // out of scope use of local1
21961      @{
21963      @}
21964 @end smallexample
21966 Another example:
21967 @smallexample
21969    struct A
21970    @{
21971        A(int k) : i(k), j(k) @{ @}
21972        int i;
21973        int j;
21974    @};
21976    A *ap;
21978    void foo(const A& ar)
21979    @{
21980       ap = &ar;
21981    @}
21983    void bar()
21984    @{
21985       foo(A(10)); // temp object's lifetime ends when foo returns
21987       @{
21988         A a(20);
21989         ....
21990       @}
21991       ap->i+= 10;  // ap references out of scope temp whose space
21992                    // is reused with a. What is the value of ap->i?
21993    @}
21995 @end smallexample
21997 The lifetime of a compiler generated temporary is well defined by the C++
21998 standard. When a lifetime of a temporary ends, and if the temporary lives
21999 in memory, the optimizing compiler has the freedom to reuse its stack
22000 space with other temporaries or scoped local variables whose live range
22001 does not overlap with it. However some of the legacy code relies on
22002 the behavior of older compilers in which temporaries' stack space is
22003 not reused, the aggressive stack reuse can lead to runtime errors. This
22004 option is used to control the temporary stack reuse optimization.
22006 @item -ftrapv
22007 @opindex ftrapv
22008 This option generates traps for signed overflow on addition, subtraction,
22009 multiplication operations.
22011 @item -fwrapv
22012 @opindex fwrapv
22013 This option instructs the compiler to assume that signed arithmetic
22014 overflow of addition, subtraction and multiplication wraps around
22015 using twos-complement representation.  This flag enables some optimizations
22016 and disables others.  This option is enabled by default for the Java
22017 front end, as required by the Java language specification.
22019 @item -fexceptions
22020 @opindex fexceptions
22021 Enable exception handling.  Generates extra code needed to propagate
22022 exceptions.  For some targets, this implies GCC generates frame
22023 unwind information for all functions, which can produce significant data
22024 size overhead, although it does not affect execution.  If you do not
22025 specify this option, GCC enables it by default for languages like
22026 C++ that normally require exception handling, and disables it for
22027 languages like C that do not normally require it.  However, you may need
22028 to enable this option when compiling C code that needs to interoperate
22029 properly with exception handlers written in C++.  You may also wish to
22030 disable this option if you are compiling older C++ programs that don't
22031 use exception handling.
22033 @item -fnon-call-exceptions
22034 @opindex fnon-call-exceptions
22035 Generate code that allows trapping instructions to throw exceptions.
22036 Note that this requires platform-specific runtime support that does
22037 not exist everywhere.  Moreover, it only allows @emph{trapping}
22038 instructions to throw exceptions, i.e.@: memory references or floating-point
22039 instructions.  It does not allow exceptions to be thrown from
22040 arbitrary signal handlers such as @code{SIGALRM}.
22042 @item -fdelete-dead-exceptions
22043 @opindex fdelete-dead-exceptions
22044 Consider that instructions that may throw exceptions but don't otherwise
22045 contribute to the execution of the program can be optimized away.
22046 This option is enabled by default for the Ada front end, as permitted by
22047 the Ada language specification.
22048 Optimization passes that cause dead exceptions to be removed are enabled independently at different optimization levels.
22050 @item -funwind-tables
22051 @opindex funwind-tables
22052 Similar to @option{-fexceptions}, except that it just generates any needed
22053 static data, but does not affect the generated code in any other way.
22054 You normally do not need to enable this option; instead, a language processor
22055 that needs this handling enables it on your behalf.
22057 @item -fasynchronous-unwind-tables
22058 @opindex fasynchronous-unwind-tables
22059 Generate unwind table in DWARF 2 format, if supported by target machine.  The
22060 table is exact at each instruction boundary, so it can be used for stack
22061 unwinding from asynchronous events (such as debugger or garbage collector).
22063 @item -fno-gnu-unique
22064 @opindex fno-gnu-unique
22065 On systems with recent GNU assembler and C library, the C++ compiler
22066 uses the @code{STB_GNU_UNIQUE} binding to make sure that definitions
22067 of template static data members and static local variables in inline
22068 functions are unique even in the presence of @code{RTLD_LOCAL}; this
22069 is necessary to avoid problems with a library used by two different
22070 @code{RTLD_LOCAL} plugins depending on a definition in one of them and
22071 therefore disagreeing with the other one about the binding of the
22072 symbol.  But this causes @code{dlclose} to be ignored for affected
22073 DSOs; if your program relies on reinitialization of a DSO via
22074 @code{dlclose} and @code{dlopen}, you can use
22075 @option{-fno-gnu-unique}.
22077 @item -fpcc-struct-return
22078 @opindex fpcc-struct-return
22079 Return ``short'' @code{struct} and @code{union} values in memory like
22080 longer ones, rather than in registers.  This convention is less
22081 efficient, but it has the advantage of allowing intercallability between
22082 GCC-compiled files and files compiled with other compilers, particularly
22083 the Portable C Compiler (pcc).
22085 The precise convention for returning structures in memory depends
22086 on the target configuration macros.
22088 Short structures and unions are those whose size and alignment match
22089 that of some integer type.
22091 @strong{Warning:} code compiled with the @option{-fpcc-struct-return}
22092 switch is not binary compatible with code compiled with the
22093 @option{-freg-struct-return} switch.
22094 Use it to conform to a non-default application binary interface.
22096 @item -freg-struct-return
22097 @opindex freg-struct-return
22098 Return @code{struct} and @code{union} values in registers when possible.
22099 This is more efficient for small structures than
22100 @option{-fpcc-struct-return}.
22102 If you specify neither @option{-fpcc-struct-return} nor
22103 @option{-freg-struct-return}, GCC defaults to whichever convention is
22104 standard for the target.  If there is no standard convention, GCC
22105 defaults to @option{-fpcc-struct-return}, except on targets where GCC is
22106 the principal compiler.  In those cases, we can choose the standard, and
22107 we chose the more efficient register return alternative.
22109 @strong{Warning:} code compiled with the @option{-freg-struct-return}
22110 switch is not binary compatible with code compiled with the
22111 @option{-fpcc-struct-return} switch.
22112 Use it to conform to a non-default application binary interface.
22114 @item -fshort-enums
22115 @opindex fshort-enums
22116 Allocate to an @code{enum} type only as many bytes as it needs for the
22117 declared range of possible values.  Specifically, the @code{enum} type
22118 is equivalent to the smallest integer type that has enough room.
22120 @strong{Warning:} the @option{-fshort-enums} switch causes GCC to generate
22121 code that is not binary compatible with code generated without that switch.
22122 Use it to conform to a non-default application binary interface.
22124 @item -fshort-double
22125 @opindex fshort-double
22126 Use the same size for @code{double} as for @code{float}.
22128 @strong{Warning:} the @option{-fshort-double} switch causes GCC to generate
22129 code that is not binary compatible with code generated without that switch.
22130 Use it to conform to a non-default application binary interface.
22132 @item -fshort-wchar
22133 @opindex fshort-wchar
22134 Override the underlying type for @samp{wchar_t} to be @samp{short
22135 unsigned int} instead of the default for the target.  This option is
22136 useful for building programs to run under WINE@.
22138 @strong{Warning:} the @option{-fshort-wchar} switch causes GCC to generate
22139 code that is not binary compatible with code generated without that switch.
22140 Use it to conform to a non-default application binary interface.
22142 @item -fno-common
22143 @opindex fno-common
22144 In C code, controls the placement of uninitialized global variables.
22145 Unix C compilers have traditionally permitted multiple definitions of
22146 such variables in different compilation units by placing the variables
22147 in a common block.
22148 This is the behavior specified by @option{-fcommon}, and is the default
22149 for GCC on most targets.
22150 On the other hand, this behavior is not required by ISO C, and on some
22151 targets may carry a speed or code size penalty on variable references.
22152 The @option{-fno-common} option specifies that the compiler should place
22153 uninitialized global variables in the data section of the object file,
22154 rather than generating them as common blocks.
22155 This has the effect that if the same variable is declared
22156 (without @code{extern}) in two different compilations,
22157 you get a multiple-definition error when you link them.
22158 In this case, you must compile with @option{-fcommon} instead.
22159 Compiling with @option{-fno-common} is useful on targets for which
22160 it provides better performance, or if you wish to verify that the
22161 program will work on other systems that always treat uninitialized
22162 variable declarations this way.
22164 @item -fno-ident
22165 @opindex fno-ident
22166 Ignore the @samp{#ident} directive.
22168 @item -finhibit-size-directive
22169 @opindex finhibit-size-directive
22170 Don't output a @code{.size} assembler directive, or anything else that
22171 would cause trouble if the function is split in the middle, and the
22172 two halves are placed at locations far apart in memory.  This option is
22173 used when compiling @file{crtstuff.c}; you should not need to use it
22174 for anything else.
22176 @item -fverbose-asm
22177 @opindex fverbose-asm
22178 Put extra commentary information in the generated assembly code to
22179 make it more readable.  This option is generally only of use to those
22180 who actually need to read the generated assembly code (perhaps while
22181 debugging the compiler itself).
22183 @option{-fno-verbose-asm}, the default, causes the
22184 extra information to be omitted and is useful when comparing two assembler
22185 files.
22187 @item -frecord-gcc-switches
22188 @opindex frecord-gcc-switches
22189 This switch causes the command line used to invoke the
22190 compiler to be recorded into the object file that is being created.
22191 This switch is only implemented on some targets and the exact format
22192 of the recording is target and binary file format dependent, but it
22193 usually takes the form of a section containing ASCII text.  This
22194 switch is related to the @option{-fverbose-asm} switch, but that
22195 switch only records information in the assembler output file as
22196 comments, so it never reaches the object file.
22197 See also @option{-grecord-gcc-switches} for another
22198 way of storing compiler options into the object file.
22200 @item -fpic
22201 @opindex fpic
22202 @cindex global offset table
22203 @cindex PIC
22204 Generate position-independent code (PIC) suitable for use in a shared
22205 library, if supported for the target machine.  Such code accesses all
22206 constant addresses through a global offset table (GOT)@.  The dynamic
22207 loader resolves the GOT entries when the program starts (the dynamic
22208 loader is not part of GCC; it is part of the operating system).  If
22209 the GOT size for the linked executable exceeds a machine-specific
22210 maximum size, you get an error message from the linker indicating that
22211 @option{-fpic} does not work; in that case, recompile with @option{-fPIC}
22212 instead.  (These maximums are 8k on the SPARC and 32k
22213 on the m68k and RS/6000.  The 386 has no such limit.)
22215 Position-independent code requires special support, and therefore works
22216 only on certain machines.  For the 386, GCC supports PIC for System V
22217 but not for the Sun 386i.  Code generated for the IBM RS/6000 is always
22218 position-independent.
22220 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22221 are defined to 1.
22223 @item -fPIC
22224 @opindex fPIC
22225 If supported for the target machine, emit position-independent code,
22226 suitable for dynamic linking and avoiding any limit on the size of the
22227 global offset table.  This option makes a difference on the m68k,
22228 PowerPC and SPARC@.
22230 Position-independent code requires special support, and therefore works
22231 only on certain machines.
22233 When this flag is set, the macros @code{__pic__} and @code{__PIC__}
22234 are defined to 2.
22236 @item -fpie
22237 @itemx -fPIE
22238 @opindex fpie
22239 @opindex fPIE
22240 These options are similar to @option{-fpic} and @option{-fPIC}, but
22241 generated position independent code can be only linked into executables.
22242 Usually these options are used when @option{-pie} GCC option is
22243 used during linking.
22245 @option{-fpie} and @option{-fPIE} both define the macros
22246 @code{__pie__} and @code{__PIE__}.  The macros have the value 1
22247 for @option{-fpie} and 2 for @option{-fPIE}.
22249 @item -fno-jump-tables
22250 @opindex fno-jump-tables
22251 Do not use jump tables for switch statements even where it would be
22252 more efficient than other code generation strategies.  This option is
22253 of use in conjunction with @option{-fpic} or @option{-fPIC} for
22254 building code that forms part of a dynamic linker and cannot
22255 reference the address of a jump table.  On some targets, jump tables
22256 do not require a GOT and this option is not needed.
22258 @item -ffixed-@var{reg}
22259 @opindex ffixed
22260 Treat the register named @var{reg} as a fixed register; generated code
22261 should never refer to it (except perhaps as a stack pointer, frame
22262 pointer or in some other fixed role).
22264 @var{reg} must be the name of a register.  The register names accepted
22265 are machine-specific and are defined in the @code{REGISTER_NAMES}
22266 macro in the machine description macro file.
22268 This flag does not have a negative form, because it specifies a
22269 three-way choice.
22271 @item -fcall-used-@var{reg}
22272 @opindex fcall-used
22273 Treat the register named @var{reg} as an allocable register that is
22274 clobbered by function calls.  It may be allocated for temporaries or
22275 variables that do not live across a call.  Functions compiled this way
22276 do not save and restore the register @var{reg}.
22278 It is an error to use this flag with the frame pointer or stack pointer.
22279 Use of this flag for other registers that have fixed pervasive roles in
22280 the machine's execution model produces disastrous results.
22282 This flag does not have a negative form, because it specifies a
22283 three-way choice.
22285 @item -fcall-saved-@var{reg}
22286 @opindex fcall-saved
22287 Treat the register named @var{reg} as an allocable register saved by
22288 functions.  It may be allocated even for temporaries or variables that
22289 live across a call.  Functions compiled this way save and restore
22290 the register @var{reg} if they use it.
22292 It is an error to use this flag with the frame pointer or stack pointer.
22293 Use of this flag for other registers that have fixed pervasive roles in
22294 the machine's execution model produces disastrous results.
22296 A different sort of disaster results from the use of this flag for
22297 a register in which function values may be returned.
22299 This flag does not have a negative form, because it specifies a
22300 three-way choice.
22302 @item -fpack-struct[=@var{n}]
22303 @opindex fpack-struct
22304 Without a value specified, pack all structure members together without
22305 holes.  When a value is specified (which must be a small power of two), pack
22306 structure members according to this value, representing the maximum
22307 alignment (that is, objects with default alignment requirements larger than
22308 this are output potentially unaligned at the next fitting location.
22310 @strong{Warning:} the @option{-fpack-struct} switch causes GCC to generate
22311 code that is not binary compatible with code generated without that switch.
22312 Additionally, it makes the code suboptimal.
22313 Use it to conform to a non-default application binary interface.
22315 @item -finstrument-functions
22316 @opindex finstrument-functions
22317 Generate instrumentation calls for entry and exit to functions.  Just
22318 after function entry and just before function exit, the following
22319 profiling functions are called with the address of the current
22320 function and its call site.  (On some platforms,
22321 @code{__builtin_return_address} does not work beyond the current
22322 function, so the call site information may not be available to the
22323 profiling functions otherwise.)
22325 @smallexample
22326 void __cyg_profile_func_enter (void *this_fn,
22327                                void *call_site);
22328 void __cyg_profile_func_exit  (void *this_fn,
22329                                void *call_site);
22330 @end smallexample
22332 The first argument is the address of the start of the current function,
22333 which may be looked up exactly in the symbol table.
22335 This instrumentation is also done for functions expanded inline in other
22336 functions.  The profiling calls indicate where, conceptually, the
22337 inline function is entered and exited.  This means that addressable
22338 versions of such functions must be available.  If all your uses of a
22339 function are expanded inline, this may mean an additional expansion of
22340 code size.  If you use @samp{extern inline} in your C code, an
22341 addressable version of such functions must be provided.  (This is
22342 normally the case anyway, but if you get lucky and the optimizer always
22343 expands the functions inline, you might have gotten away without
22344 providing static copies.)
22346 A function may be given the attribute @code{no_instrument_function}, in
22347 which case this instrumentation is not done.  This can be used, for
22348 example, for the profiling functions listed above, high-priority
22349 interrupt routines, and any functions from which the profiling functions
22350 cannot safely be called (perhaps signal handlers, if the profiling
22351 routines generate output or allocate memory).
22353 @item -finstrument-functions-exclude-file-list=@var{file},@var{file},@dots{}
22354 @opindex finstrument-functions-exclude-file-list
22356 Set the list of functions that are excluded from instrumentation (see
22357 the description of @code{-finstrument-functions}).  If the file that
22358 contains a function definition matches with one of @var{file}, then
22359 that function is not instrumented.  The match is done on substrings:
22360 if the @var{file} parameter is a substring of the file name, it is
22361 considered to be a match.
22363 For example:
22365 @smallexample
22366 -finstrument-functions-exclude-file-list=/bits/stl,include/sys
22367 @end smallexample
22369 @noindent
22370 excludes any inline function defined in files whose pathnames
22371 contain @code{/bits/stl} or @code{include/sys}.
22373 If, for some reason, you want to include letter @code{','} in one of
22374 @var{sym}, write @code{'\,'}. For example,
22375 @code{-finstrument-functions-exclude-file-list='\,\,tmp'}
22376 (note the single quote surrounding the option).
22378 @item -finstrument-functions-exclude-function-list=@var{sym},@var{sym},@dots{}
22379 @opindex finstrument-functions-exclude-function-list
22381 This is similar to @code{-finstrument-functions-exclude-file-list},
22382 but this option sets the list of function names to be excluded from
22383 instrumentation.  The function name to be matched is its user-visible
22384 name, such as @code{vector<int> blah(const vector<int> &)}, not the
22385 internal mangled name (e.g., @code{_Z4blahRSt6vectorIiSaIiEE}).  The
22386 match is done on substrings: if the @var{sym} parameter is a substring
22387 of the function name, it is considered to be a match.  For C99 and C++
22388 extended identifiers, the function name must be given in UTF-8, not
22389 using universal character names.
22391 @item -fstack-check
22392 @opindex fstack-check
22393 Generate code to verify that you do not go beyond the boundary of the
22394 stack.  You should specify this flag if you are running in an
22395 environment with multiple threads, but you only rarely need to specify it in
22396 a single-threaded environment since stack overflow is automatically
22397 detected on nearly all systems if there is only one stack.
22399 Note that this switch does not actually cause checking to be done; the
22400 operating system or the language runtime must do that.  The switch causes
22401 generation of code to ensure that they see the stack being extended.
22403 You can additionally specify a string parameter: @code{no} means no
22404 checking, @code{generic} means force the use of old-style checking,
22405 @code{specific} means use the best checking method and is equivalent
22406 to bare @option{-fstack-check}.
22408 Old-style checking is a generic mechanism that requires no specific
22409 target support in the compiler but comes with the following drawbacks:
22411 @enumerate
22412 @item
22413 Modified allocation strategy for large objects: they are always
22414 allocated dynamically if their size exceeds a fixed threshold.
22416 @item
22417 Fixed limit on the size of the static frame of functions: when it is
22418 topped by a particular function, stack checking is not reliable and
22419 a warning is issued by the compiler.
22421 @item
22422 Inefficiency: because of both the modified allocation strategy and the
22423 generic implementation, code performance is hampered.
22424 @end enumerate
22426 Note that old-style stack checking is also the fallback method for
22427 @code{specific} if no target support has been added in the compiler.
22429 @item -fstack-limit-register=@var{reg}
22430 @itemx -fstack-limit-symbol=@var{sym}
22431 @itemx -fno-stack-limit
22432 @opindex fstack-limit-register
22433 @opindex fstack-limit-symbol
22434 @opindex fno-stack-limit
22435 Generate code to ensure that the stack does not grow beyond a certain value,
22436 either the value of a register or the address of a symbol.  If a larger
22437 stack is required, a signal is raised at run time.  For most targets,
22438 the signal is raised before the stack overruns the boundary, so
22439 it is possible to catch the signal without taking special precautions.
22441 For instance, if the stack starts at absolute address @samp{0x80000000}
22442 and grows downwards, you can use the flags
22443 @option{-fstack-limit-symbol=__stack_limit} and
22444 @option{-Wl,--defsym,__stack_limit=0x7ffe0000} to enforce a stack limit
22445 of 128KB@.  Note that this may only work with the GNU linker.
22447 @item -fsplit-stack
22448 @opindex fsplit-stack
22449 Generate code to automatically split the stack before it overflows.
22450 The resulting program has a discontiguous stack which can only
22451 overflow if the program is unable to allocate any more memory.  This
22452 is most useful when running threaded programs, as it is no longer
22453 necessary to calculate a good stack size to use for each thread.  This
22454 is currently only implemented for the i386 and x86_64 back ends running
22455 GNU/Linux.
22457 When code compiled with @option{-fsplit-stack} calls code compiled
22458 without @option{-fsplit-stack}, there may not be much stack space
22459 available for the latter code to run.  If compiling all code,
22460 including library code, with @option{-fsplit-stack} is not an option,
22461 then the linker can fix up these calls so that the code compiled
22462 without @option{-fsplit-stack} always has a large stack.  Support for
22463 this is implemented in the gold linker in GNU binutils release 2.21
22464 and later.
22466 @item -fleading-underscore
22467 @opindex fleading-underscore
22468 This option and its counterpart, @option{-fno-leading-underscore}, forcibly
22469 change the way C symbols are represented in the object file.  One use
22470 is to help link with legacy assembly code.
22472 @strong{Warning:} the @option{-fleading-underscore} switch causes GCC to
22473 generate code that is not binary compatible with code generated without that
22474 switch.  Use it to conform to a non-default application binary interface.
22475 Not all targets provide complete support for this switch.
22477 @item -ftls-model=@var{model}
22478 @opindex ftls-model
22479 Alter the thread-local storage model to be used (@pxref{Thread-Local}).
22480 The @var{model} argument should be one of @code{global-dynamic},
22481 @code{local-dynamic}, @code{initial-exec} or @code{local-exec}.
22482 Note that the choice is subject to optimization: the compiler may use
22483 a more efficient model for symbols not visible outside of the translation
22484 unit, or if @option{-fpic} is not given on the command line.
22486 The default without @option{-fpic} is @code{initial-exec}; with
22487 @option{-fpic} the default is @code{global-dynamic}.
22489 @item -fvisibility=@var{default|internal|hidden|protected}
22490 @opindex fvisibility
22491 Set the default ELF image symbol visibility to the specified option---all
22492 symbols are marked with this unless overridden within the code.
22493 Using this feature can very substantially improve linking and
22494 load times of shared object libraries, produce more optimized
22495 code, provide near-perfect API export and prevent symbol clashes.
22496 It is @strong{strongly} recommended that you use this in any shared objects
22497 you distribute.
22499 Despite the nomenclature, @code{default} always means public; i.e.,
22500 available to be linked against from outside the shared object.
22501 @code{protected} and @code{internal} are pretty useless in real-world
22502 usage so the only other commonly used option is @code{hidden}.
22503 The default if @option{-fvisibility} isn't specified is
22504 @code{default}, i.e., make every
22505 symbol public---this causes the same behavior as previous versions of
22506 GCC@.
22508 A good explanation of the benefits offered by ensuring ELF
22509 symbols have the correct visibility is given by ``How To Write
22510 Shared Libraries'' by Ulrich Drepper (which can be found at
22511 @w{@uref{http://people.redhat.com/~drepper/}})---however a superior
22512 solution made possible by this option to marking things hidden when
22513 the default is public is to make the default hidden and mark things
22514 public.  This is the norm with DLLs on Windows and with @option{-fvisibility=hidden}
22515 and @code{__attribute__ ((visibility("default")))} instead of
22516 @code{__declspec(dllexport)} you get almost identical semantics with
22517 identical syntax.  This is a great boon to those working with
22518 cross-platform projects.
22520 For those adding visibility support to existing code, you may find
22521 @samp{#pragma GCC visibility} of use.  This works by you enclosing
22522 the declarations you wish to set visibility for with (for example)
22523 @samp{#pragma GCC visibility push(hidden)} and
22524 @samp{#pragma GCC visibility pop}.
22525 Bear in mind that symbol visibility should be viewed @strong{as
22526 part of the API interface contract} and thus all new code should
22527 always specify visibility when it is not the default; i.e., declarations
22528 only for use within the local DSO should @strong{always} be marked explicitly
22529 as hidden as so to avoid PLT indirection overheads---making this
22530 abundantly clear also aids readability and self-documentation of the code.
22531 Note that due to ISO C++ specification requirements, @code{operator new} and
22532 @code{operator delete} must always be of default visibility.
22534 Be aware that headers from outside your project, in particular system
22535 headers and headers from any other library you use, may not be
22536 expecting to be compiled with visibility other than the default.  You
22537 may need to explicitly say @samp{#pragma GCC visibility push(default)}
22538 before including any such headers.
22540 @samp{extern} declarations are not affected by @option{-fvisibility}, so
22541 a lot of code can be recompiled with @option{-fvisibility=hidden} with
22542 no modifications.  However, this means that calls to @code{extern}
22543 functions with no explicit visibility use the PLT, so it is more
22544 effective to use @code{__attribute ((visibility))} and/or
22545 @code{#pragma GCC visibility} to tell the compiler which @code{extern}
22546 declarations should be treated as hidden.
22548 Note that @option{-fvisibility} does affect C++ vague linkage
22549 entities. This means that, for instance, an exception class that is
22550 be thrown between DSOs must be explicitly marked with default
22551 visibility so that the @samp{type_info} nodes are unified between
22552 the DSOs.
22554 An overview of these techniques, their benefits and how to use them
22555 is at @uref{http://gcc.gnu.org/@/wiki/@/Visibility}.
22557 @item -fstrict-volatile-bitfields
22558 @opindex fstrict-volatile-bitfields
22559 This option should be used if accesses to volatile bit-fields (or other
22560 structure fields, although the compiler usually honors those types
22561 anyway) should use a single access of the width of the
22562 field's type, aligned to a natural alignment if possible.  For
22563 example, targets with memory-mapped peripheral registers might require
22564 all such accesses to be 16 bits wide; with this flag you can
22565 declare all peripheral bit-fields as @code{unsigned short} (assuming short
22566 is 16 bits on these targets) to force GCC to use 16-bit accesses
22567 instead of, perhaps, a more efficient 32-bit access.
22569 If this option is disabled, the compiler uses the most efficient
22570 instruction.  In the previous example, that might be a 32-bit load
22571 instruction, even though that accesses bytes that do not contain
22572 any portion of the bit-field, or memory-mapped registers unrelated to
22573 the one being updated.
22575 In some cases, such as when the @code{packed} attribute is applied to a 
22576 structure field, it may not be possible to access the field with a single
22577 read or write that is correctly aligned for the target machine.  In this
22578 case GCC falls back to generating multiple accesses rather than code that 
22579 will fault or truncate the result at run time.
22581 Note:  Due to restrictions of the C/C++11 memory model, write accesses are
22582 not allowed to touch non bit-field members.  It is therefore recommended
22583 to define all bits of the field's type as bit-field members.
22585 The default value of this option is determined by the application binary
22586 interface for the target processor.
22588 @item -fsync-libcalls
22589 @opindex fsync-libcalls
22590 This option controls whether any out-of-line instance of the @code{__sync}
22591 family of functions may be used to implement the C++11 @code{__atomic}
22592 family of functions.
22594 The default value of this option is enabled, thus the only useful form
22595 of the option is @option{-fno-sync-libcalls}.  This option is used in
22596 the implementation of the @file{libatomic} runtime library.
22598 @end table
22600 @c man end
22602 @node Environment Variables
22603 @section Environment Variables Affecting GCC
22604 @cindex environment variables
22606 @c man begin ENVIRONMENT
22607 This section describes several environment variables that affect how GCC
22608 operates.  Some of them work by specifying directories or prefixes to use
22609 when searching for various kinds of files.  Some are used to specify other
22610 aspects of the compilation environment.
22612 Note that you can also specify places to search using options such as
22613 @option{-B}, @option{-I} and @option{-L} (@pxref{Directory Options}).  These
22614 take precedence over places specified using environment variables, which
22615 in turn take precedence over those specified by the configuration of GCC@.
22616 @xref{Driver,, Controlling the Compilation Driver @file{gcc}, gccint,
22617 GNU Compiler Collection (GCC) Internals}.
22619 @table @env
22620 @item LANG
22621 @itemx LC_CTYPE
22622 @c @itemx LC_COLLATE
22623 @itemx LC_MESSAGES
22624 @c @itemx LC_MONETARY
22625 @c @itemx LC_NUMERIC
22626 @c @itemx LC_TIME
22627 @itemx LC_ALL
22628 @findex LANG
22629 @findex LC_CTYPE
22630 @c @findex LC_COLLATE
22631 @findex LC_MESSAGES
22632 @c @findex LC_MONETARY
22633 @c @findex LC_NUMERIC
22634 @c @findex LC_TIME
22635 @findex LC_ALL
22636 @cindex locale
22637 These environment variables control the way that GCC uses
22638 localization information which allows GCC to work with different
22639 national conventions.  GCC inspects the locale categories
22640 @env{LC_CTYPE} and @env{LC_MESSAGES} if it has been configured to do
22641 so.  These locale categories can be set to any value supported by your
22642 installation.  A typical value is @samp{en_GB.UTF-8} for English in the United
22643 Kingdom encoded in UTF-8.
22645 The @env{LC_CTYPE} environment variable specifies character
22646 classification.  GCC uses it to determine the character boundaries in
22647 a string; this is needed for some multibyte encodings that contain quote
22648 and escape characters that are otherwise interpreted as a string
22649 end or escape.
22651 The @env{LC_MESSAGES} environment variable specifies the language to
22652 use in diagnostic messages.
22654 If the @env{LC_ALL} environment variable is set, it overrides the value
22655 of @env{LC_CTYPE} and @env{LC_MESSAGES}; otherwise, @env{LC_CTYPE}
22656 and @env{LC_MESSAGES} default to the value of the @env{LANG}
22657 environment variable.  If none of these variables are set, GCC
22658 defaults to traditional C English behavior.
22660 @item TMPDIR
22661 @findex TMPDIR
22662 If @env{TMPDIR} is set, it specifies the directory to use for temporary
22663 files.  GCC uses temporary files to hold the output of one stage of
22664 compilation which is to be used as input to the next stage: for example,
22665 the output of the preprocessor, which is the input to the compiler
22666 proper.
22668 @item GCC_COMPARE_DEBUG
22669 @findex GCC_COMPARE_DEBUG
22670 Setting @env{GCC_COMPARE_DEBUG} is nearly equivalent to passing
22671 @option{-fcompare-debug} to the compiler driver.  See the documentation
22672 of this option for more details.
22674 @item GCC_EXEC_PREFIX
22675 @findex GCC_EXEC_PREFIX
22676 If @env{GCC_EXEC_PREFIX} is set, it specifies a prefix to use in the
22677 names of the subprograms executed by the compiler.  No slash is added
22678 when this prefix is combined with the name of a subprogram, but you can
22679 specify a prefix that ends with a slash if you wish.
22681 If @env{GCC_EXEC_PREFIX} is not set, GCC attempts to figure out
22682 an appropriate prefix to use based on the pathname it is invoked with.
22684 If GCC cannot find the subprogram using the specified prefix, it
22685 tries looking in the usual places for the subprogram.
22687 The default value of @env{GCC_EXEC_PREFIX} is
22688 @file{@var{prefix}/lib/gcc/} where @var{prefix} is the prefix to
22689 the installed compiler. In many cases @var{prefix} is the value
22690 of @code{prefix} when you ran the @file{configure} script.
22692 Other prefixes specified with @option{-B} take precedence over this prefix.
22694 This prefix is also used for finding files such as @file{crt0.o} that are
22695 used for linking.
22697 In addition, the prefix is used in an unusual way in finding the
22698 directories to search for header files.  For each of the standard
22699 directories whose name normally begins with @samp{/usr/local/lib/gcc}
22700 (more precisely, with the value of @env{GCC_INCLUDE_DIR}), GCC tries
22701 replacing that beginning with the specified prefix to produce an
22702 alternate directory name.  Thus, with @option{-Bfoo/}, GCC searches
22703 @file{foo/bar} just before it searches the standard directory 
22704 @file{/usr/local/lib/bar}.
22705 If a standard directory begins with the configured
22706 @var{prefix} then the value of @var{prefix} is replaced by
22707 @env{GCC_EXEC_PREFIX} when looking for header files.
22709 @item COMPILER_PATH
22710 @findex COMPILER_PATH
22711 The value of @env{COMPILER_PATH} is a colon-separated list of
22712 directories, much like @env{PATH}.  GCC tries the directories thus
22713 specified when searching for subprograms, if it can't find the
22714 subprograms using @env{GCC_EXEC_PREFIX}.
22716 @item LIBRARY_PATH
22717 @findex LIBRARY_PATH
22718 The value of @env{LIBRARY_PATH} is a colon-separated list of
22719 directories, much like @env{PATH}.  When configured as a native compiler,
22720 GCC tries the directories thus specified when searching for special
22721 linker files, if it can't find them using @env{GCC_EXEC_PREFIX}.  Linking
22722 using GCC also uses these directories when searching for ordinary
22723 libraries for the @option{-l} option (but directories specified with
22724 @option{-L} come first).
22726 @item LANG
22727 @findex LANG
22728 @cindex locale definition
22729 This variable is used to pass locale information to the compiler.  One way in
22730 which this information is used is to determine the character set to be used
22731 when character literals, string literals and comments are parsed in C and C++.
22732 When the compiler is configured to allow multibyte characters,
22733 the following values for @env{LANG} are recognized:
22735 @table @samp
22736 @item C-JIS
22737 Recognize JIS characters.
22738 @item C-SJIS
22739 Recognize SJIS characters.
22740 @item C-EUCJP
22741 Recognize EUCJP characters.
22742 @end table
22744 If @env{LANG} is not defined, or if it has some other value, then the
22745 compiler uses @code{mblen} and @code{mbtowc} as defined by the default locale to
22746 recognize and translate multibyte characters.
22747 @end table
22749 @noindent
22750 Some additional environment variables affect the behavior of the
22751 preprocessor.
22753 @include cppenv.texi
22755 @c man end
22757 @node Precompiled Headers
22758 @section Using Precompiled Headers
22759 @cindex precompiled headers
22760 @cindex speed of compilation
22762 Often large projects have many header files that are included in every
22763 source file.  The time the compiler takes to process these header files
22764 over and over again can account for nearly all of the time required to
22765 build the project.  To make builds faster, GCC allows you to
22766 @dfn{precompile} a header file.
22768 To create a precompiled header file, simply compile it as you would any
22769 other file, if necessary using the @option{-x} option to make the driver
22770 treat it as a C or C++ header file.  You may want to use a
22771 tool like @command{make} to keep the precompiled header up-to-date when
22772 the headers it contains change.
22774 A precompiled header file is searched for when @code{#include} is
22775 seen in the compilation.  As it searches for the included file
22776 (@pxref{Search Path,,Search Path,cpp,The C Preprocessor}) the
22777 compiler looks for a precompiled header in each directory just before it
22778 looks for the include file in that directory.  The name searched for is
22779 the name specified in the @code{#include} with @samp{.gch} appended.  If
22780 the precompiled header file can't be used, it is ignored.
22782 For instance, if you have @code{#include "all.h"}, and you have
22783 @file{all.h.gch} in the same directory as @file{all.h}, then the
22784 precompiled header file is used if possible, and the original
22785 header is used otherwise.
22787 Alternatively, you might decide to put the precompiled header file in a
22788 directory and use @option{-I} to ensure that directory is searched
22789 before (or instead of) the directory containing the original header.
22790 Then, if you want to check that the precompiled header file is always
22791 used, you can put a file of the same name as the original header in this
22792 directory containing an @code{#error} command.
22794 This also works with @option{-include}.  So yet another way to use
22795 precompiled headers, good for projects not designed with precompiled
22796 header files in mind, is to simply take most of the header files used by
22797 a project, include them from another header file, precompile that header
22798 file, and @option{-include} the precompiled header.  If the header files
22799 have guards against multiple inclusion, they are skipped because
22800 they've already been included (in the precompiled header).
22802 If you need to precompile the same header file for different
22803 languages, targets, or compiler options, you can instead make a
22804 @emph{directory} named like @file{all.h.gch}, and put each precompiled
22805 header in the directory, perhaps using @option{-o}.  It doesn't matter
22806 what you call the files in the directory; every precompiled header in
22807 the directory is considered.  The first precompiled header
22808 encountered in the directory that is valid for this compilation is
22809 used; they're searched in no particular order.
22811 There are many other possibilities, limited only by your imagination,
22812 good sense, and the constraints of your build system.
22814 A precompiled header file can be used only when these conditions apply:
22816 @itemize
22817 @item
22818 Only one precompiled header can be used in a particular compilation.
22820 @item
22821 A precompiled header can't be used once the first C token is seen.  You
22822 can have preprocessor directives before a precompiled header; you cannot
22823 include a precompiled header from inside another header.
22825 @item
22826 The precompiled header file must be produced for the same language as
22827 the current compilation.  You can't use a C precompiled header for a C++
22828 compilation.
22830 @item
22831 The precompiled header file must have been produced by the same compiler
22832 binary as the current compilation is using.
22834 @item
22835 Any macros defined before the precompiled header is included must
22836 either be defined in the same way as when the precompiled header was
22837 generated, or must not affect the precompiled header, which usually
22838 means that they don't appear in the precompiled header at all.
22840 The @option{-D} option is one way to define a macro before a
22841 precompiled header is included; using a @code{#define} can also do it.
22842 There are also some options that define macros implicitly, like
22843 @option{-O} and @option{-Wdeprecated}; the same rule applies to macros
22844 defined this way.
22846 @item If debugging information is output when using the precompiled
22847 header, using @option{-g} or similar, the same kind of debugging information
22848 must have been output when building the precompiled header.  However,
22849 a precompiled header built using @option{-g} can be used in a compilation
22850 when no debugging information is being output.
22852 @item The same @option{-m} options must generally be used when building
22853 and using the precompiled header.  @xref{Submodel Options},
22854 for any cases where this rule is relaxed.
22856 @item Each of the following options must be the same when building and using
22857 the precompiled header:
22859 @gccoptlist{-fexceptions}
22861 @item
22862 Some other command-line options starting with @option{-f},
22863 @option{-p}, or @option{-O} must be defined in the same way as when
22864 the precompiled header was generated.  At present, it's not clear
22865 which options are safe to change and which are not; the safest choice
22866 is to use exactly the same options when generating and using the
22867 precompiled header.  The following are known to be safe:
22869 @gccoptlist{-fmessage-length=  -fpreprocessed  -fsched-interblock @gol
22870 -fsched-spec  -fsched-spec-load  -fsched-spec-load-dangerous @gol
22871 -fsched-verbose=@var{number}  -fschedule-insns  -fvisibility= @gol
22872 -pedantic-errors}
22874 @end itemize
22876 For all of these except the last, the compiler automatically
22877 ignores the precompiled header if the conditions aren't met.  If you
22878 find an option combination that doesn't work and doesn't cause the
22879 precompiled header to be ignored, please consider filing a bug report,
22880 see @ref{Bugs}.
22882 If you do use differing options when generating and using the
22883 precompiled header, the actual behavior is a mixture of the
22884 behavior for the options.  For instance, if you use @option{-g} to
22885 generate the precompiled header but not when using it, you may or may
22886 not get debugging information for routines in the precompiled header.